Go to file
Nipunn Koorapati 937b56f57b
Match service argument names to abstract interface (#9418)
The base class/documentation suggest that the argument
names are `self` and `done`, while the runtime used
argument names `srvc` and `callback`.

`mypy.stubtest` was able to identify this - as it compares
the types (autogenerated by
[`mypy-protobuf`](https://github.com/dropbox/mypy-protobuf/))
to the actual code generated by protoc at runtime.

Since the stubs assume the generated code matches the abstract
interface in service.py - it saw these differences.
2022-02-03 09:14:44 -08:00
.github simplify mergeable UI messages (#9445) 2022-01-27 13:07:30 -05:00
benchmarks Must build project before running benchmarks (#9454) 2022-01-28 21:50:35 +00:00
cmake [cleanup] Msvc warnings (#9263) 2022-02-02 15:10:15 -08:00
conformance Update .NET SDKs to LTS versions 2021-11-10 08:49:53 +13:00
csharp Merge pull request #9430 from xoofx/fix-csharp-fielddesc-ispacked 2022-01-31 11:10:20 -08:00
docs Update protojure link (#9389) 2022-01-09 15:14:18 +00:00
editors Emacs: Protobuf mode should be derived from prog-mode (#9076) 2021-10-13 10:26:40 -07:00
examples examples: update Go example (#7217) 2021-10-21 13:27:40 -07:00
java Merge branch '3.19.x' into merge-3.19.x 2022-01-28 17:42:21 +00:00
js Merge branch '3.19.x' into merge-3.19.x 2022-01-28 17:42:21 +00:00
kokoro Merge pull request #9370 from brettmc/bugfix/php-8.1-deprecations 2022-02-02 14:17:43 -08:00
m4 Updated ax_pthread.m4 to its most recent upstream version 2020-11-20 16:36:56 -08:00
objectivec Fix comment syntax in any.proto (#8792) 2021-10-27 11:28:21 -07:00
php Merge pull request #9370 from brettmc/bugfix/php-8.1-deprecations 2022-02-02 14:17:43 -08:00
protoc-artifacts Merge branch '3.19.x' into merge-3.19.x 2022-01-28 17:42:21 +00:00
python Match service argument names to abstract interface (#9418) 2022-02-03 09:14:44 -08:00
ruby Merge branch '3.19.x' into merge-3.19.x 2022-01-28 17:42:21 +00:00
src [cleanup] Msvc warnings (#9263) 2022-02-02 15:10:15 -08:00
third_party Added utf8_range. 2022-01-21 21:01:07 -08:00
toolchain Update location of llvm-ar in bazel toolchain 2022-01-20 14:31:53 -08:00
util/python [bazel] Add fixes for --incompatible_load_{cc,java,proto}_rules_from_bzl (Part 2) 2019-07-29 14:14:04 -07:00
.bazelignore Add _build to .bazelignore 2021-08-13 23:35:37 +00:00
.gitignore same directory ignore 2021-08-26 17:28:49 +00:00
.gitmodules Include googletest as a submodule (#3993) 2018-03-26 13:54:32 -07:00
.readthedocs.yml python: publish sphinx docs to read the docs 2020-02-28 13:36:50 -06:00
BUILD [cleanup] Msvc warnings (#9263) 2022-02-02 15:10:15 -08:00
CHANGES.txt Merge branch '3.19.x' into merge-3.19.x 2022-01-28 17:42:21 +00:00
CONTRIBUTING.md document the kinds of patches the repo is open to (#8900) 2021-10-13 16:36:21 +00:00
CONTRIBUTORS.txt Match service argument names to abstract interface (#9418) 2022-02-03 09:14:44 -08:00
LICENSE Cleanup LICENSE file. 2018-03-26 15:03:41 -07:00
Makefile.am Add new files to makefile 2022-01-13 00:49:22 +00:00
Protobuf-C++.podspec Merge branch '3.19.x' into merge-3.19.x 2022-01-28 17:42:21 +00:00
Protobuf.podspec Merge branch '3.19.x' into merge-3.19.x 2022-01-28 17:42:21 +00:00
README.md Remove build badges, they were consistently out of date and not very useful. (#8634) 2021-05-20 10:06:36 -07:00
SECURITY.md grammar nit 2021-08-13 14:50:07 -04:00
WORKSPACE Addressing comments 2022-01-13 00:10:23 +00:00
appveyor.bat Update .NET SDKs to LTS versions 2021-11-10 08:49:53 +13:00
appveyor.yml Merge branch '3.6.x' into merge-3-6-x 2018-06-25 13:22:10 -07:00
autogen.sh Build updates (#5300) 2021-05-17 14:53:27 -07:00
build_files_updated_unittest.sh Fixed sort ordering and updated test to output context information. 2021-04-16 08:10:49 -07:00
cc_proto_blacklist_test.bzl [bazel] Fix blacklisted_protos in cc_toolchain and add test (#7075) 2020-01-15 10:27:35 -08:00
compiler_config_setting.bzl [bazel] Move Java runtime/toolchains into //java (#7190) 2020-02-13 13:04:14 -08:00
composer.json Update PHP descriptors (#3391) 2017-08-04 16:35:22 -07:00
configure.ac Update protobuf version for 3.19.4 (#9449) 2022-01-27 19:35:56 -08:00
fix_permissions.sh Set execute bit on files if and only if they begin with (#!). (#7347) 2020-04-01 15:28:25 -07:00
generate_changelog.py Replace repo links. 2018-08-22 11:55:30 -07:00
generate_descriptor_proto.sh Updated version to 3.12.3 and updated CHANGES.txt. (#7580) 2020-06-01 13:36:50 -07:00
global.json Update .NET SDKs to LTS versions 2021-11-10 08:49:53 +13:00
internal.bzl Bazel powered Java testing (#8506) 2021-04-20 11:36:32 -07:00
maven_install.json Adding kotlin bazel tests 2022-01-12 21:54:30 +00:00
post_process_dist.sh Removed javanano from post_process_dist.sh 2018-06-05 09:17:19 -07:00
protobuf-lite.pc.in Remove references to HAVE_PTHREAD (#9100) 2021-10-15 13:10:38 -07:00
protobuf.bzl Selectively add source or gen dir to includes. (#9438) 2022-01-28 16:44:42 -08:00
protobuf.pc.in Remove references to HAVE_PTHREAD (#9100) 2021-10-15 13:10:38 -07:00
protobuf_deps.bzl Addressing comments 2022-01-13 00:10:23 +00:00
protobuf_release.bzl No error throwing for unknown OS 2021-11-29 23:54:09 +00:00
protobuf_version.bzl Update protobuf version for 3.19.4 (#9449) 2022-01-27 19:35:56 -08:00
tests.sh php8.1 testing 2022-01-27 15:45:20 +11:00
update_compatibility_version.py Merge 3.11.0-rc1 changes to master (#6917) 2019-11-20 18:03:29 -08:00
update_file_lists.sh Tweak update_file_lists.sh to handle changes to Makefile.am. (#8965) 2021-09-10 19:32:15 -07:00
update_version.py Use matching soname when building with CMake as Makefile (#9178) 2022-02-01 15:27:56 -08:00

README.md

Protocol Buffers - Google's data interchange format

Copyright 2008 Google Inc.

https://developers.google.com/protocol-buffers/

Overview

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can find protobuf's documentation on the Google Developers site.

This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.

Protocol Compiler Installation

The protocol compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.

For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our release page:

https://github.com/protocolbuffers/protobuf/releases

In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.

If you are looking for an old version that is not available in the release page, check out the maven repo here:

https://repo1.maven.org/maven2/com/google/protobuf/protoc/

These pre-built binaries are only provided for released versions. If you want to use the github master version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.

If you would like to build protoc binary from source, see the C++ Installation Instructions.

Protobuf Runtime Installation

Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:

Language Source
C++ (include C++ runtime and protoc) src
Java java
Python python
Objective-C objectivec
C# csharp
JavaScript js
Ruby ruby
Go protocolbuffers/protobuf-go
PHP php
Dart dart-lang/protobuf

Quick Start

The best way to learn how to use protobuf is to follow the tutorials in our developer guide:

https://developers.google.com/protocol-buffers/docs/tutorials

If you want to learn from code examples, take a look at the examples in the examples directory.

Documentation

The complete documentation for Protocol Buffers is available via the web at:

https://developers.google.com/protocol-buffers/