| Home | Trees | Index | Help |
|---|
| Package Pootle :: Package storage :: Module api :: Class IAnnotatable |
|
object--+ |Interface--+ | IAnnotatable
IFolder,
IModule,
ITranslationStore,
ITranslationUnitAn 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 | |
x.__init__(...) initializes x; see x.__class__.__doc__ for signature | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
x.__hash__() <==> hash(x) | |
T.__new__(S, ...) -> a new object with type S, a subtype of T | |
helper for pickle | |
helper for pickle | |
x.__repr__() <==> repr(x) | |
x.__setattr__('name', value) <==> x.name = value | |
x.__str__() <==> str(x) | |
| Class Variable Summary | |
|---|---|
NoneType |
annotations = None |
| Class Variable Details |
|---|
annotations
|
| Home | Trees | Index | Help |
|---|
| Generated by Epydoc 2.1 on Tue Aug 22 04:29:46 2006 | http://epydoc.sf.net |