matplotlib-map-utils 3.0.1__py3-none-any.whl → 3.1.1__py3-none-any.whl

matplotlib_map_utils/defaults/scale_bar.py

@@ -28,6 +28,7 @@ _BAR_XS = {
     "minor_div":None,
     "minor_frac":0.66,
     "minor_type":"none",
+    "major_mult":None,
     "facecolors":["black","white"],
     "edgecolors":"black",
     "edgewidth":0.5, # changed
@@ -99,6 +100,7 @@ _BAR_SM = {
     "minor_div":None,
     "minor_frac":0.66,
     "minor_type":"none",
+    "major_mult":None,
     "facecolors":["black","white"],
     "edgecolors":"black",
     "edgewidth":0.75, # changed
@@ -170,6 +172,7 @@ _BAR_MD = {
     "minor_div":None,
     "minor_frac":0.66,
     "minor_type":"first",
+    "major_mult":None,
     "facecolors":["black","white"],
     "edgecolors":"black",
     "edgewidth":1, # changed
@@ -241,6 +244,7 @@ _BAR_LG = {
     "minor_div":None,
     "minor_frac":0.66,
     "minor_type":"first",
+    "major_mult":None,
     "facecolors":["black","white"],
     "edgecolors":"black",
     "edgewidth":2, # changed
@@ -312,6 +316,7 @@ _BAR_XL = {
     "minor_div":None,
     "minor_frac":0.66,
     "minor_type":"first",
+    "major_mult":None,
     "facecolors":["black","white"],
     "edgecolors":"black",
     "edgewidth":4, # changed

matplotlib_map_utils/validation/functions.py

@@ -174,8 +174,8 @@ def _validate_or(prop, val, funcs, kwargs):
              # If we pass, we can stop here and return the value
             success = True 
             break
-        except:
-            pass
+        except Exception as e:
+            continue
     if success == False:
         # If we didn't return a value and exit the loop yet, then the passed value is incorrect, as we raise an error
         raise ValueError(f"{val} is not a valid value for {prop}, please check the documentation")
@@ -223,7 +223,7 @@ def _validate_dict(input_dict, default_dict, functions, to_validate=None, return
         # Pre-checking that no invalid keys are passed
         invalid = [key for key in values.keys() if key not in functions.keys() and key not in ["bbox_to_anchor", "bbox_transform"]]
         if len(invalid) > 0:
-            print(f"Warning: Invalid keys detected ({invalid}). These will be ignored.")
+            warnings.warn(f"Warning: Invalid keys detected ({invalid}). These will be ignored.")
         # First, trimming our values to only those we need to validate
         if to_validate == "input":
             values = {key: val for key, val in values.items() if (key in input_dict.keys() and key in functions.keys())} # have to check against both here
@@ -241,9 +241,6 @@ def _validate_dict(input_dict, default_dict, functions, to_validate=None, return
             # NOTE: This is messy but the only way to get the rotation value to the crs function
             if key=="crs":
                 _ = func(prop=key, val=val, rotation_dict=values, **fd["kwargs"])
-            # NOTE: This is messy but the only way to check the projection dict without keywords
-            elif key=="projection":
-                _ = func(prop=key, val=val)
             # Our custom functions always have this dictionary key in them, so we know what form they take
             elif "kwargs" in fd:
                 _ = func(prop=key, val=val, **fd["kwargs"])

matplotlib_map_utils/validation/inset_map.py

@@ -64,6 +64,7 @@ _VALIDATE_INSET = {
     "pad":{"func":vf._validate_or, "kwargs":{"funcs":[vf._validate_range, vf._validate_and], "kwargs":[{"min":0, "none_ok":True}, {"funcs":[vf._validate_tuple, vf._validate_iterable], "kwargs":[{"length":2, "types":[float, int]}, {"func":vf._validate_range, "kwargs":{"min":0}}]}]}}, # between 0 and inf, or a two-tuple of (x,y) size, each between 0 and inf
     "coords":{"func":vf._validate_tuple, "kwargs":{"length":2, "types":[float, int], "none_ok":True}}, # a two-tuple of coordinates where you want to place the inset map
     "to_plot":{"func":vf._validate_iterable, "kwargs":{"func":vf._validate_keys, "kwargs":{"keys":["data","kwargs"], "none_ok":True}}}, # a list of dictionaries, where each contains "data" and "kwargs" keys
+    "zorder":{"func":vf._validate_type, "kwargs":{"match":int}}, # any int
 }
 
 _VALIDATE_EXTENT = {
@@ -78,6 +79,7 @@ _VALIDATE_EXTENT = {
     "linecolor":{"func":matplotlib.rcsetup.validate_color}, # any color value for matplotlib
     "alpha":{"func":vf._validate_range, "kwargs":{"min":0}}, # any positive number
     "linewidth":{"func":vf._validate_range, "kwargs":{"min":0}}, # any positive number
+    "zorder":{"func":vf._validate_type, "kwargs":{"match":int}}, # any int
     "to_return":{"func":vf._validate_list, "kwargs":{"list":["shape", "patch", "fig", "ax"], "none_ok":True}}, # any value in this list
 }
 
@@ -85,4 +87,5 @@ _VALIDATE_DETAIL = {
     "to_return":{"func":vf._validate_list, "kwargs":{"list":["connectors", "lines"], "none_ok":True}}, # any value in this list
     "connector_color":{"func":matplotlib.rcsetup.validate_color}, # any color value for matplotlib
     "connector_width":{"func":vf._validate_range, "kwargs":{"min":0}}, # any positive number
+    "zorder":{"func":vf._validate_type, "kwargs":{"match":int}}, # any int
 }

matplotlib_map_utils/validation/north_arrow.py

@@ -96,6 +96,7 @@ class _TYPE_ROTATION(TypedDict, total=False):
 _VALIDATE_PRIMARY = {
     "location":{"func":vf._validate_list, "kwargs":{"list":["upper right", "upper left", "lower left", "lower right", "center left", "center right", "lower center", "upper center", "center"]}},
     "scale":{"func":vf._validate_range, "kwargs":{"min":0, "max":None, "none_ok":True}}, # between 0 and inf
+    "zorder":{"func":vf._validate_type, "kwargs":{"match":int}}, # any int
 }
 
 _VALIDATE_BASE = {

matplotlib_map_utils/validation/scale_bar.py

@@ -37,7 +37,7 @@ preferred_divs = {
     7:[2,1],
     8:[4,2],
     9:[3,3],
-    10:[5,2],
+    10:[2,1],
 }
 
 # For converting between units
@@ -89,6 +89,7 @@ class _TYPE_BAR(TypedDict, total=False):
     minor_div: int # the number of minor divisions on the bar
     minor_frac: float # the fraction of the major division that the minor division should be (e.g. 0.5 = half the size of the major division)
     minor_type: Literal["all","first","none"] # whether the minor divisions should be drawn on all major divisions or just the first one
+    major_mult: float | int # used in conjunction with major_div to define the length of the bar, if desired
     # Boxes only
     facecolors: list | tuple | str # a color or list of colors to use for the faces of the boxes
     edgecolors: list | tuple | str # a color or list of colors to use for the edges of the boxes
@@ -165,13 +166,14 @@ class _TYPE_AOB(TypedDict, total=False):
 _VALIDATE_PRIMARY = {
     "style":{"func":vf._validate_list, "kwargs":{"list":["ticks","boxes"]}},
     "location":{"func":vf._validate_list, "kwargs":{"list":["upper right", "upper left", "lower left", "lower right", "center left", "center right", "lower center", "upper center", "center"]}},
+    "zorder":{"func":vf._validate_type, "kwargs":{"match":int}}, # only check that it is an int
 }
 
 _VALID_BAR_TICK_LOC = get_args(_TYPE_BAR.__annotations__["tick_loc"])
 _VALID_BAR_MINOR_TYPE = get_args(_TYPE_BAR.__annotations__["minor_type"]) 
 
 _VALIDATE_BAR = {
-    "projection":{"func":vf._validate_projection, "kwargs":{"none_ok":False}}, # must be a valid CRS
+    "projection":{"func":vf._validate_or, "kwargs":{"funcs":[vf._validate_projection, vf._validate_list], "kwargs":[{"none_ok":False}, {"list":["px","pixel","pixels","pt","point","points","dx","custom","axis"], "none_ok":False}]}}, # between 0 and inf, or a two-tuple of (x,y) size, each between 0 and inf
     "unit":{"func":vf._validate_list, "kwargs":{"list":list(units_standard.keys()), "none_ok":True}}, # any of the listed unit values are accepted
     "rotation":{"func":vf._validate_range, "kwargs":{"min":-360, "max":360, "none_ok":True}}, # between -360 and 360 degrees
     "max":{"func":vf._validate_range, "kwargs":{"min":0, "max":None, "none_ok":True}}, # between 0 and inf
@@ -179,10 +181,11 @@ _VALIDATE_BAR = {
     "height":{"func":vf._validate_range, "kwargs":{"min":0, "max":None, "none_ok":True}}, # between 0 and inf
     "reverse":{"func":vf._validate_type, "kwargs":{"match":bool}}, # any bool
 
-    "major_div":{"func":vf._validate_range, "kwargs":{"min":1, "max":None, "none_ok":True}}, # between 0 and inf
+    "major_div":{"func":vf._validate_range, "kwargs":{"min":1, "max":None, "none_ok":True}}, # between 1 and inf
     "minor_div":{"func":vf._validate_range, "kwargs":{"min":0, "max":None, "none_ok":True}}, # between 0 and inf
     "minor_frac":{"func":vf._validate_range, "kwargs":{"min":0, "max":1, "none_ok":True}}, # ticks only: between 0 and 1
     "minor_type":{"func":vf._validate_list, "kwargs":{"list":_VALID_BAR_MINOR_TYPE, "none_ok":True}}, # any item in the list, or None (for no minor)
+    "major_mult":{"func":vf._validate_range, "kwargs":{"min":0, "max":None, "none_ok":True}}, # between 0 and inf
 
     "facecolors":{"func":vf._validate_iterable, "kwargs":{"func":matplotlib.rcsetup.validate_color}}, # boxes only: any color value for matplotlib
     "edgecolors":{"func":vf._validate_iterable, "kwargs":{"func":matplotlib.rcsetup.validate_color}}, # boxes only: any color value for matplotlib
@@ -202,7 +205,7 @@ _VALID_LABELS_FONTWEIGHT = get_args(_TYPE_LABELS.__annotations__["fontweight"])
 _VALID_LABELS_ROTATION_MODE = get_args(_TYPE_LABELS.__annotations__["rotation_mode"])
 
 _VALIDATE_LABELS = {
-    "labels":{"func":vf._validate_iterable, "kwargs":{"func":vf._validate_types,"kwargs":{"matches":[str,bool], "none_ok":True}}}, # any list of strings
+    "labels":{"func":vf._validate_iterable, "kwargs":{"func":vf._validate_types,"kwargs":{"matches":[str,bool,int,float], "none_ok":True}}}, # any list of strings
     "format":{"func":vf._validate_type, "kwargs":{"match":str}}, # only check that it is a string, not that it is a valid format string
     "format_int":{"func":vf._validate_type, "kwargs":{"match":bool}}, # any bool
     "style":{"func":vf._validate_list, "kwargs":{"list":_VALID_LABELS_STYLE}}, # any item in the list