Skip to main content

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:

pip install protobin

Cómo empezar

Primeros Pasos

Declare un protocolo de la siguiente forma:

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

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.

{
  "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.

Metadata

Release files for protobin 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for protobin 0.1.1
File Size Uploaded Provenance Actions
protobin-0.1.1.tar.gz 18.1 kB Without provenance Details for protobin-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for protobin 0.1.1
File Interpreter ABI Platform Actions
protobin-0.1.1-py3-none-any.whl Python 3 none any Details for protobin-0.1.1-py3-none-any.whl

Total release size: 28.4 kB

Release files / protobin-0.1.1.tar.gz

Download URL protobin-0.1.1.tar.gz
Size 18.1 kB
Tags Source
SHA-256 checksum
How to use checksums
9186bd8ff9dae6b7aed723a99b68b7eb05e9a0029d6f06a536190414c601c758
BLAKE2b-256 checksum
How to use checksums
9f8fce2e0fd111471f686ae8e8be588ce30b3c42389119f03408f71320c9262e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / protobin-0.1.1-py3-none-any.whl

Download URL protobin-0.1.1-py3-none-any.whl
Size 10.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
147a90ef7dce396d44469b92d01dcff5deb026e50112c29a69c91956e62b647e
BLAKE2b-256 checksum
How to use checksums
6f389dd1362d992de277f8360fa4411b7df4bbc6d0c8348219a8e22a3499bfe4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for protobin 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page