ultraplot 0.99.3__py3-none-any.whl

ultraplot/__init__.py

@@ -0,0 +1,115 @@
+#!/usr/bin/env python3
+"""
+A succinct matplotlib wrapper for making beautiful, publication-quality graphics.
+"""
+# SCM versioning
+name = "ultraplot"
+
+try:
+    from importlib.metadata import version as get_version
+except ImportError:  # for Python < 3.8
+    from importlib_metadata import version as get_version
+try:
+    version = __version__ = get_version(name)
+except Exception:
+    version = __version__ = "unknown"
+
+# Import dependencies early to isolate import times
+from . import internals, externals, tests  # noqa: F401
+from .internals.benchmarks import _benchmark
+
+with _benchmark("pyplot"):
+    from matplotlib import pyplot  # noqa: F401
+with _benchmark("cartopy"):
+    try:
+        import cartopy  # noqa: F401
+    except ImportError:
+        pass
+with _benchmark("basemap"):
+    try:
+        from mpl_toolkits import basemap  # noqa: F401
+    except ImportError:
+        pass
+
+# Import everything to top level
+with _benchmark("config"):
+    from .config import *  # noqa: F401 F403
+with _benchmark("proj"):
+    from .proj import *  # noqa: F401 F403
+with _benchmark("utils"):
+    from .utils import *  # noqa: F401 F403
+with _benchmark("colors"):
+    from .colors import *  # noqa: F401 F403
+with _benchmark("ticker"):
+    from .ticker import *  # noqa: F401 F403
+with _benchmark("scale"):
+    from .scale import *  # noqa: F401 F403
+with _benchmark("axes"):
+    from .axes import *  # noqa: F401 F403
+with _benchmark("gridspec"):
+    from .gridspec import *  # noqa: F401 F403
+with _benchmark("figure"):
+    from .figure import *  # noqa: F401 F403
+with _benchmark("constructor"):
+    from .constructor import *  # noqa: F401 F403
+with _benchmark("ui"):
+    from .ui import *  # noqa: F401 F403
+with _benchmark("demos"):
+    from .demos import *  # noqa: F401 F403
+
+# Dynamically add registered classes to top-level namespace
+from . import proj as crs  # backwards compatibility  # noqa: F401
+from .constructor import NORMS, LOCATORS, FORMATTERS, SCALES, PROJS
+
+_globals = globals()
+for _src in (NORMS, LOCATORS, FORMATTERS, SCALES, PROJS):
+    for _key, _cls in _src.items():
+        if isinstance(_cls, type):  # i.e. not a scale preset
+            _globals[_cls.__name__] = _cls  # may overwrite ultraplot names
+# Register objects
+from .config import register_cmaps, register_cycles, register_colors, register_fonts
+
+with _benchmark("cmaps"):
+    register_cmaps(default=True)
+with _benchmark("cycles"):
+    register_cycles(default=True)
+with _benchmark("colors"):
+    register_colors(default=True)
+with _benchmark("fonts"):
+    register_fonts(default=True)
+
+# Validate colormap names and propagate 'cycle' to 'axes.prop_cycle'
+# NOTE: cmap.sequential also updates siblings 'cmap' and 'image.cmap'
+from .config import rc
+from .internals import rcsetup, warnings
+
+
+rcsetup.VALIDATE_REGISTERED_CMAPS = True
+for _key in (
+    "cycle",
+    "cmap.sequential",
+    "cmap.diverging",
+    "cmap.cyclic",
+    "cmap.qualitative",
+):  # noqa: E501
+    try:
+        rc[_key] = rc[_key]
+    except ValueError as err:
+        warnings._warn_ultraplot(f"Invalid user rc file setting: {err}")
+        rc[_key] = "Greys"  # fill value
+
+# Validate color names now that colors are registered
+# NOTE: This updates all settings with 'color' in name (harmless if it's not a color)
+from .config import rc_ultraplot, rc_matplotlib
+
+rcsetup.VALIDATE_REGISTERED_COLORS = True
+for _src in (rc_ultraplot, rc_matplotlib):
+    for _key in _src:  # loop through unsynced properties
+        if "color" not in _key:
+            continue
+        try:
+            _src[_key] = _src[_key]
+        except ValueError as err:
+            warnings._warn_ultraplot(f"Invalid user rc file setting: {err}")
+            _src[_key] = "black"  # fill value
+from .colors import _cmap_database as colormaps

ultraplot/__init__.py.rej

@@ -0,0 +1,58 @@
+diff a/ultraplot/__init__.py b/ultraplot/__init__.py	(rejected hunks)
+@@ -63,37 +63,46 @@ for _src in (NORMS, LOCATORS, FORMATTERS, SCALES, PROJS):
+
+ # Register objects
+ from .config import register_cmaps, register_cycles, register_colors, register_fonts
+-with _benchmark('cmaps'):
++
++with _benchmark("cmaps"):
+     register_cmaps(default=True)
+-with _benchmark('cycles'):
++with _benchmark("cycles"):
+     register_cycles(default=True)
+-with _benchmark('colors'):
++with _benchmark("colors"):
+     register_colors(default=True)
+-with _benchmark('fonts'):
++with _benchmark("fonts"):
+     register_fonts(default=True)
+
+ # Validate colormap names and propagate 'cycle' to 'axes.prop_cycle'
+ # NOTE: cmap.sequential also updates siblings 'cmap' and 'image.cmap'
+ from .config import rc
+ from .internals import rcsetup, warnings
++
+ rcsetup.VALIDATE_REGISTERED_CMAPS = True
+-for _key in ('cycle', 'cmap.sequential', 'cmap.diverging', 'cmap.cyclic', 'cmap.qualitative'):  # noqa: E501
++for _key in (
++    "cycle",
++    "cmap.sequential",
++    "cmap.diverging",
++    "cmap.cyclic",
++    "cmap.qualitative",
++):  # noqa: E501
+     try:
+         rc[_key] = rc[_key]
+     except ValueError as err:
+-        warnings._warn_ultraplot(f'Invalid user rc file setting: {err}')
+-        rc[_key] = 'Greys'  # fill value
++        warnings._warn_ultraplot(f"Invalid user rc file setting: {err}")
++        rc[_key] = "Greys"  # fill value
+
+ # Validate color names now that colors are registered
+ # NOTE: This updates all settings with 'color' in name (harmless if it's not a color)
+ from .config import rc_ultraplot, rc_matplotlib
++
+ rcsetup.VALIDATE_REGISTERED_COLORS = True
+ for _src in (rc_ultraplot, rc_matplotlib):
+     for _key in _src:  # loop through unsynced properties
+-        if 'color' not in _key:
++        if "color" not in _key:
+             continue
+         try:
+             _src[_key] = _src[_key]
+         except ValueError as err:
+-            warnings._warn_ultraplot(f'Invalid user rc file setting: {err}')
+-            _src[_key] = 'black'  # fill value
++            warnings._warn_ultraplot(f"Invalid user rc file setting: {err}")
++            _src[_key] = "black"  # fill value

ultraplot/axes/__init__.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+"""
+The various axes classes used throughout ultraplot.
+"""
+import matplotlib.projections as mproj
+
+from ..internals import context
+from .base import Axes  # noqa: F401
+from .cartesian import CartesianAxes
+from .geo import GeoAxes  # noqa: F401
+from .geo import _BasemapAxes, _CartopyAxes
+from .plot import PlotAxes  # noqa: F401
+from .polar import PolarAxes
+from .shared import _SharedAxes  # noqa: F401
+from .three import ThreeAxes  # noqa: F401
+
+# Prevent importing module names and set order of appearance for objects
+__all__ = [
+    "Axes",
+    "PlotAxes",
+    "CartesianAxes",
+    "PolarAxes",
+    "GeoAxes",
+    "ThreeAxes",
+]
+
+# Register projections with package prefix to avoid conflicts
+# NOTE: We integrate with cartopy and basemap rather than using matplotlib's
+# native projection system. Therefore axes names are not part of public API.
+_cls_dict = {}  # track valid names
+for _cls in (CartesianAxes, PolarAxes, _CartopyAxes, _BasemapAxes, ThreeAxes):
+    for _name in (_cls._name, *_cls._name_aliases):
+        with context._state_context(_cls, name="ultraplot_" + _name):
+            mproj.register_projection(_cls)
+            _cls_dict[_name] = _cls
+_cls_table = "\n".join(
+    " "
+    + key
+    + " " * (max(map(len, _cls_dict)) - len(key) + 7)
+    + ("GeoAxes" if cls.__name__[:1] == "_" else cls.__name__)
+    for key, cls in _cls_dict.items()
+)