feat: allow None for mod settings (#13)

* refactor: slightly improved mods error * feat: allow mod settings to be None * fix: replace dict with Mapping for mods * refactor: improve mods error for Difficulty too
MaxOhn · Dec 5, 2024 · cc3ac76 · cc3ac76
1 parent f103a91
commit cc3ac76
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 54 deletions.
diff --git a/rosu_pp_py.pyi b/rosu_pp_py.pyi
@@ -1,13 +1,13 @@
 from enum import Enum
-from typing import List, Optional, Union
+from typing import List, Mapping, Optional, Union
 from collections.abc import Iterator
 
 GameMods = Union[int, str, GameMod, List[Union[GameMod, str, int]]]
-GameMod = dict[str, Union[str, GameModSettings]]
+GameMod = Mapping[str, Union[str, Optional[GameModSettings]]]
 """
 Must contain item `'acronym': str` and optionally `'settings': GameModSettings`
 """
-GameModSettings = dict[str, Union[bool, float, str]]
+GameModSettings = Mapping[str, Union[bool, float, str]]
 
 class GameMode(Enum):
     """

diff --git a/src/difficulty.rs b/src/difficulty.rs
@@ -48,19 +48,19 @@ impl PyDifficulty {
         for (key, value) in kwargs {
             extract_args! {
                 this.key = value {
-                    mods: GameMods,
-                    clock_rate: float,
-                    ar: float,
-                    ar_with_mods: bool,
-                    cs: float,
-                    cs_with_mods: bool,
-                    hp: float,
-                    hp_with_mods: bool,
-                    od: float,
-                    od_with_mods: bool,
-                    passed_objects: int,
-                    hardrock_offsets: bool,
-                    lazer: bool,
+                    mods: "type that matches GameMods alias",
+                    clock_rate: "float",
+                    ar: "float",
+                    ar_with_mods: "bool",
+                    cs: "float",
+                    cs_with_mods: "bool",
+                    hp: "float",
+                    hp_with_mods: "bool",
+                    od: "float",
+                    od_with_mods: "bool",
+                    passed_objects: "int",
+                    hardrock_offsets: "bool",
+                    lazer: "bool",
                 }
             }
         }

diff --git a/src/macros.rs b/src/macros.rs
@@ -79,7 +79,7 @@ macro_rules! define_class {
 
 macro_rules! extract_args {
     ( $this:ident . $key:ident = $value:ident {
-        $( $field:ident: $ty:ident, )+
+        $( $field:ident: $expected:literal, )+
     } ) => {
         match $key.extract()? {
             $(
@@ -90,7 +90,7 @@ macro_rules! extract_args {
                             "kwarg '",
                             stringify!($field),
                             "': must be ",
-                            stringify!($ty),
+                            $expected,
                         )))?
                 }
             ),*

diff --git a/src/mods.rs b/src/mods.rs
@@ -126,7 +126,11 @@ impl<'py> FromPyObject<'py> for PyGameMod<'py> {
 
         Ok(PyGameMod {
             acronym: extract_struct_field(&acronym, "PyGameMod", "acronym")?,
-            settings: settings.as_ref().map(PyAnyMethods::extract).transpose()?,
+            settings: settings
+                .as_ref()
+                .map(PyAnyMethods::extract::<Option<Bound<'_, PyDict>>>)
+                .transpose()?
+                .flatten(),
         })
     }
 }

diff --git a/src/performance.rs b/src/performance.rs
@@ -61,31 +61,31 @@ impl PyPerformance {
         for (key, value) in kwargs {
             extract_args! {
                 this.key = value {
-                    mods: GameMods,
-                    clock_rate: float,
-                    ar: float,
-                    ar_with_mods: bool,
-                    cs: float,
-                    cs_with_mods: bool,
-                    hp: float,
-                    hp_with_mods: bool,
-                    od: float,
-                    od_with_mods: bool,
-                    passed_objects: int,
-                    hardrock_offsets: bool,
-                    lazer: bool,
-                    accuracy: float,
-                    combo: int,
-                    large_tick_hits: int,
-                    small_tick_hits: int,
-                    slider_end_hits: int,
-                    n_geki: int,
-                    n_katu: int,
-                    n300: int,
-                    n100: int,
-                    n50: int,
-                    misses: int,
-                    hitresult_priority: HitResultPriority,
+                    mods: "type that matches GameMods alias",
+                    clock_rate: "float",
+                    ar: "float",
+                    ar_with_mods: "bool",
+                    cs: "float",
+                    cs_with_mods: "bool",
+                    hp: "float",
+                    hp_with_mods: "bool",
+                    od: "float",
+                    od_with_mods: "bool",
+                    passed_objects: "int",
+                    hardrock_offsets: "bool",
+                    lazer: "bool",
+                    accuracy: "float",
+                    combo: "int",
+                    large_tick_hits: "int",
+                    small_tick_hits: "int",
+                    slider_end_hits: "int",
+                    n_geki: "int",
+                    n_katu: "int",
+                    n300: "int",
+                    n100: "int",
+                    n50: "int",
+                    misses: "int",
+                    hitresult_priority: "HitResultPriority",
                 }
             }
         }

diff --git a/src/score_state.rs b/src/score_state.rs
@@ -49,16 +49,16 @@ impl PyScoreState {
         for (key, value) in kwargs {
             extract_args! {
                 this.key = value {
-                    max_combo: int,
-                    osu_large_tick_hits: int,
-                    osu_small_tick_hits: int,
-                    slider_end_hits: int,
-                    n_geki: int,
-                    n_katu: int,
-                    n300: int,
-                    n100: int,
-                    n50: int,
-                    misses: int,
+                    max_combo: "int",
+                    osu_large_tick_hits: "int",
+                    osu_small_tick_hits: "int",
+                    slider_end_hits: "int",
+                    n_geki: "int",
+                    n_katu: "int",
+                    n300: "int",
+                    n100: "int",
+                    n50: "int",
+                    misses: "int",
                 }
             }
         }