Package pybaz :: Class VersionIterable
[frames] | no frames]

Class VersionIterable

source code

     object --+        
              |        
NamespaceObject --+    
                  |    
   RevisionIterable --+
                      |
                     VersionIterable
Known Subclasses:
BranchIterable, Branch

Abstract class for archive classes above Version.

VersionIterable provides features which are common to all objects
containing versions.



Instance Methods
 
iter_library_revisions(self, reverse=False)
Iterate over library revisions.
 
iter_library_versions(self, reverse=False)
Iterate over library revisions.
 
iter_revisions(self, reverse=False)
Iterate over archive revisions.
 
iter_versions(self, reverse=False)
Iterate over archive versions.

Inherited from NamespaceObject: __eq__, __ne__, __repr__, __str__, exists, get_fullname

Inherited from object: __delattr__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __setattr__

Properties

Inherited from NamespaceObject: fullname

Inherited from object: __class__

Method Details

iter_library_revisions(self, reverse=False)

 
Iterate over library revisions.

:param reverse: reverse order, recent revisions first.
:type reverse: bool
:return: revisions in this namespace which are present in the
    revision library.
:rtype: iterable of `Revision`

Overrides: RevisionIterable.iter_library_revisions
(inherited documentation)

iter_library_versions(self, reverse=False)

 
Iterate over library revisions.

:param reverse: reverse order, higher versions first.
:type reverse: bool
:return: versions in this namespace which are present in the
    revision library.
:rtype: iterable of `Version`

iter_revisions(self, reverse=False)

 
Iterate over archive revisions.

:param reverse: reverse order, recent revisions first.
:type reverse: bool
:return: all existing revisions in this namespace.
:rtype: iterable of `Revision`

:precondition: `self.exists()` returns ``True``.

Overrides: RevisionIterable.iter_revisions
(inherited documentation)

iter_versions(self, reverse=False)

 
Iterate over archive versions.

:param reverse: reverse order, higher versions first.
:type reverse: bool
:return: all existing versions in this namespace.
:rtype: iterable of `Version`

:precondition: `self.exists()` returns ``True``.