BDPotentiometer 0.2.0__tar.gz → 0.4.0__tar.gz

{bdpotentiometer-0.2.0/src/BDPotentiometer.egg-info → bdpotentiometer-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BDPotentiometer
-Version: 0.2.0
+Version: 0.4.0
 Summary: BD Digital Potentiometer
 Author-email: Anton Bondarenko <bond.anton@gmail.com>
 License: MIT License
@@ -28,27 +28,26 @@ Project-URL: Homepage, https://github.com/bond-anton/BDPotentiometer
 Project-URL: Bug Tracker, https://github.com/bond-anton/BDPotentiometer/issues
 Project-URL: Documentation, https://bdpotentiometer.readthedocs.io
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: scietex.hal.spi<1.0.0,>=0.1.0
 Provides-Extra: gpiozero
-Requires-Dist: gpiozero>=1.6.2; extra == "gpiozero"
+Requires-Dist: scietex.hal.spi[gpiozero]; extra == "gpiozero"
 Provides-Extra: spi
-Requires-Dist: spidev>=3.6; extra == "spi"
+Requires-Dist: scietex.hal.spi[spi]; extra == "spi"
 Provides-Extra: dev
-Requires-Dist: gpiozero>=1.6.2; extra == "dev"
-Requires-Dist: spidev>=3.6; extra == "dev"
+Requires-Dist: scietex.hal.spi[gpiozero,spi]; extra == "dev"
 Requires-Dist: numpy; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
-Requires-Dist: gpiozero>=1.6.2; extra == "docs"
+Requires-Dist: scietex.hal.spi[gpiozero]; extra == "docs"
 Requires-Dist: numpy; extra == "docs"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
@@ -76,14 +75,15 @@ The bare package installs the core library only: the model classes and
 $ pip install BDPotentiometer
 ```
 
-The default hardware backend is spidev; the `spi` extra installs it:
+The default hardware backend is spidev; the transport package's `spi` extra
+installs it:
 ```shell
-$ pip install 'BDPotentiometer[spi]'
+$ pip install 'scietex.hal.spi[spi]'
 ```
 
 The optional gpiozero backend needs its own extra:
 ```shell
-$ pip install 'BDPotentiometer[gpiozero]'
+$ pip install 'scietex.hal.spi[gpiozero]'
 ```
 
 ## Usage
@@ -112,20 +112,22 @@ or `spi=`; doing so raises `TypeError`.
 
 ## Transports
 
-SPI access goes through a transport object passed with `transport=`:
+The transport layer lives in the `scietex.hal.spi` distribution
+(https://github.com/bond-anton/scietex.hal.spi). SPI access goes through a
+transport object passed with `transport=`:
 
 * `SpiDevTransport` (default) opens `/dev/spidev<bus>.<device>` through
-  `spidev`; needs the `spi` extra. `port=` maps to the bus, `device=` to the
-  chip-select line.
+  `spidev`; needs `scietex.hal.spi[spi]`. `port=` maps to the bus, `device=` to
+  the chip-select line.
 * `GpiozeroSpiTransport` (optional) wraps gpiozero hardware SPI; passing
   `clock_pin=`, `mosi_pin=`, `miso_pin=`, or `select_pin=` builds one, and it
-  needs the `gpiozero` extra.
+  needs `scietex.hal.spi[gpiozero]`.
 * `FakeSpiTransport` replays scripted responses, so code can run without
   hardware or extras.
 
 ```python
 from BDPotentiometer.mcp4xxx import MCP4231
-from BDPotentiometer.transport import SpiDevTransport
+from scietex.hal.spi import SpiDevTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
@@ -134,7 +136,8 @@ my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
 For tests, the fake backend needs no extra:
 
 ```python
-from BDPotentiometer.transport import FakeSpiTransport
+from BDPotentiometer.mcp4xxx import MCP4231
+from scietex.hal.spi import FakeSpiTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
@@ -145,10 +148,46 @@ my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
 `spidev.SpiDev` or a gpiozero SPI object), and `.close()` / `.closed` release
 and report the underlying transport.
 
-`from BDPotentiometer import *` follows `__all__`, which includes
-`GpiozeroSpiTransport`. That name is resolved lazily, so a star import without
-the `gpiozero` extra raises `AttributeError`; import the names you need
-explicitly when the optional backend may be absent.
+Transports are owned by whoever constructs them: a device closes only a
+transport it built itself from backend keywords, and leaves a transport passed
+with `transport=` or `spi=` open.
+
+`from BDPotentiometer import *` follows `__all__`, which lists only the model
+classes: `DigitalPotentiometerDevice`, `DigitalWiper`, `Potentiometer`, and
+`SpiDigitalWiper`. Import transports and transport exceptions from
+`scietex.hal.spi`.
+
+## Upgrading to 0.4.0
+
+0.4.0 moves the transport layer out of this package into the published
+`scietex.hal.spi` 0.1.0 distribution.
+
+Breaking changes:
+
+* `BDPotentiometer.transport` is gone; `scietex.hal.spi` replaces it.
+* These names are no longer importable from `BDPotentiometer`: `SpiTransport`,
+  `SpiDevTransport`, `FakeSpiTransport`, `I2cTransport`, `TransportError`,
+  `TransportClosed`, `is_spi_transport`, `fix_gpiozero_dual_cs_spi`, and
+  `GpiozeroSpiTransport`.
+* `__all__` now lists only `DigitalPotentiometerDevice`, `DigitalWiper`,
+  `Potentiometer`, and `SpiDigitalWiper`.
+* The `ImportError` for a missing backend now names `scietex.hal.spi[spi]` or
+  `scietex.hal.spi[gpiozero]` instead of the `BDPotentiometer` extras.
+
+Migration:
+
+```python
+# before
+from BDPotentiometer.transport import SpiDevTransport
+
+# after
+from scietex.hal.spi import SpiDevTransport
+```
+
+Install the matching transport extra, for example
+`pip install 'scietex.hal.spi[spi]'`. Device constructors, the
+`transport=`/`spi=`/pin keywords, `.close()`, `.closed`, `.transport`, and
+`.spi` are unchanged.
 
 Please see the [examples](examples) directory for more usage examples.
 

{bdpotentiometer-0.2.0 → bdpotentiometer-0.4.0}/README.md

@@ -16,14 +16,15 @@ The bare package installs the core library only: the model classes and
 $ pip install BDPotentiometer
 ```
 
-The default hardware backend is spidev; the `spi` extra installs it:
+The default hardware backend is spidev; the transport package's `spi` extra
+installs it:
 ```shell
-$ pip install 'BDPotentiometer[spi]'
+$ pip install 'scietex.hal.spi[spi]'
 ```
 
 The optional gpiozero backend needs its own extra:
 ```shell
-$ pip install 'BDPotentiometer[gpiozero]'
+$ pip install 'scietex.hal.spi[gpiozero]'
 ```
 
 ## Usage
@@ -52,20 +53,22 @@ or `spi=`; doing so raises `TypeError`.
 
 ## Transports
 
-SPI access goes through a transport object passed with `transport=`:
+The transport layer lives in the `scietex.hal.spi` distribution
+(https://github.com/bond-anton/scietex.hal.spi). SPI access goes through a
+transport object passed with `transport=`:
 
 * `SpiDevTransport` (default) opens `/dev/spidev<bus>.<device>` through
-  `spidev`; needs the `spi` extra. `port=` maps to the bus, `device=` to the
-  chip-select line.
+  `spidev`; needs `scietex.hal.spi[spi]`. `port=` maps to the bus, `device=` to
+  the chip-select line.
 * `GpiozeroSpiTransport` (optional) wraps gpiozero hardware SPI; passing
   `clock_pin=`, `mosi_pin=`, `miso_pin=`, or `select_pin=` builds one, and it
-  needs the `gpiozero` extra.
+  needs `scietex.hal.spi[gpiozero]`.
 * `FakeSpiTransport` replays scripted responses, so code can run without
   hardware or extras.
 
 ```python
 from BDPotentiometer.mcp4xxx import MCP4231
-from BDPotentiometer.transport import SpiDevTransport
+from scietex.hal.spi import SpiDevTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
@@ -74,7 +77,8 @@ my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
 For tests, the fake backend needs no extra:
 
 ```python
-from BDPotentiometer.transport import FakeSpiTransport
+from BDPotentiometer.mcp4xxx import MCP4231
+from scietex.hal.spi import FakeSpiTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
@@ -85,10 +89,46 @@ my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
 `spidev.SpiDev` or a gpiozero SPI object), and `.close()` / `.closed` release
 and report the underlying transport.
 
-`from BDPotentiometer import *` follows `__all__`, which includes
-`GpiozeroSpiTransport`. That name is resolved lazily, so a star import without
-the `gpiozero` extra raises `AttributeError`; import the names you need
-explicitly when the optional backend may be absent.
+Transports are owned by whoever constructs them: a device closes only a
+transport it built itself from backend keywords, and leaves a transport passed
+with `transport=` or `spi=` open.
+
+`from BDPotentiometer import *` follows `__all__`, which lists only the model
+classes: `DigitalPotentiometerDevice`, `DigitalWiper`, `Potentiometer`, and
+`SpiDigitalWiper`. Import transports and transport exceptions from
+`scietex.hal.spi`.
+
+## Upgrading to 0.4.0
+
+0.4.0 moves the transport layer out of this package into the published
+`scietex.hal.spi` 0.1.0 distribution.
+
+Breaking changes:
+
+* `BDPotentiometer.transport` is gone; `scietex.hal.spi` replaces it.
+* These names are no longer importable from `BDPotentiometer`: `SpiTransport`,
+  `SpiDevTransport`, `FakeSpiTransport`, `I2cTransport`, `TransportError`,
+  `TransportClosed`, `is_spi_transport`, `fix_gpiozero_dual_cs_spi`, and
+  `GpiozeroSpiTransport`.
+* `__all__` now lists only `DigitalPotentiometerDevice`, `DigitalWiper`,
+  `Potentiometer`, and `SpiDigitalWiper`.
+* The `ImportError` for a missing backend now names `scietex.hal.spi[spi]` or
+  `scietex.hal.spi[gpiozero]` instead of the `BDPotentiometer` extras.
+
+Migration:
+
+```python
+# before
+from BDPotentiometer.transport import SpiDevTransport
+
+# after
+from scietex.hal.spi import SpiDevTransport
+```
+
+Install the matching transport extra, for example
+`pip install 'scietex.hal.spi[spi]'`. Device constructors, the
+`transport=`/`spi=`/pin keywords, `.close()`, `.closed`, `.transport`, and
+`.spi` are unchanged.
 
 Please see the [examples](examples) directory for more usage examples.
 

{bdpotentiometer-0.2.0 → bdpotentiometer-0.4.0}/pyproject.toml

@@ -13,15 +13,14 @@ license = { file = "LICENSE" }
 readme = "README.md"
 classifiers = [
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
-requires-python = ">=3.9"
-dependencies = []
+requires-python = ">=3.10"
+dependencies = ["scietex.hal.spi >= 0.1.0, < 1.0.0"]
 
 [project.urls]
 "Homepage" = "https://github.com/bond-anton/BDPotentiometer"
@@ -29,10 +28,10 @@ dependencies = []
 "Documentation" = "https://bdpotentiometer.readthedocs.io"
 
 [project.optional-dependencies]
-gpiozero = ["gpiozero>=1.6.2"]
-spi = ["spidev>=3.6"]
-dev = ["gpiozero>=1.6.2", "spidev>=3.6", "numpy"]
-docs = ["sphinx", "sphinx_rtd_theme", "gpiozero>=1.6.2", "numpy"]
+gpiozero = ["scietex.hal.spi[gpiozero]"]
+spi = ["scietex.hal.spi[spi]"]
+dev = ["scietex.hal.spi[spi,gpiozero]", "numpy"]
+docs = ["sphinx", "sphinx_rtd_theme", "scietex.hal.spi[gpiozero]", "numpy"]
 test = ["pytest", "numpy"]
 lint = ["ruff==0.17.4", "ty==0.0.99"]
 
@@ -49,7 +48,7 @@ pythonpath = [
 
 [tool.ruff]
 line-length = 88
-target-version = "py39"
+target-version = "py310"
 extend-exclude = ["docs"]
 
 [tool.ruff.lint]
@@ -66,7 +65,7 @@ line-ending = "auto"
 docstring-code-format = false
 
 [tool.ty.environment]
-python-version = "3.9"
+python-version = "3.10"
 
 [tool.ty.analysis]
 replace-imports-with-any = ["gpiozero.**", "spidev.**"]

{bdpotentiometer-0.2.0 → bdpotentiometer-0.4.0}/src/BDPotentiometer/__helpers.py

@@ -8,10 +8,9 @@ the requested range.
 
 from math import isnan
 from numbers import Integral, Real
-from typing import Union
 
 
-def check_number(num: Union[float, int, Real]) -> Union[float, int]:
+def check_number(num: float | int | Real) -> float | int:
     """
     Check that `num` is a finite real number.
 
@@ -43,7 +42,7 @@ def check_number(num: Union[float, int, Real]) -> Union[float, int]:
     return float(num)
 
 
-def check_integer(num: Union[float, int, Real]) -> int:
+def check_integer(num: float | int | Real) -> int:
     """
     Check that `num` is an integer and convert it to int.
 
@@ -102,7 +101,7 @@ def check_label(value: str) -> str:
     return text
 
 
-def check_not_negative(num: Union[float, int]) -> Union[float, int]:
+def check_not_negative(num: float | int) -> float | int:
     """
     Check that `num` is a not negative number.
 
@@ -120,7 +119,7 @@ def check_not_negative(num: Union[float, int]) -> Union[float, int]:
     return num
 
 
-def check_positive(num: Union[float, int]) -> Union[float, int]:
+def check_positive(num: float | int) -> float | int:
     """
     Check that `num` is a positive number.
 
@@ -139,8 +138,8 @@ def check_positive(num: Union[float, int]) -> Union[float, int]:
 
 
 def clamp(
-    value: Union[float, int], min_value: Union[float, int], max_value: Union[float, int]
-) -> Union[float, int]:
+    value: float | int, min_value: float | int, max_value: float | int
+) -> float | int:
     """
     Clamp `value` to the range between `min_value` and `max_value`.
 

bdpotentiometer-0.4.0/src/BDPotentiometer/__init__.py

@@ -0,0 +1,15 @@
+"""Digital potentiometer and wiper models with pluggable bus transports."""
+
+__version__ = "0.4.0"
+
+
+from .digital_potentiometer import DigitalPotentiometerDevice
+from .digital_wiper import DigitalWiper, SpiDigitalWiper
+from .potentiometer import Potentiometer
+
+__all__ = [
+    "DigitalPotentiometerDevice",
+    "DigitalWiper",
+    "Potentiometer",
+    "SpiDigitalWiper",
+]

{bdpotentiometer-0.2.0 → bdpotentiometer-0.4.0}/src/BDPotentiometer/__logger.py

@@ -11,7 +11,6 @@ propagation on the returned logger if that is not wanted.
 
 import logging
 import threading
-from typing import Union
 
 # Guards handler installation so that two threads calling `get_logger` for the
 # same label cannot attach two handlers.
@@ -25,7 +24,7 @@ _FORMAT = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
 _PACKAGE_HANDLER_ATTR = "_bdpot_package_handler"
 
 
-def _package_handler(logger: logging.Logger) -> Union[logging.Handler, None]:
+def _package_handler(logger: logging.Logger) -> logging.Handler | None:
     """Return the handler installed by this module, if it is still attached."""
     for handler in logger.handlers:
         if getattr(handler, _PACKAGE_HANDLER_ATTR, False):
@@ -33,7 +32,7 @@ def _package_handler(logger: logging.Logger) -> Union[logging.Handler, None]:
     return None
 
 
-def get_logger(label: str, log_level: Union[int, None] = None) -> logging.Logger:
+def get_logger(label: str, log_level: int | None = None) -> logging.Logger:
     """
     Return the named logger `label`, configured once.