Changeset 326:46fe057f2605

Timestamp:

03/10/10 12:32:00 (5 months ago)

Author:

acracia

Branch:

default

Message:

[api]to_dict method on the model, tailored to use as input of the api

Location:

pdw

Files:

• model/frbr.py (modified) (2 diffs)
• pd/__init__.py (modified) (5 diffs)
• tests/functional/test_api.py (modified) (1 diff)
• tests/test_model.py (modified) (2 diffs)
• tests/test_pd.py (modified) (3 diffs)

pdw/model/frbr.py

@@ -302 +302 @@
         out_obj.items = items
         return out_obj
+
     def to_dict(self):
+        '''
+        create a dict equivalent to the dict the api is receiving
+        '''
         out_dict = {}
         table = orm.class_mapper(self.__class__).mapped_table
@@ -310 +314 @@
             out_dict[col.name] = val
             # TODO: check type ...
+        persons = []
         if self.persons:
-            persons = []
             for person in self.persons:
+                #TO DO: change this for a consult to the person table, to get
+                #the attrs the person has
                 oneperson = {'name': person.name,
                              'birth_date': person.birth_date,
                              'death_date': person.death_date,
-                             'type': person.type,
-                             'country': person.country,}
+                             'type': person.entity_type,
+                             }
                 persons.append(oneperson)
             out_dict['persons'] = persons
-
-
         return out_dict
-
-
 
 

pdw/pd/__init__.py

@@ -58 +58 @@
 
 now = datetime.datetime.now()
+
 def float_date(year, month=0, day=0):
+    '''to convert a date in a float type'''
     return swiss.date.FlexiDate(year, month, day).as_float()
 
@@ -64 +66 @@
     # now dispatch on jurisdiction (+ work type?)
     # note two letter country codes based on ISO 3166
-    # 
+    # need to add 'when' parameter here and deeper 
     if jurisdiction == 'us':
         pd_calculator = CalculatorUnitedStates
@@ -80 +82 @@
     To create a Work object and analize its pd status from a 
     python or json dict
+    @param  params: json formatted string
+    @type   params: string
     '''
-
     params = json.loads(json_data)
     jur = params['jurisdiction'] 
@@ -108 +111 @@
         return "date_pd=%s pd_prob=%s log=%s" % (self.date_pd, self.pd_prob, self.log)
 
+    @classmethod
+    def to_dict(cls, self):
+        '''Creates a dict result to give back as json in the api
+        '''
+        out_dict = { 'confidence': 1-self.uncertainty,
+                    'pd probability': self.pd_prob,
+                    'date pd': self.date_pd,
+                    'log': self.log,
+                   }
+        return out_dict
+#TODO
+
 class CalculatorBase(object):
     """A Public Domain Calculator
@@ -114 +129 @@
     def __init__(self, when):
         self.author_list = None
+        self.death_dates = []
+        self.names = []
         if when:
-          self._now = when
+            self._now = when
         else:
             self._now = float_date(datetime.date.today().year)

pdw/tests/functional/test_api.py

@@ -12 +12 @@
             'work' : {
                 'title': 'A Christmas Carol'},
-            'jurisdiction': 'netherlands'
+            'jurisdiction': 'uk'
         }
         params_json = json.dumps(params)

pdw/tests/test_model.py

@@ -58 +58 @@
         out = work.to_dict()
         assert out['title'] == work.title
-        assert out['persons'] == work.persons
+        assert len(out['persons']) == len(work.persons)
         assert out['date'] == '1704', out
         # test it serializes ok
@@ -81 +81 @@
             'title': newtitle,
             'date': u'1881',
+            'type': u'text',
             'persons': [
                 { 'name': name1, 'death_date': u'1887' },

pdw/tests/test_pd.py

@@ -418 +418 @@
         calc = pd.determine_status(newwork,'ca')
         return calc
+        assert 'confidence' in calc.log
 
     def test_uk(self):
         '''
-        simple parsing of the json to create objects and pass them to the 
-        calculators / currently uk calculator is working. not Canadian one
+        test the calculator api for the UK
         '''
         parsed = json.loads(self.json_data2)
@@ -428 +428 @@
         jurisdiction = parsed['jurisdiction']
         newwork = model.Work.from_dict(workdata)
+        model.Session.remove()
         calc = pd.determine_status(newwork,jurisdiction)
 
         print parsed  
         return calc
+        assert calc.log>0
 
     def test_ca(self):
         '''
-        simple parsing of the json to create objects and pass them to the 
-        calculators / currently uk calculator is working. not Canadian one
+        test the calculator api for Canada
 
         '''
@@ -443 +444 @@
         jurisdiction = parsed['jurisdiction']
         newwork = model.Work.from_dict(workdata)
+        model.Session.remove()
         calc = pd.determine_status(newwork,jurisdiction)