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

Type Branch

         object --+            
                  |            
    NamespaceObject --+        
                      |        
            ArchiveItem --+    
                          |    
               CategoryItem --+
                              |
         object --+           |
                  |           |
    NamespaceObject --+       |
                      |       |
       RevisionIterable --+   |
                          |   |
     object --+           |   |
              |           |   |
NamespaceObject --+       |   |
                  |       |   |
        ArchiveItem --+   |   |
                      |   |   |
              Setupable --+   |
                          |   |
                    Package --+
                              |
         object --+           |
                  |           |
    NamespaceObject --+       |
                      |       |
       RevisionIterable --+   |
                          |   |
            VersionIterable --+
                              |
                             Branch


Arch branch namespace object.

:see: `Archive`, `Category`, `Version`, `Revision`

Method Summary
  __init__(self, name)
Create a Branch object from its name.
  __getitem__(self, v)
Instanciate a version belonging to this branch.
  as_version(self)
Deprecated.
  exists(self)
Does this namespace exists? Within the Arch model, history cannot be changed: created archive entries cannot be deleted.
  get_library_versions(self, reverse)
Deprecated.
  get_versions(self, reverse)
Deprecated.
  iter_library_versions(self, reverse)
Iterate over library revisions.
  iter_versions(self, reverse)
Iterate over archive versions.
  latest_version(self)
Latest version in this branch.
    Inherited from CategoryItem
  get_category(self)
Deprecated.
    Inherited from Package
  as_revision(self)
Deprecated.
  latest_revision(self)
Latest revision in this package.
    Inherited from Setupable
  setup(self)
Deprecated.
    Inherited from ArchiveItem
  get_archive(self)
Deprecated.
  get_fullname(self)
Deprecated Fully qualified name of this namespace object.
  get_nonarch(self)
Deprecated.
    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.
    Inherited from object
  __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
  library_versions: Deprecated.
  versions: Deprecated.
    Inherited from CategoryItem
  category: Category which contains this object.
    Inherited from ArchiveItem
  archive: Archive which contains this namespace object.
  fullname: Fully qualfied name of this namespace object.
  nonarch: Non-arch part of this namespace name.

Method Details

__init__(self, name)
(Constructor)

Create a Branch object from its name.

:param name: fully-qualified branch name, like
    "jdoe@example.com--2004/frob--devo" or
    "jdoe@example.com--2004/frob".
:type name: str
:raise errors.NamespaceError: ``name`` is not a valid branch name.
Overrides:
pybaz.ArchiveItem.__init__

__getitem__(self, v)
(Indexing operator)

Instanciate a version belonging to this branch.

For example ``Branch('jdoe@example.com/frob--devel')['0']`` is
equivalent to ``Branch('jdoe@example.com/frob--devel--0')``.

:param v: branch id.
:type v: str
:rtype: `Version`

:raise NamespaceError: argument is not a valid version id.

as_version(self)

Deprecated.

Latest version in this branch.

:rtype: `Version`
:precondition: `self.exists()` returns ``True``
:precondition: `self.iter_versions` yields at least one object.
:raise IndexError: this branch is empty.
:see: `latest_version`

exists(self)

Does this namespace exists?

Within the Arch model, history cannot be changed: created archive
entries cannot be deleted. However, it is possible to ``unregister`` an
archive, or to find references to archives whose location is not known.
Thus, existence cannot always be decided. Testing for the existence of
a name in a non-registered archive raises
`errors.ArchiveNotRegistered`.

:return: whether this namespace object exists.
:rtype: bool
:raise errors.ArchiveNotRegistered: the archive name is not registered,
    so existence cannot be decided.
:raise errors.ExecProblem: there was a problem accessing the archive.
Overrides:
pybaz.NamespaceObject.exists (inherited documentation)

get_library_versions(self, reverse=False)

Deprecated.

Versions in this branch present in the library.

:rtype: tuple of `Version`
:see: `iter_library_versions`

get_versions(self, reverse=False)

Deprecated.

Versions in this branch.

:rtype: tuple of `Version`
:see: `iter_versions`

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)

latest_version(self)

Latest version in this branch.

:rtype: `Version`
:precondition: `self.exists()` returns ``True``
:precondition: `self.iter_versions` yields at least one object.
:raise ValueError: the archive is not registered, or this branch does
    not exist, or it contains no version.

Property Details

library_versions

Deprecated.

Versions in this branch present in the library.

:type: tuple of `Version`
:see: `iter_library_versions`

versions

Deprecated.

Versions in this branch.

:type: tuple of `Version`
:see: `iter_versions`

Generated by Epydoc 2.1 on Thu Feb 2 14:21:54 2006 http://epydoc.sf.net