Merge remote-tracking branch 'upstream/master'

Conflicts:
	test/remote_lrs_test.py

Author: Jake Noble

test/remote_lrs_test.py

@@ -21,7 +21,7 @@
 from tincan.group import Group
 from tincan.base import Base
 from tincan.result import Result
-from tincan.substatement import Substatement
+from tincan.substatement import SubStatement
 from tincan.statement_ref import StatementRef
 from tincan.about import About
 from tincan.statements_result import StatementsResult

test/statement_test.py

@@ -27,7 +27,7 @@
 from tincan.result import Result
 from tincan.context import Context
 from tincan.attachment import Attachment
-from tincan.substatement import Substatement
+from tincan.substatement import SubStatement
 from tincan.activity import Activity
 from tincan.statement_ref import StatementRef
 
@@ -307,8 +307,8 @@ def test_InitAgentObject(self):
         self.assertIsNone(statement.authority)
         self.agentVerificationHelper(statement.object)
 
-    def test_InitSubstatementObject(self):
-        statement = Statement(object=Substatement(object_type='Substatement'))
+    def test_InitSubStatementObject(self):
+        statement = Statement(object=SubStatement(object_type='SubStatement'))
         self.assertIsNone(statement.id)
         self.assertIsNone(statement.verb)
         self.assertIsNone(statement.actor)
@@ -457,7 +457,7 @@ def attachmentVerificationHelper(self, value):
         self.assertEqual(value.usage_type, 'test')
 
     def substatementVerificationHelper(self, value):
-        self.assertIsInstance(value, Substatement)
+        self.assertIsInstance(value, SubStatement)
         self.assertEqual(value.object_type, 'SubStatement')
 
     def statementrefVerificationHelper(self, value):

test/substatement_test.py

@@ -21,89 +21,89 @@
 from tincan.verb import Verb
 from tincan.statement_ref import StatementRef
 from tincan.activity import Activity
-from tincan.substatement import Substatement
+from tincan.substatement import SubStatement
 
-class SubstatementTest(unittest.TestCase):
+class SubStatementTest(unittest.TestCase):
 
     def test_InitAnonAgentActor(self):
-        substatement = Substatement(actor={'name':'test'})
+        substatement = SubStatement(actor={'object_type':'Agent', 'name':'test'})
         self.agentVerificationHelper(substatement.actor)
 
     def test_InitAnonGroupActor(self):
-        substatement = Substatement(actor=[Agent(name='test')])
+        substatement = SubStatement(actor={'object_type':'Group', 'member':[{"name":"test"}]})
         self.groupVerificationHelper(substatement.actor)
 
     def test_InitAnonVerb(self):
-        substatement = Substatement(verb={'id':'test'})
+        substatement = SubStatement(verb={'id':'test'})
         self.verbVerificationHelper(substatement.verb)
 
     def test_InitAnonObject(self):
-        substatement = Substatement(object={'id':'test'})
+        substatement = SubStatement(object={'id':'test'})
         self.activityVerificationHelper(substatement.object)
 
     def test_InitAnonAgentObject(self):
-        substatement = Substatement(object={'object_type':'Agent', 'name':'test'})
+        substatement = SubStatement(object={'object_type':'Agent', 'name':'test'})
         self.agentVerificationHelper(substatement.object)
 
     def test_InitDifferentNamingObject(self):
-        substatement = Substatement(object={'objectType':'Agent', 'name':'test'})
+        substatement = SubStatement(object={'objectType':'Agent', 'name':'test'})
         self.agentVerificationHelper(substatement.object)
 
     def test_InitObjectType(self):
-        substatement = Substatement(object_type="SubStatement")
+        substatement = SubStatement(object_type="SubStatement")
         self.assertEqual(substatement.object_type, "SubStatement")
 
     def test_InitAgentActor(self):
-        substatement = Substatement(actor=Agent(name='test'))
+        substatement = SubStatement(actor=Agent(name='test'))
         self.agentVerificationHelper(substatement.actor)
 
     def test_InitGroupActor(self):
-        substatement = Substatement(actor=Group(member=[Agent(name='test')]))
+        substatement = SubStatement(actor=Group(member=[Agent(name='test')]))
         self.groupVerificationHelper(substatement.actor)
 
     def test_InitVerb(self):
-        substatement = Substatement(verb=Verb(id='test'))
+        substatement = SubStatement(verb=Verb(id='test'))
         self.verbVerificationHelper(substatement.verb)
 
     def test_InitAgentObject(self):
-        substatement = Substatement(object=Agent(name='test'))
+        substatement = SubStatement(object=Agent(name='test'))
         self.agentVerificationHelper(substatement.object)
 
     def test_InitGroupObject(self):
-        substatement = Substatement(object=Group(member=[Agent(name='test')]))
+        substatement = SubStatement(object=Group(member=[Agent(name='test')]))
         self.groupVerificationHelper(substatement.object)
 
     def test_InitActivityObject(self):
-        substatement = Substatement(object=Activity(id='test'))
+        substatement = SubStatement(object=Activity(id='test'))
         self.activityVerificationHelper(substatement.object)
 
     def test_InitUnpack(self):
         obj = {'object_type':'SubStatement', 'actor':{'name':'test'}, 'verb':{'id':'test'}, 'object':{'id':'test'}}
-        substatement = Substatement(**obj)
+        substatement = SubStatement(**obj)
         self.assertEqual(substatement.object_type, 'SubStatement')
         self.agentVerificationHelper(substatement.actor)
         self.verbVerificationHelper(substatement.verb)
         self.activityVerificationHelper(substatement.object)
 
     def test_FromJSON(self):
         json_str = '{"object_type":"SubStatement", "actor":{"name":"test"}, "verb":{"id":"test"}, "object":{"id":"test"}}'
-        substatement = Substatement.from_json(json_str)
+        substatement = SubStatement.from_json(json_str)
         self.assertEqual(substatement.object_type, 'SubStatement')
         self.agentVerificationHelper(substatement.actor)
         self.verbVerificationHelper(substatement.verb)
         self.activityVerificationHelper(substatement.object)
 
     def test_ToJSONEmpty(self):
-        substatement = Substatement()
+        substatement = SubStatement()
         self.assertEqual(substatement.to_json(), '{"objectType": "SubStatement"}')
 
     def test_ToJSON(self):
-        substatement = Substatement(object_type='Substatement', actor=Agent(name='test'), verb=Verb(id='test'), object=Activity(id='test'))
+        substatement = SubStatement(object_type='SubStatement', actor=Agent(name='test'), verb=Verb(id='test'), object=Activity(id='test'))
         self.assertEqual(substatement.to_json(), '{"verb": {"id": "test"}, "object": {"id": "test"}, "actor": {"name": "test", "objectType": "Agent"}, "objectType": "SubStatement"}')
 
     def test_FromJSONToJSON(self):
         json_str = '{"object_type":"SubStatement", "actor":{"name":"test"}, "verb":{"id":"test"}, "object":{"id":"test"}}'
-        substatement = Substatement.from_json(json_str)
+        substatement = SubStatement.from_json(json_str)
         self.assertEqual(substatement.object_type, 'SubStatement')
         self.agentVerificationHelper(substatement.actor)
         self.verbVerificationHelper(substatement.verb)
@@ -133,5 +133,5 @@ def activityVerificationHelper(self, value):
         self.assertEqual(value.id, 'test')
 
 if __name__ == '__main__':
-    suite = unittest.TestLoader().loadTestsFromTestCase(SubstatementTest)
+    suite = unittest.TestLoader().loadTestsFromTestCase(SubStatementTest)
     unittest.TextTestRunner(verbosity=2).run(suite)

tincan/agent.py

@@ -45,10 +45,6 @@ def object_type(self):
     def object_type(self, value):
         self._object_type = 'Agent'
 
-    @object_type.deleter
-    def object_type(self):
-        del self._object_type
-
     @property
     def name(self):
         """Name for Agent

tincan/agent_list.py

@@ -16,7 +16,7 @@
 from tincan.typed_list import TypedList
 
 """
-.. module:: interactioncomponentlist
+.. module:: agent_list
    :synopsis: A wrapper for list that is able to type check
 
 """

tincan/context.py

@@ -49,6 +49,13 @@ class Context(SerializableBase):
 
     @property
     def registration(self):
+        """Registration for Context
+
+        :setter: Tries to convert to unicode
+        :setter type: unicode
+        :rtype: unicode
+
+        """
         return self._registration
 
     @registration.setter
@@ -65,6 +72,13 @@ def registration(self):
 
     @property
     def instructor(self):
+        """Instructor for Context
+
+        :setter: Tries to convert to Agent or Group
+        :setter type: :mod:`tincan.agent` | :mod:`tincan.group`
+        :rtype: :mod:`tincan.agent` | :mod:`tincan.group`
+
+        """
         return self._instructor
 
     @instructor.setter
@@ -82,6 +96,13 @@ def instructor(self):
 
     @property
     def team(self):
+        """Team for Context
+
+        :setter: Tries to convert to Group
+        :setter type: :mod:`tincan.group`
+        :rtype: :mod:`tincan.group`
+
+        """
         return self._team
 
     @team.setter
@@ -96,6 +117,13 @@ def team(self):
 
     @property
     def context_activities(self):
+        """Context Activities for Context
+
+        :setter: Tries to convert to Context Activities
+        :setter type: :mod:`tincan.context_activities`
+        :rtype: :mod:`tincan.context_activities`
+
+        """
         return self._context_activities
 
     @context_activities.setter
@@ -105,17 +133,24 @@ def context_activities(self, value):
         self._context_activities = value
 
     @context_activities.deleter
-    def context_activities(self, value):
+    def context_activities(self):
         del self._context_activities
 
     @property
     def revision(self):
+        """Revision for Context
+
+        :setter: Tries to convert to unicode
+        :setter type: unicode
+        :rtype: unicode
+
+        """
         return self._revision
 
     @revision.setter
     def revision(self, value):
         if value is not None and not isinstance(value, basestring):
-            value = str(value)
+            value = unicode(value)
         self._revision = value
 
     @revision.deleter
@@ -124,12 +159,19 @@ def revision(self):
 
     @property
     def platform(self):
+        """Platform for Context
+
+        :setter: Tries to convert to unicode
+        :setter type: unicode
+        :rtype: unicode
+
+        """
         return self._platform
 
     @platform.setter
     def platform(self, value):
         if value is not None and not isinstance(value, basestring):
-            value = str(value)
+            value = unicode(value)
         self._platform = value
 
     @platform.deleter
@@ -138,13 +180,20 @@ def platform(self):
 
     @property
     def language(self):
+        """Language for Context
+
+        :setter: Tries to convert to unicode
+        :setter type: unicode
+        :rtype: unicode
+
+        """
         return self._language
 
     @language.setter
     def language(self, value):
         if value is not None:
             if not isinstance(value, basestring):
-                value = str(value)
+                value = unicode(value)
             if not self._LANG_REGEX.match(value):
                 raise ValueError("invalid regional identifier")
         self._language = value
@@ -155,6 +204,13 @@ def language(self):
 
     @property
     def statement(self):
+        """Statement for Context
+
+        :setter: Tries to convert to StatementRef
+        :setter type: :mod:`tincan.statement_ref`
+        :rtype: :mod:`tincan.statement_ref`
+
+        """
         return self._statement
 
     @statement.setter
@@ -169,6 +225,13 @@ def statement(self):
 
     @property
     def extensions(self):
+        """Extensions for Context
+
+        :setter: Tries to convert to StatementRef
+        :setter type: :mod:`tincan.extensions`
+        :rtype: :mod:`tincan.extensions`
+
+        """
         return self._extensions
 
     @extensions.setter

tincan/context_activities.py

@@ -29,6 +29,13 @@ class ContextActivities(SerializableBase):
 
     @property
     def category(self):
+        """Category for Context Activities
+
+        :setter: Tries to convert to Activity List
+        :setter type: :mod:`tincan.activity_list`
+        :rtype: :mod:`tincan.activity_list`
+
+        """
         return self._category
 
     @category.setter
@@ -42,6 +49,13 @@ def category(self):
 
     @property
     def parent(self):
+        """Parent for Context Activities
+
+        :setter: Tries to convert to Activity List
+        :setter type: :mod:`tincan.activity_list`
+        :rtype: :mod:`tincan.activity_list`
+
+        """
         return self._parent
 
     @parent.setter
@@ -55,6 +69,13 @@ def parent(self):
 
     @property
     def grouping(self):
+        """Grouping for Context Activities
+
+        :setter: Tries to convert to Activity List
+        :setter type: :mod:`tincan.activity_list`
+        :rtype: :mod:`tincan.activity_list`
+
+        """
         return self._grouping
 
     @grouping.setter
@@ -68,6 +89,13 @@ def grouping(self):
 
     @property
     def other(self):
+        """Other for Context Activities
+
+        :setter: Tries to convert to Activity List
+        :setter type: :mod:`tincan.activity_list`
+        :rtype: :mod:`tincan.activity_list`
+
+        """
         return self._other
 
     @other.setter
@@ -80,6 +108,11 @@ def other(self):
         del self._other
 
     def _activity_or_list(self, value):
+        """Tries to convert value to an Activity List
+
+        :param value: The value to attempt to convert to Activity List
+        :return: A :mod:`tincan.activity_list` of value
+        """
         result = value
         if value is not None and not isinstance(value, ActivityList):
             try: