Package gavo :: Package grammars :: Module cdfgrammar :: Class CDFHeaderGrammar
[frames] | no frames]

Class CDFHeaderGrammar

source code

                   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 --+
                                            |
                                           CDFHeaderGrammar

A grammar that returns the header dictionary of a CDF file (global attributes).

This grammar yields a single dictionary per file, which corresponds to the global attributes. The values in this dictionary may have complex structure; in particular, sequences are returned as lists.

To use this grammar, additional software is required that (by 2014) is not packaged for Debian. See https://pythonhosted.org/SpacePy/install.html for installation instructions. Note that you must install the CDF library itself as described further down on that page; the default installation instructions do not install the library in a public place, so if you use these, you'll have to set CDF_LIB to the right value, too, before running dachs imp.

Nested Classes
  rowIterator
an iterator for headers of CDF files.

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_ = 'cdfHeaderGrammar'
a sentinel for all kinds of undefined values.
  attrSeq = [<gavo.base.attrdef.BooleanAttribute object>, <gavo....
  managedAttrs = {'autoAtomize': <gavo.base.attrdef.BooleanAttri...

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

onElementComplete(self)

source code 
Overrides: base.structure.Structure.onElementComplete

clearProperty(self, name)

source code 
Overrides: common.Grammar.clearProperty

getFullId(self)

source code 
Overrides: common.Grammar.getFullId

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

source code 
Overrides: common.Grammar.getProperty

hasProperty(self, name)

source code 
Overrides: common.Grammar.hasProperty

setProperty(self, name, value)

source code 
Overrides: common.Grammar.setProperty

Class Variable Details

attrSeq

Value:
[<gavo.base.attrdef.BooleanAttribute object>,
 <gavo.base.attrdef.UnicodeAttribute object>,
 <gavo.base.parsecontext.IdAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.parsecontext.OriginalAttribute object>,
 <gavo.base.complexattrs.PropertyAttribute object>,
 <gavo.rscdef.common.RDAttribute object>,
...

managedAttrs

Value:
{'autoAtomize': <gavo.base.attrdef.BooleanAttribute object>,
 'enc': <gavo.base.attrdef.UnicodeAttribute object>,
 'id': <gavo.base.parsecontext.IdAttribute object>,
 'ignoreOn': <gavo.base.complexattrs.StructAttribute object>,
 'mapKeys': <gavo.base.complexattrs.StructAttribute object>,
 'original': <gavo.base.parsecontext.OriginalAttribute object>,
 'properties': <gavo.base.complexattrs.PropertyAttribute object>,
 'property': <gavo.base.complexattrs.PropertyAttribute object>,
...

Property Details

rd

Get Method:
unreachable._getRD(self)