pyLodStorage 0.0.26__tar.gz → 0.0.28__tar.gz

{pylodstorage-0.0.26 → pylodstorage-0.0.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pylodstorage
-Version: 0.0.26
+Version: 0.0.28
 Summary: python List of Dict (Table) Storage library
 Home-page: https://github.com/WolfgangFahl/pyLodStorage
 Author: Wolfgang Fahl

{pylodstorage-0.0.26 → pylodstorage-0.0.28}/lodstorage/jsonable.py

@@ -9,26 +9,31 @@ import datetime
 import sys
 import re
 
-class JSONAble(object):
-    '''
-    mixin to allow classes to be JSON serializable see
-    
-    - https://stackoverflow.com/questions/3768895/how-to-make-a-class-json-serializable
-    
-    '''
+class JSONAbleSettings():
     indent=4
-    
     '''
     regular expression to be used for conversion from singleQuote to doubleQuote
     see https://stackoverflow.com/a/50257217/1497139
     '''
     singleQuoteRegex = re.compile('(?<!\\\\)\'')
+    
+class JSONAble(object):
+    '''
+    mixin to allow classes to be JSON serializable see
+    
+    - https://stackoverflow.com/questions/3768895/how-to-make-a-class-json-serializable
+    
+    '''    
  
     def __init__(self):
         '''
         Constructor
         '''
         
+    @classmethod
+    def getPluralname(cls):
+        return "%ss" % cls.__name__  
+        
     @staticmethod 
     def singleQuoteToDoubleQuote(singleQuoted,useRegex=False):
         '''
@@ -70,7 +75,7 @@ class JSONAble(object):
         Note:
             see https://stackoverflow.com/a/50257217/1497139
         """
-        doubleQuoted=JSONAble.singleQuoteRegex.sub('\"', singleQuoted)
+        doubleQuoted=JSONAbleSettings.singleQuoteRegex.sub('\"', singleQuoted)
         return doubleQuoted
     
     @staticmethod    
@@ -102,30 +107,17 @@ class JSONAble(object):
         doubleQuoted="".join(cList)    
         return doubleQuoted
     
-    def storeToJsonFile(self,storeFilePrefix,tableName):
+    def getJsonTypeSamples(self):
         '''
-        store me with the given storeFilePrefix
-        
-        Args:
-            storeFilePrefix(string): the prefix for the JSON file name
-            tableName(string): the name of the attribute for which to store the type information
+        does my class provide a "getSamples" method?
         '''
-        JSONAble.storeJsonToFile(self.toJSON(), "%s.json" % storeFilePrefix)
-        types=Types.forTable(self, tableName)
-        JSONAble.storeJsonToFile(types.toJSON(), "%s-types.json" % storeFilePrefix)
-       
-    def restoreFromJsonFile(self,storeFilePrefix):
-        '''
-        restore me from the given storeFilePrefix
-        
-        Args:
-            storeFilePrefix(string): the prefix for the JSON file name
-        '''
-        jsonStr=JSONAble.readJsonFromFile("%s.json" % storeFilePrefix)
-        typesJson=JSONAble.readJsonFromFile("%s-types.json" % storeFilePrefix)
-        types=Types(type(self).__name__)
-        types.fromJson(typesJson)
-        self.fromJson(jsonStr, types)
+        if hasattr(self, '__class__'):
+            cls=self.__class__
+            if hasattr(cls, 'getSamples'):
+                getSamples=getattr(cls,'getSamples');
+                if callable(getSamples):
+                    return getSamples()
+        return None
     
     @staticmethod
     def readJsonFromFile(jsonFilePath):
@@ -163,9 +155,31 @@ class JSONAble(object):
             jsonStr(str): the JSON string
             fixType(Types): the types to be fixed
         '''
-        data=json.loads(jsonStr)       
+        lod=self.getLoDfromJson(jsonStr, types)
+        self.fromDict(lod) 
+        
+    def getLoDfromJson(self,jsonStr,types=None):
+        '''
+        get a list of Dicts form the given JSON String
+        
+        Args:
+            jsonStr(str): the JSON string
+            fixType(Types): the types to be fixed
+        Returns:
+            list: a list of dicts
+        '''
+        lod=json.loads(jsonStr)       
         if types is not None:
-            types.fixTypes(data)     
+            types.fixTypes(lod)   
+        return lod 
+            
+    def fromDict(self,data):
+        '''
+        initialize me from the given data
+        
+        Args:
+            data: the dictionary to initalize me from
+        '''        
         # https://stackoverflow.com/questions/38987/how-do-i-merge-two-dictionaries-in-a-single-expression-in-python-taking-union-o                 
         self.__dict__=data
     
@@ -191,7 +205,7 @@ class JSONAble(object):
             a recursive JSON dump of the dicts of my objects
         '''
         jsonStr=json.dumps(self, default=lambda v: self.toJsonAbleValue(v), 
-            sort_keys=True, indent=JSONAble.indent)
+            sort_keys=True, indent=JSONAbleSettings.indent)
         return jsonStr
         
     def getJSONValue(self,v):
@@ -238,20 +252,113 @@ class JSONAble(object):
             d[a]=self.getJSONValue(v)
         return d
     
-    def asJSON(self,asString=True):
+    def asJSON(self,asString=True,data=None):
         '''
         recursively return my dict elements
         
         Args:
             asString(boolean): if True return my result as a string
         '''
-        jsonDict=self.reprDict(self.__dict__)
+        if data is None: 
+            data=self.__dict__
+        jsonDict=self.reprDict(data)
         if asString:
             jsonStr=str(jsonDict)
             jsonStr = JSONAble.singleQuoteToDoubleQuote(jsonStr)
             return jsonStr
         return jsonDict
     
+class JSONAbleList(JSONAble):
+    '''
+    Container class 
+    '''
+    
+    def __init__(self,listName:str=None,clazz=None,tableName:str=None,):
+        '''
+        Constructor
+        
+        Args:
+            listName(str): the name of the list attribute to be used for storing the List
+            clazz(class): a class to be used for Object relational mapping (if any) 
+            tableName(str): the name of the "table" to be used
+        '''
+        self.clazz=clazz
+        if listName is None:
+            if self.clazz is not None:
+                listName=self.clazz.getPluralname()
+            else:
+                listName=self.__class__.name.lower()
+        self.listName=listName
+        if tableName is None:
+            self.tableName=listName
+        else:
+            self.tableName=tableName
+            
+    def getJsonData(self):    
+        '''
+        get my Jsondata
+        '''
+        jsonData={
+                self.listName:self.__dict__[self.listName]
+            }
+        return jsonData    
+            
+    def toJsonAbleValue(self,v):
+        '''
+        make sure we don't store our meta information
+        clazz, tableName and listName but just the list we are holding
+        '''
+        if v==self:
+            
+            return self.getJsonData()
+        else:
+            return super().toJsonAbleValue(v)     
+        
+    def asJSON(self,asString=True):
+        jsonData=self.getJsonData()
+        return super().asJSON(asString, data=jsonData)
+        
+        
+    def storeToJsonFile(self,storeFilePrefix):
+        '''
+        store me with the given storeFilePrefix
+        
+        Args:
+            storeFilePrefix(string): the prefix for the JSON file name
+        '''
+        JSONAble.storeJsonToFile(self.toJSON(), "%s.json" % storeFilePrefix)
+       
+    def restoreFromJsonFile(self,storeFilePrefix):
+        '''
+        restore me from the given storeFilePrefix
+        
+        Args:
+            storeFilePrefix(string): the prefix for the JSON file name
+        '''
+        jsonStr=JSONAble.readJsonFromFile("%s.json" % storeFilePrefix)
+        if self.clazz is None:
+            typeSamples=self.getJsonTypeSamples()
+        else:
+            typeSamples=self.clazz.getSamples()
+        if typeSamples is None:
+            types=None
+        else:
+            types=Types(self.listName)
+            types.getTypes(self.listName, typeSamples, len(typeSamples))
+        lod=self.getLoDfromJson(jsonStr, types)
+        
+        if self.clazz is None:
+            result=lod
+        else:
+            instanceList=[]
+            for record in lod[self.listName]:
+                instance=self.clazz()
+                instance.fromDict(record)
+                instanceList.append(instance)
+            result=instanceList
+        self.__dict__[self.listName]=result
+        return result
+    
 class Types(JSONAble):
     '''
     Types
@@ -320,10 +427,14 @@ class Types(JSONAble):
         determine the types for the given sample records
         '''     
         for sampleRecord in sampleRecords[:limit]:
-            for key,value in sampleRecord.items():
+            items=sampleRecord.items()
+            self.getTypesForItems(listName,items,warnOnNone=len(sampleRecords)==1)
+          
+    def getTypesForItems(self,listName,items,warnOnNone=False):  
+            for key,value in items:
                 valueType=None
                 if value is None:
-                    if len(sampleRecords)==1:
+                    if warnOnNone:
                         print("Warning sampleRecord field %s is None - using string as type" % key)
                         valueType=str
                 else:

{pylodstorage-0.0.26 → pylodstorage-0.0.28}/lodstorage/sample.py

@@ -5,7 +5,7 @@ Created on 2020-08-24
 '''
 import urllib.request
 import json
-from lodstorage.jsonable import JSONAble
+from lodstorage.jsonable import JSONAble, JSONAbleList
 from datetime import date, datetime
 
 class Sample(object):
@@ -55,6 +55,41 @@ class Sample(object):
     
     @staticmethod
     def getRoyals():
+        return Royal.getSamples()
+    
+    @staticmethod
+    def getRoyalsInstances():
+        lod=Royal.getSamples()
+        royals=[]
+        for record in lod:
+            royal=Royal()
+            royal.fromDict(record)
+            royals.append(royal)
+        return royals
+    
+class Royals(JSONAbleList):
+    def __init__(self,load=False):
+        super(Royals, self).__init__("royals",clazz=None)
+        if load:
+            self.royals=Royal.getSamples()
+        else:
+            self.royals=None
+        
+class RoyalsORMList(JSONAbleList):
+    def __init__(self,load=False):
+        super(RoyalsORMList, self).__init__("royals",Royal)
+        if load:
+            self.royals=Sample.getRoyalsInstances()
+        else:
+            self.royals=None
+            
+class Royal(JSONAble):
+    '''
+    i am a single Royal
+    '''
+    
+    @classmethod
+    def getSamples(cls):
         listOfDicts=[
             {'name': 'Elizabeth Alexandra Mary Windsor', 'born': Sample.dob('1926-04-21'), 'numberInLine': 0, 'wikidataurl': 'https://www.wikidata.org/wiki/Q9682' },
             {'name': 'Charles, Prince of Wales',         'born': Sample.dob('1948-11-14'), 'numberInLine': 1, 'wikidataurl': 'https://www.wikidata.org/wiki/Q43274' },
@@ -69,16 +104,10 @@ class Sample(object):
             person['ofAge']=age>=18
             person['lastmodified']=datetime.now()
         return listOfDicts
-        
-class Royals(JSONAble):
-    def __init__(self,load=False):
-        if load:
-            self.royals=Sample.getRoyals()
-        else:
-            self.royals=None
-        
-class Cities(JSONAble):
+    
+class Cities(JSONAbleList):
     def __init__(self,load=False):
+        super(Cities, self).__init__("cities",clazz=None)
         if load:
             self.cities=Sample.getCities()      
         else:

{pylodstorage-0.0.26 → pylodstorage-0.0.28}/lodstorage/sql.py

@@ -131,7 +131,7 @@ class SQLDB(object):
                 for record in listOfRecords:
                     index+=1
                     if fixNone:
-                        SQLDB.setNone(record, entityInfo.typeMap.keys())
+                        LOD.setNone(record, entityInfo.typeMap.keys())
                     self.c.execute(insertCmd,record)
             self.c.commit()
         except sqlite3.ProgrammingError as pe:

{pylodstorage-0.0.26 → pylodstorage-0.0.28}/pylodstorage.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pylodstorage
-Version: 0.0.26
+Version: 0.0.28
 Summary: python List of Dict (Table) Storage library
 Home-page: https://github.com/WolfgangFahl/pyLodStorage
 Author: Wolfgang Fahl

{pylodstorage-0.0.26 → pylodstorage-0.0.28}/setup.py

@@ -11,7 +11,7 @@ with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='pylodstorage',
-    version='0.0.26',
+    version='0.0.28',
 
     packages=['lodstorage',],
     author='Wolfgang Fahl',