general cleanups of the main modules

felixdivo · felixdivo · commit 8fe1b5a74d90 · 2018-02-22T17:47:55.000+01:00
diff --git a/can/CAN.py b/can/CAN.py
@@ -1,9 +1,13 @@
+#!/usr/bin/env python
+# coding: utf-8
+
 """
 This module was once the core of python-can, containing
 implementations of all the major classes in the library, now
-however all functionality has been refactored out. This api
+however all functionality has been refactored out. This API
 is left intact for version 2.0 to aide with migration.
 """
+
 from __future__ import absolute_import
 
 from can.message import Message
diff --git a/can/__init__.py b/can/__init__.py
@@ -1,6 +1,10 @@
+#!/usr/bin/env python
+# coding: utf-8
+
 """
 can is an object-orient Controller Area Network interface module.
 """
+
 from __future__ import absolute_import
 
 import logging
diff --git a/can/broadcastmanager.py b/can/broadcastmanager.py
@@ -1,7 +1,8 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
+# coding: utf-8
+
 """
 Exposes several methods for transmitting cyclic messages.
-20/09/13
 """
 
 import can
diff --git a/can/bus.py b/can/bus.py
@@ -1,15 +1,17 @@
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python
+# coding: utf-8
 
 """
 Contains the ABC bus implementation.
 """
 
 from __future__ import print_function, absolute_import
+
 import abc
 import logging
 import threading
-from can.broadcastmanager import ThreadBasedCyclicSendTask
 
+from can.broadcastmanager import ThreadBasedCyclicSendTask
 
 logger = logging.getLogger(__name__)
 
diff --git a/can/ctypesutil.py b/can/ctypesutil.py
@@ -1,6 +1,9 @@
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python
+# coding: utf-8
 
-" Common ctypes utils "
+"""
+This module contains common `ctypes` utils.
+"""
 
 import binascii
 import ctypes
@@ -11,6 +14,11 @@
 
 __all__ = ['CLibrary', 'HANDLE', 'PHANDLE']
 
+try:
+    _LibBase = ctypes.WinDLL
+except AttributeError:
+    _LibBase = ctypes.CDLL
+
 
 class LibraryMixin:
     def map_symbol(self, func_name, restype=None, argtypes=(), errcheck=None):
@@ -46,11 +54,6 @@ def map_symbol(self, func_name, restype=None, argtypes=(), errcheck=None):
         return symbol
 
 
-try:
-    _LibBase = ctypes.WinDLL
-except AttributeError:
-    _LibBase = ctypes.CDLL
-
 class CLibrary_Win32(_LibBase, LibraryMixin):
     " Basic ctypes.WinDLL derived class + LibraryMixin "
 
diff --git a/can/interface.py b/can/interface.py
@@ -1,3 +1,12 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+"""
+This module contains the base implementation of `can.Bus` as well
+as a list of all avalibale backends and some implemented
+CyclicSendTasks.
+"""
+
 from __future__ import absolute_import
 
 import can
diff --git a/can/listener.py b/can/listener.py
@@ -1,6 +1,15 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+"""
+This module contains the implementation of `can.Listener` and some readers.
+"""
+
 try:
+    # Python 3
     import queue
 except ImportError:
+    # Python 2
     import Queue as queue
 
 
diff --git a/can/logger.py b/can/logger.py
@@ -1,4 +1,6 @@
 #!/usr/bin/env python
+# coding: utf-8
+
 """
 logger.py logs CAN traffic to the terminal and to a file on disk.
 
@@ -14,7 +16,9 @@
 
 Dynamic Controls 2010
 """
+
 from __future__ import print_function
+
 import datetime
 import argparse
 import socket
diff --git a/can/message.py b/can/message.py
@@ -1,3 +1,10 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+"""
+This module contains the implementation of `can.Message`.
+"""
+
 import logging
 logger = logging.getLogger(__name__)
 
diff --git a/can/notifier.py b/can/notifier.py
@@ -1,3 +1,10 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+"""
+This module contains the implementation of `can.Notifier`.
+"""
+
 import threading
 import logging
 
diff --git a/can/player.py b/can/player.py
@@ -1,4 +1,6 @@
 #!/usr/bin/env python
+# coding: utf-8
+
 """
 Replays CAN traffic saved with can.logger back
 to a CAN bus.
diff --git a/can/util.py b/can/util.py
@@ -1,7 +1,10 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
+# coding: utf-8
+
 """
 Utilities and configuration file parsing.
 """
+
 from __future__ import absolute_import
 
 import can
