Generate unpack_with

Author: VirxEC

Cargo.lock

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

Cargo.toml

@@ -248,7 +248,7 @@ impl Generator for EnumBindGenerator {
         &self.file_contents
     }
 
-    fn add_get_size_derive(&self, path: &Path) {
+    fn modify_source(&self, path: &Path) {
         let mut contents = fs::read_to_string(path).unwrap();
 
         #[cfg(windows)]

codegen/enums.rs

@@ -6,7 +6,7 @@ pub trait Generator {
     fn struct_name(&self) -> &str;
     fn file_contents(&self) -> &Vec<Cow<'static, str>>;
 
-    fn add_get_size_derive(&self, path: &Path);
+    fn modify_source(&self, path: &Path);
     fn generate_definition(&mut self);
     fn generate_from_flat_impls(&mut self);
     fn generate_to_flat_impls(&mut self);
@@ -23,7 +23,7 @@ pub trait Generator {
     }
 
     fn generate(&mut self, filepath: &Path) -> io::Result<()> {
-        self.add_get_size_derive(filepath);
+        self.modify_source(filepath);
         self.generate_definition();
         self.generate_from_flat_impls();
         self.generate_to_flat_impls();

codegen/generator.rs

@@ -27,8 +27,16 @@ pub enum PythonBindType {
 
 impl PythonBindType {
     pub const BASE_TYPES: [&'static str; 6] = ["bool", "i32", "u32", "f32", "String", "u8"];
-    pub const FROZEN_TYPES: [&'static str; 21] = [
+    pub const FROZEN_TYPES: [&'static str; 6] = [
         "GoalInfo",
+        "BoostPad",
+        "FieldInfo",
+        "ControllableInfo",
+        "ControllableTeamInfo",
+        "PlayerClass",
+    ];
+    pub const NO_SET_TYPES: [&'static str; 16] = [
+        "Physics",
         "GamePacket",
         "PlayerInfo",
         "ScoreInfo",
@@ -41,13 +49,8 @@ impl PythonBindType {
         "BoostPadState",
         "MatchInfo",
         "TeamInfo",
-        "Physics",
         "Vector2",
-        "ControllableInfo",
-        "ControllableTeamInfo",
-        "BoostPad",
         "PredictionSlice",
-        "FieldInfo",
         "BallPrediction",
     ];
     pub const UNIONS: [&'static str; 4] = [

codegen/main.rs

@@ -310,10 +310,26 @@ pub fn generator(type_data: &[PythonBindType]) -> io::Result<()> {
                     }
                 }
 
-                write_str!(file, "    def pack(self) -> bytes: ...");
+                write_str!(file, "    def pack(self) -> bytes:");
+                write_str!(file, "        \"\"\"");
+                write_str!(file, "        Serializes this instance into a byte array");
+                write_str!(file, "        \"\"\"");
+
+                if !gen.is_frozen {
+                    write_str!(file, "    def unpack_with(self, data: bytes):");
+                    write_str!(file, "        \"\"\"");
+                    write_str!(file, "        Deserializes the data into this instance\n");
+                    write_str!(
+                        file,
+                        "        :raises InvalidFlatbuffer: If the `data` is invalid for this type"
+                    );
+                    write_str!(file, "        \"\"\"");
+                }
+
                 write_str!(file, "    @staticmethod");
                 write_fmt!(file, "    def unpack(data: bytes) -> {type_name}:");
                 write_str!(file, "        \"\"\"");
+                write_str!(file, "        Deserializes the data into a new instance\n");
                 write_str!(
                     file,
                     "        :raises InvalidFlatbuffer: If the `data` is invalid for this type"