Address blf GzipFile negative seek error

.github/workflows/build.yml

@@ -13,21 +13,17 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         experimental: [false]
-        python-version: [
-          "3.7",
-          "3.8",
-          "3.9",
-          "3.10",
-          "3.11",
-          "pypy-3.7",
-          "pypy-3.8",
-          "pypy-3.9",
-        ]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "pypy-3.7", "pypy-3.8"]
+        include:
+          # Only test on a single configuration while there are just pre-releases
+          - os: ubuntu-latest
+            experimental: true
+            python-version:  "3.11.0-alpha - 3.11.0"
       fail-fast: false
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -38,16 +34,16 @@ jobs:
       run: |
         tox -e gh
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v2
       with:
         fail_ci_if_error: true
 
   static-code-analysis:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v2
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v3
       with:
         python-version: "3.10"
     - name: Install dependencies
@@ -67,9 +63,6 @@ jobs:
     - name: mypy 3.10
       run: |
         mypy --python-version 3.10 .
-    - name: mypy 3.11
-      run: |
-        mypy --python-version 3.11 .
     - name: pylint
       run: |
         pylint --rcfile=.pylintrc \
@@ -82,9 +75,9 @@ jobs:
   format:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v2
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v3
       with:
         python-version: "3.10"
     - name: Install dependencies
@@ -94,38 +87,3 @@ jobs:
     - name: Code Format Check with Black
       run: |
         black --check --verbose .
-
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.10"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -e .[canalystii,gs_usb]
-        pip install -r doc/doc-requirements.txt
-    - name: Build documentation
-      run: |
-        python -m sphinx -an doc build
-    - uses: actions/upload-artifact@v3
-      with:
-        name: sphinx-out
-        path: ./build/
-        retention-days: 5
-
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-      - name: Build wheel and sdist
-        run: pipx run build
-      - name: Check build artifacts
-        run: pipx run twine check --strict dist/*

.github/workflows/format-code.yml

@@ -9,9 +9,9 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v2
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v2
       with:
         python-version: "3.10"
     - name: Install dependencies
@@ -22,7 +22,7 @@ jobs:
       run: |
         black --verbose .
     - name: Commit Formated Code
-      uses: EndBug/add-and-commit@v9
+      uses: EndBug/add-and-commit@v7
       with:
         message: "Format code with black"
         # Ref https://git-scm.com/docs/git-add#_examples

can/broadcastmanager.py

@@ -39,7 +39,7 @@ class CyclicTask(abc.ABC):
     def stop(self) -> None:
         """Cancel this periodic task.
 
-        :raises ~can.exceptions.CanError:
+        :raises can.CanError:
             If stop is called on an already stopped task.
         """
 

can/bus.py

@@ -66,10 +66,8 @@ def __init__(
             Any backend dependent configurations are passed in this dictionary
 
         :raises ValueError: If parameters are out of range
-        :raises ~can.exceptions.CanInterfaceNotImplementedError:
-            If the driver cannot be accessed
-        :raises ~can.exceptions.CanInitializationError:
-            If the bus cannot be initialized
+        :raises can.CanInterfaceNotImplementedError: If the driver cannot be accessed
+        :raises can.CanInitializationError: If the bus cannot be initialized
         """
         self._periodic_tasks: List[_SelfRemovingCyclicTask] = []
         self.set_filters(can_filters)
@@ -83,11 +81,9 @@ def recv(self, timeout: Optional[float] = None) -> Optional[Message]:
         :param timeout:
             seconds to wait for a message or None to wait indefinitely
 
-        :return:
-            :obj:`None` on timeout or a :class:`~can.Message` object.
+        :return: ``None`` on timeout or a :class:`Message` object.
 
-        :raises ~can.exceptions.CanOperationError:
-            If an error occurred while reading
+        :raises can.CanOperationError: If an error occurred while reading
         """
         start = time()
         time_left = timeout
@@ -152,8 +148,7 @@ def _recv_internal(
             2.  a bool that is True if message filtering has already
                 been done and else False
 
-        :raises ~can.exceptions.CanOperationError:
-            If an error occurred while reading
+        :raises can.CanOperationError: If an error occurred while reading
         :raises NotImplementedError:
             if the bus provides it's own :meth:`~can.BusABC.recv`
             implementation (legacy implementation)
@@ -176,8 +171,7 @@ def send(self, msg: Message, timeout: Optional[float] = None) -> None:
             Might not be supported by all interfaces.
             None blocks indefinitely.
 
-        :raises ~can.exceptions.CanOperationError:
-            If an error occurred while sending
+        :raises can.CanOperationError: If an error occurred while sending
         """
         raise NotImplementedError("Trying to write to a readonly bus?")
 
@@ -195,8 +189,8 @@ def send_periodic(
         - the (optional) duration expires
         - the Bus instance goes out of scope
         - the Bus instance is shutdown
-        - :meth:`stop_all_periodic_tasks` is called
-        - the task's :meth:`~can.broadcastmanager.CyclicTask.stop` method is called.
+        - :meth:`BusABC.stop_all_periodic_tasks()` is called
+        - the task's :meth:`CyclicTask.stop()` method is called.
 
         :param msgs:
             Message(s) to transmit
@@ -210,8 +204,7 @@ def send_periodic(
             Disable to instead manage tasks manually.
         :return:
             A started task instance. Note the task can be stopped (and depending on
-            the backend modified) by calling the task's
-            :meth:`~can.broadcastmanager.CyclicTask.stop` method.
+            the backend modified) by calling the task's :meth:`stop` method.
 
         .. note::
 
@@ -281,8 +274,8 @@ def _send_periodic_internal(
             no duration is provided, the task will continue indefinitely.
         :return:
             A started task instance. Note the task can be stopped (and
-            depending on the backend modified) by calling the
-            :meth:`~can.broadcastmanager.CyclicTask.stop` method.
+            depending on the backend modified) by calling the :meth:`stop`
+            method.
         """
         if not hasattr(self, "_lock_send_periodic"):
             # Create a send lock for this bus, but not for buses which override this method
@@ -295,7 +288,7 @@ def _send_periodic_internal(
         return task
 
     def stop_all_periodic_tasks(self, remove_tasks: bool = True) -> None:
-        """Stop sending any messages that were started using :meth:`send_periodic`.
+        """Stop sending any messages that were started using **bus.send_periodic**.
 
         .. note::
             The result is undefined if a single task throws an exception while being stopped.

can/exceptions.py

@@ -74,7 +74,7 @@ class CanInitializationError(CanError):
     """Indicates an error the occurred while initializing a :class:`can.BusABC`.
 
     If initialization fails due to a driver or platform missing/being unsupported,
-    a :exc:`~can.exceptions.CanInterfaceNotImplementedError` is raised instead.
+    a :class:`can.CanInterfaceNotImplementedError` is raised instead.
     If initialization fails due to a value being out of range, a :class:`ValueError`
     is raised.
 

can/interface.py

@@ -60,44 +60,37 @@ class Bus(BusABC):  # pylint: disable=abstract-method
 
     Instantiates a CAN Bus of the given ``interface``, falls back to reading a
     configuration file from default locations.
+    """
 
-    :param channel:
-        Channel identification. Expected type is backend dependent.
-        Set to ``None`` to let it be resolved automatically from the default
-        :ref:`configuration`.
+    @staticmethod
+    def __new__(  # type: ignore  # pylint: disable=keyword-arg-before-vararg
+        cls: Any, channel: Optional[Channel] = None, *args: Any, **kwargs: Any
+    ) -> BusABC:
+        """
+        Takes the same arguments as :class:`can.BusABC.__init__`.
+        Some might have a special meaning, see below.
 
-    :param interface:
-        See :ref:`interface names` for a list of supported interfaces.
-        Set to ``None`` to let it be resolved automatically from the default
-        :ref:`configuration`.
+        :param channel:
+            Set to ``None`` to let it be resolved automatically from the default
+            configuration. That might fail, see below.
 
-    :param args:
-        ``interface`` specific positional arguments.
+            Expected type is backend dependent.
 
-    :param kwargs:
-        ``interface`` specific keyword arguments.
+        :param dict kwargs:
+            Should contain an ``interface`` key with a valid interface name. If not,
+            it is completed using :meth:`can.util.load_config`.
 
-    :raises ~can.exceptions.CanInterfaceNotImplementedError:
-        if the ``interface`` isn't recognized or cannot be loaded
+        :raises: can.CanInterfaceNotImplementedError
+            if the ``interface`` isn't recognized or cannot be loaded
 
-    :raises ~can.exceptions.CanInitializationError:
-        if the bus cannot be instantiated
+        :raises: can.CanInitializationError
+            if the bus cannot be instantiated
 
-    :raises ValueError:
-        if the ``channel`` could not be determined
-    """
+        :raises: ValueError
+            if the ``channel`` could not be determined
+        """
 
-    @staticmethod
-    def __new__(  # type: ignore  # pylint: disable=keyword-arg-before-vararg
-        cls: Any,
-        channel: Optional[Channel] = None,
-        interface: Optional[str] = None,
-        *args: Any,
-        **kwargs: Any,
-    ) -> BusABC:
         # figure out the rest of the configuration; this might raise an error
-        if interface is not None:
-            kwargs["interface"] = interface
         if channel is not None:
             kwargs["channel"] = channel
         if "context" in kwargs:

can/interfaces/cantact.py

@@ -59,7 +59,7 @@ def __init__(
             Bitrate in bits/s
         :param bool monitor:
             If true, operate in listen-only monitoring mode
-        :param BitTiming bit_timing:
+        :param BitTiming bit_timing
             Optional BitTiming to use for custom bit timing setting. Overrides bitrate if not None.
         """
 

can/interfaces/ixxat/canlib_vcinpl.py

@@ -372,8 +372,10 @@ class IXXATBus(BusABC):
     .. warning::
 
         This interface does implement efficient filtering of messages, but
-        the filters have to be set in ``__init__`` using the ``can_filters`` parameter.
-        Using :meth:`~can.BusABC.set_filters` does not work.
+        the filters have to be set in :meth:`~can.interfaces.ixxat.IXXATBus.__init__`
+        using the ``can_filters`` parameter. Using :meth:`~can.interfaces.ixxat.IXXATBus.set_filters`
+        does not work.
+
     """
 
     CHANNEL_BITRATES = {

can/interfaces/ixxat/canlib_vcinpl2.py

@@ -411,8 +411,9 @@ class IXXATBus(BusABC):
     .. warning::
 
         This interface does implement efficient filtering of messages, but
-        the filters have to be set in ``__init__`` using the ``can_filters`` parameter.
-        Using :meth:`~can.BusABC.set_filters` does not work.
+        the filters have to be set in :meth:`~can.interfaces.ixxat.IXXATBus.__init__`
+        using the ``can_filters`` parameter. Using :meth:`~can.interfaces.ixxat.IXXATBus.set_filters`
+        does not work.
 
     """
 

can/interfaces/kvaser/canlib.py

@@ -657,7 +657,7 @@ def shutdown(self):
         canBusOff(self._write_handle)
         canClose(self._write_handle)
 
-    def get_stats(self) -> structures.BusStatistics:
+    def get_stats(self):
         """Retrieves the bus statistics.
 
         Use like so:
@@ -667,6 +667,7 @@ def get_stats(self) -> structures.BusStatistics:
         std_data: 0, std_remote: 0, ext_data: 0, ext_remote: 0, err_frame: 0, bus_load: 0.0%, overruns: 0
 
         :returns: bus statistics.
+        :rtype: can.interfaces.kvaser.structures.BusStatistics
         """
         canRequestBusStatistics(self._write_handle)
         stats = structures.BusStatistics()