matplotlib-map-utils 2.0.0__tar.gz → 2.0.1__tar.gz

{matplotlib_map_utils-2.0.0 → matplotlib_map_utils-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: matplotlib-map-utils
-Version: 2.0.0
+Version: 2.0.1
 Summary: A suite of tools for creating maps in matplotlib
 Author-email: David Moss <davidmoss1221@gmail.com>
 Project-URL: Homepage, https://github.com/moss-xyz/matplotlib-map-utils/
@@ -242,6 +242,10 @@ Two more projects assisted with the creation of this script:
 
 * [`Cartopy`](https://github.com/SciTools/cartopy/issues/2361) fixed an issue inherent to calling `.copy()` on `CRS` objects.
 
+#### Releases
+
+- `v2.0.1`: Fixed a bug in the `dual_bars()` function that prevented empty dictionaries to be passed. Also added a warning when auto-calculated bar widths appear to be exceeding the dimension of the axis (usually occurs when the axis is <2 kilometeres or miles long, depending on the units selected).
+
 #### Future Roadmap
 
 With the release of `v2.x`, and the addition of **Scale Bar** tools, this project has achieved the two main objectives that I set out to.

{matplotlib_map_utils-2.0.0 → matplotlib_map_utils-2.0.1}/README.md

@@ -225,6 +225,10 @@ Two more projects assisted with the creation of this script:
 
 * [`Cartopy`](https://github.com/SciTools/cartopy/issues/2361) fixed an issue inherent to calling `.copy()` on `CRS` objects.
 
+#### Releases
+
+- `v2.0.1`: Fixed a bug in the `dual_bars()` function that prevented empty dictionaries to be passed. Also added a warning when auto-calculated bar widths appear to be exceeding the dimension of the axis (usually occurs when the axis is <2 kilometeres or miles long, depending on the units selected).
+
 #### Future Roadmap
 
 With the release of `v2.x`, and the addition of **Scale Bar** tools, this project has achieved the two main objectives that I set out to.

{matplotlib_map_utils-2.0.0 → matplotlib_map_utils-2.0.1}/matplotlib_map_utils/core/scale_bar.py

@@ -511,42 +511,57 @@ def dual_bars(ax, draw=True, style: Literal["ticks","boxes"]="boxes",
                   return_aob: bool=True
                   ):
     
+    _style = sbf._validate(sbt._VALIDATE_PRIMARY, "style", style)
+    _location = sbf._validate(sbt._VALIDATE_PRIMARY, "location", location)
+
+    ##### CONCATENATION #####
+    # NOTE: Probably a better way to do this, will investigate
+    # Validation is done within each call of the scale_bar function, so don't need to do as much here
+    if _style == "boxes":
+        _bar = (_del_keys(_DEFAULT_BAR, ["rotation", "unit", "max", "length", "major_div", "minor_div",
+                                         "minor_frac","tick_loc","basecolors","tickcolors","tickwidth"]) | bar)
+    else:
+        _bar = (_del_keys(_DEFAULT_BAR, ["rotation", "unit", "max", "length", "major_div", "minor_div",
+                                         "facecolors","edgecolors","edgewidth"]) | bar)
+    _units = _DEFAULT_UNITS | units if units is not None else _DEFAULT_UNITS
+    _labels = _DEFAULT_LABELS | labels if labels is not None else _DEFAULT_LABELS
+    _text = _DEFAULT_TEXT | text if text is not None else _DEFAULT_TEXT
+    _aob = _DEFAULT_AOB | aob if aob is not None else _DEFAULT_AOB
+    
     ##### VALIDATION #####
-    if type(units_dual) not in [list, tuple] or len(units_dual) != 2:
+    if not isinstance(units_dual, (list, tuple)) or len(units_dual) != 2:
         raise ValueError("units_dual must be a list or tuple of length 2")
-    if type(bar_maxes) not in [list, tuple] or len(bar_maxes) != 2:
+    if not isinstance(bar_maxes, (list, tuple)) or len(bar_maxes) != 2:
         raise ValueError("bar_maxes must be a list or tuple of length 2")
-    if type(bar_lengths) not in [list, tuple] or len(bar_lengths) != 2:
+    if not isinstance(bar_lengths, (list, tuple)) or len(bar_lengths) != 2:
         raise ValueError("bar_lengths must be a list or tuple of length 2")
-    if type(major_divs) not in [list, tuple] or len(major_divs) != 2:
+    if not isinstance(major_divs, (list, tuple)) or len(major_divs) != 2:
         raise ValueError("major_divs must be a list or tuple of length 2")
-    if type(minor_divs) not in [list, tuple] or len(minor_divs) != 2:
+    if not isinstance(minor_divs, (list, tuple)) or len(minor_divs) != 2:
         raise ValueError("minor_divs must be a list or tuple of length 2")
 
-    if units.get("loc", None) == "opposite":
+    if _units.get("loc", None) == "opposite":
         raise ValueError("units['loc'] for units cannot be opposite for dual_bars, as it will not align correctly with the second scale bar")
 
-    if bar.get("rotation", None) is not None and bar.get("rotation", 0) != 0:
-        warnings.warn("bar['rotation'] is not fully support. It is recommended instead that you set rotation to zero and return the image by setting draw=False and return_aob=False, to return the OffsetImage of the dual scale bars instead.")
-    if bar.get("unit", None) is not None:
+    if _bar.get("rotation", None) is not None and bar.get("rotation", 0) != 0:
+        warnings.warn("bar['rotation'] is not fully supported. It is recommended instead that you set rotation to zero and return the image by setting draw=False and return_aob=False, to return the OffsetImage of the dual scale bars instead.")
+    if _bar.get("unit", None) is not None:
         warnings.warn("bar['unit'] is ignored for dual_bars, as it is set by units_dual")
-        _ = bar.pop("unit")
-    if bar.get("max", None) is not None:
+        _ = _bar.pop("unit")
+    if _bar.get("max", None) is not None:
         warnings.warn("bar['max'] is ignored for dual_bars, as it is (optionally) set by bar_maxes")
-        _ = bar.pop("max")
-    if bar.get("length", None) is not None:
+        _ = _bar.pop("max")
+    if _bar.get("length", None) is not None:
         warnings.warn("bar['length'] is ignored for dual_bars, as it is (optionally) set by bar_lengths")
-        _ = bar.pop("length")
-    if bar.get("major_div", None) is not None:
+        _ = _bar.pop("length")
+    if _bar.get("major_div", None) is not None:
         warnings.warn("bar['major_div'] is ignored for dual_bars, as it is (optionally) set by major_divs")
-        _ = bar.pop("major_div")
-    if bar.get("minor_div", None) is not None:
+        _ = _bar.pop("major_div")
+    if _bar.get("minor_div", None) is not None:
         warnings.warn("bar['minor_div'] is ignored for dual_bars, as it is (optionally) set by minor_divs")
-        _ = bar.pop("minor_div")
+        _ = _bar.pop("minor_div")
     
-    _style = sbf._validate(sbt._VALIDATE_PRIMARY, "style", style)
-    _location = sbf._validate(sbt._VALIDATE_PRIMARY, "location", location)
-    _aob = sbf._validate_dict(aob, _DEFAULT_AOB, sbt._VALIDATE_AOB, return_clean=True)
+    _aob = sbf._validate_dict(_aob, _DEFAULT_AOB, sbt._VALIDATE_AOB, return_clean=True)
     
     ##### CREATION #####
     # Setting up the order of some other settings (label location, tick location)
@@ -563,15 +578,16 @@ def dual_bars(ax, draw=True, style: Literal["ticks","boxes"]="boxes",
         # Creating a bar
         # Because draw is False and return_aob is false, an OffsetImage will be returned
         bars.append(scale_bar(ax, draw=False, style=_style, location=location, 
-                              bar=((bar | bar_settings) if bar is not None else bar_settings), 
-                              units=units, 
-                              labels=(labels | label_settings if labels is not None else label_settings), 
-                              text=text,
+                              bar=(_bar | bar_settings), 
+                              units=_units, 
+                              labels=(_labels | label_settings),
+                              text=_text,
+                              aob=None,
                               return_aob=False))
 
     ##### PACKING  #####
     # First need to know if we pack vertically or horizontally
-    bar_vertical = _calc_vert(bar["rotation"])
+    bar_vertical = _calc_vert(_bar["rotation"])
     packer = matplotlib.offsetbox.VPacker if bar_vertical == False else matplotlib.offsetbox.HPacker
     if bar["reverse"] == True:
         align = "right" if bar_vertical == False else "top"
@@ -586,7 +602,7 @@ def dual_bars(ax, draw=True, style: Literal["ticks","boxes"]="boxes",
     # Placing the packer in the AOB first off
     aob_pack = matplotlib.offsetbox.AnchoredOffsetbox(loc=_location, child=pack, **_del_keys(_aob, ["facecolor","edgecolor","alpha"]))
     # Finding if and how much we need to nudge either image
-    aob_pack = _align_dual(ax, aob_pack, bar_vertical, bar["reverse"])
+    aob_pack = _align_dual(ax, aob_pack, bar_vertical, _bar["reverse"])
     
     ##### FINAL RENDER #####
     # If desired, we can just return the final packer
@@ -733,7 +749,7 @@ def _config_bar(ax, bar):
             if bar["length"] < ax_dim:
                 bar_max = (bar["length"] / ax_dim) * ax_range
             else:
-                warnings.warn(f"Provided bar length ({bar["length"]}) is greater than the axis length ({ax_dim}); setting bar length to default (20% of axis length).")
+                warnings.warn(f"Provided bar length ({bar["length"]}) is greater than the axis length ({ax_dim}); setting bar length to default (25% of axis length).")
                 bar_max = 0.25 * ax_range
     # If bar["max"] is provided, don't need to go through all of this effort
     else:
@@ -791,6 +807,10 @@ def _config_bar(ax, bar):
             minor_div = 1
         else:
             minor_div = sbt.preferred_divs[bar_max_best][1]
+        
+        # Doing a quick check of the calculated value, to see if it is "too long"
+        if (bar_length / ax_dim > 0.9) or (bar_max > ax_range * 0.9):
+            warnings.warn(f"The auto-calculated dimensions of the bar are too large for the axis. This usually happens when the height or width of your map is ~1 to 2 miles or kilometres (depending on your selected unit). This will result in a bar close to or longer than your axis, extending beyond your frame. Consider either manually specifying a 'max' and 'major_div' value less than 2, or switching your units to feet/metres as necessary.")
 
     return bar_max, bar_length, units_label, major_div, minor_div
 

{matplotlib_map_utils-2.0.0 → matplotlib_map_utils-2.0.1}/matplotlib_map_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: matplotlib-map-utils
-Version: 2.0.0
+Version: 2.0.1
 Summary: A suite of tools for creating maps in matplotlib
 Author-email: David Moss <davidmoss1221@gmail.com>
 Project-URL: Homepage, https://github.com/moss-xyz/matplotlib-map-utils/
@@ -242,6 +242,10 @@ Two more projects assisted with the creation of this script:
 
 * [`Cartopy`](https://github.com/SciTools/cartopy/issues/2361) fixed an issue inherent to calling `.copy()` on `CRS` objects.
 
+#### Releases
+
+- `v2.0.1`: Fixed a bug in the `dual_bars()` function that prevented empty dictionaries to be passed. Also added a warning when auto-calculated bar widths appear to be exceeding the dimension of the axis (usually occurs when the axis is <2 kilometeres or miles long, depending on the units selected).
+
 #### Future Roadmap
 
 With the release of `v2.x`, and the addition of **Scale Bar** tools, this project has achieved the two main objectives that I set out to.

{matplotlib_map_utils-2.0.0 → matplotlib_map_utils-2.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "matplotlib-map-utils"
-version = "2.0.0"
+version = "2.0.1"
 authors = [
   { name="David Moss", email="davidmoss1221@gmail.com" },
 ]