Book Image

Protocol Buffers Handbook

By : Clément Jean
Book Image

Protocol Buffers Handbook

By: Clément Jean

Overview of this book

Explore how Protocol Buffers (Protobuf) serialize structured data and provides a language-neutral, platform-neutral, and extensible solution. With this guide to mastering Protobuf, you'll build your skills to effectively serialize, transmit, and manage data across diverse platforms and languages. This book will help you enter the world of Protocol Buffers by unraveling the intricate nuances of Protobuf syntax and showing you how to define complex data structures. As you progress, you’ll learn schema evolution, ensuring seamless compatibility as your projects evolve. The book also covers advanced topics such as custom options and plugins, allowing you to tailor validation processes to your specific requirements. You’ll understand how to automate project builds using cutting-edge tools such as Buf and Bazel, streamlining your development workflow. With hands-on projects in Go and Python programming, you’ll learn how to practically apply Protobuf concepts. Later chapters will show you how to integrate data interchange capabilities across different programming languages, enabling efficient collaboration and system interoperability. By the end of this book, you’ll have a solid understanding of Protobuf internals, enabling you to discern when and how to use and redefine your approach to data serialization.
Table of Contents (13 chapters)

Boilerplate code

Let us prepare some convenient helpers for the journey ahead. We know we will need to write/read to/from files and that we will need to transform some arguments, passed as strings, into Python types. Let us deal with the latter first since this is a very trivial task.

Converting strings to enum values

We are going to create two functions: str_to_phone_type and str_to_department. Both look similar since we are going to check the value of the string and derive an enum value out of it. Let us start with str_to_phone_type.

We know that the PhoneType enum contains the TYPE_HOME, TYPE_MOBILE, TYPE_WORK, and TYPE_UNSPECIFIED values. Thus, we will simply check for the home, mobile, and work values. If the string does not contain anything or a value outside of these, the phone type will be considered unspecified. The pseudocode for str_to_phone_type looks like the following:

def str_to_phone_type(s: str) Type:
  match s:
    case &quot...