move scripts back to the old location in python-can/can/*

felixdivo · felixdivo · commit 924e5ed94b9c · 2018-09-05T19:05:26.000+02:00
diff --git a/can/__init__.py b/can/__init__.py
@@ -47,5 +47,3 @@ class CanError(IOError):
     ModifiableCyclicTaskABC, \
     MultiRateCyclicSendTaskABC, \
     RestartableCyclicTaskABC
-
-from .scripts import *
diff --git a/can/logger.py b/can/logger.py
diff --git a/can/player.py b/can/player.py
diff --git a/can/scripts/__init__.py b/can/scripts/__init__.py
diff --git a/doc/scripts.rst b/doc/scripts.rst
@@ -3,9 +3,7 @@ Scripts
 
 The following modules are callable from python-can.
 
-They can either be called by for example ``python -m can.logger`` or ``can_logger.py`` (if installed by pip).
-The scripts are internally placed in the module ``can.scripts.*``,
-so they could also be launched by ``python -m can.scripts.logger``.
+They can be called for example by ``python -m can.logger`` or ``can_logger.py`` (if installed using pip).
 
 
 can.logger
diff --git a/scripts/can_logger.py b/scripts/can_logger.py
@@ -2,12 +2,12 @@
 # coding: utf-8
 
 """
-See :mod:`can.scripts.logger`.
+See :mod:`can.logger`.
 """
 
 from __future__ import absolute_import
 
-from can.scripts.logger import main
+from can.logger import main
 
 
 if __name__ == "__main__":
diff --git a/scripts/can_player.py b/scripts/can_player.py
@@ -2,12 +2,12 @@
 # coding: utf-8
 
 """
-See :mod:`can.scripts.player`.
+See :mod:`can.player`.
 """
 
 from __future__ import absolute_import
 
-from can.scripts.player import main
+from can.player import main
 
 
 if __name__ == "__main__":
diff --git a/setup.cfg b/setup.cfg
@@ -15,12 +15,10 @@ branch = False
 omit =
     # legacy code
     can/CAN.py
-    can/logger.py
-    can/player.py
 
 [coverage:report]
 # two digits after decimal point
-precision = 2
+precision = 3
 show_missing = True
 exclude_lines =
     # Have to re-enable the standard pragma, see https://coverage.readthedocs.io/en/coverage-4.5.1a/config.html#syntax
diff --git a/test/test_scripts.py b/test/test_scripts.py
@@ -19,17 +19,20 @@ class CanScriptTest(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        # clean out the argument list
+        # clean up the argument list so the call to the main() functions
+        # in test_does_not_crash() succeeds
         sys.argv = sys.argv[:1]
 
+    #: this is override by the subclasses
     __test__ = False
 
     __metaclass__ = ABCMeta
 
     #@unittest.skipUnless(IS_UNIX, "commands may only be available on unix")
     def test_do_commands_exist(self):
         """This test calls each scripts once and veifies that the help
-        can be read without any errors.
+        can be read without any other errors, like the script not being
+        found.
         """
         for command in self._commands():
             try:
@@ -38,6 +41,9 @@ def test_do_commands_exist(self):
                 self.assertEqual(e.returncode, errno.EINVAL,
                     'Calling "{}" failed (exit code was {} and not EINVAL/22):\n{}'
                     .format(command, e.returncode, e.output))
+            else:
+                # this is also okay
+                pass
 
     def test_does_not_crash(self):
         # test import
@@ -50,10 +56,15 @@ def test_does_not_crash(self):
 
     @abstractmethod
     def _commands(self):
+        """Returns an Iterable of commands that should "succeed", meaning they exit
+        normally (exit code 0) or with the exit code for invalid arguments: EINVAL/22.
+        """
         pass
 
     @abstractmethod
     def _import(self):
+        """Returns the modue of the script that has a main() function.
+        """
         pass
 
 
@@ -65,7 +76,6 @@ def _commands(self):
         return (
             "can_logger.py --help",
             "python -m can.logger --help",
-            "python -m can.scripts.logger --help"
         )
 
     def _import(self):
@@ -81,7 +91,6 @@ def _commands(self):
         return (
             "can_player.py --help",
             "python -m can.player --help",
-            "python -m can.scripts.player --help"
         )
 
     def _import(self):
