Add cftime support for non-standard calendars (#344)

* add cftime formatter

* add unittest

* add converter and register units

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* add cftime dep

* add more unittests

* fix some tests

* rm debug

* add more points

* revert regex

* fix resolution

* add more tests and redo resolution computation

* fix f strings

* add more tests for coverage

* Update ultraplot/ticker.py

Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>

* rename classes

* rename classes

* Update ultraplot/ticker.py

Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>

* Update ultraplot/ticker.py

Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>

* safe casting for non-greg calendars

* check that resolution is correct

* check resolution in test_auto_datetime_locator_tick_values

* setters to rc

* add validators

* replace real_world_calendar with internal cftime variable

* use calendar attr lookup

* mv max_display_ticks to rc and spelling

* update defaults

* update defaults

* rename standard_unit time_unit

* fix typo

* remove debug

* remove try block in test

* get calendars from private var

* rm type info from default data range

* simplify type registry

* Replace datetime specific objects with general datetime

* More replacements

* Update ultraplot/tests/test_tickers.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update ultraplot/ticker.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* rm resolution format in ticker

* make standard a bit less extreme

* make standard a bit less extreme

* rm dead comment

* more tests

* refactor tests

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>

Author: 3 people

environment.yml

@@ -28,5 +28,6 @@ dependencies:
   - sphinx-design
   - networkx
   - pyarrow
+  - cftime
   - pip:
       - git+https://github.com/ultraplot/UltraTheme.git

ultraplot/internals/rcsetup.py

@@ -264,6 +264,37 @@ def _validate_belongs(value):  # noqa: E306
     return _validate_belongs
 
 
+_CFTIME_RESOLUTIONS = (
+    "SECONDLY",
+    "MINUTELY",
+    "HOURLY",
+    "DAILY",
+    "MONTHLY",
+    "YEARLY",
+)
+
+
+def _validate_cftime_resolution_format(units: dict) -> dict:
+    if not isinstance(units, dict):
+        raise ValueError("Cftime units expects a dict")
+
+    for resolution, format_ in units.items():
+        unit = _validate_cftime_resolution(resolution)
+
+    # Delegate format parsing to cftime
+    _rc_ultraplot_default["cftime.time_resolution_format"].update(units)
+    return _rc_ultraplot_default["cftime.time_resolution_format"]
+
+
+def _validate_cftime_resolution(unit: str) -> str:
+    if not isinstance(unit, str):
+        raise TypeError("Time unit cftime is expecting str")
+    if unit in _CFTIME_RESOLUTIONS:
+        return unit
+    msg = f"Unit not understood. Got {unit} expected one of: {_CFTIME_RESOLUTIONS}"
+    raise ValueError(msg)
+
+
 def _validate_cmap(subtype):
     """
     Validate the colormap or cycle. Possibly skip name registration check
@@ -997,6 +1028,33 @@ def copy(self):
         _validate_fontweight,
         "Font weight for column labels on the bottom of the figure.",
     ),
+    "cftime.time_unit": (
+        "days since 2000-01-01",
+        _validate_string,
+        "Time unit for non-Gregorian calendars.",
+    ),
+    "cftime.resolution": (
+        "DAILY",
+        _validate_cftime_resolution,
+        "Default time resolution for non-Gregorian calendars.",
+    ),
+    "cftime.time_resolution_format": (
+        {
+            "SECONDLY": "%S",
+            "MINUTELY": "%M",
+            "HOURLY": "%H",
+            "DAILY": "%d",
+            "MONTHLY": "%m",
+            "YEARLY": "%Y",
+        },
+        _validate_cftime_resolution_format,
+        "Dict used for formatting non-Gregorian calendars.",
+    ),
+    "cftime.max_display_ticks": (
+        7,
+        _validate_int,
+        "Number of ticks to display for cftime units.",
+    ),
     # Coastlines
     "coast": (False, _validate_bool, "Toggles coastline lines on and off."),
     "coast.alpha": (