Package pybaz :: Class BranchIterable

Class BranchIterable

     object --+            
              |            
NamespaceObject --+        
                  |        
   RevisionIterable --+    
                      |    
        VersionIterable --+
                          |
                         BranchIterable

Known Subclasses:: CategoryIterable, Category

Base class for archive classes above Branch.

BranchIterable provides features which are common to all objects
containing branches.

Instance Methods

iter_branches(self)
Iterate over archive branches.

iter_library_branches(self)
Iterate over library branches.

iter_library_versions(self, reverse=False)
Iterate over library revisions.

iter_versions(self, reverse=False)
Iterate over archive versions.

Inherited from VersionIterable: iter_library_revisions, iter_revisions

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_branches(self)

Iterate over archive branches.

:return: all existing branches in this namespace.
:rtype: iterable of `Branch`
:precondition: `self.exists()` returns ``True``.

iter_library_branches(self)

Iterate over library branches.

:return: branches in this namespace which are present in the
    revision library.
:rtype: iterable of `Branch`

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`

Overrides: VersionIterable.iter_library_versions: (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``.

Overrides: VersionIterable.iter_versions: (inherited documentation)