protobin 0.0.2__tar.gz → 0.0.4__tar.gz

protobin-0.0.4/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.3
+Name: protobin
+Version: 0.0.4
+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
+Author-email: Daniel Robles <drm.electronic@gmail.com>
+License: MIT License
+        
+        Copyright (c) [Año] [Tu Nombre]
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE. 1
+        1. en.wikipedia.org
+        en.wikipedia.org
+License-File: LICENSE.txt
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# protobin
+
+**protobin** es una biblioteca Python diseñada para facilitar la interacción con el formato de transferencia de datos Protobin en modo binario. Esta biblioteca proporciona una interfaz sencilla y eficiente para:
+
+* **Serializar** objetos Python en datos Protobin.
+* **Deserializar** datos Protobin en objetos Python.
+* **Validar** la integridad de los datos Protobin.
+
+## Instalación
+
+Para instalar `protobin`, puedes utilizar pip:
+
+```bash
+pip install protobin
+```
+
+## Cómo empezar
+
+### Primeros Pasos
+Declare un protocolo de la siguiente forma:
+
+```python
+from protobin import Protocol
+protocol = Protocol(js={'medida': [
+        {'key': 'id', 'bytes': 1, 'type': 'unsigned'},
+        {'key': 'nombre', 'type': 'string'},
+        {'key': 'valor', 'bytes': 2, 'type': 'signed'}
+    ]})
+```
+
+luego cree la variable que desea transmitir como un diccionario de python, codiféquela, decodifíquela, y compruebe que la información se recuperó correctamente 
+
+```python
+data = {'id': 2, 'nombre': 'Voltaje', 'valor': -20}
+binary = protocol.encode(data, 'medida')
+print('binary', binary)
+recv = protocol.decode(binary, 'medida')
+print('recv', recv)
+```
+
+### Archivo Json
+
+El protocolo se declara en un archivo *.json o un objeto dict en python.
+Éste contiene un diccionario donde cada clave del diccionario es el identificador de un formato.
+
+```json
+{
+  "formato1": [{}, {}, {}],
+  "formato2": [{}, {}]  
+}
+```
+
+Cada formato se declara como una lista de campos, y cada campo es representado por un diccionario, que debe tener un **key** para identificar el dato que se almacenará en esa posición, también debe tener un **type** que define el tipo de dato que se guardará y opcionalmente **bytes** o **length** para definir la cantidad de espacio o datos que se guardarán.
+
+
+### Tipos de Datos
+
+**array** : Sirve para declarar listas de objetos, requiere el campo **array* que contiene un formato completo.
+
+**bits** : Sirve para declarar una lista de valores booleanos como un arreglo de bits en la cantidad necesaria de bytes. Es opcional el campo **length** si se quiere fijar una cantidad de elementos y usar un byte menos en su codificación.
+
+**bool** : Sirve para declarar un único valor booleano en un byte. No requiere campos adicionales, ocupa 1 byte.
+
+**char** : Sirve para declarar un único valor booleano en un byte. No requiere campos adicionales, ocupa 1 byte.
+
+**date** : Sirve para declarar un valor datetime.date. No requiere campos adicionales, ocupa 3 bytes.
+
+**datetime** : Sirve para declarar un valor datetime.datetime con presicion de segundos. No requiere campos adicionales, ocupa 6 bytes.
+
+**flags** : Sirve para declarar una lista de keys cuyos valores sean booleanos y representarlos en un arreglo de bits. No requiere campos adicionales.
+
+**float** : Sirve para declarar un valor numérico con una precisión fija de decimales. Requiere el campo **bytes** y **decimales**, tamaño variable.
+
+**signed** : Sirve para declarar un valor entero positivo. Requiere el campo **bytes**, tamaño variable.
+
+**string** : Sirve para declarar un texto. Es opcional el campo **bytes**, tamaño variable.
+
+**time** : Sirve para declarar un valor datetime.time con presicion de minutos. No requiere campos adicionales, ocupa 2 bytes.
+
+**timestamp** : Sirve para declarar un valor datetime.datetime con presicion de microsegundos. No requiere campos adicionales, ocupa 8 bytes.
+
+**unsigned** : Sirve para declarar un valor entero. Requiere el campo **bytes**, tamaño variable.

protobin-0.0.4/README.md

@@ -0,0 +1,82 @@
+# protobin
+
+**protobin** es una biblioteca Python diseñada para facilitar la interacción con el formato de transferencia de datos Protobin en modo binario. Esta biblioteca proporciona una interfaz sencilla y eficiente para:
+
+* **Serializar** objetos Python en datos Protobin.
+* **Deserializar** datos Protobin en objetos Python.
+* **Validar** la integridad de los datos Protobin.
+
+## Instalación
+
+Para instalar `protobin`, puedes utilizar pip:
+
+```bash
+pip install protobin
+```
+
+## Cómo empezar
+
+### Primeros Pasos
+Declare un protocolo de la siguiente forma:
+
+```python
+from protobin import Protocol
+protocol = Protocol(js={'medida': [
+        {'key': 'id', 'bytes': 1, 'type': 'unsigned'},
+        {'key': 'nombre', 'type': 'string'},
+        {'key': 'valor', 'bytes': 2, 'type': 'signed'}
+    ]})
+```
+
+luego cree la variable que desea transmitir como un diccionario de python, codiféquela, decodifíquela, y compruebe que la información se recuperó correctamente 
+
+```python
+data = {'id': 2, 'nombre': 'Voltaje', 'valor': -20}
+binary = protocol.encode(data, 'medida')
+print('binary', binary)
+recv = protocol.decode(binary, 'medida')
+print('recv', recv)
+```
+
+### Archivo Json
+
+El protocolo se declara en un archivo *.json o un objeto dict en python.
+Éste contiene un diccionario donde cada clave del diccionario es el identificador de un formato.
+
+```json
+{
+  "formato1": [{}, {}, {}],
+  "formato2": [{}, {}]  
+}
+```
+
+Cada formato se declara como una lista de campos, y cada campo es representado por un diccionario, que debe tener un **key** para identificar el dato que se almacenará en esa posición, también debe tener un **type** que define el tipo de dato que se guardará y opcionalmente **bytes** o **length** para definir la cantidad de espacio o datos que se guardarán.
+
+
+### Tipos de Datos
+
+**array** : Sirve para declarar listas de objetos, requiere el campo **array* que contiene un formato completo.
+
+**bits** : Sirve para declarar una lista de valores booleanos como un arreglo de bits en la cantidad necesaria de bytes. Es opcional el campo **length** si se quiere fijar una cantidad de elementos y usar un byte menos en su codificación.
+
+**bool** : Sirve para declarar un único valor booleano en un byte. No requiere campos adicionales, ocupa 1 byte.
+
+**char** : Sirve para declarar un único valor booleano en un byte. No requiere campos adicionales, ocupa 1 byte.
+
+**date** : Sirve para declarar un valor datetime.date. No requiere campos adicionales, ocupa 3 bytes.
+
+**datetime** : Sirve para declarar un valor datetime.datetime con presicion de segundos. No requiere campos adicionales, ocupa 6 bytes.
+
+**flags** : Sirve para declarar una lista de keys cuyos valores sean booleanos y representarlos en un arreglo de bits. No requiere campos adicionales.
+
+**float** : Sirve para declarar un valor numérico con una precisión fija de decimales. Requiere el campo **bytes** y **decimales**, tamaño variable.
+
+**signed** : Sirve para declarar un valor entero positivo. Requiere el campo **bytes**, tamaño variable.
+
+**string** : Sirve para declarar un texto. Es opcional el campo **bytes**, tamaño variable.
+
+**time** : Sirve para declarar un valor datetime.time con presicion de minutos. No requiere campos adicionales, ocupa 2 bytes.
+
+**timestamp** : Sirve para declarar un valor datetime.datetime con presicion de microsegundos. No requiere campos adicionales, ocupa 8 bytes.
+
+**unsigned** : Sirve para declarar un valor entero. Requiere el campo **bytes**, tamaño variable.

{protobin-0.0.2 → protobin-0.0.4}/protobin/fields.py

@@ -75,8 +75,7 @@ class FieldBase:
     def split(self, binary):
         if self.bytes:
             return binary[:self.bytes], binary[self.bytes:]
-        self.bytes = binary[0]
-        return binary[1:self.bytes + 1], binary[self.bytes + 1:]
+        return binary[1:binary[0] + 1], binary[binary[0] + 1:]
 
     def to_dict(self):
         return {
@@ -134,11 +133,18 @@ class FieldBits(FieldBase):
         self.length = js.get('length', 0)
         self.bytes = math.ceil(self.length / 8)
 
+    def decode(self, binary):
+        self.ensure_length(binary)
+        a, b, length = self.split(binary)
+        val = self.from_binary_bits(a, length)
+        return val, b
+
     def split(self, binary):
-        if not self.length:
-            self.length = binary[0]
-            self.bytes = math.ceil(self.length / 8)
-        return binary[1:self.bytes + 1], binary[self.bytes + 1:]
+        if self.length:
+            return binary[:self.bytes], binary[self.bytes:], self.length
+        length = binary[0]
+        bts = math.ceil(length / 8)
+        return binary[1:bts + 1], binary[bts + 1:], length
 
     def to_binary(self, val: List[bool]):
         if len(val) == 0:
@@ -150,18 +156,19 @@ class FieldBits(FieldBase):
             bits = ''
         for b in val:
             bits += '1' if b else '0'
-        length = int(len(bits) / 8)
-        binary += len(val).to_bytes(1, 'big', signed=False)
-        binary += int(bits, 2).to_bytes(length, 'big', signed=False)
+        bts = int(len(bits) / 8)
+        if not self.length:
+            binary += len(val).to_bytes(1, 'big', signed=False)
+        binary += int(bits, 2).to_bytes(bts, 'big', signed=False)
         return binary
 
-    def from_binary(self, binary):
+    def from_binary_bits(self, binary, length):
         numero = int.from_bytes(binary, 'big', signed=False)
         bits = bin(numero)[2:]
         val = [False] * 8
         for b in bits:
             val.append(b == '1')
-        val = val[-self.length:]
+        val = val[-length:]
         return val
 
 
@@ -306,15 +313,14 @@ class FieldSigned(FieldBase):
 class FieldString(FieldBase):
 
     def to_binary(self, val):
-        if self.bytes == 0:
-            utf = str(val).encode('utf')[:255]
-            return len(utf).to_bytes(1, 'big') + utf
+        if self.bytes:
+            utf = str(val).encode('utf')[:self.bytes]
+            return utf
+        utf = str(val).encode('utf')[:255]
+        return len(utf).to_bytes(1, 'big') + utf
 
     def from_binary(self, binary):
-        if self.bytes == 0:
-            self.bytes = int.from_bytes(binary[:1], 'big', signed=False)
-            binary = binary[1:]
-        return binary[:self.bytes].decode('utf')
+        return binary.decode('utf')
 
 
 class FieldTime(FieldBase):

{protobin-0.0.2 → protobin-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "protobin"
-version = "0.0.2"
+version = "0.0.4"
 authors = [
     { name="Daniel Robles", email="drm.electronic@gmail.com" },
 ]

{protobin-0.0.2 → protobin-0.0.4}/tests/tests.py

@@ -116,6 +116,7 @@ class BasicTest(unittest.TestCase):
                 {'key': 'test', 'bytes': 0, 'type': 'string'}
             ]}],
             'bits': [{'key': 'test', 'type': 'bits'}],
+            'bits_fixed': [{'key': 'test', 'type': 'bits', 'length': 7}],
             'bool': [{'key': 'test', 'bytes': 1, 'type': 'bool'}],
             'char': [{'key': 'test', 'bytes': 1, 'type': 'char'}],
             'date': [{'key': 'test', 'bytes': 1, 'type': 'date'}],
@@ -148,6 +149,15 @@ class BasicTest(unittest.TestCase):
         print('recv', recv)
         self.assertEqual(data, recv)
 
+    def test_bits_fixed(self):
+        data = {'test': [True, False, True, False, False, True, True]}
+        print('data', data)
+        binary = self.protocol.encode(data, 'bits_fixed')
+        print('binary', binary)
+        recv = self.protocol.decode(binary, 'bits_fixed')
+        print('recv', recv)
+        self.assertEqual(data, recv)
+
     def test_bool(self):
         data = {'test': False}
         binary = self.protocol.encode(data, 'bool')
@@ -207,6 +217,10 @@ class BasicTest(unittest.TestCase):
         binary = self.protocol.encode(data, 'string')
         recv = self.protocol.decode(binary, 'string')
         self.assertEqual(data, recv)
+        data = {'test': 'otro texto de prueba más largo'}
+        binary = self.protocol.encode(data, 'string')
+        recv = self.protocol.decode(binary, 'string')
+        self.assertEqual(data, recv)
 
     def test_timestamp(self):
         data = {'test': datetime.datetime(2024, 9, 13, 15, 23, 51, 265981)}
@@ -217,12 +231,23 @@ class BasicTest(unittest.TestCase):
 
 class AdvancedTest(unittest.TestCase):
 
-    def setUp(self):
-        self.parser = Protocol(file='demo.json')
-
-    def test_report(self):
-        binary = self.parser.encode(DATA, 'report')
-        recv = self.parser.decode(binary, 'report')
+    def test_file(self):
+        protocol = Protocol(file='demo.json')
+        binary = protocol.encode(DATA, 'report')
+        recv = protocol.decode(binary, 'report')
         self.assertEqual(DATA, recv)
 
+    def test_json(self):
+        protocol = Protocol(js={'medida': [
+                {'key': 'id', 'bytes': 1, 'type': 'unsigned'},
+                {'key': 'nombre', 'type': 'string'},
+                {'key': 'valor', 'bytes': 2, 'type': 'signed'}
+            ]})
+        data = {'id': 2, 'nombre': 'Voltaje', 'valor': -20}
+        binary = protocol.encode(data, 'medida')
+        print('binary', binary)
+        recv = protocol.decode(binary, 'medida')
+        print('recv', recv)
+        self.assertEqual(data, recv)
+
 

protobin-0.0.2/PKG-INFO

@@ -1,51 +0,0 @@
-Metadata-Version: 2.3
-Name: protobin
-Version: 0.0.2
-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
-Author-email: Daniel Robles <drm.electronic@gmail.com>
-License: MIT License
-        
-        Copyright (c) [Año] [Tu Nombre]
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE. 1
-        1. en.wikipedia.org
-        en.wikipedia.org
-License-File: LICENSE.txt
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-
-# protobin
-
-**protobin** es una biblioteca Python diseñada para facilitar la interacción con el formato de transferencia de datos Protobin en modo binario. Esta biblioteca proporciona una interfaz sencilla y eficiente para:
-
-* **Serializar** objetos Python en datos Protobin.
-* **Deserializar** datos Protobin en objetos Python.
-* **Validar** la integridad de los datos Protobin.
-
-## Instalación
-
-Para instalar `protobin-python`, puedes utilizar pip:
-
-```bash
-pip install protobin

protobin-0.0.2/README.md

@@ -1,14 +0,0 @@
-# protobin
-
-**protobin** es una biblioteca Python diseñada para facilitar la interacción con el formato de transferencia de datos Protobin en modo binario. Esta biblioteca proporciona una interfaz sencilla y eficiente para:
-
-* **Serializar** objetos Python en datos Protobin.
-* **Deserializar** datos Protobin en objetos Python.
-* **Validar** la integridad de los datos Protobin.
-
-## Instalación
-
-Para instalar `protobin-python`, puedes utilizar pip:
-
-```bash
-pip install protobin

protobin-0.0.2/tests/test_data.py

@@ -1,2 +0,0 @@
-import datetime
-