mirror of
https://github.com/wxWidgets/Phoenix.git
synced 2025-07-21 12:41:10 +02:00
e4e8bf8317
Adding missing close for open. If the "close()" call is missing after a "open(filename)" call, the filename isn't guaranteed to be closed before the interpreter exits. This is generally a bad practice as explained here: https://stackoverflow.com/questions/7395542/is-explicitly-closing-files-important Also replaced "fid=open(filename) fid.close()" statements for files with the safer "with open(filename) as fid:" blocks. See https://www.python.org/dev/peps/pep-0343/
271 lines
9.4 KiB
Python
271 lines
9.4 KiB
Python
"""
|
|
|
|
:copyright: Copyright 2006-2009 by Oliver Schoenborn, all rights reserved.
|
|
:license: BSD, see LICENSE.txt for details.
|
|
|
|
|
|
"""
|
|
import os
|
|
import unittest
|
|
from unittests import wtc
|
|
|
|
from textwrap import dedent
|
|
|
|
|
|
class my_topics:
|
|
class rootTopic1:
|
|
'''Root topic 1'''
|
|
|
|
class subtopic_1:
|
|
'''
|
|
Sub topic 1 of root topic. Docs rely on one blank line for
|
|
topic doc, and indentation for each argument doc.
|
|
'''
|
|
|
|
def msgDataSpec(arg1, arg2=None):
|
|
'''
|
|
- arg1: some multiline doc
|
|
for arg1
|
|
- arg2: some multiline doc
|
|
for arg2
|
|
'''
|
|
pass
|
|
|
|
class subsubtopic_12:
|
|
'''Sub sub topic 2 of sub topic 1.'''
|
|
|
|
def msgDataSpec(arg1, argA, arg2=None, argB=None):
|
|
'''
|
|
- argA: doc for argA
|
|
- argB: doc for argB
|
|
'''
|
|
pass
|
|
|
|
class rootTopic2:
|
|
'''Root topic 2'''
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
|
class lib_pubsub_Except(wtc.PubsubTestCase):
|
|
|
|
def test1(self):
|
|
|
|
self.pub.addTopicDefnProvider(my_topics, self.pub.TOPIC_TREE_FROM_CLASS)
|
|
|
|
|
|
provString = """
|
|
class rootTopic1:
|
|
class subtopic_1:
|
|
class subsubtopic_11:
|
|
'''
|
|
Sub sub topic 1 of sub topic 1. Only need to doc the
|
|
extra args.
|
|
'''
|
|
def msgDataSpec(arg1, arg3, arg2=None, arg4=None):
|
|
'''
|
|
- arg3: doc for arg3
|
|
- arg4: doc for arg4
|
|
'''
|
|
pass
|
|
|
|
"""
|
|
|
|
self.pub.addTopicDefnProvider(provString,
|
|
format=self.pub.TOPIC_TREE_FROM_STRING)
|
|
|
|
|
|
provFile = """
|
|
class rootTopic1:
|
|
class subtopic_2:
|
|
class subsubtopic_21:
|
|
'''Sub sub topic 1 of sub topic 2.'''
|
|
def msgDataSpec(arg1, arg2=None, someArg=456, arg4=None):
|
|
'''
|
|
- arg1: doc for arg1
|
|
- arg2: doc for arg2
|
|
- arg4: doc for arg4
|
|
'''
|
|
pass
|
|
"""
|
|
|
|
with open('myTopicTree.py', 'w') as myTopicTree:
|
|
myTopicTree.write(dedent(provFile))
|
|
self.pub.addTopicDefnProvider('myTopicTree',
|
|
format=self.pub.TOPIC_TREE_FROM_MODULE)
|
|
import os
|
|
os.remove('myTopicTree.py')
|
|
if os.path.exists('myTopicTree.pyc'):
|
|
os.remove('myTopicTree.pyc')
|
|
|
|
assert not self.pub.getDefaultTopicMgr().getTopic('rootTopic1.subtopic_2', okIfNone=True)
|
|
# the following should create all topic tree since parent
|
|
# topics are automatically created
|
|
assert self.pub.getDefaultTopicMgr().getOrCreateTopic('rootTopic1.subtopic_1.subsubtopic_11')
|
|
assert self.pub.getDefaultTopicMgr().getOrCreateTopic('rootTopic1.subtopic_1.subsubtopic_12')
|
|
assert self.pub.getDefaultTopicMgr().getOrCreateTopic('rootTopic1.subtopic_2.subsubtopic_21')
|
|
|
|
# validate that topic specs were properly parsed
|
|
def isValid(topicName, listener):
|
|
topic = self.pub.getDefaultTopicMgr().getTopic(topicName)
|
|
assert topic.getDescription()
|
|
assert topic.hasMDS()
|
|
return topic.isValid(listener)
|
|
|
|
def sub():
|
|
pass
|
|
def sub_1(arg1, arg2=123):
|
|
pass
|
|
def sub_11(arg1, arg3, arg2=None, arg4=None):
|
|
pass
|
|
assert isValid('rootTopic1', sub)
|
|
assert isValid('rootTopic1.subtopic_1', sub_1)
|
|
assert isValid('rootTopic1.subtopic_1.subsubtopic_11', sub_11)
|
|
# no providers have spec for subtopic_2
|
|
assert not self.pub.getDefaultTopicMgr().getTopic('rootTopic1.subtopic_2').hasMDS()
|
|
|
|
#printTreeSpec()
|
|
|
|
self.pub.exportTopicTreeSpec('newTopicTree')
|
|
root2Defn = self.pub.exportTopicTreeSpec(rootTopic='rootTopic1')
|
|
|
|
import os
|
|
os.remove('newTopicTree.py')
|
|
if os.path.exists('newTopicTree.pyc'):
|
|
os.remove('newTopicTree.pyc')
|
|
|
|
|
|
@unittest.skip("TODO: This test may need fixed after update from PyPubSub")
|
|
def test2_import_export_no_change(self):
|
|
#
|
|
# Test that import/export/import does not change the import
|
|
#
|
|
|
|
importStr = '''
|
|
"""Tree docs, can be anything you want."""
|
|
|
|
class test_import_export_no_change:
|
|
"""Root topic 1."""
|
|
|
|
class subtopic_1:
|
|
"""
|
|
Sub topic 1 of root topic. Docs rely on one
|
|
blank line for topic doc, and indentation for
|
|
each argument doc.
|
|
"""
|
|
|
|
def msgDataSpec(arg1, arg2=None):
|
|
"""
|
|
- arg1: some multiline doc
|
|
for arg1
|
|
- arg2: some multiline doc
|
|
for arg2
|
|
"""
|
|
pass
|
|
'''
|
|
self.pub.clearTopicDefnProviders()
|
|
provider = self.pub.addTopicDefnProvider(importStr,
|
|
self.pub.TOPIC_TREE_FROM_STRING)
|
|
treeDoc = provider.getTreeDoc()
|
|
assert treeDoc == '''Tree docs, can be anything you want.'''
|
|
root = self.pub.getDefaultTopicMgr().getOrCreateTopic('test_import_export_no_change.subtopic_1')
|
|
# few sanity checks
|
|
def sub_1(arg1, arg2=None):
|
|
pass
|
|
assert root.hasMDS()
|
|
assert self.pub.isValid(sub_1, 'test_import_export_no_change.subtopic_1')
|
|
|
|
# export tree
|
|
exported = self.pub.exportTopicTreeSpec(rootTopic='test_import_export_no_change', moduleDoc=treeDoc)
|
|
#print exported
|
|
|
|
expectExport = '''\
|
|
# Automatically generated by TopicTreeSpecPrinter(**kwargs).
|
|
# The kwargs were:
|
|
# - fileObj: StringIO
|
|
# - footer: '# End of topic tree definition. Note that application may l...'
|
|
# - indentStep: 4
|
|
# - treeDoc: 'Tree docs, can be anything you want....'
|
|
# - width: 70
|
|
|
|
|
|
"""
|
|
Tree docs, can be anything you want.
|
|
"""
|
|
|
|
|
|
class test_import_export_no_change:
|
|
"""
|
|
Root topic 1.
|
|
"""
|
|
|
|
class subtopic_1:
|
|
"""
|
|
Sub topic 1 of root topic. Docs rely on one
|
|
blank line for topic doc, and indentation for
|
|
each argument doc.
|
|
"""
|
|
|
|
def msgDataSpec(arg1, arg2=None):
|
|
"""
|
|
- arg1: some multiline doc
|
|
for arg1
|
|
- arg2: some multiline doc
|
|
for arg2
|
|
"""
|
|
|
|
|
|
# End of topic tree definition. Note that application may load
|
|
# more than one definitions provider.
|
|
'''
|
|
|
|
# check there are no differences
|
|
from difflib import context_diff, ndiff
|
|
diffs = ndiff( dedent(expectExport).splitlines(), exported.splitlines())
|
|
diffs = [d for d in diffs if not d.startswith(' ')]
|
|
#print '\n'.join(diffs)
|
|
assert diffs == ['- ', '+ ']
|
|
|
|
# now for module:
|
|
import sys
|
|
sys.path.append(os.path.dirname(__file__))
|
|
provider = self.pub.addTopicDefnProvider('lib_pubsub_provider_expect',
|
|
self.pub.TOPIC_TREE_FROM_MODULE)
|
|
sys.path.remove(os.path.dirname(__file__))
|
|
self.pub.instantiateAllDefinedTopics(provider)
|
|
modDoc = provider.getTreeDoc()
|
|
assert modDoc.startswith('\nTree docs, can be anything you')
|
|
basepath = os.path.dirname(__file__)
|
|
self.pub.exportTopicTreeSpec(os.path.join(basepath,'lib_pubsub_provider_actual'),
|
|
rootTopic='test_import_export_no_change2',
|
|
moduleDoc=treeDoc)
|
|
with open(os.path.join(basepath,'lib_pubsub_provider_actual.py'), 'r') as f:
|
|
lines1 = f.readlines()
|
|
with open(os.path.join(basepath,'lib_pubsub_provider_expect.py'), 'r') as f:
|
|
lines2 = f.readlines()
|
|
diffs = ndiff( lines1, lines2 )
|
|
diffs = [d for d in diffs if not d.startswith(' ')]
|
|
assert not list(diffs) or list(diffs) == ['- # - fileObj: TextIOWrapper\n', '+ # - fileObj: file\n']
|
|
|
|
def test_module_as_class(self):
|
|
assert self.pub.getDefaultTopicMgr().getTopic('root_topic1', True) is None
|
|
assert self.pub.getDefaultTopicMgr().getTopic('root_topic2.sub_topic21', True) is None
|
|
|
|
from . import lib_pubsub_provider_my_import_topics
|
|
provider = self.pub.addTopicDefnProvider(lib_pubsub_provider_my_import_topics,
|
|
self.pub.TOPIC_TREE_FROM_CLASS)
|
|
self.pub.instantiateAllDefinedTopics(provider)
|
|
|
|
assert self.pub.getDefaultTopicMgr().getTopic('root_topic1') is not None
|
|
assert self.pub.getDefaultTopicMgr().getTopic('root_topic2.sub_topic21') is not None
|
|
|
|
self.pub.sendMessage(lib_pubsub_provider_my_import_topics.root_topic1)
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|
|
|