Use dependency groups for docs/lint/test (#1945)

* use dependency groups for docs/lint/test

---------

Co-authored-by: zariiii9003 <[email protected]>

Author: zariiii9003

.github/workflows/ci.yml

@@ -79,7 +79,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[lint]
+        pip install --group lint -e .
     - name: mypy 3.9
       run: |
         mypy --python-version 3.9 .
@@ -92,6 +92,9 @@ jobs:
     - name: mypy 3.12
       run: |
         mypy --python-version 3.12 .
+    - name: mypy 3.13
+      run: |
+        mypy --python-version 3.13 .
     - name: ruff
       run: |
         ruff check can
@@ -115,7 +118,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[lint]
+        pip install --group lint
     - name: Code Format Check with Black
       run: |
         black --check --verbose .

.readthedocs.yml

@@ -10,6 +10,9 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
+  jobs:
+    post_install:
+      - pip install --group docs
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -23,10 +26,11 @@ formats:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-    - requirements: doc/doc-requirements.txt
     - method: pip
       path: .
       extra_requirements:
         - canalystii
-        - gs_usb
+        - gs-usb
         - mf4
+        - remote
+        - serial

can/interfaces/udp_multicast/bus.py

@@ -11,7 +11,7 @@
 from can import BusABC, CanProtocol
 from can.typechecking import AutoDetectedConfig
 
-from .utils import check_msgpack_installed, pack_message, unpack_message
+from .utils import is_msgpack_installed, pack_message, unpack_message
 
 ioctl_supported = True
 
@@ -104,7 +104,7 @@ def __init__(
         fd: bool = True,
         **kwargs,
     ) -> None:
-        check_msgpack_installed()
+        is_msgpack_installed()
 
         if receive_own_messages:
             raise can.CanInterfaceNotImplementedError(

can/interfaces/udp_multicast/utils.py

@@ -13,10 +13,22 @@
     msgpack = None
 
 
-def check_msgpack_installed() -> None:
-    """Raises a :class:`can.CanInterfaceNotImplementedError` if `msgpack` is not installed."""
+def is_msgpack_installed(raise_exception: bool = True) -> bool:
+    """Check whether the ``msgpack`` module is installed.
+
+    :param raise_exception:
+        If True, raise a :class:`can.CanInterfaceNotImplementedError` when ``msgpack`` is not installed.
+        If False, return False instead.
+    :return:
+        True if ``msgpack`` is installed, False otherwise.
+    :raises can.CanInterfaceNotImplementedError:
+        If ``msgpack`` is not installed and ``raise_exception`` is True.
+    """
     if msgpack is None:
-        raise CanInterfaceNotImplementedError("msgpack not installed")
+        if raise_exception:
+            raise CanInterfaceNotImplementedError("msgpack not installed")
+        return False
+    return True
 
 
 def pack_message(message: Message) -> bytes:
@@ -25,7 +37,7 @@ def pack_message(message: Message) -> bytes:
 
     :param message: the message to be packed
     """
-    check_msgpack_installed()
+    is_msgpack_installed()
     as_dict = {
         "timestamp": message.timestamp,
         "arbitration_id": message.arbitration_id,
@@ -58,7 +70,7 @@ def unpack_message(
     :raise ValueError: if `check` is true and the message metadata is invalid in some way
     :raise Exception: if there was another problem while unpacking
     """
-    check_msgpack_installed()
+    is_msgpack_installed()
     as_dict = msgpack.unpackb(data, raw=False)
     if replace is not None:
         as_dict.update(replace)

can/listener.py

@@ -136,6 +136,7 @@ class AsyncBufferedReader(
     """
 
     def __init__(self, **kwargs: Any) -> None:
+        self._is_stopped: bool = False
         self.buffer: asyncio.Queue[Message]
 
         if "loop" in kwargs:
@@ -150,7 +151,6 @@ def __init__(self, **kwargs: Any) -> None:
                 return
 
         self.buffer = asyncio.Queue()
-        self._is_stopped: bool = False
 
     def on_message_received(self, msg: Message) -> None:
         """Append a message to the buffer.

doc/development.rst

@@ -52,7 +52,7 @@ The documentation can be built with::
 
 The linters can be run with::
 
-    pip install -e .[lint]
+    pip install --group lint -e .
     black --check can
     mypy can
     ruff check can

doc/doc-requirements.txt

@@ -22,6 +22,15 @@ sufficiently reliable for this interface to function properly.
 Please refer to the `Bus class documentation`_ below for configuration options and useful resources
 for specifying multicast IP addresses.
 
+Installation
+-------------------
+
+The Multicast IP Interface depends on the **msgpack** python library,
+which is automatically installed with the `multicast` extra keyword::
+
+       $ pip install python-can[multicast]
+
+
 Supported Platforms
 -------------------
 

doc/interfaces/udp_multicast.rst

@@ -11,7 +11,6 @@ dependencies = [
     "wrapt~=1.10",
     "packaging >= 23.1",
     "typing_extensions>=3.10.0.0",
-    "msgpack~=1.1.0",
 ]
 requires-python = ">=3.9"
 license = { text = "LGPL v3" }
@@ -58,20 +57,14 @@ repository = "https://github.com/hardbyte/python-can"
 changelog = "https://github.com/hardbyte/python-can/blob/develop/CHANGELOG.md"
 
 [project.optional-dependencies]
-lint = [
-    "pylint==3.2.*",
-    "ruff==0.11.12",
-    "black==25.1.*",
-    "mypy==1.16.*",
-]
 pywin32 = ["pywin32>=305; platform_system == 'Windows' and platform_python_implementation == 'CPython'"]
 seeedstudio = ["pyserial>=3.0"]
 serial = ["pyserial~=3.0"]
 neovi = ["filelock", "python-ics>=2.12"]
 canalystii = ["canalystii>=0.1.0"]
 cantact = ["cantact>=0.0.7"]
 cvector = ["python-can-cvector"]
-gs_usb = ["gs_usb>=0.2.1"]
+gs-usb = ["gs-usb>=0.2.1"]
 nixnet = ["nixnet>=0.3.2"]
 pcan = ["uptime~=3.0.1"]
 remote = ["python-can-remote"]
@@ -82,6 +75,32 @@ viewer = [
     "windows-curses; platform_system == 'Windows' and platform_python_implementation=='CPython'"
 ]
 mf4 = ["asammdf>=6.0.0"]
+multicast = ["msgpack~=1.1.0"]
+
+[dependency-groups]
+docs = [
+    "sphinx>=5.2.3",
+    "sphinxcontrib-programoutput",
+    "sphinx-inline-tabs",
+    "sphinx-copybutton",
+    "furo",
+]
+lint = [
+    "pylint==3.2.*",
+    "ruff==0.11.12",
+    "black==25.1.*",
+    "mypy==1.16.*",
+]
+test = [
+    "pytest==8.3.*",
+    "pytest-timeout==2.1.*",
+    "coveralls==3.3.1",
+    "pytest-cov==4.0.0",
+    "coverage==6.5.0",
+    "hypothesis~=6.35.0",
+    "pyserial~=3.5",
+    "parameterized~=0.8",
+]
 
 [tool.setuptools.dynamic]
 readme = { file = "README.rst" }

pyproject.toml

@@ -14,14 +14,12 @@
 import can
 from can import CanInterfaceNotImplementedError
 from can.interfaces.udp_multicast import UdpMulticastBus
+from can.interfaces.udp_multicast.utils import is_msgpack_installed
 
 from .config import (
     IS_CI,
     IS_OSX,
     IS_PYPY,
-    IS_TRAVIS,
-    IS_UNIX,
-    IS_WINDOWS,
     TEST_CAN_FD,
     TEST_INTERFACE_SOCKETCAN,
 )
@@ -307,6 +305,10 @@ class BasicTestSocketCan(Back2BackTestCase):
     IS_CI and IS_OSX,
     "not supported for macOS CI",
 )
+@unittest.skipUnless(
+    is_msgpack_installed(raise_exception=False),
+    "msgpack not installed",
+)
 class BasicTestUdpMulticastBusIPv4(Back2BackTestCase):
     INTERFACE_1 = "udp_multicast"
     CHANNEL_1 = UdpMulticastBus.DEFAULT_GROUP_IPv4
@@ -324,6 +326,10 @@ def test_unique_message_instances(self):
     IS_CI and IS_OSX,
     "not supported for macOS CI",
 )
+@unittest.skipUnless(
+    is_msgpack_installed(raise_exception=False),
+    "msgpack not installed",
+)
 class BasicTestUdpMulticastBusIPv6(Back2BackTestCase):
     HOST_LOCAL_MCAST_GROUP_IPv6 = "ff11:7079:7468:6f6e:6465:6d6f:6d63:6173"