matplotlib-map-utils 4.0.0__py3-none-any.whl → 4.1.1__py3-none-any.whl

matplotlib_map_utils/__init__.py

@@ -4,18 +4,44 @@ from .core.scale_bar import ScaleBar, scale_bar, dual_bars
 from .core.inset_map import InsetMap, inset_map, ExtentIndicator, indicate_extent, DetailIndicator, indicate_detail, inset_usa
 from typing import Literal
 
+# TypedDicts describing the config dictionaries accepted by the objects/functions above.
+# These power editor intellisense (key + value autocomplete) and can be used by callers
+# to annotate their own config variables; runtime validation is still handled by pydantic.
+from .validation.scale_bar import (ScaleBarBarDict, ScaleBarLabelsDict, ScaleBarUnitsDict,
+                                    ScaleBarTextDict, ScaleBarAobDict)
+from .validation.north_arrow import (NorthArrowBaseDict, NorthArrowFancyDict, NorthArrowLabelDict,
+                                      NorthArrowShadowDict, NorthArrowPackDict, NorthArrowAobDict,
+                                      NorthArrowRotationDict)
+from .validation.inset_map import InsetMapPlotDict
+
 # This defines what wildcard imports should import
-__all__ = ["NorthArrow", "north_arrow", 
+__all__ = ["NorthArrow", "north_arrow",
            "ScaleBar", "scale_bar", "dual_bars",
            "InsetMap","inset_map", "ExtentIndicator","indicate_extent", "DetailIndicator","indicate_detail", "inset_usa",
-           "set_size"]
+           "set_size",
+           "ScaleBarBarDict", "ScaleBarLabelsDict", "ScaleBarUnitsDict", "ScaleBarTextDict", "ScaleBarAobDict",
+           "NorthArrowBaseDict", "NorthArrowFancyDict", "NorthArrowLabelDict", "NorthArrowShadowDict",
+           "NorthArrowPackDict", "NorthArrowAobDict", "NorthArrowRotationDict",
+           "InsetMapPlotDict"]
+
+from . import config
 
 def set_size(size: Literal["xs","xsmall","x-small",
                            "sm","small",
                            "md","medium",
                            "lg","large",
                            "xl","xlarge","x-large"]):
-
-    NorthArrow.set_size(size)
-    ScaleBar.set_size(size)
-    InsetMap.set_size(size)
+    
+    # standardize the size string
+    size_map = {
+        "xs": "xs", "xsmall": "xs", "x-small": "xs",
+        "sm": "sm", "small": "sm",
+        "md": "md", "medium": "md",
+        "lg": "lg", "large": "lg",
+        "xl": "xl", "xlarge": "xl", "x-large": "xl"
+    }
+    
+    if size.lower() not in size_map:
+        raise ValueError("Invalid value supplied, try one of ['xsmall', 'small', 'medium', 'large', 'xlarge']")
+        
+    config.DEFAULT_SIZE = size_map[size.lower()]

matplotlib_map_utils/config.py

@@ -0,0 +1,4 @@
+# Global configuration variables for matplotlib-map-utils
+
+# Default size used across all artists if no size is specified during initialization
+DEFAULT_SIZE = "md"