forked from BigfootDev/flatbuffers
69a31b807a
Adding an API reference for the supported languages. General docs cleanup, including a new `tutorial` section that supports all of the supported languages. Added samples for each supported language to mirror the new tutorial page. Cleaned up all the links by making them `@ref` style links, instead of referencing the names of the generated `.html` files. Removed all generated files that were unnecessarily committed. Also fixed the C# tests (two were failing due to a missing file). Bug: b/25801305 Tested: Tested all samples on Ubuntu, Mac, and Android. Docs were generated using doxygen and viewed on Chrome. Change-Id: I2acaba6e332a15ae2deff5f26a4a25da7bd2c954
74 lines
2.8 KiB
Markdown
Executable File
74 lines
2.8 KiB
Markdown
Executable File
Use in Python {#flatbuffers_guide_use_python}
|
|
=============
|
|
|
|
## Before you get started
|
|
|
|
Before diving into the FlatBuffers usage in Python, it should be noted that the
|
|
[Tutorial](@ref flatbuffers_guide_tutorial) page has a complete guide to general
|
|
FlatBuffers usage in all of the supported languages (including Python). This
|
|
page is designed to cover the nuances of FlatBuffers usage, specific to
|
|
Python.
|
|
|
|
You should also have read the [Building](@ref flatbuffers_guide_building)
|
|
documentation to build `flatc` and should be familiar with
|
|
[Using the schema compiler](@ref flatbuffers_guide_using_schema_compiler) and
|
|
[Writing a schema](@ref flatbuffers_guide_writing_schema).
|
|
|
|
## FlatBuffers Python library code location
|
|
|
|
The code for the FlatBuffers Python library can be found at
|
|
`flatbuffers/python/flatbuffers`. You can browse the library code on the
|
|
[FlatBuffers GitHub page](https://github.com/google/flatbuffers/tree/master/
|
|
python).
|
|
|
|
## Testing the FlatBuffers Python library
|
|
|
|
The code to test the Python library can be found at `flatbuffers/tests`.
|
|
The test code itself is located in [py_test.py](https://github.com/google/
|
|
flatbuffers/blob/master/tests/py_test.py).
|
|
|
|
To run the tests, use the [PythonTest.sh](https://github.com/google/flatbuffers/
|
|
blob/master/tests/PythonTest.sh) shell script.
|
|
|
|
*Note: This script requires [python](https://www.python.org/) to be
|
|
installed.*
|
|
|
|
## Using the FlatBuffers Python library
|
|
|
|
*Note: See [Tutorial](@ref flatbuffers_guide_tutorial) for a more in-depth
|
|
example of how to use FlatBuffers in Python.*
|
|
|
|
There is support for both reading and writing FlatBuffers in Python.
|
|
|
|
To use FlatBuffers in your own code, first generate Python classes from your
|
|
schema with the `--python` option to `flatc`. Then you can include both
|
|
FlatBuffers and the generated code to read or write a FlatBuffer.
|
|
|
|
For example, here is how you would read a FlatBuffer binary file in Python:
|
|
First, import the library and the generated code. Then read a FlatBuffer binary
|
|
file into a `bytearray`, which you pass to the `GetRootAsMonster` function:
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.py}
|
|
import MyGame.Example as example
|
|
import flatbuffers
|
|
|
|
buf = open('monster.dat', 'rb').read()
|
|
buf = bytearray(buf)
|
|
monster = example.GetRootAsMonster(buf, 0)
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Now you can access values like this:
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.py}
|
|
hp = monster.Hp()
|
|
pos = monster.Pos()
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
## Text Parsing
|
|
|
|
There currently is no support for parsing text (Schema's and JSON) directly
|
|
from Python, though you could use the C++ parser through SWIG or ctypes. Please
|
|
see the C++ documentation for more on text parsing.
|
|
|
|
<br>
|