FM / source

/srv/osrm/osrm-backend/third_party/flatbuffers/docs/source/

/srv/osrm/osrm-backend/third_party/flatbuffers/docs/source

Name	Size	Mode	Actions
gRPC/	-	0755	rm
Benchmarks.md	4946	0644	edit dl rm
Building.md	4708	0644	edit dl rm
Compiler.md	8001	0644	edit dl rm
CONTRIBUTING.md	2242	0644	edit dl rm
CppUsage.md	27376	0644	edit dl rm
CUsage.md	8284	0644	edit dl rm
DartUsage.md	5153	0644	edit dl rm
doxyfile	102503	0644	edit dl rm
doxygen_layout.xml	8635	0644	edit dl rm
FlatBuffers.md	9219	0644	edit dl rm
FlexBuffers.md	7041	0644	edit dl rm
GoApi.md	1206	0644	edit dl rm
GoApi_generated.txt	4615	0644	edit dl rm
GoUsage.md	3782	0644	edit dl rm
Grammar.md	2267	0644	edit dl rm
groups	675	0644	edit dl rm
Internals.md	20064	0644	edit dl rm
JavaCsharpUsage.md	7055	0644	edit dl rm
JavaScriptUsage.md	4066	0644	edit dl rm
KotlinUsage.md	3774	0644	edit dl rm
LobsterUsage.md	3383	0644	edit dl rm
LuaUsage.md	3085	0644	edit dl rm
PHPUsage.md	3360	0644	edit dl rm
PythonUsage.md	3997	0644	edit dl rm
README_TO_GENERATE_DOCS.md	1078	0644	edit dl rm
RustUsage.md	7871	0644	edit dl rm
Schemas.md	27101	0644	edit dl rm
style.css	5507	0644	edit dl rm
Support.md	3425	0644	edit dl rm
Tutorial.md	104592	0644	edit dl rm
TypeScriptUsage.md	2431	0644	edit dl rm
WhitePaper.md	5744	0644	edit dl rm

Edit: /srv/osrm/osrm-backend/third_party/flatbuffers/docs/source/PythonUsage.md (3997B)

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()
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

## Support for Numpy arrays

The Flatbuffers python library also has support for accessing scalar
vectors as numpy arrays. This can be orders of magnitude faster than
iterating over the vector one element at a time, and is particularly
useful when unpacking large nested flatbuffers. The generated code for
a scalar vector will have a method `<vector name>AsNumpy()`. In the
case of the Monster example, you could access the inventory vector
like this:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.py}
    inventory = monster.InventoryAsNumpy()
    # inventory is a numpy array of type np.dtype('uint8')
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

instead of

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.py}
    inventory = []
    for i in range(monster.InventoryLength()):
        inventory.append(int(monster.Inventory(i)))
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Numpy is not a requirement. If numpy is not installed on your system,
then attempting to access one of the `*asNumpy()` methods will result
in a `NumpyRequiredForThisFeature` exception.

## 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>

cmd: