Package pybaz :: Class CategoryIterable

Class CategoryIterable

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

Known Subclasses:: Archive

Base class for Archive.

CategoryIterable provides features for the aspect of Archive wich
relates to its containing other archive objects.

Instance Methods

iter_branches(self)
Iterate over archive branches.

iter_categories(self)
Iterate over archive categories.

iter_library_branches(self)
Iterate over library branches.

iter_library_categories(self)
Iterate over library categories.

Inherited from BranchIterable: iter_library_versions, iter_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``.

Overrides: BranchIterable.iter_branches: (inherited documentation)

iter_categories(self)

Iterate over archive categories.

:return: all existing categories in this namespace.
:rtype: iterable of `Category`
: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`

Overrides: BranchIterable.iter_library_branches: (inherited documentation)

iter_library_categories(self)

Iterate over library categories.

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