forked from BigfootDev/flatbuffers
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")
```
53 lines
2.3 KiB
Python
53 lines
2.3 KiB
Python
from __future__ import annotations
|
|
|
|
import flatbuffers
|
|
import numpy as np
|
|
|
|
import typing
|
|
from MyGame.Example.NestedUnion.Any import Any
|
|
from MyGame.Example.NestedUnion.TestSimpleTableWithEnum import TestSimpleTableWithEnumT
|
|
from MyGame.Example.NestedUnion.Vec3 import Vec3T
|
|
from flatbuffers import table
|
|
|
|
uoffset: typing.TypeAlias = flatbuffers.number_types.UOffsetTFlags.py_type
|
|
|
|
class NestedUnionTest(object):
|
|
@classmethod
|
|
def GetRootAs(cls, buf: bytes, offset: int) -> NestedUnionTest: ...
|
|
@classmethod
|
|
def GetRootAsNestedUnionTest(cls, buf: bytes, offset: int) -> NestedUnionTest: ...
|
|
def Init(self, buf: bytes, pos: int) -> None: ...
|
|
def Name(self) -> str | None: ...
|
|
def DataType(self) -> typing.Literal[Any.NONE, Any.Vec3, Any.TestSimpleTableWithEnum]: ...
|
|
def Data(self) -> table.Table | None: ...
|
|
def Id(self) -> int: ...
|
|
class NestedUnionTestT(object):
|
|
name: str | None
|
|
dataType: typing.Literal[Any.NONE, Any.Vec3, Any.TestSimpleTableWithEnum]
|
|
data: typing.Union[None, Vec3T, TestSimpleTableWithEnumT]
|
|
id: int
|
|
def __init__(
|
|
self,
|
|
name: str | None = ...,
|
|
dataType: typing.Literal[Any.NONE, Any.Vec3, Any.TestSimpleTableWithEnum] = ...,
|
|
data: typing.Union[None, Vec3T, TestSimpleTableWithEnumT] = ...,
|
|
id: int = ...,
|
|
) -> None: ...
|
|
@classmethod
|
|
def InitFromBuf(cls, buf: bytes, pos: int) -> NestedUnionTestT: ...
|
|
@classmethod
|
|
def InitFromPackedBuf(cls, buf: bytes, pos: int = 0) -> NestedUnionTestT: ...
|
|
@classmethod
|
|
def InitFromObj(cls, nestedUnionTest: NestedUnionTest) -> NestedUnionTestT: ...
|
|
def _UnPack(self, nestedUnionTest: NestedUnionTest) -> None: ...
|
|
def Pack(self, builder: flatbuffers.Builder) -> None: ...
|
|
def NestedUnionTestStart(builder: flatbuffers.Builder) -> None: ...
|
|
def Start(builder: flatbuffers.Builder) -> None: ...
|
|
def NestedUnionTestAddName(builder: flatbuffers.Builder, name: uoffset) -> None: ...
|
|
def NestedUnionTestAddDataType(builder: flatbuffers.Builder, dataType: typing.Literal[Any.NONE, Any.Vec3, Any.TestSimpleTableWithEnum]) -> None: ...
|
|
def NestedUnionTestAddData(builder: flatbuffers.Builder, data: uoffset) -> None: ...
|
|
def NestedUnionTestAddId(builder: flatbuffers.Builder, id: int) -> None: ...
|
|
def NestedUnionTestEnd(builder: flatbuffers.Builder) -> uoffset: ...
|
|
def End(builder: flatbuffers.Builder) -> uoffset: ...
|
|
|