Add dim_order to BaseFormatter

Move the proposed `dim_sort` functionality from being a system registry property to being a formatter property, specifically `BaseFormatter`.

Also fix typos noticed in `pint/testsuite/conftest.py`.

Signed-off-by: Michael Tiemann <[email protected]>

CHANGES

@@ -4,9 +4,9 @@ Pint Changelog
 0.24 (unreleased)
 -----------------
 
+- Add `dim_order` property to BaseFormatter.
 - Add `dim_sort` parameter to formatter.
   (PR #1864, fixes Issue #1841)
-- Nothing changed yet.
 
 
 0.23 (2023-12-08)

pint/default_en.txt

@@ -56,8 +56,6 @@
 @defaults
     group = international
     system = mks
-    # This default order for sorting dimensions was described in the proposed ISO 80000 specification.
-    dim_order = [ "[substance]", "[mass]", "[current]", "[luminosity]", "[length]", "[]", "[time]", "[temperature]", ]
 @end
 
 

pint/delegates/formatter/__init__.py

@@ -7,11 +7,10 @@
 """
 
 
-from .base_formatter import BabelFormatter
-from .iso80000_formatter import ISO80000Formatter
+from .base_formatter import BaseFormatter, BabelFormatter
 
 
-class Formatter(ISO80000Formatter, BabelFormatter):
+class Formatter(BabelFormatter, BaseFormatter):
     # TODO: this should derive from all relevant formaters to
     # reproduce the current behavior of Pint.
     pass

pint/delegates/formatter/base_formatter.py

@@ -34,6 +34,9 @@
 
 
 class BaseFormatter:
+    # This default order for sorting dimensions was described in the proposed ISO 80000 specification.
+    dim_order = ( "[substance]", "[mass]", "[current]", "[luminosity]", "[length]", "[]", "[time]", "[temperature]", )
+
     def format_quantity(
         self, quantity: PlainQuantity[MagnitudeT], spec: str = ""
     ) -> str:

pint/facets/plain/definitions.py

@@ -14,7 +14,7 @@
 import ast
 from dataclasses import dataclass
 from functools import cached_property
-from typing import Any, List, Optional
+from typing import Any, Optional
 
 from ..._typing import Magnitude
 from ... import errors
@@ -61,15 +61,12 @@ class DefaultsDefinition:
 
     group: ty.Optional[str]
     system: ty.Optional[str]
-    dim_order: ty.Optional[List[str]]
 
     def items(self):
         if self.group is not None:
             yield "group", self.group
         if self.system is not None:
             yield "system", self.system
-        if self.dim_order is not None:
-            yield "dim_order", ast.literal_eval(self.dim_order)
 
 
 @dataclass(frozen=True)

pint/formatting.py

@@ -307,7 +307,7 @@ def format_compact(unit: UnitsContainer, registry: UnitRegistry, **options) -> s
 
 
 def dim_sort(items: Iterable[Tuple[str, Number]], registry: UnitRegistry):
-    """Sort a list of units by dimensional order (from `registry._defaults['dim_order']`).
+    """Sort a list of units by dimensional order (from `registry.formatter.dim_order`).
 
     Parameters
     ----------
@@ -329,7 +329,7 @@ def dim_sort(items: Iterable[Tuple[str, Number]], registry: UnitRegistry):
     if registry is None or len(items) <= 1:
         return items
     ret_dict = dict()
-    dim_order = registry._defaults["dim_order"]
+    dim_order = registry.formatter.dim_order
     for unit_name, unit_exponent in items:
         cname = registry.get_name(unit_name)
         if not cname:

pint/testsuite/conftest.py

@@ -70,19 +70,19 @@ def func_registry():
 
 @pytest.fixture(scope="class")
 def class_registry():
-    """Only use for those test that do not modify the registry."""
+    """Only use for those tests that do not modify the registry."""
     return pint.UnitRegistry()
 
 
 @pytest.fixture(scope="module")
 def module_registry():
-    """Only use for those test that do not modify the registry."""
+    """Only use for those tests that do not modify the registry."""
     return pint.UnitRegistry()
 
 
 @pytest.fixture(scope="session")
 def sess_registry():
-    """Only use for those test that do not modify the registry."""
+    """Only use for those tests that do not modify the registry."""
     return pint.UnitRegistry()