protobin 0.0.7__tar.gz → 0.0.8__tar.gz

{protobin-0.0.7 → protobin-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: protobin
-Version: 0.0.7
+Version: 0.0.8
 Summary: Python library for encode and decode data in protobin format
 Project-URL: Homepage, https://github.com/drmelectronic/protobin-python
 Project-URL: Bug Tracker, https://github.com/drmelectronic/protobin-python/issues
@@ -33,6 +33,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9
+Requires-Dist: pyyaml~=6.0
 Description-Content-Type: text/markdown
 
 # protobin

{protobin-0.0.7 → protobin-0.0.8}/protobin/fields.py

@@ -13,6 +13,7 @@ class FieldEnum(enum.StrEnum):
     CHAR = 'char'
     DATE = 'date'
     DATETIME = 'datetime'
+    ID = 'id'
     FLAGS = 'flags'
     FLOAT = 'float'
     SIGNED = 'signed'
@@ -77,12 +78,6 @@ class FieldBase:
             return binary[:self.bytes], binary[self.bytes:]
         return binary[1:binary[0] + 1], binary[binary[0] + 1:]
 
-    def to_dict(self):
-        return {
-            'key': self.key,
-            'bytes': self.bytes,
-            'type': self.type
-        }
 
 
 class FieldArray(FieldBase):
@@ -98,11 +93,6 @@ class FieldArray(FieldBase):
         val, binary = self.from_binary(binary)
         return val, binary
 
-    def to_dict(self):
-        d = super().to_dict()
-        d['array'] = self.array
-        return d
-
     def to_binary(self, val):
         binary = b''
         length = len(val)
@@ -304,10 +294,23 @@ class FieldFloat(FieldBase):
     def to_binary(self, val):
         return int(round(val * (10 ** self.decimals))).to_bytes(self.bytes, 'big', signed=True)
 
-    def to_dict(self):
-        d = super().to_dict()
-        d['decimals'] = self.decimals
-        return d
+
+class FieldId(FieldBase):
+
+    def to_binary(self, val):
+        if val is None:
+            val = 0
+        max_value = 256 ** self.bytes - 1
+        val = min(val, max_value)
+        if val < 0:
+            raise ValueError('Negative values not allowed')
+        return int(val).to_bytes(self.bytes, 'big', signed=False)
+
+    def from_binary(self, binary):
+        val = int.from_bytes(binary[:self.bytes], 'big', signed=False)
+        if val == 0:
+            val = None
+        return val
 
 
 class FieldSigned(FieldBase):
@@ -380,11 +383,11 @@ class FieldUnsigned(FieldBase):
 
     def to_binary(self, val):
         if val is None:
-            val = 0
+            raise ValueError(f'Error en el campo "{self.key}" no se permite None')
         max_value = 256 ** self.bytes - 1
         val = min(val, max_value)
         if val < 0:
-            raise ValueError('Negative values not allowed')
+            raise ValueError(f'Error en el campo "{self.key}" se espera enteros positivos y se recibió {val}')
         return int(val).to_bytes(self.bytes, 'big', signed=False)
 
     def from_binary(self, binary):
@@ -400,6 +403,7 @@ FIELD_MAP = {
     'datetime': FieldDateTime,
     'flags': FieldFlags,
     'float': FieldFloat,
+    'id': FieldId,
     'signed': FieldSigned,
     'string': FieldString,
     'time': FieldTime,

{protobin-0.0.7 → protobin-0.0.8}/protobin/protocol.py

@@ -1,29 +1,38 @@
 import json
-
 import yaml
-
 from protobin.fields import FieldBase, FIELD_MAP
 
 
 class Format:
 
-    fields: [FieldBase]
+    input_fields: [FieldBase]
+    output_fields: [FieldBase]
 
-    def __init__(self, format: [object]):
-        self.fields = []
+    def __init__(self, name: str, format, server: bool):
+        self.name = name
+        self.input_fields = []
+        self.output_fields = []
         self.header = format['header']
-        for k, f in format['fields'].items():
-            self.fields.append(FIELD_MAP[f['type']](k, f))
+        if server is None:
+            input_mode = 'fields'
+            output_mode = 'fields'
+        else:
+            input_mode = 'device' if server else 'server'
+            output_mode = 'server' if server else 'device'
+        for k, f in format[input_mode].items():
+            self.input_fields.append(FIELD_MAP[f['type']](k, f))
+        for k, f in format[output_mode].items():
+            self.output_fields.append(FIELD_MAP[f['type']](k, f))
 
     def encode(self, data):
         binary = self.header.encode('utf') + b'='
-        for f in self.fields:
+        for f in self.output_fields:
             binary += f.encode(data)
         return binary
 
     def decode(self, binary):
         data = {}
-        for f in self.fields:
+        for f in self.input_fields:
             val, binary = f.decode(binary)
             if isinstance(f.key, list):
                 for k in f.key:
@@ -32,13 +41,11 @@ class Format:
                 data[f.key] = val
         return data
 
-    def to_dict(self):
-        return [f.to_dict() for f in self.fields]
-
 
 class Protocol:
 
-    def __init__(self, file=None, js=None):
+    def __init__(self, server: bool = None, file=None, js=None):
+        self.server = server
         self.headers = {}
         if file:
             with open(file, 'r') as f:
@@ -54,7 +61,7 @@ class Protocol:
     def load_format(self, js):
         self.formats = {}
         for k in js.keys():
-            self.formats[k] = Format(js[k])
+            self.formats[k] = Format(name=k, format=js[k], server=self.server)
             self.headers[js[k]['header']] = k
 
     def get_format(self, h):
@@ -66,4 +73,4 @@ class Protocol:
     def decode(self, binary):
         h, binary = binary.split(b'=')
         format = self.get_format(h)
-        return h.decode('utf'), format.decode(binary)
+        return format.name, format.decode(binary)

{protobin-0.0.7 → protobin-0.0.8}/pyproject.toml

@@ -4,10 +4,13 @@ build-backend = "hatchling.build"
 
 [project]
 name = "protobin"
-version = "0.0.7"
+version = "0.0.8"
 authors = [
     { name="Daniel Robles", email="drm.electronic@gmail.com" },
 ]
+dependencies = [
+  'PyYAML ~= 6.0'
+]
 description = "Python library for encode and decode data in protobin format"
 readme = "README.md"
 license = { file="LICENSE.txt" }

{protobin-0.0.7 → protobin-0.0.8}/tests/demo.json

@@ -1,20 +1,30 @@
 {
     "login": {
         "header": "T",
-        "fields": {
+        "device": {
             "serial": {"bytes": 0, "type": "string"}
-        }
+        },
+         "server": {
+            "id": {"bytes": 2, "type": "id"},
+            "bus_number": {"bytes": 2, "type": "id"},
+            "route": {"bytes": 1, "type": "id"},
+            "direction": {"bytes": 1, "type": "bool"},
+            "geofence": {"bytes": 2, "type": "id"},
+            "state": {"bytes": 1, "type": "char"},
+            "trip": {"bytes": 4, "type": "id"},
+            "driver": {"bytes": 4, "type": "id"}
+         }
     },
     "report": {
         "header": "P",
-        "fields": {
+        "device": {
             "positions": {"bytes": 19, "type": "array", "array": {
                 "time": {"bytes": 6, "type": "datetime"},
                 "lng": {"bytes": 4, "type": "float", "decimals": 6},
                 "lat": {"bytes": 4, "type": "float", "decimals": 6},
                 "speed": {"bytes": 1, "type": "unsigned"},
-                "mark": {"bytes": 2, "type": "unsigned"},
-                "busstop": {"bytes": 2, "type": "unsigned"}}
+                "mark": {"bytes": 2, "type": "id"},
+                "busstop": {"bytes": 2, "type": "id"}}
             },
             "trip": {"bytes": 4, "type": "unsigned"},
             "route": {"bytes": 1, "type": "unsigned"},
@@ -25,6 +35,9 @@
                 "id": {"bytes": 2, "type": "unsigned"},
                 "value": {"bytes": 1, "type": "unsigned"}}
             }
+        },
+        "server": {
+            "positions": {"bytes":  1, "type":  "unsigned"}
         }
     }
 }

{protobin-0.0.7 → protobin-0.0.8}/tests/tests.py

@@ -12,7 +12,7 @@ DATA = {
                 'lng': -11.485014,
                 'lat': -77.621845,
                 'speed': 20,
-                'mark': 0,
+                'mark': None,
                 'busstop': 16
             },
             {
@@ -20,7 +20,7 @@ DATA = {
                 'lng': -11.485414,
                 'lat': -77.622245,
                 'speed': 25,
-                'mark': 0,
+                'mark': None,
                 'busstop': 16
             },
             {
@@ -28,7 +28,7 @@ DATA = {
                 'lng': -11.485514,
                 'lat': -77.621945,
                 'speed': 18,
-                'mark': 0,
+                'mark': None,
                 'busstop': 16
             },
             {
@@ -228,6 +228,7 @@ class BasicTest(unittest.TestCase):
     def test_float(self):
         data = {'test': -11.659812}
         binary = self.protocol.encode(data, 'float')
+        print(binary)
         h, recv = self.protocol.decode(binary)
         self.assertEqual(data, recv)
 
@@ -263,11 +264,12 @@ class BasicTest(unittest.TestCase):
 class AdvancedTest(unittest.TestCase):
 
     def test_file_json(self):
-        protocol = Protocol(file='demo.json')
-        binary = protocol.encode(DATA, 'report')
-        h, recv = protocol.decode(binary)
+        device = Protocol(file='demo.json', server=False)
+        binary = device.encode(DATA, 'report')
+        server = Protocol(file='demo.json', server=True)
+        name, recv = server.decode(binary)
         self.assertEqual(DATA, recv)
-        self.assertEqual(h, 'P')
+        self.assertEqual(name, 'report')
 
     # def test_file_yaml(self):
     #     protocol = Protocol(file='demo.yaml')
@@ -347,12 +349,27 @@ class AdvancedTest(unittest.TestCase):
         js = json.dumps(ym, indent=2)
 
     def test_convert_json_to_yaml(self):
-        protocol = Protocol(file='demo.json')
+        protocol = Protocol(file='demo.json', server=True)
 
     def test_login(self):
-        protocol = Protocol(file='demo.json')
+        device = Protocol(file='demo.json', server=False)
+        server = Protocol(file='demo.json', server=True)
         data = {'serial': '15984316545'}
-        binary = protocol.encode(data, 'login')
-        header, recv = protocol.decode(binary)
+        binary = device.encode(data, 'login')
+        header, recv = server.decode(binary)
+        self.assertEqual(header, 'login')
+        self.assertEqual(data, recv)
+        data = {
+            'id': 43,
+            'bus_number': 18,
+            'route': 2,
+            'direction': True,
+            'geofence': None,
+            'state': 'R',
+            'trip': 5681121,
+            'driver': 1432
+        }
+        binary = server.encode(data, 'login')
+        header, recv = device.decode(binary)
+        self.assertEqual(header, 'login')
         self.assertEqual(data, recv)
-        self.assertEqual(header, 'T')