Home       Trees       Index       Help   
Package Pootle :: Package storage :: Module api :: Class IFolder
[show private | hide private]
[frames | no frames]

Type IFolder

 object --+        
          |        
  Interface --+    
              |    
   IAnnotatable --+
                  |
 object --+       |
          |       |
  Interface --+   |
              |   |
IHaveStatistics --+
                  |
 object --+       |
          |       |
  Interface --+   |
              |   |
    IRefersToDB --+
                  |
 object --+       |
          |       |
  Interface --+   |
              |   |
    ISearchable --+
                  |
                 IFolder

A folder is a collection of modules and possibly other folders.
Method Summary
  __getitem__(self, key)
Return a module or a subfolder.
  __len__(self)
  find_containers(self, substring)
Find containers with a given substring in their name.
    Inherited from IHaveStatistics
  statistics(self)
Return statistics for this object.
    Inherited from ISearchable
  find(self, substring)
Search for a substring in all translation units.
    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
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
NoneType folder = None                                                                  
type key = Pootle.storage.api.String
type modules = Pootle.storage.api.IMapping
type subfolders = Pootle.storage.api.IMapping
    Inherited from IAnnotatable
NoneType annotations = None                                                                  
    Inherited from IRefersToDB
NoneType db = None                                                                  

Method Details

__getitem__(self, key)
(Indexing operator)

Return a module or a subfolder.

If both a subfolder and a module happen to have the key, the subfolder is returned.

This is a convenience method; it is usually better to use folder.modules[] or subfolder.modules[] directly.

find_containers(self, substring)

Find containers with a given substring in their name.

Performs a recursive search.

Returns a tuple ([folder, ...], [module, ...]).

Class Variable Details

folder

Type:
NoneType
Value:
None                                                                  

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Tue Aug 22 04:29:45 2006 http://epydoc.sf.net