quantiphy 2.19__tar.gz → 2.20__tar.gz

{quantiphy-2.19 → quantiphy-2.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quantiphy
-Version: 2.19
+Version: 2.20
 Summary: physical quantities (numbers with units)
 Keywords: quantities,physical quantity,units,SI scale factors,engineering notation,mks,cgs
 Author: Ken Kundert
@@ -24,28 +24,11 @@ Project-URL: repository, https://github.com/kenkundert/quantiphy
 QuantiPhy — Physical Quantities
 ===============================
 
-.. image:: https://pepy.tech/badge/quantiphy/month
-    :target: https://pepy.tech/project/quantiphy
-
-.. image:: https://img.shields.io/readthedocs/quantiphy.svg
-   :target: https://quantiphy.readthedocs.io/en/latest/?badge=latest
-
-.. image:: https://github.com/KenKundert/quantiphy/actions/workflows/build.yaml/badge.svg
-    :target: https://github.com/KenKundert/quantiphy/actions/workflows/build.yaml
-
-.. image:: https://coveralls.io/repos/github/KenKundert/quantiphy/badge.svg?branch=master
-    :target: https://coveralls.io/github/KenKundert/quantiphy?branch=master
-
-.. image:: https://img.shields.io/pypi/v/quantiphy.svg
-    :target: https://pypi.python.org/pypi/quantiphy
-
-.. image:: https://img.shields.io/pypi/pyversions/quantiphy.svg
-    :target: https://pypi.python.org/pypi/quantiphy/
-
+|downloads| |build status| |coverage| |rtd status| |pypi version| |anaconda version| |python version|
 
 | Author: Ken Kundert
-| Version: 2.19
-| Released: 2023-01-05
+| Version: 2.20
+| Released: 2024-04-27
 |
 
 
@@ -228,3 +211,26 @@ incorporate quantity values into strings:
 *QuantiPhy* has many more features and capabilities. For more information, view 
 the `documentation <https://quantiphy.readthedocs.io>`_.
 
+
+.. |downloads| image:: https://pepy.tech/badge/quantiphy/month
+    :target: https://pepy.tech/project/quantiphy
+
+.. |rtd status| image:: https://img.shields.io/readthedocs/quantiphy.svg
+   :target: https://quantiphy.readthedocs.io/en/latest/?badge=latest
+
+.. |build status| image:: https://github.com/KenKundert/quantiphy/actions/workflows/build.yaml/badge.svg
+    :target: https://github.com/KenKundert/quantiphy/actions/workflows/build.yaml
+
+.. |coverage| image:: https://coveralls.io/repos/github/KenKundert/quantiphy/badge.svg?branch=master
+    :target: https://coveralls.io/github/KenKundert/quantiphy?branch=master
+
+.. |pypi version| image:: https://img.shields.io/pypi/v/quantiphy.svg
+    :target: https://pypi.python.org/pypi/quantiphy
+
+.. |anaconda version| image:: https://anaconda.org/conda-forge/quantiphy/badges/version.svg
+    :target: https://anaconda.org/conda-forge/quantiphy
+
+.. |python version| image:: https://img.shields.io/pypi/pyversions/quantiphy.svg
+    :target: https://pypi.python.org/pypi/quantiphy/
+
+

{quantiphy-2.19 → quantiphy-2.20}/README.rst

@@ -1,28 +1,11 @@
 QuantiPhy — Physical Quantities
 ===============================
 
-.. image:: https://pepy.tech/badge/quantiphy/month
-    :target: https://pepy.tech/project/quantiphy
-
-.. image:: https://img.shields.io/readthedocs/quantiphy.svg
-   :target: https://quantiphy.readthedocs.io/en/latest/?badge=latest
-
-.. image:: https://github.com/KenKundert/quantiphy/actions/workflows/build.yaml/badge.svg
-    :target: https://github.com/KenKundert/quantiphy/actions/workflows/build.yaml
-
-.. image:: https://coveralls.io/repos/github/KenKundert/quantiphy/badge.svg?branch=master
-    :target: https://coveralls.io/github/KenKundert/quantiphy?branch=master
-
-.. image:: https://img.shields.io/pypi/v/quantiphy.svg
-    :target: https://pypi.python.org/pypi/quantiphy
-
-.. image:: https://img.shields.io/pypi/pyversions/quantiphy.svg
-    :target: https://pypi.python.org/pypi/quantiphy/
-
+|downloads| |build status| |coverage| |rtd status| |pypi version| |anaconda version| |python version|
 
 | Author: Ken Kundert
-| Version: 2.19
-| Released: 2023-01-05
+| Version: 2.20
+| Released: 2024-04-27
 |
 
 
@@ -204,3 +187,26 @@ incorporate quantity values into strings:
 
 *QuantiPhy* has many more features and capabilities. For more information, view 
 the `documentation <https://quantiphy.readthedocs.io>`_.
+
+
+.. |downloads| image:: https://pepy.tech/badge/quantiphy/month
+    :target: https://pepy.tech/project/quantiphy
+
+.. |rtd status| image:: https://img.shields.io/readthedocs/quantiphy.svg
+   :target: https://quantiphy.readthedocs.io/en/latest/?badge=latest
+
+.. |build status| image:: https://github.com/KenKundert/quantiphy/actions/workflows/build.yaml/badge.svg
+    :target: https://github.com/KenKundert/quantiphy/actions/workflows/build.yaml
+
+.. |coverage| image:: https://coveralls.io/repos/github/KenKundert/quantiphy/badge.svg?branch=master
+    :target: https://coveralls.io/github/KenKundert/quantiphy?branch=master
+
+.. |pypi version| image:: https://img.shields.io/pypi/v/quantiphy.svg
+    :target: https://pypi.python.org/pypi/quantiphy
+
+.. |anaconda version| image:: https://anaconda.org/conda-forge/quantiphy/badges/version.svg
+    :target: https://anaconda.org/conda-forge/quantiphy
+
+.. |python version| image:: https://img.shields.io/pypi/pyversions/quantiphy.svg
+    :target: https://pypi.python.org/pypi/quantiphy/
+

{quantiphy-2.19 → quantiphy-2.20}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "quantiphy"
-version = "2.19"
+version = "2.20"
 description = "physical quantities (numbers with units)"
 readme = "README.rst"
 keywords = [

{quantiphy-2.19 → quantiphy-2.20}/quantiphy/quantiphy.py

@@ -22,7 +22,7 @@ Documentation can be found at https://quantiphy.readthedocs.io.
 """
 
 # MIT License {{{1
-# Copyright (C) 2016-2023 Kenneth S. Kundert
+# Copyright (C) 2016-2024 Kenneth S. Kundert
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -62,7 +62,7 @@ def _scale(scale, unscaled):
     #     scale (what you want) scale is scaling factor or function, or to_units
     #     unscaled (what you have), a quantity
 
-    # allow subclasss of Quantity that has units to be the scale
+    # allow subclass of Quantity that has units to be the scale
     try:
         if issubclass(scale, Quantity):
             scale = scale.units
@@ -77,7 +77,7 @@ def _scale(scale, unscaled):
         # otherwise, it might be a function
         try:
             scaled, to_units = scale(unscaled, unscaled.units)
-                 # passing units as second argument is redundant, deprecated
+                # passing units as second argument is redundant, deprecated
         except TypeError:
             # otherwise, assume it is a scale factor
             try:
@@ -367,38 +367,38 @@ def add_constant(value, alias=None, unit_systems=None):
 
 
 # Globals {{{1
-__version__ = '2.19'
-__released__ = '2023-01-05'
+__version__ = '2.20'
+__released__ = '2024-04-27'
 
 # These mappings are only used when reading numbers
 # The key for these mappings must be a single character
 MAPPINGS = {
-    'Q': 'e30',  # quetta
-    'R': 'e27',  # ronna
-    'Y': 'e24',  # yotta
-    'Z': 'e21',  # zetta
-    'E': 'e18',  # exa
-    'P': 'e15',  # peta
-    'T': 'e12',  # tera
-    'G': 'e9',   # giga
-    'M': 'e6',   # mega
-    'K': 'e3',   # kilo
-    'k': 'e3',   # kilo
-    '_': 'e0',   # unity
-    'c': 'e-2',  # centi, only available for input, not used in output
-    '%': 'e-2',  # percent, potentially available for input, not used in output
-    'm': 'e-3',  # milli
-    'u': 'e-6',  # micro (ASCII)
-    'µ': 'e-6',  # micro (unicode micro)
-    'μ': 'e-6',  # micro (unicode greek mu)
-    'n': 'e-9',  # nano
-    'p': 'e-12', # pico
-    'f': 'e-15', # femto
-    'a': 'e-18', # ato
-    'z': 'e-21', # zepto
-    'y': 'e-24', # yocto
-    'r': 'e-27', # ronto
-    'q': 'e-30', # quecto
+    'Q': 'e30',   # quetta
+    'R': 'e27',   # ronna
+    'Y': 'e24',   # yotta
+    'Z': 'e21',   # zetta
+    'E': 'e18',   # exa
+    'P': 'e15',   # peta
+    'T': 'e12',   # tera
+    'G': 'e9',    # giga
+    'M': 'e6',    # mega
+    'K': 'e3',    # kilo
+    'k': 'e3',    # kilo
+    '_': 'e0',    # unity
+    'c': 'e-2',   # centi, only available for input, not used in output
+    '%': 'e-2',   # percent, potentially available for input, not used in output
+    'm': 'e-3',   # milli
+    'u': 'e-6',   # micro (ASCII)
+    'µ': 'e-6',   # micro (unicode micro)
+    'μ': 'e-6',   # micro (unicode greek mu)
+    'n': 'e-9',   # nano
+    'p': 'e-12',  # pico
+    'f': 'e-15',  # femto
+    'a': 'e-18',  # ato
+    'z': 'e-21',  # zepto
+    'y': 'e-24',  # yocto
+    'r': 'e-27',  # ronto
+    'q': 'e-30',  # quecto
 }
 ALL_SF = ''.join(MAPPINGS.keys())
 BINARY_MAPPINGS = {
@@ -1652,7 +1652,6 @@ class Quantity(float):
 
         # perform scaling {{{3
         # scaling can either be explicitly requested using scale parameter
-        original = number
         if scale or isinstance(scale, numbers.Number):
             try:
                 unscaled = Quantity(number, units, params=params)
@@ -1774,9 +1773,10 @@ class Quantity(float):
               the units, so the second argument is redundant and will eventually
               be deprecated.  The function returns two values, the value and
               units of the new value.
-            - If a string, it is taken to the be desired units. This value along
-              with the units of the quantity are used to select a known unit
-              conversion, which is applied to create the new value.
+            - If a string, it is taken to the be desired units, perhaps with a
+              scale factor. This value along with the units of the quantity are
+              used to select a known unit conversion, which is applied to create
+              the new value.
             - If a quantity, the units are ignored and the scale is treated as
               if were specified as a unitless float.
             - If a subclass of :class:`Quantity` that includes units, the units
@@ -1803,7 +1803,7 @@ class Quantity(float):
 
         """
 
-        # if subclasss of Quantity is passed as scale, use as cls if not given
+        # if subclass of Quantity is passed as scale, use as cls if not given
         try:
             if issubclass(scale, Quantity) and not cls:
                 cls = scale
@@ -1852,13 +1852,10 @@ class Quantity(float):
 
         try:
             if check_units and self.units != addend.units:
-                raise IncompatibleUnits(self.units, addend.units)
+                raise IncompatibleUnits(self, addend)
         except AttributeError:
             if check_units == 'strict':
-                raise IncompatibleUnits(
-                    getattr(self, 'units', None),
-                    getattr(addend, 'units', None)
-                )
+                raise IncompatibleUnits(self, addend)
         new = self.__class__(self.real + addend, self.units)
         new._inherit_attributes(self)
         return new
@@ -2371,7 +2368,7 @@ class Quantity(float):
         units = self._preferred_units.get(self.units, self.units) if show_units else ''
         if prec is None:
             prec = self.prec
-        elif prec == 'full':
+        if prec == 'full':
             prec = self.full_prec
 
         # check for infinities or NaN {{{3
@@ -2579,6 +2576,7 @@ class Quantity(float):
             scale = units if units else None
             prec = int(prec) if prec else None
             ftype = ftype if ftype else ''
+            alt_form = dict(strip_zeros=False, strip_radix=False) if alt_form else {}
             if ftype and ftype in 'dnu':
                 if ftype == 'u':
                     value = scale if scale else self.units
@@ -2593,28 +2591,28 @@ class Quantity(float):
             ftype = ftype.lower()
             if ftype in 's':  # note that ftype = '' matches this case
                 label = label if ftype else None
-                value = self.render(prec=prec, show_label=label, scale=scale)
+                value = self.render(
+                    prec=prec, show_label=label, scale=scale, **alt_form
+                )
             elif ftype == 'q':
                 value = self.render(
                     form='si', prec=prec, show_units=True, show_label=label,
-                    strip_zeros=not alt_form, strip_radix=not alt_form, scale=scale
+                    scale=scale, **alt_form
                 )
             elif ftype == 'r':
                 value = self.render(
                     form='si', prec=prec, show_units=False, show_label=label,
-                    strip_zeros=not alt_form, strip_radix=not alt_form, scale=scale
+                    scale=scale, **alt_form
                 )
             elif ftype == 'p':
                 value = self.fixed(
                     prec=prec, show_units=True, show_label=label,
-                    show_commas=bool(comma), strip_zeros=not alt_form,
-                    strip_radix=not alt_form, scale=scale
+                    show_commas=bool(comma), scale=scale, **alt_form
                 )
             elif ftype == 'b':
                 value = self.binary(
                     prec=prec, show_units=True, show_label=label,
-                    strip_zeros=not alt_form, strip_radix=not alt_form,
-                    scale=scale
+                    scale=scale, **alt_form
                 )
             else:
                 if prec is None:
@@ -3425,7 +3423,7 @@ class UnitConversion(object):
                 elif from_units in self.to_units and value.units in self.to_units:
                     pass
                 else:
-                    raise IncompatibleUnits(value.units, from_units)
+                    raise IncompatibleUnits(value, from_units)
 
         if to_units is None and from_units is None:
             to_units = self.to_units[0]
@@ -3773,4 +3771,3 @@ def binary(value, units, params=None, *args, **kwargs):
 
     """
     return Quantity(value, units=units, params=params).binary(*args, **kwargs)
-

{quantiphy-2.19 → quantiphy-2.20}/quantiphy/quantiphy.pyi

@@ -161,7 +161,7 @@ class Quantity(float):
         text: str,
         predefined: dict = ...,
         **kwargs,
-    ): ...
+    ) -> dict[str, Quantity]: ...
 
     @staticmethod
     def map_sf_to_sci_notation(sf: str): ...