Merge branch 'develop' into etas

Author: felixdivo

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,34 +7,35 @@ assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+### Describe the bug
+<!-- A clear and concise description of what the bug is. -->
 
-**To Reproduce**
-Steps to reproduce the behavior (please add longer code examples below):
 
+### To Reproduce
+<!-- Steps to reproduce the behavior. Please add longer code examples below. -->
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
 
+### Expected behavior
+<!-- A clear and concise description of what you expected to happen. -->
 
-**Additional context**
 
-OS-version:
+### Additional context
+
+OS and version:
 Python version:
 python-can version:
-python-can interface/s:
+python-can interface/s (if applicable):
 
 <!-- Add any other context about the problem here. -->
-  
+
 <details><summary>Traceback and logs</summary>
-<!-- have to be followed by an empty line! -->
-  
+<!-- Has to be followed by an empty line! -->
+
 <!-- More details such as a minimal script to demonstrate the bug, relevant logs and any tracebacks go here. -->
-  
+
 <!-- Code examples can be included: -->
 ```python
 def func():
-    return 'hello, world!'
+    return "hello, world!"
 ```
 </details>

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,14 +7,14 @@ assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+### Is your feature request related to a problem? Please describe.
+<!-- A clear and concise description of what the problem is. Ex.: I'm always frustrated when [...] -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+### Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+### Additional context
+<!-- Add any other context or screenshots about the feature request here. -->

.mergify.yml

@@ -1,7 +1,8 @@
 queue_rules:
   - name: default
     conditions:
-      - "status-success=test,format"  # "GitHub Actions works slightly differently [...], only the job name is used."
+      - "status-success=test"  # "GitHub Actions works slightly differently [...], only the job name is used."
+      - "status-success=format"
 
 pull_request_rules:
   - name: Automatic merge passing PR on up to date branch with approving CR
@@ -10,22 +11,13 @@ pull_request_rules:
       - "#approved-reviews-by>=1"
       - "#review-requested=0"
       - "#changes-requested-reviews-by=0"
-      - "status-success=test,format"
+      - "status-success=test"
+      - "status-success=format"
       - "label!=work-in-progress"
     actions:
       queue:
         name: default
 
-  - name: Request Brian to review changes to the core API
-    conditions:
-      - "-files~=^can/interfaces/$"
-      - "-closed"
-      - "author!=hardbyte"
-    actions:
-      request_reviews:
-        users:
-          - hardbyte
-
   - name: Delete head branch after merge
     conditions:
       - merged

CONTRIBUTORS.txt

@@ -28,4 +28,5 @@ Jan Goeteyn
 "ykzheng" <[email protected]>
 Lear Corporation
 Nick Black <[email protected]>
+Francisco Javier Burgos Macia
 Felix Nieuwenhuizen <[email protected]>

README.rst

@@ -18,7 +18,7 @@ python-can
    :alt: Downloads on PePy
 
 .. |downloads_monthly| image:: https://pepy.tech/badge/python-can/month
-   :target: https://pepy.tech/project/python-can/month
+   :target: https://pepy.tech/project/python-can
    :alt: Monthly downloads on PePy
 
 .. |formatter| image:: https://img.shields.io/badge/code%20style-black-000000.svg

can/__init__.py

@@ -12,7 +12,7 @@
 
 log = logging.getLogger("can")
 
-rc: Dict[str, Any] = dict()
+rc: Dict[str, Any] = {}
 
 from .listener import Listener, BufferedReader, RedirectReader, AsyncBufferedReader
 
@@ -25,7 +25,7 @@
 )
 
 from .io import Logger, SizedRotatingLogger, Printer, LogReader, MessageSync
-from .io import ASCWriter, ASCReader
+from .io import ASCWriter, ASCReader, GzipASCWriter, GzipASCReader
 from .io import BLFReader, BLFWriter
 from .io import CanutilsLogReader, CanutilsLogWriter
 from .io import CSVWriter, CSVReader

can/bus.py

@@ -411,6 +411,7 @@ def shutdown(self) -> None:
         Called to carry out any interface specific cleanup required
         in shutting down a bus.
         """
+        self.stop_all_periodic_tasks()
 
     def __enter__(self):
         return self

can/exceptions.py

@@ -15,7 +15,11 @@
 :class:`ValueError`. This should always be documented for the function at hand.
 """
 
+
+from contextlib import contextmanager
+
 from typing import Optional
+from typing import Type
 
 
 class CanError(Exception):
@@ -96,3 +100,18 @@ class CanTimeoutError(CanError, TimeoutError):
       - Some message could not be sent after the timeout elapsed
       - No message was read within the given time
     """
+
+
+@contextmanager
+def error_check(
+    error_message: Optional[str] = None,
+    exception_type: Type[CanError] = CanOperationError,
+) -> None:
+    """Catches any exceptions and turns them into the new type while preserving the stack trace."""
+    try:
+        yield
+    except Exception as error:
+        if error_message is None:
+            raise exception_type(str(error)) from error
+        else:
+            raise exception_type(error_message) from error

can/interfaces/__init__.py

@@ -26,6 +26,7 @@
     "nixnet": ("can.interfaces.nixnet", "NiXNETcanBus"),
     "neousys": ("can.interfaces.neousys", "NeousysBus"),
     "etas": ("can.interfaces.etas", "EtasBus"),
+    "socketcand": ("can.interfaces.socketcand", "SocketCanDaemonBus"),
 }
 
 try:

can/interfaces/canalystii.py

@@ -53,7 +53,7 @@ def __init__(
         elif isinstance(channel, int):
             self.channels = [channel]
         else:  # Sequence[int]
-            self.channels = [c for c in channel]
+            self.channels = list(channel)
 
         self.rx_queue = collections.deque(
             maxlen=rx_queue_size
@@ -204,6 +204,7 @@ def flush_tx_buffer(self, channel: Optional[int] = None) -> None:
                 self.device.flush_tx_buffer(ch, float("infinity"))
 
     def shutdown(self) -> None:
+        super().shutdown()
         for channel in self.channels:
             self.device.stop(channel)
         self.device = None