Cómo utilizar los búferes de protocolo de Google en Python

Cuando las personas que hablan diferentes idiomas se reúnen y hablan, intentan usar un idioma que todos en el grupo entiendan.

Para lograr esto, todos deben traducir sus pensamientos, que generalmente están en su idioma nativo, al idioma del grupo. Esta "codificación y decodificación" del lenguaje, sin embargo, conduce a una pérdida de eficiencia, velocidad y precisión.

El mismo concepto está presente en los sistemas informáticos y sus componentes. ¿Por qué deberíamos enviar datos en XML, JSON o cualquier otro formato legible por humanos si no es necesario que entendamos de qué están hablando directamente? Siempre que podamos traducirlo a un formato legible por humanos si es explícitamente necesario.

Los búferes de protocolo son una forma de codificar datos antes del transporte, lo que reduce de manera eficiente los bloques de datos y, por lo tanto, aumenta la velocidad al enviarlos. Extrae datos en un formato neutral en cuanto al lenguaje y la plataforma.

Tabla de contenido

  • ¿Por qué necesitamos búferes de protocolo?
  • ¿Qué son los búferes de protocolo y cómo funcionan?
  • Búferes de protocolo en Python
  • Notas finales

¿Por qué Protocol Buffers?

El propósito inicial de Protocol Buffers era simplificar el trabajo con protocolos de solicitud / respuesta. Antes de ProtoBuf, Google usaba un formato diferente que requería un manejo adicional de clasificación para los mensajes enviados.

Además de eso, las nuevas versiones del formato anterior requerían que los desarrolladores se aseguraran de que se entendieran las nuevas versiones antes de reemplazar las antiguas, por lo que trabajar con ellas era complicado.

Esta sobrecarga motivó a Google a diseñar una interfaz que resuelva precisamente esos problemas.

ProtoBuf permite introducir cambios en el protocolo sin romper la compatibilidad. Además, los servidores pueden pasar los datos y ejecutar operaciones de lectura en los datos sin modificar su contenido.

Dado que el formato es algo autodescriptivo, ProtoBuf se utiliza como base para la generación automática de código para serializadores y deserializadores.

Otro caso de uso interesante es cómo lo usa Google para llamadas a procedimiento remoto (RPC) de corta duración y para almacenar datos de manera persistente en Bigtable. Debido a su caso de uso específico, integraron interfaces RPC en ProtoBuf. Esto permite una generación de códigos auxiliar rápida y sencilla que se puede utilizar como puntos de partida para la implementación real. (Más sobre ProtoBuf RPC.)

Otros ejemplos en los que ProtoBuf puede ser útil son los dispositivos IoT que están conectados a través de redes móviles en las que la cantidad de datos enviados debe mantenerse pequeña o para aplicaciones en países donde los anchos de banda altos aún son raros. El envío de cargas útiles en formatos binarios optimizados puede generar diferencias notables en el costo de operación y la velocidad.

El uso de gzipcompresión en su comunicación HTTPS puede mejorar aún más esas métricas.

¿Qué son los búferes de protocolo y cómo funcionan?

En términos generales, los búferes de protocolo son una interfaz definida para la serialización de datos estructurados. Define una forma normalizada de comunicarse, totalmente independiente de lenguajes y plataformas.

Google anuncia su ProtoBuf así:

Los búferes de protocolo son el mecanismo extensible, neutral en cuanto al lenguaje y la plataforma, de Google para serializar datos estructurados; piense en XML, pero más pequeño, más rápido y más simple. Tú defines cómo quieres que se estructuran tus datos una vez ...

La interfaz ProtoBuf describe la estructura de los datos que se enviarán. Las estructuras de carga útil se definen como "mensajes" en lo que se denomina Proto-Archivos. Esos archivos siempre terminan con un.protoextensión.

Por ejemplo, la estructura básica de un archivo todolist.proto se ve así. También veremos un ejemplo completo en la siguiente sección.

syntax = "proto3"; // Not necessary for Python, should still be declared to avoid name collisions // in the Protocol Buffers namespace and non-Python languages package protoblog; message TodoList { // Elements of the todo list will be defined here ... }

Luego, esos archivos se utilizan para generar clases de integración o códigos auxiliares para el lenguaje de su elección utilizando generadores de código dentro del compilador de protocolo. La versión actual, Proto3, ya es compatible con los principales lenguajes de programación. La comunidad admite muchos más en implementaciones de código abierto de terceros.

Las clases generadas son los elementos centrales de Protocol Buffers. Permiten la creación de elementos instanciando nuevos mensajes, basados ​​en los .protoarchivos, que luego se utilizan para la serialización. Veremos cómo se hace esto con Python en detalle en la siguiente sección.

Independientemente del lenguaje para la serialización, los mensajes se serializan en un formato binario no autodescriptivo que es bastante inútil sin la definición de estructura inicial.

Los datos binarios pueden almacenarse, enviarse a través de la red y utilizarse de cualquier otra forma que los datos legibles por humanos, como JSON o XML. Después de la transmisión o el almacenamiento, el flujo de bytes se puede deserializar y restaurar utilizando cualquier clase protobuf compilada específica del idioma que generemos a partir del archivo .proto.

Usando Python como ejemplo, el proceso podría verse así:

Primero, creamos una nueva lista de tareas pendientes y la llenamos con algunas tareas. Esta lista de tareas pendientes se serializa y se envía a través de la red, se guarda en un archivo o se almacena de forma persistente en una base de datos.

El flujo de bytes enviado se deserializa utilizando el método de análisis de nuestra clase compilada específica del idioma.

La mayoría de las arquitecturas e infraestructuras actuales, especialmente los microservicios, se basan en comunicaciones REST, WebSockets o GraphQL. Sin embargo, cuando la velocidad y la eficiencia son esenciales, los ERT de bajo nivel pueden marcar una gran diferencia.

En lugar de protocolos de alta sobrecarga, podemos usar una forma rápida y compacta de mover datos entre las diferentes entidades a nuestro servicio sin desperdiciar muchos recursos.

Pero, ¿por qué todavía no se usa en todas partes?

Los búferes de protocolo son un poco más complicados que otros formatos legibles por humanos. Esto los hace comparativamente más difíciles de depurar e integrar en sus aplicaciones.

Los tiempos de iteración en ingeniería también tienden a aumentar, ya que las actualizaciones de los datos requieren actualizar los archivos proto antes de su uso.

Se deben hacer consideraciones cuidadosas ya que ProtoBuf podría ser una solución sobre-diseñada en muchos casos.

¿Qué alternativas tengo?

Several projects take a similar approach to Google’s Protocol Buffers.

Google’s Flatbuffers and a third party implementation, called Cap’n Proto, are more focused on removing the parsing and unpacking step, which is necessary to access the actual data when using ProtoBufs. They have been designed explicitly for performance-critical applications, making them even faster and more memory efficient than ProtoBuf.

When focusing on the RPC capabilities of ProtoBuf (used with gRPC), there are projects from other large companies like Facebook (Apache Thrift) or Microsoft (Bond protocols) that can offer alternatives.

Python and Protocol Buffers

Python already provides some ways of data persistence using pickling. Pickling is useful in Python-only applications. It's not well suited for more complex scenarios where data sharing with other languages or changing schemas is involved.

Protocol Buffers, in contrast, are developed for exactly those scenarios.

The .proto files, we’ve quickly covered before, allow the user to generate code for many supported languages.

To compile the .protofile to the language class of our choice, we use protoc, the proto compiler.

If you don’t have the protoc compiler installed, there are excellent guides on how to do that:

  • MacOS / Linux
  • Windows

Once we’ve installed protoc on our system, we can use an extended example of our todo list structure from before and generate the Python integration class from it.

syntax = "proto3"; // Not necessary for Python but should still be declared to avoid name collisions // in the Protocol Buffers namespace and non-Python languages package protoblog; // Style guide prefers prefixing enum values instead of surrounding // with an enclosing message enum TaskState { TASK_OPEN = 0; TASK_IN_PROGRESS = 1; TASK_POST_PONED = 2; TASK_CLOSED = 3; TASK_DONE = 4; } message TodoList { int32 owner_id = 1; string owner_name = 2; message ListItems { TaskState state = 1; string task = 2; string due_date = 3; } repeated ListItems todos = 3; } 

Let’s take a more detailed look at the structure of the .proto file to understand it.

In the first line of the proto file, we define whether we’re using Proto2 or 3. In this case, we’re using Proto3.

The most uncommon elements of proto files are the numbers assigned to each entity of a message. Those dedicated numbers make each attribute unique and are used to identify the assigned fields in the binary encoded output.

One important concept to grasp is that only values 1-15 are encoded with one less byte (Hex), which is useful to understand so we can assign higher numbers to the less frequently used entities. The numbers define neitherthe order of encoding nor the position of the given attribute in the encoded message.

The package definition helps prevent name clashes. In Python, packages are defined by their directory. Therefore providing a package attribute doesn’t have any effect on the generated Python code.

Please note that this should still be declared to avoid protocol buffer related name collisions and for other languages like Java.

Enumerations are simple listings of possible values for a given variable.

In this case, we define an Enum for the possible states of each task on the todo list.

We’ll see how to use them in a bit when we look at the usage in Python.

As we can see in the example, we can also nest messages inside messages.

If we, for example, want to have a list of todos associated with a given todo list, we can use the repeated keyword, which is comparable to dynamically sized arrays.

To generate usable integration code, we use the proto compiler which compiles a given .proto file into language-specific integration classes. In our case we use the --python-out argument to generate Python-specific code.

protoc -I=. --python_out=. ./todolist.proto

In the terminal, we invoke the protocol compiler with three parameters:

  1. -I: defines the directory where we search for any dependencies (we use . which is the current directory)
  2. --python_out: defines the location we want to generate a Python integration class in (again we use . which is the current directory)
  3. The last unnamed parameter defines the .proto file that will be compiled (we use the todolist.proto file in the current directory)

This creates a new Python file called _pb2.py. In our case, it is todolist_pb2.py. When taking a closer look at this file, we won’t be able to understand much about its structure immediately.

This is because the generator doesn’t produce direct data access elements, but further abstracts away the complexity using metaclasses and descriptors for each attribute. They describe how a class behaves instead of each instance of that class.

The more exciting part is how to use this generated code to create, build, and serialize data. A straightforward integration done with our recently generated class is seen in the following:

import todolist_pb2 as TodoList my_list = TodoList.TodoList() my_list.owner_id = 1234 my_list.owner_name = "Tim" first_item = my_list.todos.add() first_item.state = TodoList.TaskState.Value("TASK_DONE") first_item.task = "Test ProtoBuf for Python" first_item.due_date = "31.10.2019" print(my_list)

It merely creates a new todo list and adds one item to it. We then print the todo list element itself and can see the non-binary, non-serialized version of the data we just defined in our script.

owner_id: 1234 owner_name: "Tim" todos { state: TASK_DONE task: "Test ProtoBuf for Python" due_date: "31.10.2019" }

Each Protocol Buffer class has methods for reading and writing messages using a Protocol Buffer-specific encoding, that encodes messages into binary format.

Those two methods are SerializeToString() and ParseFromString().

import todolist_pb2 as TodoList my_list = TodoList.TodoList() my_list.owner_id = 1234 # ... with open("./serializedFile", "wb") as fd: fd.write(my_list.SerializeToString()) my_list = TodoList.TodoList() with open("./serializedFile", "rb") as fd: my_list.ParseFromString(fd.read()) print(my_list)

In the code example above, we write the Serialized string of bytes into a file using the wb flags.

Since we have already written the file, we can read back the content and Parse it using ParseFromString. ParseFromString calls on a new instance of our Serialized class using the rb flags and parses it.

If we serialize this message and print it in the console, we get the byte representation which looks like this.

b'\x08\xd2\t\x12\x03Tim\x1a(\x08\x04\x12\x18Test ProtoBuf for Python\x1a\n31.10.2019'

Note the b in front of the quotes. This indicates that the following string is composed of byte octets in Python.

If we directly compare this to, e.g., XML, we can see the impact ProtoBuf serialization has on the size.

 1234 Tim   TASK_DONE Test ProtoBuf for Python 31.10.2019   

The JSON representation, non-uglified, would look like this.

{ "todoList": { "ownerId": "1234", "ownerName": "Tim", "todos": [ { "state": "TASK_DONE", "task": "Test ProtoBuf for Python", "dueDate": "31.10.2019" } ] } }

Judging the different formats only by the total number of bytes used, ignoring the memory needed for the overhead of formatting it, we can of course see the difference.

But in addition to the memory used for the data, we also have 12 extra bytes in ProtoBuf for formatting serialized data. Comparing that to XML, we have 171 extra bytes in XML for formatting serialized data.

Without Schema, we need 136 extra bytes in JSON forformattingserialized data.

If we’re talking about several thousands of messages sent over the network or stored on disk, ProtoBuf can make a difference.

However, there is a catch. The platform Auth0.com created an extensive comparison between ProtoBuf and JSON. It shows that, when compressed, the size difference between the two can be marginal (only around 9%).

If you’re interested in the exact numbers, please refer to the full article, which gives a detailed analysis of several factors like size and speed.

An interesting side note is that each data type has a default value. If attributes are not assigned or changed, they will maintain the default values. In our case, if we don’t change the TaskState of a ListItem, it has the state of “TASK_OPEN” by default. The significant advantage of this is that non-set values are not serialized, saving additional space.

If we, for example, change the state of our task from TASK_DONE to TASK_OPEN, it will not be serialized.

owner_id: 1234 owner_name: "Tim" todos { task: "Test ProtoBuf for Python" due_date: "31.10.2019" }

b'\x08\xd2\t\x12\x03Tim\x1a&\x12\x18Test ProtoBuf for Python\x1a\n31.10.2019'

Final Notes

As we have seen, Protocol Buffers are quite handy when it comes to speed and efficiency when working with data. Due to its powerful nature, it can take some time to get used to the ProtoBuf system, even though the syntax for defining new messages is straightforward.

As a last note, I want to point out that there were/are discussions going on about whether Protocol Buffers are “useful” for regular applications. They were developed explicitly for problems Google had in mind.

If you have any questions or feedback, feel free to reach out to me on any social media like twitter or email :)