B
lßU\±! ã @ sÖ d Z dZdZdZddlmZ ddlmZmZm Z yddl
m Z W nF e
k
r† yddlm Z W n e
k
r€ ddlm Z Y nX Y nX d d
d gZd d
„ ZdZG dd „ d eƒZG dd„ deƒZddd„Zddd
„ZdS )a3
Contributed by Joshua R English, adapted by Oliver Schoenborn to be
consistent with pubsub API.
An extension for pubsub (http://pubsub.sourceforge.net) so topic tree
specification can be encoded in XML format rather than pubsub's default
Python nested class format.
To use:
xml = '''
Test showing topic hierarchy and inheritance
Parent with a parameter and subtopics
given name
surname
This is the first child
A nickname
'''
These topic definitions are loaded through an XmlTopicDefnProvider:
pub.addTopicDefnProvider( XmlTopicDefnProvider(xml) )
The XmlTopicDefnProvider also accepts a filename instead of XML string:
provider = XmlTopicDefnProvider("path/to/XMLfile.xml", TOPIC_TREE_FROM_FILE)
pub.addTopicDefnProvider( provider )
Topics can be exported to an XML file using the exportTopicTreeSpecXml function.
This will create a text file for the XML and return the string representation
of the XML tree.
:copyright: Copyright since 2013 by Oliver Schoenborn, all rights reserved.
:license: BSD, see LICENSE_BSD_Simple.txt for details.
zJoshua R Englishé z
2013-07-27é )ÚITopicTreeVisitor)ÚITopicDefnProviderÚ ArgSpecGivenÚTOPIC_TREE_FROM_STRINGé )Ú ElementTreeÚXmlTopicDefnProviderÚexportTopicTreeSpecXmlÚTOPIC_TREE_FROM_FILEc C s< t | ¡s8yt | ¡} W n td| ƒ tdƒ‚Y nX | S )zh
Assume an ETree.Element object or a string representation.
Return the ETree.Element object
z Value ErrorzCannot convert to element)ÚETZ iselementZ
fromstringÚprintÚ
ValueError)Úelem© r ú@lib/python3.7/site-packages/pubsub/utils/xmltopicdefnprovider.pyÚ _get_elemJ s
r Úfilec @ sb e Zd ZG dd„ deƒZG dd„ deƒZefdd„Zdd„ Z dd
d „Z
d d
„ Z dd„ Z dd„ Z
d S )r c @ s e Zd ZdS )z#XmlTopicDefnProvider.XmlParserErrorN)Ú__name__Ú
__module__Ú __qualname__r r r r ÚXmlParserError\ s r c @ s e Zd ZdS )z2XmlTopicDefnProvider.UnrecognizedSourceFormatErrorN)r r r r r r r Ú UnrecognizedSourceFormatError_ s r c C sR i | _ d| _|tkr0| tt|dd ¡ ƒ¡ n |tkrH| t|ƒ¡ ntƒ ‚d S )NÚ Úr)Úmode) Ú_topicsÚ_treeDocr Ú _parse_treer ÚopenÚreadr r )ÚselfZxmlÚformatr r r Ú__init__b s z XmlTopicDefnProvider.__init__c C sN | d¡}|d krd| _nd |j ¡ ¡| _x | d¡D ]}| |¡ q8W d S )NÚ descriptionÚ UNDOCUMENTEDú Útopic)Úfindr ÚjoinÚtextÚsplitÚfindallÚ _parse_topic)r! ÚtreeZdoc_nodeÚnoder r r r l s
z XmlTopicDefnProvider._parse_treeNc
C s< |pg }|pi }|pg }| d¡}|d kr0d}nd |j ¡ ¡}| d¡}|d krZtdƒ‚xr| d¡D ]d}| d¡} | d kr„tdƒ‚|j ¡ }
|
p”d}
d |
¡ ¡}
|
|| < | dd ¡ ¡ d
krf| | ¡ qfW t
|t |ƒƒ} | | d¡¡ || f| j t |ƒ< x8| d ¡D ]*} |
| |d d … | ¡ |d d … ¡ q
W d S ) Nr$ r% r& Úidz'topic element must have an id attributezlistenerspec/argz%arg element must have an id attributeÚoptionalr )ÚtrueÚtZyesÚyr' )r( r) r* r+ Úgetr r, ÚstripÚlowerÚappendr Útupler r- Úcopy)
r! r/ ÚparentsZspecsZreqlistZdescNodeZdescZnode_idÚthisZthis_idZ this_descZdefnZsubtopicr r r r- w s2
z!XmlTopicDefnProvider._parse_topicc C s | j |d¡S )N)NN)r r5 )r! ZtopicNameTupler r r ÚgetDefnž s z XmlTopicDefnProvider.getDefnc C s
| j ¡ S )N)r Úkeys)r! r r r Ú
topicNames¡ s z XmlTopicDefnProvider.topicNamesc C s | j S )N)r )r! r r r Ú
getTreeDoc¤ s z XmlTopicDefnProvider.getTreeDoc)NNN)r r r Ú RuntimeErrorr r r r r# r r- r= r? r@ r r r r r [ s
'c @ s4 e Zd Zdd„ Zdd„ Zdd„ Zdd„ Zd d
„ Zd S ) Ú
XmlVisitorc C s || _ g | _d S )N)r. Ú known_topics)r! r r r r r# © s zXmlVisitor.__init__c C s | j g| _d S )N)r. Úroots)r! r r r Ú_startTraversal s zXmlVisitor._startTraversalc C s® | ¡ r| j| _d S | jr8t | jd dd| ¡ i¡}nt dd| ¡ i¡}| ¡ \}}|p^d}|pfd}t |d¡}| ¡ }|r’d
| ¡ ¡|_ nd|_ |
¡ }g }| ¡ } xB| rî| | jkrä| ¡ \}
} |
rÖ| |
¡ | rä| | ¡ | ¡ } q®W |sú|r˜t |d¡} xF|D ]>}
|
|kr q t | d d|
i¡}d
| |
d¡ ¡ ¡|_ q W xH|D ]@}
|
|krfqTt | d |
d
d œ¡}d
| |
d¡ ¡ ¡|_ qTW || _| j |¡ d S ) Néÿÿÿÿr' r0 r r$ r& r% Z listenerspecÚargÚTrue)r0 r1 )ZisAllr. Ú last_elemrD r Ú
SubElementZ getNodeNameÚElementZgetArgsZgetDescriptionr) r+ r* ZgetArgDescriptionsZ getParentrC Úextendr5 r8 )r! ZtopicObjZ this_elemZreqÚoptZ desc_elemZ topicDescZargDescriptionsZ
known_argsÚparentZp_reqZp_optÚspecrG Zarg_elemr r r Ú_onTopic° sP
zXmlVisitor._onTopicc C s | j | j¡ d S )N)rD r8 rI )r! r r r Ú_startChildrená s zXmlVisitor._startChildrenc C s | j ¡ d S )N)rD Úpop)r! r r r Ú _endChildrenä s zXmlVisitor._endChildrenN)r r r r# rE rP rQ rS r r r r rB ¨ s
1rB c C s¢ d|d }t | ƒr|| jr$| j ¡ s.|d | _x4| D ],}t||d ƒ |jrV|j ¡ s4|d |_q4W |jrt|j ¡ sž||_n"|r˜| jr| j ¡ s˜|| _nd| _d S )NÚ
z z é )Úlenr* r6 ÚindentÚtail)r ÚlevelÚiÚer r r rW é s
rW NÚbakc
C sÆ |dkr ddl m} | ¡ }n t|tƒr>ddl m} | |¡}t d¡}|rht |d¡}d |
¡ ¡|_ | t
|ƒ¡}| |¡ t|ƒ | r¼d| }|r¤| ||¡ t |¡} | |dd ¡ t |¡S )
zN
If rootTopic is None, then pub.getDefaultTopicTreeRoot() is assumed.
Nr )ÚpubZ
topicdefntreer$ r& z%s.xmlzutf-8T)r r] ZgetDefaultTopicTreeRootÚ
isinstanceÚstrZgetTopicr rK rJ r) r+ r* ZTopicTreeTraverserrB ZtraverserW Z_backupIfExistsr ÚwriteZtostring)
Z
moduleNameZ rootTopicr\ Z moduleDocr] r. Zmod_descZ traverserÚfilenameZfulltreer r r r
û s(
)r )NNr\ N)Ú__doc__Ú
__author__Z __revision__Z__date__Zcore.topictreetraverserr Zcore.topicdefnproviderr r r Z elementtreer r Ú ImportErrorZ xml.etreeZ cElementTreeÚ__all__r r r rB rW r
r r r r Ú. s* MA