Comment utiliser les tampons de protocole de Google en Python

Lorsque des personnes qui parlent différentes langues se réunissent et parlent, elles essaient d'utiliser une langue que tout le monde dans le groupe comprend.

Pour y parvenir, chacun doit traduire ses pensées, qui sont généralement dans sa langue maternelle, dans la langue du groupe. Cet «encodage et décodage» du langage entraîne cependant une perte d'efficacité, de rapidité et de précision.

Le même concept est présent dans les systèmes informatiques et leurs composants. Pourquoi devrions-nous envoyer des données au format XML, JSON ou tout autre format lisible par l'homme si nous n'avons pas besoin de comprendre directement de quoi ils parlent? Tant que nous pouvons encore le traduire dans un format lisible par l'homme si cela est explicitement nécessaire.

Les tampons de protocole sont un moyen d'encoder les données avant le transport, ce qui réduit efficacement les blocs de données et augmente donc la vitesse lors de leur envoi. Il extrait les données dans un format indépendant du langage et de la plate-forme.

Table des matières

  • Pourquoi avons-nous besoin de tampons de protocole?
  • Que sont les tampons de protocole et comment fonctionnent-ils?
  • Tampons de protocole en Python
  • Notes finales

Pourquoi des tampons de protocole?

L'objectif initial des tampons de protocole était de simplifier le travail avec les protocoles de demande / réponse. Avant ProtoBuf, Google utilisait un format différent qui nécessitait une gestion supplémentaire du marshaling pour les messages envoyés.

En plus de cela, les nouvelles versions du format précédent obligeaient les développeurs à s'assurer que les nouvelles versions sont comprises avant de remplacer les anciennes, ce qui rend le travail compliqué.

Cette surcharge a motivé Google à concevoir une interface qui résout précisément ces problèmes.

ProtoBuf permet d'apporter des modifications au protocole sans rompre la compatibilité. De plus, les serveurs peuvent transmettre les données et exécuter des opérations de lecture sur les données sans en modifier le contenu.

Comme le format est quelque peu auto-descriptif, ProtoBuf est utilisé comme base pour la génération automatique de code pour les sérialiseurs et les désérialiseurs.

Un autre cas d'utilisation intéressant est la façon dont Google l'utilise pour les appels de procédure à distance (RPC) de courte durée et pour stocker de manière persistante des données dans Bigtable. En raison de leur cas d'utilisation spécifique, ils ont intégré des interfaces RPC dans ProtoBuf. Cela permet une génération de stub de code rapide et simple qui peut être utilisée comme point de départ pour l'implémentation réelle. (Plus d'informations sur ProtoBuf RPC.)

D'autres exemples où ProtoBuf peut être utile sont pour les appareils IoT qui sont connectés via des réseaux mobiles dans lesquels la quantité de données envoyées doit être réduite ou pour des applications dans des pays où les bandes passantes élevées sont encore rares. L'envoi de charges utiles dans des formats binaires optimisés peut entraîner des différences notables en termes de coût et de vitesse de fonctionnement.

L'utilisation de la gzipcompression dans votre communication HTTPS peut encore améliorer ces métriques.

Que sont les tampons de protocole et comment fonctionnent-ils?

De manière générale, les tampons de protocole sont une interface définie pour la sérialisation des données structurées. Il définit une manière normalisée de communiquer, totalement indépendante des langages et des plates-formes.

Google annonce son ProtoBuf comme ceci:

Les tampons de protocole sont le mécanisme extensible de Google, indépendant du langage, de la plateforme et de la sérialisation des données structurées - pensez XML, mais plus petit, plus rapide et plus simple. Vous définissez la manière dont vous souhaitez que vos données soient structurées une fois…

L'interface ProtoBuf décrit la structure des données à envoyer. Les structures de charge utile sont définies comme des «messages» dans ce qu'on appelle les proto-fichiers. Ces fichiers se terminent toujours par un.protoextension.

Par exemple, la structure de base d'un fichier todolist.proto ressemble à ceci. Nous examinerons également un exemple complet dans la section suivante.

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 ... }

Ces fichiers sont ensuite utilisés pour générer des classes d'intégration ou des stubs pour la langue de votre choix à l'aide de générateurs de code dans le compilateur protoc. La version actuelle, Proto3, prend déjà en charge tous les principaux langages de programmation. La communauté prend en charge beaucoup plus dans les implémentations open source tierces.

Les classes générées sont les éléments de base des tampons de protocole. Ils permettent la création d'éléments en instanciant de nouveaux messages, basés sur les .protofichiers, qui sont ensuite utilisés pour la sérialisation. Nous verrons comment cela est fait avec Python en détail dans la section suivante.

Indépendamment du langage de sérialisation, les messages sont sérialisés dans un format binaire non auto-descriptif qui est assez inutile sans la définition de structure initiale.

Les données binaires peuvent ensuite être stockées, envoyées sur le réseau et utilisées de toute autre manière des données lisibles par l'homme comme JSON ou XML. Après la transmission ou le stockage, le flux d'octets peut être désérialisé et restauré à l'aide de n'importe quelle classe protobuf compilée spécifique au langage que nous générons à partir du fichier .proto.

En utilisant Python comme exemple, le processus pourrait ressembler à ceci:

Tout d'abord, nous créons une nouvelle liste de tâches et la remplissons de certaines tâches. Cette liste de tâches est ensuite sérialisée et envoyée sur le réseau, enregistrée dans un fichier ou stockée de manière permanente dans une base de données.

Le flux d'octets envoyé est désérialisé à l'aide de la méthode parse de notre classe compilée spécifique au langage.

La plupart des architectures et infrastructures actuelles, en particulier les microservices, sont basées sur la communication REST, WebSockets ou GraphQL. Cependant, lorsque la vitesse et l'efficacité sont essentielles, les RPC de bas niveau peuvent faire une énorme différence.

Au lieu de protocoles à frais généraux élevés, nous pouvons utiliser un moyen rapide et compact pour déplacer des données entre les différentes entités dans notre service sans gaspiller beaucoup de ressources.

Mais pourquoi n'est-il pas encore utilisé partout?

Les tampons de protocole sont un peu plus compliqués que les autres formats lisibles par l'homme. Cela les rend relativement plus difficiles à déboguer et à intégrer dans vos applications.

Les temps d'itération en ingénierie ont également tendance à augmenter car les mises à jour des données nécessitent la mise à jour des fichiers proto avant utilisation.

Des considérations prudentes doivent être prises car ProtoBuf peut être une solution sur-conçue dans de nombreux cas.

Quelles alternatives ai-je?

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 :)