add pycodestyle and fix issues.

Author: schettino72

Diff for: .github/workflows/ci.yml

@@ -46,6 +46,7 @@ jobs:
       - run: pip freeze
       - run: pip check
       - run: doit pyflakes
+      - run: doit codestyle
       - run: py.test -vv ${{ matrix.pytest-args }}
       - if: ${{ matrix.os == 'ubuntu' && matrix.python-version == '3.8' }}
         run: |

Diff for: dev_requirements.txt

@@ -3,7 +3,8 @@
 
 setuptools # for plugins
 pyflakes
-pytest>=5.4.1
-coverage>=4.0,<5
+pycodestyle
+pytest>=7.1.0
+coverage>=6.0
 doit-py>=0.4.0
 tomli; python_version<"3.11"

Diff for: dodo.py

@@ -134,3 +134,9 @@ def task_package():
     yield pkg.manifest_git()
     yield pkg.sdist()
     # yield pkg.sdist_upload()
+
+
+def task_codestyle():
+    return {
+        'actions': ['pycodestyle doit'],
+    }

Diff for: doit/__main__.py

@@ -1,5 +1,5 @@
 # lazy way to ignore coverage in this file
-if True: # pragma: no cover
+if True:  # pragma: no cover
     def main():
         import sys
 

Diff for: doit/action.py

@@ -2,7 +2,8 @@
 """
 
 import os
-import subprocess, sys
+import sys
+import subprocess
 import io
 from io import StringIO
 import inspect
@@ -21,6 +22,7 @@ def normalize_callable(ref):
         return list(ref)
     return [ref, (), {}]
 
+
 # Actions
 class BaseAction(object):
     """Base class for all actions"""
@@ -45,15 +47,15 @@ def _prepare_kwargs(task, func, args, kwargs):
 
         func_sig = inspect.signature(func)
         sig_params = func_sig.parameters.values()
-        func_has_kwargs = any(p.kind==p.VAR_KEYWORD for p in sig_params)
+        func_has_kwargs = any(p.kind == p.VAR_KEYWORD for p in sig_params)
 
         # use task meta information as extra_args
         meta_args = {
             'task': lambda: task,
             'targets': lambda: list(task.targets),
             'dependencies': lambda: list(task.file_dep),
             'changed': lambda: list(task.dep_changed),
-            }
+        }
 
         # start with dict passed together on action definition
         kwargs = kwargs.copy()
@@ -67,17 +69,16 @@ def _prepare_kwargs(task, func, args, kwargs):
 
                 # it is forbidden to use default values for this arguments
                 # because the user might be unaware of this magic.
-                if (sig_param.default!=sig_param.empty):
-                    msg = ("Task %s, action %s(): The argument '%s' is not "
-                           "allowed  to have a default value (reserved by doit)"
-                           % (task.name, func.__name__, key))
+                if (sig_param.default != sig_param.empty):
+                    msg = (f"Task {task.name}, action {func.__name__}():"
+                           f"The argument '{key}' is not allowed to have "
+                           "a default value (reserved by doit)")
                     raise InvalidTask(msg)
 
                 # if value not taken from position parameter
                 if key not in bound_args.arguments:
                     kwargs[key] = meta_args[key]()
 
-
         # add tasks parameter options
         opt_args = dict(task.options)
         if task.pos_arg is not None:
@@ -120,7 +121,7 @@ class CmdAction(BaseAction):
 
     def __init__(self, action, task=None, save_out=None, shell=True,
                  encoding='utf-8', decode_error='replace', buffering=0,
-                 **pkwargs): #pylint: disable=W0231
+                 **pkwargs):  # pylint: disable=W0231
         '''
         :ivar buffering: (int) stdout/stderr buffering.
                Not to be confused with subprocess buffering
@@ -168,7 +169,7 @@ def _print_process_output(self, process, input_, capture, realtime):
         while True:
             try:
                 line = read().decode(self.encoding, self.decode_error)
-            except:
+            except Exception:
                 # happens when fails to decoded input
                 process.terminate()
                 input_.read()
@@ -178,7 +179,7 @@ def _print_process_output(self, process, input_, capture, realtime):
             capture.write(line)
             if realtime:
                 realtime.write(line)
-                realtime.flush() # required if on byte buffering mode
+                realtime.flush()  # required if on byte buffering mode
 
 
     def execute(self, out=None, err=None):
@@ -223,7 +224,7 @@ def execute(self, out=None, err=None):
         process = subprocess.Popen(
             action,
             shell=self.shell,
-            #bufsize=2, # ??? no effect use PYTHONUNBUFFERED instead
+            # bufsize=2, # ??? no effect use PYTHONUNBUFFERED instead
             stdout=p_out,
             stderr=p_err,
             env=env,
@@ -283,14 +284,14 @@ def expand_action(self):
                 elif isinstance(element, PurePath):
                     action.append(str(element))
                 else:
-                    msg = ("%s. CmdAction element must be a str " +
+                    msg = ("%s. CmdAction element must be a str "
                            "or Path from pathlib. Got '%r' (%s)")
                     raise InvalidTask(
                         msg % (self.task.name, element, type(element)))
             return action
 
         subs_dict = {
-            'targets' : " ".join(self.task.targets),
+            'targets': " ".join(self.task.targets),
             'dependencies': " ".join(self.task.file_dep),
         }
 
@@ -330,12 +331,13 @@ def __repr__(self):
 class Writer(object):
     """Write to N streams.
 
-    This is used on python-actions to allow the stream to be output to terminal and captured at the same time.
+    This is used on python-actions to allow the stream to be output to terminal
+    and captured at the same time.
     """
     def __init__(self, *writers):
         """@param writers - file stream like objects"""
         self.writers = []
-        self.orig_stream = None # The original stream terminal/file
+        self.orig_stream = None  # The original stream terminal/file
         for writer in writers:
             self.add_writer(writer)
 
@@ -380,7 +382,7 @@ class PythonAction(BaseAction):
     pm_pdb = False
 
     def __init__(self, py_callable, args=None, kwargs=None, task=None):
-        #pylint: disable=W0231
+        # pylint: disable=W0231
         self.py_callable = py_callable
         self.task = task
         self.out = None
@@ -458,7 +460,7 @@ def execute(self, out=None, err=None):
         try:
             returned_value = self.py_callable(*self.args, **kwargs)
         except Exception as exception:
-            if self.pm_pdb: # pragma: no cover
+            if self.pm_pdb:  # pragma: no cover
                 # start post-mortem debugger
                 deb = pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__)
                 deb.reset()
@@ -495,10 +497,10 @@ def execute(self, out=None, err=None):
 
     def __str__(self):
         # get object description excluding runtime memory address
-        return "Python: %s"% str(self.py_callable)[1:].split(' at ')[0]
+        return "Python: %s" % str(self.py_callable)[1:].split(' at ')[0]
 
     def __repr__(self):
-        return "<PythonAction: '%s'>"% (repr(self.py_callable))
+        return "<PythonAction: '%s'>" % (repr(self.py_callable))
 
 
 def create_action(action, task_ref, param_name):
@@ -526,7 +528,7 @@ def create_action(action, task_ref, param_name):
             msg = "Task '{}': invalid '{}' tuple length. got: {!r} {}".format(
                 task_ref.name, param_name, action, type(action))
             raise InvalidTask(msg)
-        py_callable, args, kwargs = (list(action) + [None]*(3-len(action)))
+        py_callable, args, kwargs = (list(action) + [None] * (3 - len(action)))
         return PythonAction(py_callable, args, kwargs, task_ref)
 
     if hasattr(action, '__call__'):

Diff for: doit/api.py

@@ -1,4 +1,9 @@
-"""Definition of stuff that can be used directly by a user in a dodo.py file."""
+"""APIs to execute doit in non standard way.
+
+- run(): shortcut to get tasks from current module/dict (instead of dodo.py).
+- run_tasks(): to be used by custom CLIs, run tasks without CLI parsing.
+
+"""
 
 import sys
 
@@ -23,7 +28,7 @@ def run_tasks(loader, tasks, extra_config=None):
 
     :params tasks: list of task names (str)
     """
-    loader.task_opts = tasks # task_opts will be used as @task_param
+    loader.task_opts = tasks  # task_opts will be used as @task_param
     main = DoitMain(loader, extra_config=extra_config)
     task_names = list(tasks.keys())
 
@@ -39,7 +44,7 @@ def run_tasks(loader, tasks, extra_config=None):
         bin_name=main.BIN_NAME,
         cmds=sub_cmds,
         opt_vals={},
-        )
+    )
 
     try:
         return command.parse_execute(task_names)

Diff for: doit/cmd_base.py

@@ -26,7 +26,7 @@ def version_tuple(ver_in):
     for rev in parts:
         try:
             result.append(int(rev))
-        except:
+        except ValueError:
             result.append(-1)
     assert len(result) == 3
     return result
@@ -65,7 +65,7 @@ class Command(object):
     # doc attributes, should be sub-classed
     doc_purpose = ''
     doc_usage = ''
-    doc_description = None # None value will completely omit line from doc
+    doc_description = None  # None value will completely omit line from doc
 
     # sequence of dicts
     cmd_options = tuple()
@@ -130,7 +130,7 @@ def get_options(self):
         return [CmdOption(opt) for opt in self.cmd_options]
 
 
-    def execute(self, opt_values, pos_args): # pragma: no cover
+    def execute(self, opt_values, pos_args):  # pragma: no cover
         """execute command
         :param opt_values: (dict) with cmd_options values
         :param pos_args: (list) of cmd-line positional arguments
@@ -200,7 +200,7 @@ def help(self):
 opt_depfile = {
     'section': 'DB backend',
     'name': 'dep_file',
-    'short':'',
+    'short': '',
     'long': 'db-file',
     'type': str,
     'default': ".doit.db",
@@ -211,7 +211,7 @@ def help(self):
 opt_backend = {
     'section': 'DB backend',
     'name': 'backend',
-    'short':'',
+    'short': '',
     'long': 'backend',
     'type': str,
     'default': "dbm",
@@ -251,24 +251,24 @@ def help(self):
 opt_dodo = {
     'section': 'task loader',
     'name': 'dodoFile',
-    'short':'f',
+    'short': 'f',
     'long': 'file',
     'type': str,
     'default': 'dodo.py',
     'env_var': 'DOIT_FILE',
-    'help':"load task from dodo FILE [default: %(default)s]"
+    'help': "load task from dodo FILE [default: %(default)s]"
 }
 
 # cwd
 opt_cwd = {
     'section': 'task loader',
     'name': 'cwdPath',
-    'short':'d',
+    'short': 'd',
     'long': 'dir',
     'type': str,
     'default': None,
-    'help':("set path to be used as cwd directory (file paths on " +
-            "dodo file are relative to dodo.py location).")
+    'help': ("set path to be used as cwd directory "
+             "(file paths on dodo file are relative to dodo.py location).")
 }
 
 # seek dodo file on parent folders
@@ -280,14 +280,14 @@ def help(self):
     'type': bool,
     'default': False,
     'env_var': 'DOIT_SEEK_FILE',
-    'help': ("seek dodo file on parent folders " +
-             "[default: %(default)s]")
+    'help': ("seek dodo file on parent folders [default: %(default)s]")
 }
 
 
 class TaskLoader():
     def __init__(self):
-        raise NotImplementedError('doit.cmd_base.py:TaskLoader was removed on 0.36.0, use TaskLoader2 instead')
+        raise NotImplementedError(
+            'doit.cmd_base.py:TaskLoader was removed on 0.36.0, use TaskLoader2 instead')
 
 class TaskLoader2():
     """Interface of task loaders with new-style API.
@@ -305,8 +305,8 @@ class TaskLoader2():
     def __init__(self):
         # list of command names, used to detect clash of task names and commands
         self.cmd_names = []
-        self.config = None  # reference to config object taken from Command
-        self.task_opts = None # dict with task options (no need parsing, API usage)
+        self.config = None   # reference to config object taken from Command
+        self.task_opts = None  # dict with task options (no need parsing, API usage)
 
     def setup(self, opt_values):
         """Delayed initialization.
@@ -417,7 +417,7 @@ def get_loader(config, task_loader=None, cmds=None):
             loader = plugins.get_plugin(loader_name)()
 
     if not loader:
-        loader = DodoTaskLoader() # default loader
+        loader = DodoTaskLoader()  # default loader
 
     if cmds:
         loader.cmd_names = list(sorted(cmds.keys()))
@@ -438,9 +438,9 @@ class DoitCmdBase(Command):
 
     def __init__(self, task_loader, cmds=None, **kwargs):
         super(DoitCmdBase, self).__init__(**kwargs)
-        self.sel_tasks = None # selected tasks for command
-        self.sel_default_tasks = True # False if tasks were specified from command line
-        self.dep_manager = None #
+        self.sel_tasks = None  # selected tasks for command
+        self.sel_default_tasks = True  # False if tasks were specified from command line
+        self.dep_manager = None
         self.outstream = sys.stdout
         self.loader = task_loader
         self._backends = self.get_backends()
@@ -449,12 +449,11 @@ def __init__(self, task_loader, cmds=None, **kwargs):
     def get_options(self):
         """from base class - merge base_options, loader_options and cmd_options
         """
-        opt_list = (self.base_options + self.loader.cmd_options +
-                    self.cmd_options)
+        opt_list = (self.base_options + self.loader.cmd_options + self.cmd_options)
         return [CmdOption(opt) for opt in opt_list]
 
 
-    def _execute(self): # pragma: no cover
+    def _execute(self):  # pragma: no cover
         """to be subclassed - actual command implementation"""
         raise NotImplementedError
 
@@ -508,7 +507,7 @@ def get_backends(self):
 
         # set choices, sub-classes might not have this option
         if 'backend' in self.cmdparser:
-            choices = {k: getattr(v, 'desc', '') for k,v in backend_map.items()}
+            choices = {k: getattr(v, 'desc', '') for k, v in backend_map.items()}
             self.cmdparser['backend'].choices = choices
 
         return backend_map
@@ -592,8 +591,8 @@ def tasks_and_deps_iter(tasks, sel_tasks, yield_duplicates=False):
     @param tasks (dict - Task)
     @param sel_tasks(list - str)
     """
-    processed = set() # str - task name
-    to_process = deque(sel_tasks) # str - task name
+    processed = set()  # str - task name
+    to_process = deque(sel_tasks)  # str - task name
     # get initial task
     while to_process:
         task = tasks[to_process.popleft()]