Reformat code according to PEP8.

Add explicit property names for Group, removing appropriate tests.
Initialize all fields for properties in __init__.
Added long-fill-in interaction type.
Changed default date conversion to assume a timestamp, since the
existing default called datetime with an invalid parameter.

Author: Zach Lowry

examples/example_script.py

@@ -1,6 +1,7 @@
 # An example script showing the functionality of the TinCanPython Library
 
 import uuid
+
 from resources import lrs_properties
 from tincan import (
     RemoteLRS,
@@ -14,6 +15,7 @@
     StateDocument,
 )
 
+
 # construct an LRS
 print "constructing the LRS..."
 lrs = RemoteLRS(
@@ -59,7 +61,7 @@
         name='Lord TinCan',
         mbox='mailto:lordtincan@tincanapi.com',
     ),
-    #language='en-US',
+    # language='en-US',
 )
 print "...done"
 
@@ -105,7 +107,7 @@
 # we can query our statements using an object
 # constructing the query object with common fields
 # note: more information about queries can be found in the API documentation:
-#   docs/build/html/tincan.html#module-tincan.remote_lrs
+# docs/build/html/tincan.html#module-tincan.remote_lrs
 query = {
     "agent": actor,
     "verb": verb,

test/about_test.py

@@ -1,4 +1,4 @@
-#    Copyright 2014 Rustici Software
+# Copyright 2014 Rustici Software
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -16,13 +16,13 @@
 
 if __name__ == '__main__':
     from main import setup_tincan_path
+
     setup_tincan_path()
 from test_utils import TinCanBaseTestCase
 from tincan import Version, About
 
 
 class AboutTest(TinCanBaseTestCase):
-
     def test_defaults(self):
         a = About()
         self.assertEqual(a.version, [Version.latest])

test/activity_test.py

@@ -1,4 +1,4 @@
-#    Copyright 2014 Rustici Software
+# Copyright 2014 Rustici Software
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 
 if __name__ == '__main__':
     from main import setup_tincan_path
+
     setup_tincan_path()
 from tincan import (
     Activity,
@@ -26,7 +27,6 @@
 
 
 class ActivityTest(unittest.TestCase):
-
     def test_InitEmpty(self):
         activity = Activity()
         self.assertIsNone(activity.id)
@@ -95,7 +95,7 @@ def test_ToJSONFromJSON(self):
 
     def test_ToJSON(self):
         check_str = '{"definition": {}, "id": "test", "objectType": "Activity"}'
-        activity = Activity(**{'id':'test', 'definition':{}, 'object_type':'Activity'})
+        activity = Activity(**{'id': 'test', 'definition': {}, 'object_type': 'Activity'})
         self.assertEqual(activity.to_json(), check_str)
 
     def test_setDefinitionException(self):
@@ -128,6 +128,7 @@ def activityVerificationHelper(self, activity):
         self.assertIsInstance(activity.definition, ActivityDefinition)
         self.assertEqual(activity.object_type, 'Activity')
 
+
 if __name__ == '__main__':
     suite = unittest.TestLoader().loadTestsFromTestCase(ActivityTest)
     unittest.TextTestRunner(verbosity=2).run(suite)

test/activitydefinition_test.py

@@ -1,4 +1,4 @@
-#    Copyright 2014 Rustici Software
+# Copyright 2014 Rustici Software
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -16,20 +16,32 @@
 
 if __name__ == '__main__':
     from main import setup_tincan_path
+
     setup_tincan_path()
 from tincan import (
     ActivityDefinition,
     LanguageMap,
     InteractionComponentList,
-    InteractionComponent,
 )
 
 
 class ActivityDefinitionTest(unittest.TestCase):
-
     def test_InitEmpty(self):
         adef = ActivityDefinition()
-        self.assertEqual(vars(adef), {})
+        self.assertEqual(vars(adef), {
+            '_choices': None,
+            '_correct_responses_pattern': None,
+            '_description': None,
+            '_extensions': None,
+            '_interaction_type': None,
+            '_more_info': None,
+            '_name': None,
+            '_scale': None,
+            '_source': None,
+            '_steps': None,
+            '_target': None,
+            '_type': None
+        })
         self.assertIsInstance(adef, ActivityDefinition)
 
     def test_InitAll(self):
@@ -43,67 +55,67 @@ def test_InitAll(self):
             'choices': InteractionComponentList(),
             'scale': InteractionComponentList(),
             'source': InteractionComponentList(),
-            'target':InteractionComponentList(),
+            'target': InteractionComponentList(),
             'steps': InteractionComponentList(),
             'extensions': {'test': 'test'}
         })
         self.definitionVerificationHelper(adef)
 
     def test_InitExceptionType(self):
         with self.assertRaises(ValueError):
-            adef = ActivityDefinition(type='')
+            ActivityDefinition(type='')
 
     def test_InitExceptionMoreInfo(self):
         with self.assertRaises(ValueError):
-            adef = ActivityDefinition(more_info='')
+            ActivityDefinition(more_info='')
 
     def test_InitExceptionInteractionType(self):
         with self.assertRaises(ValueError):
-            adef = ActivityDefinition(interaction_type='notvalidinteraction')
+            ActivityDefinition(interaction_type='notvalidinteraction')
 
     def test_InitExceptionCorrectResponsesPattern(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(correct_responses_pattern='notlist')
+            ActivityDefinition(correct_responses_pattern='notlist')
 
     def test_InitExceptionChoices(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(choices='notlist')
+            ActivityDefinition(choices='notlist')
 
     def test_InitExceptionChoicesNotComponentList(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(choices=['not component'])
+            ActivityDefinition(choices=['not component'])
 
     def test_InitExceptionScale(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(scale='notlist')
+            ActivityDefinition(scale='notlist')
 
     def test_InitExceptionScaleNotComponentList(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(scale=['not component'])
+            ActivityDefinition(scale=['not component'])
 
     def test_InitExceptionSource(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(source='notlist')
+            ActivityDefinition(source='notlist')
 
     def test_InitExceptionSourceNotComponentList(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(source=['not component'])
+            ActivityDefinition(source=['not component'])
 
     def test_InitExceptionTarget(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(target='notlist')
+            ActivityDefinition(target='notlist')
 
     def test_InitExceptionTargetNotComponentList(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(target=['not component'])
+            ActivityDefinition(target=['not component'])
 
     def test_InitExceptionSteps(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(steps='notlist')
+            ActivityDefinition(steps='notlist')
 
     def test_InitExceptionStepsNotComponentList(self):
         with self.assertRaises(TypeError):
-            adef = ActivityDefinition(steps=['not component'])
+            ActivityDefinition(steps=['not component'])
 
     def test_InitUnpack(self):
         obj = {
@@ -116,7 +128,7 @@ def test_InitUnpack(self):
             'choices': InteractionComponentList(),
             'scale': InteractionComponentList(),
             'source': InteractionComponentList(),
-            'target':InteractionComponentList(),
+            'target': InteractionComponentList(),
             'steps': InteractionComponentList(),
             'extensions': {'test': 'test'}
         }
@@ -125,20 +137,20 @@ def test_InitUnpack(self):
 
     def test_FromJSONExceptionBadJSON(self):
         with self.assertRaises(ValueError):
-            adef = ActivityDefinition.from_json('{"bad JSON"}')
+            ActivityDefinition.from_json('{"bad JSON"}')
 
     def test_FromJSONExceptionMalformedJSON(self):
         with self.assertRaises(AttributeError):
-            adef = ActivityDefinition.from_json('{"test": "invalid property"}')
+            ActivityDefinition.from_json('{"test": "invalid property"}')
 
     def test_FromJSONExceptionPartiallyMalformedJSON(self):
         with self.assertRaises(AttributeError):
-            adef = ActivityDefinition.from_json('{"test": "invalid property", "id": \
+            ActivityDefinition.from_json('{"test": "invalid property", "id": \
             "valid property"}')
 
     def test_FromJSONExceptionEmpty(self):
         with self.assertRaises(ValueError):
-            adef = ActivityDefinition.from_json('')
+            ActivityDefinition.from_json('')
 
     def test_FromJSON(self):
         json_str = '{"name":{"en-US":"test"},\

test/activitylist_test.py

@@ -1,6 +1,6 @@
-#    Copyright 2014 Rustici Software
+# Copyright 2014 Rustici Software
 #
-#    Licensed under the Apache License, Version 2.0 (the "License");
+# Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
 #    You may obtain a copy of the License at
 #
@@ -16,12 +16,12 @@
 
 if __name__ == '__main__':
     from main import setup_tincan_path
+
     setup_tincan_path()
 from tincan import ActivityList, Activity
 
 
 class ActivityListTest(unittest.TestCase):
-
     def test_InitNoArgs(self):
         alist = ActivityList()
         self.assertEqual(alist, [])
@@ -53,7 +53,7 @@ def test_InitActivityList(self):
 
     def test_InitExceptionNotActivity(self):
         with self.assertRaises(TypeError):
-            alist = ActivityList([Activity(), 'not InteractionComponent'])
+            ActivityList([Activity(), 'not InteractionComponent'])
 
     def test_FromJSON(self):
         alist = ActivityList.from_json(
@@ -63,11 +63,11 @@ def test_FromJSON(self):
 
     def test_FromJSONExceptionBadJSON(self):
         with self.assertRaises(ValueError):
-            alist = ActivityList.from_json('{"bad JSON"}')
+            ActivityList.from_json('{"bad JSON"}')
 
     def test_FromJSONExceptionNestedObject(self):
         with self.assertRaises(TypeError):
-            alist = ActivityList.from_json(
+            ActivityList.from_json(
                 '[{"id": "test1"}, [{"id": "nested!"}]]'
             )
 
@@ -87,8 +87,7 @@ def test_AsVersionNotEmpty(self):
         alist = ActivityList([a1, a2])
         check = alist.as_version()
         self.assertEqual(check,
-            [{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]
-        )
+                         [{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}])
 
     def test_ToJSONFromJSON(self):
         json_str = '[{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]'
@@ -98,7 +97,8 @@ def test_ToJSONFromJSON(self):
 
     def test_ToJSON(self):
         alist = ActivityList([{"id": "test1"}, {"id": "test2"}])
-        self.assertEqual(alist.to_json(), '[{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]')
+        self.assertEqual(alist.to_json(),
+                         '[{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]')
 
     def test_setItem(self):
         alist = ActivityList([Activity(), Activity()])
@@ -177,6 +177,7 @@ def listVerificationHelper(self, alist):
         self.assertEqual(alist[0].id, 'test1')
         self.assertEqual(alist[1].id, 'test2')
 
+
 if __name__ == '__main__':
     suite = unittest.TestLoader().loadTestsFromTestCase(ActivityListTest)
     unittest.TextTestRunner(verbosity=2).run(suite)