Package gavo :: Package base :: Module meta :: Class MetaValue

Class MetaValue

object --+    
         |    
 MetaMixin --+
             |
            MetaValue

Known Subclasses:

is a piece of meta information about a resource.

The content is always a string.

The text content may be in different formats, notably

literal
rst (restructured text)
plain (the default)
raw (for embedded HTML, mainly -- only use this if you know the item will only be embedded into HTML templates).

Instance Methods

__init__(self, content='', format='plain')
is a constructor for standalone use. source code

__str__(self)
str(x)

source code

__unicode__(self)

source code

getExpandedContent(self, macroPackage)

source code

getContent(self, targetFormat='text', macroPackage=None) source code

encode(self, enc)

source code

copy(self)
returns a deep copy of self.

source code

Inherited from MetaMixin: addMeta, buildRepr, copyMetaFrom, delMeta, getAllMetaPairs, getMeta, getMetaKeys, getMetaParent, isEmpty, iterMeta, keys, makeOriginal, setMeta, setMetaParent, traverse

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables
	knownFormats = `set(['literal', 'plain', 'raw', 'rst'])`
	paragraphPat = `re.compile(r'\n\s*\n')`
	consecutiveWSPat = `re.compile(r'\s\s+')`
	plainWrapper = `<gavo.base.meta._NoHyphenWrapper object>`

Properties
Inherited from `object`: `__class__`

Method Details

init(self, content=`''`, format=`'plain'`)
(Constructor)

source code

is a constructor for standalone use. You do *not* want to call this when mixing into a Structure.

Overrides: object.__init__: (inherited documentation)

str(self)
(Informal representation operator)

source code

str(x)

Overrides: object.__str__: (inherited documentation)

Class MetaValue

__init__(self, content='', format='plain') (Constructor)

__str__(self) (Informal representation operator)

init(self, content=`''`, format=`'plain'`)
(Constructor)

str(self)
(Informal representation operator)