serialx-compat 1.1.1__tar.gz

serialx_compat-1.1.1/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: serialx-compat
+Version: 1.1.1
+Summary: Compatibility package exposing pyserial-style imports backed by serialx
+Author-email: puddly <puddly3@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/puddly/serialx
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: serialx==1.1.1
+Provides-Extra: esphome
+Requires-Dist: serialx[esphome]; extra == "esphome"
+Provides-Extra: dev
+Requires-Dist: serialx[dev]; extra == "dev"
+
+# serialx-compat
+`serialx-compat` provides import-path compatibility for projects that expect:
+
+- `serial`
+- `serial_asyncio`
+- `serial_asyncio_fast`
+
+All functionality is delegated to [`serialx`](https://pypi.org/project/serialx/).
+
+> [!IMPORTANT] 
+> WARNING: This package intentionally overlaps Python import paths with
+> `pyserial`, `pyserial-asyncio`, and `pyserial-asyncio-fast`. Uninstall those packages
+> first.

serialx_compat-1.1.1/README.md

@@ -0,0 +1,13 @@
+# serialx-compat
+`serialx-compat` provides import-path compatibility for projects that expect:
+
+- `serial`
+- `serial_asyncio`
+- `serial_asyncio_fast`
+
+All functionality is delegated to [`serialx`](https://pypi.org/project/serialx/).
+
+> [!IMPORTANT] 
+> WARNING: This package intentionally overlaps Python import paths with
+> `pyserial`, `pyserial-asyncio`, and `pyserial-asyncio-fast`. Uninstall those packages
+> first.

serialx_compat-1.1.1/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=80"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "serialx-compat"
+version = "1.1.1"  # Rewritten by CI to match the serialx version
+description = "Compatibility package exposing pyserial-style imports backed by serialx"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+authors = [{ name = "puddly", email = "puddly3@gmail.com" }]
+dependencies = ["serialx==1.1.1"]  # Rewritten to serialx==<release version> by release CI
+
+[project.optional-dependencies]
+esphome = [
+    "serialx[esphome]",
+]
+
+dev = [
+    "serialx[dev]",
+]
+
+[project.urls]
+Repository = "https://github.com/puddly/serialx"
+
+[tool.setuptools]
+py-modules = ["serial_asyncio", "serial_asyncio_fast"]
+
+[tool.setuptools.packages.find]
+include = ["serial", "serial.*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.mypy]
+check_untyped_defs = true
+show_error_codes = true
+show_error_context = true

serialx_compat-1.1.1/serial/__init__.py

@@ -0,0 +1,79 @@
+"""Compatibility shim for pyserial's ``serial`` package backed by serialx."""
+
+from __future__ import annotations
+
+import importlib.util
+
+if importlib.util.find_spec("serial.serialcli"):
+    raise RuntimeError(
+        "serialx-compat detected a mixed installation with pyserial files. Uninstall"
+        " pyserial, pyserial-asyncio, and pyserial-asyncio-fast before installing"
+        " serialx-compat."
+    )
+
+from importlib.metadata import version
+
+from serialx import (
+    CR,
+    EIGHTBITS,
+    LF,
+    PARITY_EVEN,
+    PARITY_NONE,
+    PARITY_ODD,
+    SEVENBITS,
+    STOPBITS_ONE,
+    STOPBITS_TWO,
+    BaseSerial,
+    BaseSerialTransport,
+    ModemPins,
+    Parity,
+    PinState,
+    Serial,
+    SerialException,
+    SerialPortInfo,
+    SerialStreamWriter,
+    SerialTimeoutException,
+    SerialTransport,
+    StopBits,
+    UnsupportedSetting,
+    create_serial_connection,
+    get_serial_classes,
+    list_serial_ports,
+    open_serial_connection,
+    serial_for_url,
+)
+
+VERSION = version("serialx-compat")
+__version__ = VERSION
+
+__all__ = [
+    "create_serial_connection",
+    "get_serial_classes",
+    "list_serial_ports",
+    "open_serial_connection",
+    "serial_for_url",
+    "ModemPins",
+    "Parity",
+    "PinState",
+    "BaseSerial",
+    "BaseSerialTransport",
+    "Serial",
+    "SerialException",
+    "UnsupportedSetting",
+    "SerialPortInfo",
+    "SerialStreamWriter",
+    "SerialTransport",
+    "StopBits",
+    "SerialTimeoutException",
+    "EIGHTBITS",
+    "SEVENBITS",
+    "PARITY_NONE",
+    "PARITY_EVEN",
+    "PARITY_ODD",
+    "STOPBITS_ONE",
+    "STOPBITS_TWO",
+    "CR",
+    "LF",
+    "VERSION",
+    "__version__",
+]

serialx_compat-1.1.1/serial/serialutil.py

@@ -0,0 +1,8 @@
+"""Compatibility shim for pyserial's ``serial.serialutil`` module."""
+
+from __future__ import annotations
+
+from serialx.serialutil import *  # noqa: F401,F403
+from serialx.serialutil import __all__ as _serialutil_all
+
+__all__ = _serialutil_all

serialx_compat-1.1.1/serial/tools/__init__.py

@@ -0,0 +1,5 @@
+"""Compatibility shim for pyserial's ``serial.tools`` package."""
+
+from __future__ import annotations
+
+__all__: list[str] = []

serialx_compat-1.1.1/serial/tools/list_ports.py

@@ -0,0 +1,8 @@
+"""Compatibility shim for pyserial's ``serial.tools.list_ports`` module."""
+
+from __future__ import annotations
+
+from serialx.tools.list_ports import *  # noqa: F401,F403
+from serialx.tools.list_ports import __all__ as _list_ports_all
+
+__all__ = _list_ports_all

serialx_compat-1.1.1/serial/tools/list_ports_common.py

@@ -0,0 +1,8 @@
+"""Compatibility shim for ``serial.tools.list_ports_common`` module."""
+
+from __future__ import annotations
+
+from serialx.tools.list_ports_common import *  # noqa: F401,F403
+from serialx.tools.list_ports_common import __all__ as _list_ports_common_all
+
+__all__ = _list_ports_common_all

serialx_compat-1.1.1/serial_asyncio.py

@@ -0,0 +1,24 @@
+"""Compatibility shim for ``serial_asyncio`` backed by serialx."""
+
+from __future__ import annotations
+
+from importlib.metadata import version
+
+from serialx import (
+    SerialStreamWriter,
+    SerialTransport,
+    create_serial_connection,
+    open_serial_connection,
+)
+
+VERSION = version("serialx-compat")
+__version__ = VERSION
+
+__all__ = [
+    "SerialStreamWriter",
+    "SerialTransport",
+    "create_serial_connection",
+    "open_serial_connection",
+    "VERSION",
+    "__version__",
+]

serialx_compat-1.1.1/serial_asyncio_fast.py

@@ -0,0 +1,24 @@
+"""Compatibility shim for ``serial_asyncio_fast`` backed by serialx."""
+
+from __future__ import annotations
+
+from importlib.metadata import version
+
+from serialx import (
+    SerialStreamWriter,
+    SerialTransport,
+    create_serial_connection,
+    open_serial_connection,
+)
+
+VERSION = version("serialx-compat")
+__version__ = VERSION
+
+__all__ = [
+    "SerialStreamWriter",
+    "SerialTransport",
+    "create_serial_connection",
+    "open_serial_connection",
+    "VERSION",
+    "__version__",
+]

serialx_compat-1.1.1/serialx_compat.egg-info/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: serialx-compat
+Version: 1.1.1
+Summary: Compatibility package exposing pyserial-style imports backed by serialx
+Author-email: puddly <puddly3@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/puddly/serialx
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: serialx==1.1.1
+Provides-Extra: esphome
+Requires-Dist: serialx[esphome]; extra == "esphome"
+Provides-Extra: dev
+Requires-Dist: serialx[dev]; extra == "dev"
+
+# serialx-compat
+`serialx-compat` provides import-path compatibility for projects that expect:
+
+- `serial`
+- `serial_asyncio`
+- `serial_asyncio_fast`
+
+All functionality is delegated to [`serialx`](https://pypi.org/project/serialx/).
+
+> [!IMPORTANT] 
+> WARNING: This package intentionally overlaps Python import paths with
+> `pyserial`, `pyserial-asyncio`, and `pyserial-asyncio-fast`. Uninstall those packages
+> first.

serialx_compat-1.1.1/serialx_compat.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+serial_asyncio.py
+serial_asyncio_fast.py
+serial/__init__.py
+serial/serialutil.py
+serial/tools/__init__.py
+serial/tools/list_ports.py
+serial/tools/list_ports_common.py
+serialx_compat.egg-info/PKG-INFO
+serialx_compat.egg-info/SOURCES.txt
+serialx_compat.egg-info/dependency_links.txt
+serialx_compat.egg-info/requires.txt
+serialx_compat.egg-info/top_level.txt
+tests/test_compat_imports.py

serialx_compat-1.1.1/serialx_compat.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

serialx_compat-1.1.1/serialx_compat.egg-info/requires.txt

@@ -0,0 +1,7 @@
+serialx==1.1.1
+
+[dev]
+serialx[dev]
+
+[esphome]
+serialx[esphome]

serialx_compat-1.1.1/serialx_compat.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+serial
+serial_asyncio
+serial_asyncio_fast

serialx_compat-1.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

serialx_compat-1.1.1/tests/test_compat_imports.py

@@ -0,0 +1,42 @@
+"""Smoke tests for import compatibility shims."""
+
+from __future__ import annotations
+
+import serial
+import serial.serialutil
+import serial.tools
+import serial.tools.list_ports
+import serial.tools.list_ports_common
+import serial_asyncio
+import serial_asyncio_fast
+
+
+def test_serial_exports_versions_and_core_symbols() -> None:
+    """Serial module exposes expected symbols and version attributes."""
+    assert serial.__version__ == serial.VERSION
+    assert isinstance(serial.VERSION, str)
+    assert hasattr(serial, "Serial")
+    assert hasattr(serial, "serial_for_url")
+
+
+def test_serial_submodules_are_importable() -> None:
+    """Serial package submodules expected by pyserial users import correctly."""
+    assert hasattr(serial.tools.list_ports, "comports")
+
+
+def test_serial_asyncio_exports_versions_and_core_symbols() -> None:
+    """serial_asyncio module exposes expected symbols and version attributes."""
+    assert serial_asyncio.__version__ == serial_asyncio.VERSION
+    assert isinstance(serial_asyncio.VERSION, str)
+    assert hasattr(serial_asyncio, "create_serial_connection")
+    assert hasattr(serial_asyncio, "open_serial_connection")
+    assert hasattr(serial_asyncio, "SerialTransport")
+
+
+def test_serial_asyncio_fast_exports_versions_and_core_symbols() -> None:
+    """serial_asyncio_fast module exposes expected symbols and version attributes."""
+    assert serial_asyncio_fast.__version__ == serial_asyncio_fast.VERSION
+    assert isinstance(serial_asyncio_fast.VERSION, str)
+    assert hasattr(serial_asyncio_fast, "create_serial_connection")
+    assert hasattr(serial_asyncio_fast, "open_serial_connection")
+    assert hasattr(serial_asyncio_fast, "SerialTransport")