Skip to content

Commit 6e510f8

Browse files
author
Chaim-Leib Halbert
committed
refactored so that documents can be imported directly from tincan; refactored docstrings and error messages to match new simplified import scheme.
1 parent bff7989 commit 6e510f8

27 files changed

+165
-152
lines changed

‎test/documents/activity_profile_document_test.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@
2222
sys.path.insert(0, dirname(dirname(dirname(abspath(__file__)))))
2323
from test.main import setup_tincan_path
2424
setup_tincan_path()
25-
from tincan.documents import ActivityProfileDocument
26-
from tincan.activity import Activity
27-
from tincan.activity_definition import ActivityDefinition
28-
from tincan.language_map import LanguageMap
25+
from tincan import (
26+
ActivityProfileDocument,
27+
Activity,
28+
ActivityDefinition,
29+
LanguageMap,
30+
)
2931

3032

3133
class ActivityProfileDocumentTest(unittest.TestCase):

‎test/documents/agent_profile_document_test.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222
sys.path.insert(0, dirname(dirname(dirname(abspath(__file__)))))
2323
from test.main import setup_tincan_path
2424
setup_tincan_path()
25-
from tincan.documents import AgentProfileDocument
26-
from tincan.agent import Agent
25+
from tincan import AgentProfileDocument, Agent
2726

2827

2928
class AgentProfileDocumentTest(unittest.TestCase):

‎test/documents/document_test.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
sys.path.insert(0, dirname(dirname(dirname(abspath(__file__)))))
2323
from test.main import setup_tincan_path
2424
setup_tincan_path()
25-
from tincan.documents import Document
25+
from tincan import Document
2626

2727

2828
class DocumentTest(unittest.TestCase):

‎test/documents/state_document_test.py‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@
2222
sys.path.insert(0, dirname(dirname(dirname(abspath(__file__)))))
2323
from test.main import setup_tincan_path
2424
setup_tincan_path()
25-
from tincan.documents import StateDocument
26-
from tincan.agent import Agent
27-
from tincan.activity import Activity
28-
from tincan.activity_definition import ActivityDefinition
29-
from tincan.language_map import LanguageMap
25+
from tincan import (
26+
StateDocument,
27+
Agent,
28+
Activity,
29+
ActivityDefinition,
30+
LanguageMap
31+
)
3032

3133

3234
class StateDocumentTest(unittest.TestCase):

‎tincan/__init__.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@
3030
from base import Base
3131
from context import Context
3232
from context_activities import ContextActivities
33+
from documents.activity_profile_document import ActivityProfileDocument
34+
from documents.agent_profile_document import AgentProfileDocument
35+
from documents.document import Document
36+
from documents.state_document import StateDocument
3337
from extensions import Extensions
3438
from group import Group
3539
from http_request import HTTPRequest

‎tincan/about.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ def check_version(v):
103103
def extensions(self):
104104
"""Extensions for About
105105
106-
:setter: Tries to convert to Extensions. If None is provided,
107-
sets to an empty `tincan.Extensions` dict.
106+
:setter: Tries to convert to :class:`tincan.Extensions`. If None is provided,
107+
sets to an empty :class:`tincan.Extensions` dict.
108108
:setter type: :class:`tincan.Extensions` | dict | None
109109
:rtype: :class:`tincan.Extensions`
110110
"""

‎tincan/activity.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ def object_type(self, value):
7676
def definition(self):
7777
"""Definition for Activity
7878
79-
:setter: Tries to convert to ActivityDefinition
80-
:setter type: :mod:`tincan.activity_definition`
81-
:rtype: :mod:`tincan.activity_definition`
79+
:setter: Tries to convert to :class:`tincan.ActivityDefinition`
80+
:setter type: :class:`tincan.ActivityDefinition`
81+
:rtype: :class:`tincan.ActivityDefinition`
8282
8383
"""
8484
return self._definition

‎tincan/activity_definition.py‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ class ActivityDefinition(SerializableBase):
5858
def name(self):
5959
"""Name for Activity Definition
6060
61-
:setter: Tries to convert to LanguageMap
62-
:setter type: :mod:`tincan.language_map`
63-
:rtype: :mod:`tincan.language_map`
61+
:setter: Tries to convert to :class:`tincan.LanguageMap`
62+
:setter type: :class:`tincan.LanguageMap`
63+
:rtype: :class:`tincan.LanguageMap`
6464
6565
"""
6666
return self._name
@@ -79,9 +79,9 @@ def name(self):
7979
def description(self):
8080
"""Description for Activity Definition
8181
82-
:setter: Tries to convert to LanguageMap
83-
:setter type: :mod:`tincan.language_map`
84-
:rtype: :mod:`tincan.language_map`
82+
:setter: Tries to convert to :class:`tincan.LanguageMap`
83+
:setter type: :class:`tincan.LanguageMap`
84+
:rtype: :class:`tincan.LanguageMap`
8585
8686
"""
8787
return self._description
@@ -190,9 +190,9 @@ def correct_responses_pattern(self):
190190
def choices(self):
191191
"""Choices for Activity Definition
192192
193-
:setter: Tries to convert to InteractionComponentList
194-
:setter type: :mod:`tincan.interaction_component_list`
195-
:rtype: :mod:`tincan.interaction_component_list`
193+
:setter: Tries to convert to :class:`tincan.InteractionComponentList`
194+
:setter type: :class:`tincan.InteractionComponentList`
195+
:rtype: :class:`tincan.InteractionComponentList`
196196
197197
"""
198198
return self._choices
@@ -211,9 +211,9 @@ def choices(self):
211211
def scale(self):
212212
"""Scale for Activity Definition
213213
214-
:setter: Tries to convert to InteractionComponentList
215-
:setter type: :mod:`tincan.interaction_component_list`
216-
:rtype: :mod:`tincan.interaction_component_list`
214+
:setter: Tries to convert to :class:`tincan.InteractionComponentList`
215+
:setter type: :class:`tincan.InteractionComponentList`
216+
:rtype: :class:`tincan.InteractionComponentList`
217217
218218
"""
219219
return self._scale
@@ -232,9 +232,9 @@ def scale(self):
232232
def source(self):
233233
"""Source for Activity Definition
234234
235-
:setter: Tries to convert to InteractionComponentList
236-
:setter type: :mod:`tincan.interaction_component_list`
237-
:rtype: :mod:`tincan.interaction_component_list`
235+
:setter: Tries to convert to :class:`tincan.InteractionComponentList`
236+
:setter type: :class:`tincan.InteractionComponentList`
237+
:rtype: :class:`tincan.InteractionComponentList`
238238
239239
"""
240240
return self._source
@@ -253,9 +253,9 @@ def source(self):
253253
def target(self):
254254
"""Target for Activity Definition
255255
256-
:setter: Tries to convert to InteractionComponentList
257-
:setter type: :mod:`tincan.interaction_component_list`
258-
:rtype: :mod:`tincan.interaction_component_list`
256+
:setter: Tries to convert to :class:`tincan.InteractionComponentList`
257+
:setter type: :class:`tincan.InteractionComponentList`
258+
:rtype: :class:`tincan.InteractionComponentList`
259259
260260
"""
261261
return self._target
@@ -274,9 +274,9 @@ def target(self):
274274
def steps(self):
275275
"""Steps for Activity Definition
276276
277-
:setter: Tries to convert to InteractionComponentList
278-
:setter type: :mod:`tincan.interaction_component_list`
279-
:rtype: :mod:`tincan.interaction_component_list`
277+
:setter: Tries to convert to :class:`tincan.InteractionComponentList`
278+
:setter type: :class:`tincan.InteractionComponentList`
279+
:rtype: :class:`tincan.InteractionComponentList`
280280
281281
"""
282282
return self._steps
@@ -295,9 +295,9 @@ def steps(self):
295295
def extensions(self):
296296
"""Extensions for Activity Definition
297297
298-
:setter: Tries to convert to Extensions
299-
:setter type: :mod:`tincan.extensions`
300-
:rtype: :mod:`tincan.extensions`
298+
:setter: Tries to convert to :class:`tincan.Extensions`
299+
:setter type: :class:`tincan.Extensions`
300+
:rtype: :class:`tincan.Extensions`
301301
302302
"""
303303
return self._extensions

‎tincan/agent.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,9 @@ def openid(self):
155155
def account(self):
156156
"""Account for Agent
157157
158-
:setter: Tries to convert to Account
159-
:setter type: :class:`tincan.agent_account.AgentAccount`
160-
:rtype: :class:`tincan.agent_account.AgentAccount`
158+
:setter: Tries to convert to :class:`tincan.AgentAccount`
159+
:setter type: :class:`tincan.AgentAccount`
160+
:rtype: :class:`tincan.AgentAccount`
161161
162162
"""
163163
return self._account

‎tincan/attachment.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ def sha2(self):
116116
:setter type: unicode
117117
:rtype: unicode
118118
119-
"""
119+
"""
120120
return self._sha2
121121

122122
@sha2.setter
@@ -160,9 +160,9 @@ def fileurl(self):
160160
def display(self):
161161
"""Display for Attachment
162162
163-
:setter: Tries to convert to LanguageMap
164-
:setter type: :class:`tincan.language_map.LanguageMap`
165-
:rtype: :class:`tincan.language_map.LanguageMap`
163+
:setter: Tries to convert to :class:`tincan.LanguageMap`
164+
:setter type: :class:`tincan.LanguageMap`
165+
:rtype: :class:`tincan.LanguageMap`
166166
167167
"""
168168
return self._display
@@ -181,9 +181,9 @@ def display(self):
181181
def description(self):
182182
"""Description for Attachment
183183
184-
:setter: Tries to convert to LanguageMap
185-
:setter type: :class:`tincan.language_map.LanguageMap`
186-
:rtype: :class:`tincan.language_map.LanguageMap`
184+
:setter: Tries to convert to :class:`tincan.LanguageMap`
185+
:setter type: :class:`tincan.LanguageMap`
186+
:rtype: :class:`tincan.LanguageMap`
187187
188188
"""
189189
return self._description

0 commit comments

Comments
 (0)