1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
"""
: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()
|
