Package pyxb :: Package xmlschema :: Module structures :: Class Annotation

Class Annotation

                       object --+                
                                |                
                          cscRoot --+            
                                    |            
 utils.utility.PrivateTransient_mixin --+        
                                        |        
                           object --+   |        
                                    |   |        
                              cscRoot --+        
                                        |        
     namespace._ComponentDependency_mixin --+    
                                            |    
                           object --+       |    
                                    |       |    
                              cscRoot --+   |    
                                        |   |    
namespace.archive._ArchivableObject_mixin --+    
                                            |    
                           object --+       |    
                                    |       |    
                              cscRoot --+   |    
                                        |   |    
     utils.utility.PrivateTransient_mixin --+    
                                            |    
                           object --+       |    
                                    |       |    
                              cscRoot --+   |    
                                        |   |    
            utils.utility.Locatable_mixin --+    
                                            |    
                       _SchemaComponent_mixin --+
                                                |
                                               Annotation

An XMLSchema Annotation component.

Instance Methods

[hide private]

applicationInformation(self)

source code

userInformation(self)

source code

__init__(self, **kw)
Initialize portions of a component.

source code

asDocString(self, encoding='ascii', error='xmlcharrefreplace')
Return the text in a form suitable for embedding in a triple-double-quoted docstring. source code

text(self)

source code

__str__(self)
Return the catenation of all user information elements in the annotation as a single unicode string.

source code

Inherited from _SchemaComponent_mixin: bestNCName, hasBinding, isTypeDefinition, isUrTypeDefinition, nameInBinding, owner, setNameInBinding

Inherited from _SchemaComponent_mixin (private): _clearNamespaceContext, _clone, _cloneSource, _clones, _dissociateFromNamespace, _namespaceContext, _resetClone_csc, _scope, _scopeIsGlobal, _scopeIsIndeterminate, _setOwner, _setScope, _updateFromOther_csc

Inherited from namespace._ComponentDependency_mixin: bindingRequires

Inherited from namespace._ComponentDependency_mixin (private): _bindingRequires_vx

Inherited from namespace.archive._ArchivableObject_mixin (private): _allowUpdateFromOther, _objectOrigin, _prepareForArchive, _setObjectOrigin, _updateFromOther

Inherited from utils.utility.PrivateTransient_mixin: __getstate__

Inherited from utils.utility.Locatable_mixin (private): _location, _setLocation

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

Class Methods

[hide private]

CreateFromDOM(cls, node, **kw)

source code

Class Variables

[hide private]

__applicationInformation = None
hash(x)

__userInformation = None
hash(x)

__attributes = None
hash(x)

__RemoveMultiQuote_re = re.compile(r'""+')

Inherited from _SchemaComponent_mixin (private): _SchemaComponent_mixin__PrivateTransient, _SchemaComponent_mixin__cloneSource, _SchemaComponent_mixin__clones, _SchemaComponent_mixin__nameInBinding, _SchemaComponent_mixin__namespaceContext, _SchemaComponent_mixin__ownedComponents, _SchemaComponent_mixin__owner, _SchemaComponent_mixin__scope

Inherited from namespace._ComponentDependency_mixin (private): _ComponentDependency_mixin__PrivateTransient, _ComponentDependency_mixin__bindingRequires

Inherited from namespace.archive._ArchivableObject_mixin (private): _ArchivableObject_mixin__objectOrigin

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, **kw)
(Constructor)

source code

Initialize portions of a component.

Parameters:

scope - The scope in which the component is defined
namespace_context - The NamespaceContext to use within this component
node - If no namespace_context is provided, a DOM node must be provided from which a namespace context can be identified.
owner - Reference to the component that owns this one (the immediately enclosing component). Is None in the case of top-level components.
schema - Reference to the Schema component to which the component belongs. Required for every component except Schema, Annotation, and Wildcard.

Overrides: object.__init__

(inherited documentation)

asDocString(self, encoding=`'ascii'`, error=`'xmlcharrefreplace'`)

source code

Return the text in a form suitable for embedding in a triple-double-quoted docstring.

Any sequence of two or more double quotes is replaced by a sequence of single quotes that is the same length. Following this, spaces are added at the start and the end as necessary to ensure a double quote does not appear in those positions.

str(self)
(Informal representation operator)

source code

Return the catenation of all user information elements in the annotation as a single unicode string. Returns the empty string if there are no user information elements.

Overrides: object.__str__

Class Annotation

__init__(self, **kw) (Constructor)

asDocString(self, encoding='ascii', error='xmlcharrefreplace')

__str__(self) (Informal representation operator)

init(self, **kw)
(Constructor)

asDocString(self, encoding=`'ascii'`, error=`'xmlcharrefreplace'`)

str(self)
(Informal representation operator)