Package Pootle :: Package storage :: Module api :: Class IAnnotatable
[show private | hide private]
[frames | no frames]

Type IAnnotatable

object --+    
         |    
 Interface --+
             |
            IAnnotatable

Known Subclasses:
IFolder, IModule, ITranslationStore, ITranslationUnit

An object that can have annotations.

Annotations are arbitrary pieces of data that are stored as strings. Each of these must have a key, a 7-bit string; the value must be an ordinary string or a unicode string.

Intended use of annotations is to store metadata, e.g., last modification date, last author, translation owner, permissions, etc.

Note that you can store arbitrary objects by simply pickling them before writing and then unpickling after read. However, transparent, human-readable strings are preferred. It may also be not a very good idea to use annotations for large blobs.

TODO: How about timing, when to serialize annotations?
Method Summary
    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 annotations = None                                                                  

Class Variable Details

annotations

Type:
NoneType
Value:
None                                                                  

Generated by Epydoc 2.1 on Tue Aug 22 04:29:46 2006 http://epydoc.sf.net