Move helper functions in proper utils modules

pierreluctg · pierreluctg · commit e05024c9db8d · 2020-06-18T08:30:36.000-04:00
diff --git a/can/ctypesutil.py b/can/ctypesutil.py
@@ -101,3 +101,8 @@ class HANDLE(ctypes.c_void_p):
 
 
 PHANDLE = ctypes.POINTER(HANDLE)
+
+
+def arg_to_c_uint(value):
+    """Convert a number or string to an C unsigned integer"""
+    return ctypes.c_uint(int(value))
diff --git a/can/interfaces/vector/canlib.py b/can/interfaces/vector/canlib.py
@@ -7,14 +7,13 @@
 # Import Standard Python Modules
 # ==============================
 import ctypes
-import functools
 import logging
 import time
 import os
-import warnings
 
 from typing import Optional, Tuple
 
+
 try:
     # Try builtin Python 3 Windows API
     from _winapi import WaitForSingleObject, INFINITE
@@ -33,7 +32,8 @@
 # Import Modules
 # ==============
 from can import BusABC, Message
-from can.util import len2dlc, dlc2len
+from can.ctypesutil import arg_to_c_uint
+from can.util import len2dlc, dlc2len, deprecated_args_alias
 from .exceptions import VectorError
 
 # Define Module Logger
@@ -52,37 +52,6 @@
     LOG.warning("Could not import vxlapi: %s", exc)
 
 
-def deprecated_args_alias(**aliases):
-    def deco(f):
-        @functools.wraps(f)
-        def wrapper(*args, **kwargs):
-            rename_kwargs(f.__name__, kwargs, aliases)
-            return f(*args, **kwargs)
-
-        return wrapper
-
-    return deco
-
-
-def rename_kwargs(func_name, kwargs, aliases):
-    for alias, new in aliases.items():
-        if alias in kwargs:
-            warnings.warn(
-                "{} is deprecated; use {}".format(alias, new), DeprecationWarning
-            )
-            if new in kwargs:
-                raise TypeError(
-                    "{} received both {} (deprecated) and {}".format(
-                        func_name, alias, new
-                    )
-                )
-            kwargs[new] = kwargs.pop(alias)
-
-
-def arg_to_c_uint(value):
-    return ctypes.c_uint(int(value))
-
-
 class VectorBus(BusABC):
     """The CAN Bus implemented for the Vector interface."""
 
diff --git a/can/util.py b/can/util.py
@@ -1,7 +1,8 @@
 """
 Utilities and configuration file parsing.
 """
-
+import functools
+import warnings
 from typing import Dict, Optional, Union
 
 from can import typechecking
@@ -279,6 +280,38 @@ def channel2int(channel: Optional[Union[typechecking.Channel]]) -> Optional[int]
     return None
 
 
+def deprecated_args_alias(**aliases):
+    """Allows to rename/deprecate a function kwarg(s) and
+    have the deprecated kwarg(s) set as alias(es)
+    """
+
+    def deco(f):
+        @functools.wraps(f)
+        def wrapper(*args, **kwargs):
+            rename_kwargs(f.__name__, kwargs, aliases)
+            return f(*args, **kwargs)
+
+        return wrapper
+
+    return deco
+
+
+def rename_kwargs(func_name, kwargs, aliases):
+    """Helper function for `deprecated_args_alias`"""
+    for alias, new in aliases.items():
+        if alias in kwargs:
+            warnings.warn(
+                "{} is deprecated; use {}".format(alias, new), DeprecationWarning
+            )
+            if new in kwargs:
+                raise TypeError(
+                    "{} received both {} (deprecated) and {}".format(
+                        func_name, alias, new
+                    )
+                )
+            kwargs[new] = kwargs.pop(alias)
+
+
 if __name__ == "__main__":
     print("Searching for configuration named:")
     print("\n".join(CONFIG_FILES))
