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

Type BranchIterable

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

Known Subclasses:
Category, CategoryIterable

Base class for archive classes above Branch.

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

Method Summary
  iter_branches(self)
Iterate over archive branches.
  iter_library_branches(self)
Iterate over library branches.
  iter_library_versions(self, reverse)
Iterate over library revisions.
  iter_versions(self, reverse)
Iterate over archive versions.
    Inherited from VersionIterable
  iter_library_revisions(self, reverse)
Iterate over library revisions.
  iter_revisions(self, reverse)
Iterate over archive revisions.
    Inherited from NamespaceObject
  __eq__(self, x)
Compare types and fully-qualified names.
  __ne__(self, x)
Compare types and fully-qualified names.
  __repr__(self)
Fully-qualified name in angle brackets.
  __str__(self)
Fully-qualified name.
  exists(self)
Does this namespace exists? Within the Arch model, history cannot be changed: created archive entries cannot be deleted.
  get_fullname(self)
Deprecated Fully qualified name of this namespace object.
    Inherited from object
  __init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature...
  __delattr__(...)
x.__delattr__('name') <==> del x.name...
  __getattribute__(...)
x.__getattribute__('name') <==> x.name...
  __hash__(x)
x.__hash__() <==> hash(x)...
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle...
  __reduce_ex__(...)
helper for pickle...
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value...

Property Summary
    Inherited from NamespaceObject
  fullname: Fully qualfied name of this namespace object.

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:
pybaz.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:
pybaz.VersionIterable.iter_versions (inherited documentation)

Generated by Epydoc 2.1 on Tue Jul 11 07:23:51 2006 http://epydoc.sf.net