Merge branch 'hgrecco:master' into master

.github/workflows/bench.yml

@@ -17,10 +17,10 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: Install dependencies
-        run: pip install "numpy>=1.21,<2.0.0"
+        run: pip install "numpy>=1.23,<2.0.0"
 
       - name: Install bench dependencies
         run: pip install .[bench]

.github/workflows/ci.yml

@@ -7,18 +7,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.9, "3.10", "3.11"]
-        numpy: [null, "numpy>=1.21,<2.0.0"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        numpy: [null, "numpy>=1.23,<2.0.0", "numpy>=2.0.0rc1"]
         uncertainties: [null, "uncertainties==3.1.6", "uncertainties>=3.1.6,<4.0.0"]
         extras: [null]
         include:
-          - python-version: 3.9 # Minimal versions
-            numpy: "numpy"
-            extras: matplotlib==2.2.5
-          - python-version: 3.9
+          - python-version: "3.10" # Minimal versions
+            numpy: "numpy>=1.23,<2.0.0"
+            extras: matplotlib==3.5.3
+          - python-version: "3.10"
             numpy: "numpy"
             uncertainties: "uncertainties"
-            extras: "sparse xarray netCDF4 dask[complete]==2023.4.0 graphviz babel==2.8 mip>=1.13"
+            extras: "sparse xarray netCDF4 dask[complete]==2024.5.1 graphviz babel==2.8 mip>=1.13"
+          - python-version: "3.10"
+            numpy: "numpy==1.26.1"
+            uncertainties: null
+            extras: "babel==2.15 matplotlib==3.9.0"
     runs-on: ubuntu-latest
 
     env:
@@ -100,8 +104,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.9, "3.10", "3.11"]
-        numpy: [ "numpy>=1.21,<2.0.0" ]
+        python-version: ["3.10", "3.11", "3.12"]
+        numpy: [ "numpy>=1.23,<2.0.0" ]
     runs-on: windows-latest
 
     env:
@@ -161,8 +165,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.9, "3.10", "3.11"]
-        numpy: [null, "numpy>=1.21,<2.0.0" ]
+        python-version: ["3.10", "3.11", "3.12"]
+        numpy: [null, "numpy>=1.23,<2.0.0" ]
     runs-on: macos-latest
 
     env:

.github/workflows/docs.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up minimal Python version
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: "3.10"
 
       - name: Get pip cache dir
         id: pip-cache

.gitignore

@@ -14,6 +14,8 @@ MANIFEST
 .mypy_cache
 pip-wheel-metadata
 pint/testsuite/dask-worker-space
+venv
+.envrc
 
 # WebDAV file system cache files
 .DAV/

.pre-commit-config.yaml

@@ -1,23 +1,21 @@
 exclude: '^pint/_vendor'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
--   repo: https://github.com/psf/black
-    rev: 23.1.0
-    hooks:
-    - id: black
-    - id: black-jupyter
--   repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.240'
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.7
     hooks:
     - id: ruff
-      args: ["--fix"]
+      args: ["--fix", "--show-fixes"]
+      types_or: [ python, pyi, jupyter ]
+    - id: ruff-format
+      types_or: [ python, pyi, jupyter ]
 -   repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.16
+    rev: 0.7.17
     hooks:
     - id: mdformat
       additional_dependencies:

CHANGES

@@ -1,10 +1,49 @@
 Pint Changelog
 ==============
 
-0.24 (unreleased)
+0.25 (unreleased)
 -----------------
 
-- Nothing changed yet.
+- Nothing added yet.
+
+
+0.24.1 (2024-06-24)
+-----------------
+
+- Fix custom formatter needing the registry object. (PR #2011)
+- Support python 3.9 following difficulties installing with NumPy 2. (PR #2019)
+- Fix default formatting of dimensionless unit issue. (PR #2012)
+- Fix bug preventing custom formatters with modifiers working. (PR #2021)
+
+
+0.24 (2024-06-07)
+-----------------
+
+- Fix detection of invalid conversion between offset and delta units. (PR #1905)
+- Added dBW, decibel Watts, which is used in RF high power applications
+- NumPy 2.0 support
+  (PR #1985, #1971)
+- Implement numpy roll (Related to issue #981)
+- Implement numpy correlate
+  (PR #1990)
+- Add `dim_sort` function to _formatter_helpers.
+- Add `dim_order` and `default_sort_func` properties to FullFormatter.
+  (PR #1926, fixes Issue #1841)
+- Documented packages using pint.
+  (PR #1960)
+- Fixed bug causing operations between arrays of quantity scalars and quantity holding
+  array resulting in incorrect units.
+  (PR #1677)
+- Fix LaTeX siuntix formatting when using non_int_type=decimal.Decimal.
+  (PR #1977)
+- Added refractive index units.
+  (PR #1816)
+- Fix converting to offset units of higher dimension e.g. gauge pressure
+  (PR #1949)
+- Fix unhandled TypeError when auto_reduce_dimensions=True and non_int_type=Decimal
+  (PR #1853)
+- Improved error message in `get_dimensionality()` when non existent units are passed.
+  (PR #1874, Issue #1716)
 
 
 0.23 (2023-12-08)
@@ -35,6 +74,7 @@ Pint Changelog
 - Add numpy.linalg.norm implementation.
   (PR #1251)
 
+
 0.22 (2023-05-25)
 -----------------
 

README.rst

@@ -2,8 +2,13 @@
     :target: https://pypi.python.org/pypi/pint
     :alt: Latest Version
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/python/black
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff-Format
 
 .. image:: https://readthedocs.org/projects/pint/badge/
     :target: https://pint.readthedocs.org/

docs/advanced/currencies.rst

@@ -84,3 +84,16 @@ currency on its own dimension, and then implement transformations::
 More sophisticated formulas, e.g. dealing with flat fees and thresholds, can be
 implemented with arbitrary python code by programmatically defining a context (see
 :ref:`contexts`).
+
+Currency Symbols
+----------------
+
+Many common currency symbols are not supported by the pint parser. A preprocessor can be used as a workaround:
+
+.. doctest::
+
+   >>> import pint
+   >>> ureg = pint.UnitRegistry(preprocessors = [lambda s: s.replace("€", "EUR")])
+   >>> ureg.define("euro = [currency] = € = EUR")
+   >>> print(ureg.Quantity("1 €"))
+   1 euro

docs/advanced/pitheorem.rst

@@ -33,8 +33,10 @@ Which can be pretty printed using the `Pint` formatter:
 
     >>> from pint import formatter
     >>> result = pi_theorem({'V': '[length]/[time]', 'T': '[time]', 'L': '[length]'})
-    >>> print(formatter(result[0].items()))
-    T * V / L
+    >>> numerator = [item for item in result[0].items() if item[1]>0]
+    >>> denominator = [item for item in result[0].items() if item[1]<0]
+    >>> print(formatter(numerator, denominator))
+    V * T / L
 
 You can also apply the Buckingham π theorem associated to a Registry. In this case,
 you can use derived dimensions such as speed:

docs/api/facets.rst

@@ -16,7 +16,7 @@ The default UnitRegistry inherits from all of them.
     :members:
     :exclude-members: Quantity, Unit, Measurement, Group, Context, System
 
-.. automodule:: pint.facets.formatting
+.. automodule:: pint.delegates.formatter
     :members:
     :exclude-members: Quantity, Unit, Measurement, Group, Context, System
 

docs/conf.py

@@ -10,6 +10,7 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
+from __future__ import annotations
 
 import datetime
 from importlib.metadata import version

docs/ecosystem.rst

@@ -7,5 +7,18 @@ Here is a list of known projects, packages and integrations using pint.
 Pint integrations:
 ------------------
 
+- `ucumvert <https://github.com/dalito/ucumvert>`_ `UCUM <https://ucum.org/>`_ (Unified Code for Units of Measure) integration
 - `pint-pandas <https://github.com/hgrecco/pint-pandas>`_ Pandas integration
 - `pint-xarray <https://github.com/xarray-contrib/pint-xarray>`_ Xarray integration
+
+
+Packages using pint:
+------------------
+
+- `fluids <https://github.com/CalebBell/fluids>`_ Practical fluid dynamics calculations
+- `ht <https://github.com/CalebBell/ht/>`_ Practical heat transfer calculations
+- `chemicals <https://github.com/CalebBell/chemicals/>`_ Chemical property calculations and lookups
+- `thermo <https://github.com/CalebBell/thermo/>`_ Thermodynamic equilibrium calculations
+- `Taurus <https://taurus-scada.org/>`_ Control system UI creation
+- `InstrumentKit <https://github.com/instrumentkit/InstrumentKit>`_ Interacting with laboratory equipment over various buses.
+- `NEMO <https://github.com/bje-/NEMO/>`_ Electricity production cost model

docs/getting/tutorial.rst

@@ -428,7 +428,7 @@ If Babel_ is installed you can translate unit names to any language
 .. doctest::
 
    >>> ureg.formatter.format_quantity(accel, locale='fr_FR')
-   '1,3 mètres/secondes²'
+   '1,3 mètres par seconde²'
 
 You can also specify the format locale at the registry level either at creation:
 
@@ -449,11 +449,11 @@ and by doing that, string formatting is now localized:
     >>> ureg.default_format = 'P'
     >>> accel = 1.3 * ureg.parse_units('meter/second**2')
     >>> str(accel)
-    '1,3 mètres/secondes²'
+    '1,3 mètres par seconde²'
     >>> "%s" % accel
-    '1,3 mètres/secondes²'
+    '1,3 mètres par seconde²'
     >>> "{}".format(accel)
-    '1,3 mètres/secondes²'
+    '1,3 mètres par seconde²'
 
 If you want to customize string formatting, take a look at :ref:`formatting`.
 

docs/user/angular_frequency.rst

@@ -1,12 +1,43 @@
 .. _angular_frequency:
 
 
+Angles and Angular Frequency
+=============================
+
+Angles
+------
+
+pint treats angle quantities as `dimensionless`, following the conventions of SI. The base unit for angle is the `radian`.
+The SI BIPM Brochure (Bureau International des Poids et Mesures) states:
+
+.. note::
+
+    Plane and solid angles, when expressed in radians and steradians respectively, are in effect
+    also treated within the SI as quantities with the unit one (see section 5.4.8). The symbols rad
+    and sr are written explicitly where appropriate, in order to emphasize that, for radians or
+    steradians, the quantity being considered is, or involves the plane angle or solid angle
+    respectively. For steradians it emphasizes the distinction between units of flux and intensity
+    in radiometry and photometry for example. However, it is a long-established practice in
+    mathematics and across all areas of science to make use of rad = 1 and sr = 1.
+
+
+This leads to behavior some users may find unintuitive. For example, since angles have no dimensionality, it is not possible to check whether a quantity has an angle dimension.
+
+.. code-block:: python
+
+    >>> import pint
+    >>> ureg = pint.UnitRegistry()
+    >>> angle = ureg('1 rad')
+    >>> angle.dimensionality
+    <UnitsContainer({})>
+
+
 Angular Frequency
-=================
+-----------------
 
 `Hertz` is a unit for frequency, that is often also used for angular frequency. For example, a shaft spinning at `60 revolutions per minute` will often be said to spin at `1 Hz`, rather than `1 revolution per second`.
 
-By default, pint treats angle quantities as `dimensionless`, so allows conversions between frequencies and angular frequencies. The base unit for angle is the `radian`. This leads to some unintuitive behaviour, as pint will convert angular frequencies into frequencies by converting angles into `radians`, rather than `revolutions`. This leads to converted values `2 * pi` larger than expected:
+Since pint treats angle quantities as `dimensionless`, it allows conversions between frequencies and angular frequencies. This leads to some unintuitive behaviour, as pint will convert angular frequencies into frequencies by converting angles into `radians`, rather than `revolutions`. This leads to converted values `2 * pi` larger than expected:
 
 .. code-block:: python
 
@@ -16,7 +47,7 @@ By default, pint treats angle quantities as `dimensionless`, so allows conversio
     >>> angular_frequency.to('Hz')
     <Quantity(6.28318531, 'hertz')>
 
-pint follows the conventions of SI. The SI BIPM Brochure (Bureau International des Poids et Mesures) states:
+The SI BIPM Brochure (Bureau International des Poids et Mesures) states:
 
 .. note::
 

docs/user/defining-quantities.rst

@@ -134,7 +134,7 @@ For example, the units of
 .. doctest::
 
    >>> Q_('3 l / 100 km')
-   <Quantity(0.03, 'kilometer * liter')>
+   <Quantity(0.03, 'liter * kilometer')>
 
 may be unexpected at first but, are a consequence of applying this rule. Use
 brackets to get the expected result:

docs/user/formatting.rst

@@ -95,10 +95,11 @@ formats:
    ... def format_unit_simple(unit, registry, **options):
    ...     return " * ".join(f"{u} ** {p}" for u, p in unit.items())
    >>> f"{q:Z}"
-   '2.3e-06 meter ** 3 * second ** -2 * kilogram ** -1'
+   '2.3e-06 kilogram ** -1 * meter ** 3 * second ** -2'
 
 where ``unit`` is a :py:class:`dict` subclass containing the unit names and
-their exponents.
+their exponents, ``registry`` is the current instance of :py:class:``UnitRegistry`` and
+``options`` is not yet implemented.
 
 You can choose to replace the complete formatter. Briefly, the formatter if an object with the
 following methods: `format_magnitude`, `format_unit`, `format_quantity`, `format_uncertainty`,
@@ -111,10 +112,11 @@ following methods: `format_magnitude`, `format_unit`, `format_quantity`, `format
    ...
    ...      default_format = ""
    ...
-   ...      def format_unit(self, unit, uspec: str = "", **babel_kwds) -> str:
+   ...      def format_unit(self, unit, uspec, sort_func, **babel_kwds) -> str:
    ...          return "ups!"
    ...
    >>> ureg.formatter = MyFormatter()
+   >>> ureg.formatter._registry = ureg
    >>> str(q)
    '2.3e-06 ups!'
 

docs/user/log_units.rst

@@ -111,16 +111,16 @@ will not work:
 .. doctest::
 
     >>> -161.0 * ureg('dBm/Hz') == (-161.0 * ureg.dBm / ureg.Hz)
-    False
+    np.False_
 
 But this will:
 
 .. doctest::
 
     >>> ureg('-161.0 dBm/Hz') == (-161.0 * ureg.dBm / ureg.Hz)
-    True
+    np.True_
     >>> Q_(-161.0, 'dBm') / ureg.Hz == (-161.0 * ureg.dBm / ureg.Hz)
-    True
+    np.True_
 
 To begin using this feature while avoiding problems, define logarithmic units
 as single-unit quantities and convert them to their base units as quickly as