mirror of
https://github.com/google/flatbuffers.git
synced 2026-06-02 04:04:19 +00:00
c526cb640b
This commit significantly improves the developer experience for the Python Object-Based API by overhauling the generated `__init__` method for `T`-suffixed classes.
Previously, `T` objects had to be instantiated with an empty constructor, and their fields had to be populated manually one by one. This was verbose and not idiomatic Python.
This change modifies the Python code generator (`GenInitialize`) to produce `__init__` methods that are:
1. **Keyword-Argument-Friendly**: The constructor now accepts all table/struct fields as keyword arguments, allowing for concise, single-line object creation.
2. **Fully Typed**: The signature of the `__init__` method is now annotated with Python type hints. This provides immediate benefits for static analysis tools (like Mypy) and IDEs, enabling better autocompletion and type checking.
3. **Correctly Optional**: The generator now correctly wraps types in `Optional[...]` if their default value is `None`. This applies to strings, vectors, and other nullable fields, ensuring strict type safety.
The new approach remains **fully backward-compatible**, as all arguments have default values. Existing code that uses the empty constructor will continue to work without modification.
#### Example of a Generated `__init__`
**Before:**
```python
class KeyValueT(object):
def __init__(self):
self.key = None # type: str
self.value = None # type: str
```
**After:**
```python
class KeyValueT(object):
def __init__(self, key: Optional[str] = None, value: Optional[str] = None):
self.key = key
self.value = value
```
#### Example of User Code
**Before:**
```python
# Old, verbose way
kv = KeyValueT()
kv.key = "instrument"
kv.value = "EUR/USD"
```
**After:**
```python
# New, Pythonic way
kv = KeyValueT(key="instrument", value="EUR/USD")
```
59 lines
2.1 KiB
Python
59 lines
2.1 KiB
Python
from __future__ import annotations
|
|
|
|
import flatbuffers
|
|
import numpy as np
|
|
|
|
import typing
|
|
from MyGame.Example.NestedUnion.Color import Color
|
|
from MyGame.Example.NestedUnion.Test import Test, TestT
|
|
|
|
uoffset: typing.TypeAlias = flatbuffers.number_types.UOffsetTFlags.py_type
|
|
|
|
class Vec3(object):
|
|
@classmethod
|
|
def GetRootAs(cls, buf: bytes, offset: int) -> Vec3: ...
|
|
@classmethod
|
|
def GetRootAsVec3(cls, buf: bytes, offset: int) -> Vec3: ...
|
|
def Init(self, buf: bytes, pos: int) -> None: ...
|
|
def X(self) -> float: ...
|
|
def Y(self) -> float: ...
|
|
def Z(self) -> float: ...
|
|
def Test1(self) -> float: ...
|
|
def Test2(self) -> typing.Literal[Color.Red, Color.Green, Color.Blue]: ...
|
|
def Test3(self) -> Test | None: ...
|
|
class Vec3T(object):
|
|
x: float
|
|
y: float
|
|
z: float
|
|
test1: float
|
|
test2: typing.Literal[Color.Red, Color.Green, Color.Blue]
|
|
test3: TestT | None
|
|
def __init__(
|
|
self,
|
|
x: float = ...,
|
|
y: float = ...,
|
|
z: float = ...,
|
|
test1: float = ...,
|
|
test2: typing.Literal[Color.Red, Color.Green, Color.Blue] = ...,
|
|
test3: 'TestT' | None = ...,
|
|
) -> None: ...
|
|
@classmethod
|
|
def InitFromBuf(cls, buf: bytes, pos: int) -> Vec3T: ...
|
|
@classmethod
|
|
def InitFromPackedBuf(cls, buf: bytes, pos: int = 0) -> Vec3T: ...
|
|
@classmethod
|
|
def InitFromObj(cls, vec3: Vec3) -> Vec3T: ...
|
|
def _UnPack(self, vec3: Vec3) -> None: ...
|
|
def Pack(self, builder: flatbuffers.Builder) -> None: ...
|
|
def Vec3Start(builder: flatbuffers.Builder) -> None: ...
|
|
def Start(builder: flatbuffers.Builder) -> None: ...
|
|
def Vec3AddX(builder: flatbuffers.Builder, x: float) -> None: ...
|
|
def Vec3AddY(builder: flatbuffers.Builder, y: float) -> None: ...
|
|
def Vec3AddZ(builder: flatbuffers.Builder, z: float) -> None: ...
|
|
def Vec3AddTest1(builder: flatbuffers.Builder, test1: float) -> None: ...
|
|
def Vec3AddTest2(builder: flatbuffers.Builder, test2: typing.Literal[Color.Red, Color.Green, Color.Blue]) -> None: ...
|
|
def Vec3AddTest3(builder: flatbuffers.Builder, test3: uoffset) -> None: ...
|
|
def Vec3End(builder: flatbuffers.Builder) -> uoffset: ...
|
|
def End(builder: flatbuffers.Builder) -> uoffset: ...
|
|
|