rlbot-flatbuffers 0.18.0__tar.gz → 0.18.2__tar.gz

{rlbot_flatbuffers-0.18.0 → rlbot_flatbuffers-0.18.2}/Cargo.lock

@@ -815,7 +815,7 @@ checksum = "caf4aa5b0f434c91fe5c7f1ecb6a5ece2130b02ad2a590589dda5146df959001"
 
 [[package]]
 name = "rlbot_flatbuffers"
-version = "0.18.0"
+version = "0.18.2"
 dependencies = [
  "eyre",
  "indexmap",
@@ -858,15 +858,15 @@ checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
 
 [[package]]
 name = "semver"
-version = "1.0.26"
+version = "1.0.27"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "56e6fa9c48d24d85fb3de5ad847117517440f6beceb7798af16b4a87d616b8d0"
+checksum = "d767eb0aabc880b29956c35734170f26ed551a859dbd361d140cdbeca61ab1e2"
 
 [[package]]
 name = "serde"
-version = "1.0.221"
+version = "1.0.223"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "341877e04a22458705eb4e131a1508483c877dca2792b3781d4e5d8a6019ec43"
+checksum = "a505d71960adde88e293da5cb5eda57093379f64e61cf77bf0e6a63af07a7bac"
 dependencies = [
  "serde_core",
  "serde_derive",
@@ -874,18 +874,18 @@ dependencies = [
 
 [[package]]
 name = "serde_core"
-version = "1.0.221"
+version = "1.0.223"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0c459bc0a14c840cb403fc14b148620de1e0778c96ecd6e0c8c3cacb6d8d00fe"
+checksum = "20f57cbd357666aa7b3ac84a90b4ea328f1d4ddb6772b430caa5d9e1309bb9e9"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.221"
+version = "1.0.223"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d6185cf75117e20e62b1ff867b9518577271e58abe0037c40bb4794969355ab0"
+checksum = "3d428d07faf17e306e699ec1e91996e5a165ba5d6bce5b5155173e91a8a01a56"
 dependencies = [
  "proc-macro2",
  "quote",

{rlbot_flatbuffers-0.18.0 → rlbot_flatbuffers-0.18.2}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rlbot_flatbuffers"
-version = "0.18.0"
+version = "0.18.2"
 edition = "2024"
 description = "A Python module implemented in Rust for serializing and deserializing RLBot's flatbuffers"
 repository = "https://github.com/RLBot/flatbuffers-python"

rlbot_flatbuffers-0.18.2/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: rlbot_flatbuffers
+Version: 0.18.2
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+License-File: LICENSE
+Summary: A Python module implemented in Rust for serializing and deserializing RLBot's flatbuffers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Source Code, https://github.com/RLBot/flatbuffers-python
+
+## rlbot-flatbuffers
+
+A Python module implemented in Rust for fast and safe serialization and deserialization of RLBot's flatbuffers
+
+### The goal of this project
+
+A majority of the code is auto-generated by `codegen/` upon first compile
+using the RLBot's schema as defined by the `flatbuffers-schema` submodule.
+
+This includes the code generated by Planus (`src/planus_flat.rs`),
+the Python wrapper binds to the generated Rust code (`src/python/`),
+and the Python type hints (`rlbot_flatbuffers.pyi`).
+
+Usage of this API should not significantly differ from RLBot v4 to reduce developer confusion, while not holding back changes that would make the API easier to work with.
+
+### Minimum support Python version
+
+The crate used to generate Python binds (PyO3) supports all the way back to Python 3.7, however the minimum supported Python version is 3.10 for a few reasons:
+
+1. RLBot v4 currently runs Python 3.11
+1. The RLBot v5's [Python interface](https://github.com/RLBot/python-interface) has a minimum Python version of 3.11, but the difference between 3.10 and 3.11 doesn't mean much for these binds specifically.
+1. Python 3.10 is the version of Python that added `match`/`case`
+1. [Python 3.7 & 3.8 are EOL, with 3.9's EOL date being 2025-10](https://devguide.python.org/versions/)
+
+### Dev setup
+
+- Ensure Python 3.10+ is installed
+- Create a virtual Python environment
+    - `python3 -m venv venv`
+- Activate the virtual environment
+    - Windows: `venv\Scripts\activate.bat`
+    - Linux: `source venv/bin/activate`
+- Install maturin
+    - `pip install maturin`
+- Build & install for testing
+    - `maturin develop --release`
+
+To use in another Python environment, like if testing [python-interface](https://github.com/RLBot/python-interface), you can build the wheel:
+
+- `maturin build --release`
+- (In another environment) `pip install path/to/file.whl`
+
+The exact path of the wheel will be printed by maturin, just copy+paste it.
+
+### Basic usage
+
+All classes and methods should have types hints readable by your IDE, removing the guesswork of common operations.
+
+#### Creating
+
+```python
+import rlbot_flatbuffers as flat
+
+desired_ball = flat.DesiredBallState(
+    physics=flat.Physics(
+        location=flat.Vector3Partial(z=200),
+        velocity=flat.Vector3Partial(x=1500, y=1500),
+        angular_velocity=flat.Vector3Partial(),
+    ),
+)
+
+desired_game_info = flat.DesiredGameInfoState(
+    world_gravity_z=-100,
+    game_speed=2,
+)
+
+desired_game_state = flat.DesiredGameState(
+    ball_state=desired_ball,
+    game_info_state=desired_game_info,
+)
+```
+
+In the above code, we:
+
+- Set the ball to:
+    - Location (0, 0, 200)
+    - Velocity (1500, 1500, 0)
+    - Angular velocity of (0, 0, 0)
+- Don't set the car states
+- Set the game info state:
+    - World gravity to -100
+    - Game speed to 2x default
+    - Don't set end match or paused
+- Don't set any console commands
+
+All values are optional when creating a class and have the proper defaults.
+
+#### Reading values
+
+```python
+import rlbot_flatbuffers as flat
+
+def handle_packet(packet: flat.GamePacket):
+    if packet.match_info.match_phase not in {
+        flat.MatchPhase.Active,
+        flat.MatchPhase.Kickoff,
+    }:
+        # Return early if the game isn't active
+        return
+
+    # Print the ball's location
+    print(packet.ball.physics.location)
+
+    for car in packet.players:
+        # Print the every car's location
+        print(car.physics.location)
+```
+
+The goal of the above was to feel familiar to RLBot v4 while providing a more Pythonic interface.
+
+- Unions aren't custom types, rather a normal Python variable that can be 1 of a few types.
+    - For example, previously [`BallInfo.shape` had the separate type `CollisionShape` which contained the union's data](https://github.com/RLBot/RLBot/blob/e34dd4598bc643e2b8e50b77f7ffe4ca38e335de/src/main/python/rlbot/utils/structures/game_data_struct.pyi#L65-L95) but the type is now just `BoxShape | CylinderShape | SphereShape`
+
+- Classes implement `__match_args__` for easy destructuring via the `match`/`case` pattern.
+    - Enums can still be used to match against the type,
+      they just can't be destructured.
+- Classes and enums properly implement `__repr__`, with `__str__` being an alias.
+- Enums implement `__hash__`, `__int__` and `__eq__`.
+- Lists no longer have `num_x` fields accompanying them,
+  they are just Python lists of the appropriate length.
+- Classes implement `pack` and `unpack`,
+  which are used to serialize and deserialize data.
+    - These are public methods that can be used directly for any purpose,
+      for example saving `flat.GamePacket` to a file.
+
+- Auto-generated python type stub (`.pyi`) generation that includes doc comments from the Flatbuffers schema
+

{rlbot_flatbuffers-0.18.0 → rlbot_flatbuffers-0.18.2}/pyproject.toml

@@ -10,7 +10,7 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
-dynamic = ["version"]
+dynamic = ["version", "description", "urls", "readme"]
 
 [tool.maturin]
 features = ["pyo3/extension-module", "pyo3/abi3-py310"]

rlbot_flatbuffers-0.18.0/PKG-INFO

@@ -1,8 +0,0 @@
-Metadata-Version: 2.4
-Name: rlbot_flatbuffers
-Version: 0.18.0
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-License-File: LICENSE
-Requires-Python: >=3.10