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

Type Category

     object --+                
              |                
NamespaceObject --+            
                  |            
   RevisionIterable --+        
                      |        
        VersionIterable --+    
                          |    
             BranchIterable --+
                              |
         object --+           |
                  |           |
    NamespaceObject --+       |
                      |       |
            ArchiveItem --+   |
                          |   |
                  Setupable --+
                              |
                             Category


Arch category namespace object.


See Also:

Archive, Branch, Version, Revision

Method Summary
  __init__(self, name)
Create a category object from its name.

Category

__getitem__(self, b)
Instanciate a branch belonging to this category.

bool

exists(self)
Does this namespace exists?

tuple of Branch

get_branches(self)
Deprecated.

tuple of Branch

get_library_branches(self)
Deprecated.

iterable of Branch

iter_branches(self)
Iterate over archive branches.

iterable of Branch

iter_library_branches(self)
Iterate over library branches.
    Inherited from Setupable
  setup(self)
Deprecated.
    Inherited from ArchiveItem

Archive

get_archive(self)
Deprecated.

str

get_fullname(self)
Deprecated

str

get_nonarch(self)
Deprecated.
    Inherited from BranchIterable

iterable of Version

iter_library_versions(self, reverse)
Iterate over library revisions.

iterable of Version

iter_versions(self, reverse)
Iterate over archive versions.
    Inherited from VersionIterable

iterable of Revision

iter_library_revisions(self, reverse)
Iterate over library revisions.

iterable of Revision

iter_revisions(self, reverse)
Iterate over archive revisions.
    Inherited from NamespaceObject

bool

__eq__(self, x)
Compare types and fully-qualified names.

bool

__ne__(self, x)
Compare types and fully-qualified names.

str

__repr__(self)
Fully-qualified name in angle brackets.

str

__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

tuple of Branch

branches: Deprecated.

tuple of Branch

library_branches: Deprecated.
    Inherited from ArchiveItem

Archive

archive: Archive which contains this namespace object.

str

fullname: Fully qualfied name of this namespace object.

str

nonarch: Non-arch part of this namespace name.

Method Details

__init__(self, name)
(Constructor)

Create a category object from its name.

Parameters:
name -

fully-qualified category name, like "jdoe@example.com/frob"


           (type=

str

)
Raises:
errors.NamespaceError -

name is not a valid category name.

Overrides:
pybaz.ArchiveItem.__init__

__getitem__(self, b)
(Indexing operator)

Instanciate a branch belonging to this category.

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

Parameters:
b -

branch id.


           (type=

str

)
Returns:

Category

Raises:
NamespaceError -

argument is not a valid branch id.

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.

Returns:

whether this namespace object exists.


           (type=

bool

)
Raises:
errors.ArchiveNotRegistered -

the archive name is not registered, so existence cannot be decided.

errors.ExecProblem -

there was a problem accessing the archive.

Overrides:
pybaz.NamespaceObject.exists (inherited documentation)

get_branches(self)

Deprecated.

Branches in this category.

Returns:

tuple of Branch

See Also:

iter_branches

get_library_branches(self)

Deprecated.

Branches in this category present in the library.

Returns:

tuple of Branch

See Also:

iter_library_branches

iter_branches(self)

Iterate over archive branches.

Returns:

all existing branches in this namespace.


           (type=

iterable of Branch

)
Overrides:
pybaz.BranchIterable.iter_branches (inherited documentation)

Precondition:

self.exists() returns True.

iter_library_branches(self)

Iterate over library branches.

Returns:

branches in this namespace which are present in the revision library.


           (type=

iterable of Branch

)
Overrides:
pybaz.BranchIterable.iter_library_branches (inherited documentation)

Property Details

branches

Deprecated.

Branches in this category.

library_branches

Deprecated.

Branches in this category present in the library.


Generated by Epydoc 2.1 on Fri Jul 7 17:05:34 2006 http://epydoc.sf.net