Thanks to visit codestin.com
Credit goes to chromium.googlesource.com

Google Git
Sign in
chromium / external / github.com / google / protobuf / HEAD / . / python / README.md
blob: f0c9ce4f44d361d1c060e7bc5559086f8e1da6b3 [file] [log] [blame] [view]
temporal40ee5512008-07-10 02:12:20[diff] [blame]1Protocol Buffers - Google's data interchange format
jessecd04e9b2015-03-16 22:15:59[diff] [blame]2===================================================
3
temporal40ee5512008-07-10 02:12:20[diff] [blame]4Copyright 2008 Google Inc.
5
6This directory contains the Python Protocol Buffers runtime library.
7
temporalcc930432008-07-21 20:28:30[diff] [blame]8Normally, this directory comes as part of the protobuf package, available
9from:
10
Feng Xiaoe4288622014-10-01 23:26:23[diff] [blame]11 https://developers.google.com/protocol-buffers/
temporalcc930432008-07-21 20:28:30[diff] [blame]12
13The complete package includes the C++ source code, which includes the
14Protocol Compiler (protoc). If you downloaded this package from PyPI
15or some other Python-specific source, you may have received only the
16Python part of the code. In this case, you will need to obtain the
17Protocol Compiler from some other source before you can use this
18package.
19
temporal742e4092008-08-27 19:25:48[diff] [blame]20Development Warning
21===================
22
Peter Newmane2cc2de2020-08-10 18:08:25[diff] [blame]23The pure python performance is slow. For better performance please
Jie Luodec49392020-03-25 22:59:46[diff] [blame]24use python c++ implementation.
temporal742e4092008-08-27 19:25:48[diff] [blame]25
temporal40ee5512008-07-10 02:12:20[diff] [blame]26Installation
27============
28
Joshua Habermana33aa732021-09-09 20:20:34[diff] [blame]291) Make sure you have Python 3.5 or newer. If in doubt, run:
temporal40ee5512008-07-10 02:12:20[diff] [blame]30
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]31 $ python -V
temporal40ee5512008-07-10 02:12:20[diff] [blame]32
332) If you do not have setuptools installed, note that it will be
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]34 downloaded and installed automatically as soon as you run `setup.py`.
temporal40ee5512008-07-10 02:12:20[diff] [blame]35 If you would rather install it manually, you may do so by following
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]36 the instructions on [this page](https://packaging.python.org/en/latest/installing.html#setup-for-installing-packages).
temporal40ee5512008-07-10 02:12:20[diff] [blame]37
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]383) Build the C++ code, or install a binary distribution of `protoc`. If
temporal40ee5512008-07-10 02:12:20[diff] [blame]39 you install a binary distribution, make sure that it is the same
40 version as this package. If in doubt, run:
41
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]42 $ protoc --version
temporal40ee5512008-07-10 02:12:20[diff] [blame]43
[email protected]a36f1b42013-02-26 17:49:03[diff] [blame]444) Build and run the tests:
temporal40ee5512008-07-10 02:12:20[diff] [blame]45
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]46 $ python setup.py build
47 $ python setup.py test
[email protected]1eba9d92014-08-25 20:17:53[diff] [blame]48
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]49 To build, test, and use the C++ implementation, you must first compile
50 `libprotobuf.so`:
Tamir Dubersteind632bc72015-04-10 19:26:58[diff] [blame]51
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]52 $ (cd .. && make)
Tamir Dubersteind632bc72015-04-10 19:26:58[diff] [blame]53
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]54 On OS X:
Tamir Dubersteind632bc72015-04-10 19:26:58[diff] [blame]55
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]56 If you are running a Homebrew-provided Python, you must make sure another
57 version of protobuf is not already installed, as Homebrew's Python will
58 search `/usr/local/lib` for `libprotobuf.so` before it searches
59 `../src/.libs`.
Tamir Dubersteind632bc72015-04-10 19:26:58[diff] [blame]60
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]61 You can either unlink Homebrew's protobuf or install the `libprotobuf` you
62 built earlier:
Tamir Dubersteind632bc72015-04-10 19:26:58[diff] [blame]63
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]64 $ brew unlink protobuf
Tamir Dubersteind632bc72015-04-10 19:26:58[diff] [blame]65
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]66 or
Tamir Dubersteind632bc72015-04-10 19:26:58[diff] [blame]67
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]68 $ (cd .. && make install)
Tamir Dubersteind632bc72015-04-10 19:26:58[diff] [blame]69
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]70 On other *nix:
Josh Haberman2bd813b2015-04-09 23:41:58[diff] [blame]71
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]72 You must make `libprotobuf.so` dynamically available. You can either
73 install libprotobuf you built earlier, or set `LD_LIBRARY_PATH`:
74
75 $ export LD_LIBRARY_PATH=../src/.libs
76
77 or
78
79 $ (cd .. && make install)
80
81 To build the C++ implementation run:
82
83 $ python setup.py build --cpp_implementation
84
85 Then run the tests like so:
86
87 $ python setup.py test --cpp_implementation
temporal40ee5512008-07-10 02:12:20[diff] [blame]88
89 If some tests fail, this library may not work correctly on your
90 system. Continue at your own risk.
91
92 Please note that there is a known problem with some versions of
93 Python on Cygwin which causes the tests to fail after printing the
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]94 error: `sem_init: Resource temporarily unavailable`. This appears
95 to be a [bug either in Cygwin or in
96 Python](http://www.cygwin.com/ml/cygwin/2005-07/msg01378.html).
97
Ian Hunter130bb072016-11-16 17:34:28[diff] [blame]98 We do not know if or when it might be fixed. We also do not know
temporal40ee5512008-07-10 02:12:20[diff] [blame]99 how likely it is that this bug will affect users in practice.
100
1015) Install:
102
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]103 $ python setup.py install
jessecd04e9b2015-03-16 22:15:59[diff] [blame]104
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]105 or:
jessecd04e9b2015-03-16 22:15:59[diff] [blame]106
Misha Brukman67755702017-05-23 14:33:03[diff] [blame]107 $ (cd .. && make install)
108 $ python setup.py install --cpp_implementation
temporal40ee5512008-07-10 02:12:20[diff] [blame]109
110 This step may require superuser privileges.
Josh Haberman2bd813b2015-04-09 23:41:58[diff] [blame]111 NOTE: To use C++ implementation, you need to export an environment
112 variable before running your program. See the "C++ Implementation"
113 section below for more details.
temporal40ee5512008-07-10 02:12:20[diff] [blame]114
115Usage
116=====
117
118The complete documentation for Protocol Buffers is available via the
119web at:
120
Feng Xiaoe4288622014-10-01 23:26:23[diff] [blame]121 https://developers.google.com/protocol-buffers/
[email protected]9b7f6c52010-12-08 03:45:27[diff] [blame]122
123C++ Implementation
124==================
125
[email protected]9b7f6c52010-12-08 03:45:27[diff] [blame]126The C++ implementation for Python messages is built as a Python extension to
127improve the overall protobuf Python performance.
128
Manjunath Kudlurcf828de2016-03-25 17:58:46[diff] [blame]129To use the C++ implementation, you need to install the C++ protobuf runtime
130library, please see instructions in the parent directory.