Merge 'master' into feature-asyncio

Author: sveinse

canopen/__init__.py

@@ -1,10 +1,10 @@
-from .network import Network, NodeScanner
-from .node import RemoteNode, LocalNode
-from .sdo import SdoCommunicationError, SdoAbortedError
-from .objectdictionary import import_od, export_od, ObjectDictionary, ObjectDictionaryError
-from .profiles.p402 import BaseNode402
+from canopen.network import Network, NodeScanner
+from canopen.node import RemoteNode, LocalNode
+from canopen.sdo import SdoCommunicationError, SdoAbortedError
+from canopen.objectdictionary import import_od, export_od, ObjectDictionary, ObjectDictionaryError
+from canopen.profiles.p402 import BaseNode402
 try:
-    from ._version import version as __version__
+    from canopen._version import version as __version__
 except ImportError:
     # package is not installed
     __version__ = "unknown"

canopen/emcy.py

@@ -5,18 +5,19 @@
 import asyncio
 import time
 from typing import Callable, List, Optional, TYPE_CHECKING
-from .async_guard import ensure_not_async
+
+from canopen.async_guard import ensure_not_async
 
 if TYPE_CHECKING:
-    from .network import Network
+    from canopen.network import Network
 
 # Error code, error register, vendor specific data
 EMCY_STRUCT = struct.Struct("<HB5s")
 
 logger = logging.getLogger(__name__)
 
 
-class EmcyConsumer(object):
+class EmcyConsumer:
 
     def __init__(self):
         #: Log of all received EMCYs for this node
@@ -114,7 +115,7 @@ def wait(
                     return emcy
 
 
-class EmcyProducer(object):
+class EmcyProducer:
 
     def __init__(self, cob_id: int):
         self.network: Optional[Network] = None

canopen/lss.py

@@ -8,10 +8,11 @@
     import queue
 except ImportError:
     import Queue as queue
-from .async_guard import ensure_not_async
+
+from canopen.async_guard import ensure_not_async
 
 if TYPE_CHECKING:
-    from .network import Network
+    from canopen.network import Network
 
 logger = logging.getLogger(__name__)
 
@@ -72,7 +73,7 @@
 ]
 
 
-class LssMaster(object):
+class LssMaster:
     """The Master of Layer Setting Services"""
 
     LSS_TX_COBID = 0x7E5

canopen/network.py

@@ -19,17 +19,18 @@
 except ImportError:
     # Do not fail if python-can is not installed
     can = None
-    Listener = object
     CanError = Exception
-
-from .node import RemoteNode, LocalNode
-from .sync import SyncProducer
-from .timestamp import TimeProducer
-from .nmt import NmtMaster
-from .lss import LssMaster
-from .objectdictionary.eds import import_from_node
-from .objectdictionary import ObjectDictionary
-from .async_guard import set_async_sentinel
+    class Listener:
+        """ Dummy listener """
+
+from canopen.node import RemoteNode, LocalNode
+from canopen.sync import SyncProducer
+from canopen.timestamp import TimeProducer
+from canopen.nmt import NmtMaster
+from canopen.lss import LssMaster
+from canopen.objectdictionary.eds import import_from_node
+from canopen.objectdictionary import ObjectDictionary
+from canopen.async_guard import set_async_sentinel
 
 logger = logging.getLogger(__name__)
 
@@ -41,8 +42,8 @@ class Network(MutableMapping):
 
     def __init__(
         self,
-        bus: Optional[BusABC] = None,
-        loop: Optional[AbstractEventLoop] = None
+        bus: can.BusABC | None = None,
+        loop: AbstractEventLoop | None = None
     ):
         """
         :param can.BusABC bus:
@@ -137,7 +138,8 @@ def connect(self, *args, **kwargs) -> "Network":
             # async mode. This enables the @ensure_not_async() decorator to
             # work. See async_guard.py
             set_async_sentinel(self.is_async)
-        self.bus = can.Bus(*args, **kwargs)
+        if self.bus is None:
+            self.bus = can.Bus(*args, **kwargs)
         logger.info("Connected to '%s'", self.bus.channel_info)
         self.notifier = can.Notifier(self.bus, self.listeners, 1, **kwargs_notifier)
         return self
@@ -307,6 +309,9 @@ def __getitem__(self, node_id: int) -> Union[RemoteNode, LocalNode]:
 
     def __setitem__(self, node_id: int, node: Union[RemoteNode, LocalNode]):
         assert node_id == node.id
+        if node_id in self.nodes:
+            # Remove old callbacks
+            self.nodes[node_id].remove_network()
         self.nodes[node_id] = node
         node.associate_network(self)
 
@@ -321,7 +326,7 @@ def __len__(self) -> int:
         return len(self.nodes)
 
 
-class PeriodicMessageTask(object):
+class PeriodicMessageTask:
     """
     Task object to transmit a message periodically using python-can's
     CyclicSendTask
@@ -399,8 +404,11 @@ def on_message_received(self, msg):
             # Exceptions in any callbaks should not affect CAN processing
             logger.error(str(e))
 
+    def stop(self) -> None:
+        """Override abstract base method to release any resources."""
+
 
-class NodeScanner(object):
+class NodeScanner:
     """Observes which nodes are present on the bus.
 
     Listens for the following messages:

canopen/nmt.py

@@ -6,11 +6,10 @@
 import asyncio
 from typing import Callable, Optional, TYPE_CHECKING
 
-from .network import CanError
-from .async_guard import ensure_not_async
+from canopen.async_guard import ensure_not_async
 
 if TYPE_CHECKING:
-    from .network import Network
+    from canopen.network import Network
 
 
 logger = logging.getLogger(__name__)
@@ -46,7 +45,7 @@
 }
 
 
-class NmtBase(object):
+class NmtBase:
     """
     Can set the state of the node it controls using NMT commands and monitor
     the current state using the heartbeat protocol.

canopen/node/__init__.py

@@ -1,2 +1,2 @@
-from .remote import RemoteNode
-from .local import LocalNode
+from canopen.node.remote import RemoteNode
+from canopen.node.local import LocalNode

canopen/node/base.py

@@ -1,12 +1,13 @@
 from __future__ import annotations
 from typing import TextIO, Union, Optional, TYPE_CHECKING
-from .. import objectdictionary
+
+from canopen.objectdictionary import ObjectDictionary, import_od
 
 if TYPE_CHECKING:
-    from ..network import Network
+    from canopen.network import Network
 
 
-class BaseNode(object):
+class BaseNode:
     """A CANopen node.
 
     :param node_id:
@@ -19,14 +20,12 @@ class BaseNode(object):
     def __init__(
         self,
         node_id: int,
-        object_dictionary: Union[objectdictionary.ObjectDictionary, str, TextIO],
+        object_dictionary: Union[ObjectDictionary, str, TextIO],
     ):
         self.network: Optional[Network] = None
 
-        if not isinstance(object_dictionary,
-                          objectdictionary.ObjectDictionary):
-            object_dictionary = objectdictionary.import_od(
-                object_dictionary, node_id)
+        if not isinstance(object_dictionary, ObjectDictionary):
+            object_dictionary = import_od(object_dictionary, node_id)
         self.object_dictionary = object_dictionary
 
         self.id = node_id or self.object_dictionary.node_id

canopen/node/local.py

@@ -2,15 +2,16 @@
 import logging
 from typing import Dict, Union, TYPE_CHECKING
 
-from .base import BaseNode
-from ..sdo import SdoServer, SdoAbortedError
-from ..pdo import PDO, TPDO, RPDO
-from ..nmt import NmtSlave
-from ..emcy import EmcyProducer
-from .. import objectdictionary
+from canopen.node.base import BaseNode
+from canopen.sdo import SdoServer, SdoAbortedError
+from canopen.pdo import PDO, TPDO, RPDO
+from canopen.nmt import NmtSlave
+from canopen.emcy import EmcyProducer
+from canopen.objectdictionary import ObjectDictionary
+from canopen import objectdictionary
 
 if TYPE_CHECKING:
-    from ..network import Network
+    from canopen.network import Network
 
 logger = logging.getLogger(__name__)
 
@@ -20,7 +21,7 @@ class LocalNode(BaseNode):
     def __init__(
         self,
         node_id: int,
-        object_dictionary: Union[objectdictionary.ObjectDictionary, str],
+        object_dictionary: Union[ObjectDictionary, str],
     ):
         super(LocalNode, self).__init__(node_id, object_dictionary)
 
@@ -132,7 +133,7 @@ def _find_object(self, index, subindex):
             # Index does not exist
             raise SdoAbortedError(0x06020000)
         obj = self.object_dictionary[index]
-        if not isinstance(obj, objectdictionary.Variable):
+        if not isinstance(obj, objectdictionary.ODVariable):
             # Group or array
             if subindex not in obj:
                 # Subindex does not exist

canopen/node/remote.py

@@ -2,19 +2,15 @@
 import logging
 from typing import Union, TextIO, TYPE_CHECKING
 
-from ..sdo import SdoClient
-from ..nmt import NmtMaster
-from ..emcy import EmcyConsumer
-from ..pdo import TPDO, RPDO, PDO
-from ..objectdictionary import Record, Array, Variable, List
-from .base import BaseNode
-
-import canopen
-
-from canopen import objectdictionary
+from canopen.sdo import SdoClient, SdoCommunicationError, SdoAbortedError
+from canopen.nmt import NmtMaster
+from canopen.emcy import EmcyConsumer
+from canopen.pdo import TPDO, RPDO, PDO
+from canopen.objectdictionary import ODRecord, ODArray, ODVariable, ObjectDictionary
+from canopen.node.base import BaseNode
 
 if TYPE_CHECKING:
-    from ..network import Network
+    from canopen.network import Network
 
 logger = logging.getLogger(__name__)
 
@@ -35,7 +31,7 @@ class RemoteNode(BaseNode):
     def __init__(
         self,
         node_id: int,
-        object_dictionary: Union[objectdictionary.ObjectDictionary, str, TextIO],
+        object_dictionary: Union[ObjectDictionary, str, TextIO],
         load_od: bool = False,
     ):
         super(RemoteNode, self).__init__(node_id, object_dictionary)
@@ -160,9 +156,9 @@ def __load_configuration_helper(self, index, subindex, name, value):
                     index=index,
                     name=name,
                     value=value)))
-        except canopen.SdoCommunicationError as e:
+        except SdoCommunicationError as e:
             logger.warning(str(e))
-        except canopen.SdoAbortedError as e:
+        except SdoAbortedError as e:
             # WORKAROUND for broken implementations: the SDO is set but the error
             # "Attempt to write a read-only object" is raised any way.
             if e.code != 0x06010002:
@@ -174,10 +170,10 @@ def __load_configuration_helper(self, index, subindex, name, value):
     def load_configuration(self):
         ''' Load the configuration of the node from the object dictionary.'''
         for obj in self.object_dictionary.values():
-            if isinstance(obj, Record) or isinstance(obj, Array):
+            if isinstance(obj, ODRecord) or isinstance(obj, ODArray):
                 for subobj in obj.values():
-                    if isinstance(subobj, Variable) and subobj.writable and (subobj.value is not None):
+                    if isinstance(subobj, ODVariable) and subobj.writable and (subobj.value is not None):
                         self.__load_configuration_helper(subobj.index, subobj.subindex, subobj.name, subobj.value)
-            elif isinstance(obj, Variable) and obj.writable and (obj.value is not None):
+            elif isinstance(obj, ODVariable) and obj.writable and (obj.value is not None):
                 self.__load_configuration_helper(obj.index, None, obj.name, obj.value)
         self.pdo.read()  # reads the new configuration from the driver