Package gavo :: Package grammars :: Module kvgrammar :: Class KeyValueGrammar

Class KeyValueGrammar

                   object --+                
                            |                
 base.structure.StructureBase --+            
                                |            
                   object --+   |            
                            |   |            
           base.common.Parser --+            
                                |            
base.structure.ParseableStructure --+        
                                    |        
             base.structure.Structure --+    
                                        |    
                   object --+           |    
                            |           |    
     base.macros.MacroPackage --+       |    
                                |       |    
   base.macros.StandardMacroMixin --+   |    
                                    |   |    
             common.GrammarMacroMixin --+    
                                        |    
                           common.Grammar --+
                                            |
                                           KeyValueGrammar

A grammar to parse key-value pairs from files.

The default assumes one pair per line, with # comments and = as separating character.

yieldPairs makes the grammar return an empty docdict and {"key":, "value":} rowdicts.

Whitespace around key and value is ignored.

Nested Classes
	rowIterator is an iterator over a file containing key, value pairs.
Inherited from `base.structure.StructureBase`: `__metaclass__`

Instance Methods

onElementComplete(self)

source code

clearProperty(self, name)

source code

getFullId(self)

source code

getProperty(self, name, default=<Undefined>)

source code

hasProperty(self, name)

source code

setProperty(self, name, value)

source code

Inherited from common.Grammar: getSourceFields, parse

Inherited from base.structure.Structure: __provides__, callCompletedCallbacks, completeElement, finishElement, validate

Inherited from base.structure.ParseableStructure: __init__, end_, feed, feedFrom, feedObject, getAttribute, iterEvents, start_, value_

Inherited from base.structure.StructureBase: __providedBy__, adopt, breakCircles, change, copy, getAttributes, getCopyableAttributes, getSourcePosition, iterChildren, setPosition

Inherited from base.common.Parser: feedEvent

Inherited from common.GrammarMacroMixin: macro_colNames, macro_dlMetaURI, macro_fullDLURL, macro_inputRelativePath, macro_inputSize, macro_lastSourceElements, macro_property, macro_rootlessPath, macro_rowsProcessed, macro_sourceDate, macro_splitPreviewPath, macro_srcstem, macro_standardPreviewPath

Inherited from base.macros.StandardMacroMixin: macro_RSTservicelink, macro_RSTtable, macro_decapitalize, macro_getConfig, macro_internallink, macro_magicEmpty, macro_metaSeq, macro_metaString, macro_rdId, macro_rdIdDotted, macro_schema, macro_test, macro_today, macro_upper, macro_urlquote

Inherited from base.macros.MacroPackage: execMacro, expand, getExpander, listMacros, macro_quote, macro_reSub, macro_sql_standardPubDID, macro_sqlquote

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

Class Methods
Inherited from `base.structure.StructureBase`: `fromStructure`

Class Variables
	name_ = `'keyValueGrammar'` a sentinel for all kinds of undefined values.
	attrSeq = `[<gavo.grammars.common.REAttribute object>, <gavo.ba...`
	managedAttrs = `{'commentPattern': <gavo.grammars.common.REAttr...`
Inherited from `common.Grammar`: `isDispatching` Inherited from `base.structure.Structure`: `__implemented__` Inherited from `base.structure.StructureBase`: `completedCallbacks`

Properties
	rd
Inherited from `object`: `__class__`

Method Details

Class Variable Details

attrSeq

Value:

[<gavo.grammars.common.REAttribute object>,
 <gavo.base.attrdef.UnicodeAttribute object>,
 <gavo.base.parsecontext.IdAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.attrdef.UnicodeAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.parsecontext.OriginalAttribute object>,
 <gavo.base.attrdef.UnicodeAttribute object>,
...

managedAttrs

Value:

{'commentPattern': <gavo.grammars.common.REAttribute object>,
 'enc': <gavo.base.attrdef.UnicodeAttribute object>,
 'id': <gavo.base.parsecontext.IdAttribute object>,
 'ignoreOn': <gavo.base.complexattrs.StructAttribute object>,
 'kvSeparators': <gavo.base.attrdef.UnicodeAttribute object>,
 'mapKeys': <gavo.base.complexattrs.StructAttribute object>,
 'original': <gavo.base.parsecontext.OriginalAttribute object>,
 'pairSeparators': <gavo.base.attrdef.UnicodeAttribute object>,
...

Property Details

rd

Get Method:: unreachable._getRD(self)