make output colorful (#1114)

* document tox profiles

Author: mr-c

cwltool/main.py

@@ -59,6 +59,8 @@
                     windows_default_container_id)
 from .subgraph import get_subgraph
 
+import coloredlogs
+
 def _terminate_processes():
     # type: () -> None
     """Kill all spawned processes.
@@ -495,12 +497,12 @@ def main(argsl=None,                   # type: List[str]
             stdout = cast(TextIO, sys.stdout)  # type: ignore
 
     _logger.removeHandler(defaultStreamHandler)
+    stderr_handler = logger_handler
     if logger_handler is not None:
-        stderr_handler = logger_handler
+        _logger.addHandler(stderr_handler)
     else:
-        stderr_handler = logging.StreamHandler(stderr)
-    _logger.addHandler(stderr_handler)
-    # pre-declared for finally block
+        coloredlogs.install(logger=_logger, stream=stderr)
+        stderr_handler = _logger.handlers[-1]
     workflowobj = None
     prov_log_handler = None  # type: Optional[logging.StreamHandler]
     try:
@@ -542,12 +544,16 @@ def main(argsl=None,                   # type: List[str]
         if runtimeContext.debug:
             # Increase to debug for both stderr and provenance log file
             _logger.setLevel(logging.DEBUG)
+            stderr_handler.setLevel(logging.DEBUG)
             rdflib_logger.setLevel(logging.DEBUG)
         formatter = None  # type: Optional[logging.Formatter]
         if args.timestamps:
-            formatter = logging.Formatter("[%(asctime)s] %(message)s",
-                                          "%Y-%m-%d %H:%M:%S")
-            stderr_handler.setFormatter(formatter)
+            formatter = coloredlogs.ColoredFormatter(
+                "[%(asctime)s] %(levelname)s %(message)s",
+                "%Y-%m-%d %H:%M:%S")
+        else:
+            formatter = coloredlogs.ColoredFormatter("%(levelname)s %(message)s")
+        stderr_handler.setFormatter(formatter)
         ##
 
         if args.version:

requirements.txt

@@ -12,3 +12,4 @@ psutil
 scandir
 subprocess32 >= 3.5.0; os.name=="posix" and python_version<"3.5"
 typing-extensions
+coloredlogs

setup.py

@@ -65,6 +65,7 @@
           'prov == 1.5.1',
           'bagit >= 1.6.4',
           'typing-extensions',
+          'coloredlogs',
       ],
       extras_require={
           ':os.name=="posix" and python_version<"3.5"': ['subprocess32 >= 3.5.0'],

tests/test_ext.py

@@ -191,6 +191,6 @@ def test_warn_large_inputs():
         main([get_data('tests/wf/listing_v1_0.cwl'), get_data('tests/listing2-job.yml')],
              stderr=stream)
 
-        assert "Recursive directory listing has resulted in a large number of File objects" in re.sub("\n  *", " ", stream.getvalue())
+        assert "Recursive directory listing has resulted in a large number of File" in re.sub("\n  *", " ", stream.getvalue())
     finally:
         cwltool.process.FILE_COUNT_WARNING = was

tox.ini

@@ -20,6 +20,12 @@ python =
   3.8-dev: py38
 
 [testenv]
+description =
+  py{27,35,36,37,38}-unit: Run the unit tests
+  py{27,35,36,37,38}-lint: Lint the Python code
+  py{27,35,36,37,38}-bandit: Search for common security issues
+  py{27,35,36,37,38}-mypy{2,3}: Check for type safety
+
 passenv =
   CI
   TRAVIS
@@ -57,13 +63,15 @@ whitelist_externals =
   py{35,36,36,37,38}-mypy{2,3}: make
 
 [testenv:py27-pipconflictchecker]
+description = Ensure that there are no dependency version conflicts
 commands = pipconflictchecker
 whitelist_externals = pipconflictchecker
 deps =
   pip-conflict-checker
   pip==9.0.3
 
 [testenv:py27-lint-readme]
+description = Lint the README.rst->.md conversion
 commands =
   python setup.py sdist
   python setup.py bdist_wheel
@@ -74,6 +82,7 @@ deps =
     readme_renderer[md]
 
 [testenv:py27-pydocstyle]
+description = docstring style checker
 whitelist_externals = make
 commands = make diff_pydocstyle_report
 deps =

typeshed/2and3/coloredlogs/__init__.pyi

@@ -0,0 +1,94 @@
+# Stubs for coloredlogs (Python 3.7)
+#
+# NOTE: This dynamically typed stub was automatically generated by stubgen.
+
+import logging
+from typing import Any, Optional
+
+WINDOWS: Any
+NEED_COLORAMA = WINDOWS
+DEFAULT_LOG_LEVEL: Any
+DEFAULT_LOG_FORMAT: str
+DEFAULT_DATE_FORMAT: str
+CHROOT_FILES: Any
+CAN_USE_BOLD_FONT: Any
+DEFAULT_FIELD_STYLES: Any
+DEFAULT_LEVEL_STYLES: Any
+DEFAULT_FORMAT_STYLE: str
+FORMAT_STYLE_PATTERNS: Any
+
+def auto_install() -> None: ...
+def install(level: Optional[Any] = ..., **kw: Any): ...
+def check_style(value: Any): ...
+def increase_verbosity() -> None: ...
+def decrease_verbosity() -> None: ...
+def is_verbose(): ...
+def get_level(): ...
+def set_level(level: Any) -> None: ...
+def adjust_level(logger: Any, level: Any) -> None: ...
+def find_defined_levels(): ...
+def level_to_number(value: Any): ...
+def find_level_aliases(): ...
+def parse_encoded_styles(text: Any, normalize_key: Optional[Any] = ...): ...
+def find_hostname(use_chroot: bool = ...): ...
+def find_program_name(): ...
+def replace_handler(logger: Any, match_handler: Any, reconfigure: Any): ...
+def find_handler(logger: Any, match_handler: Any): ...
+def match_stream_handler(handler: Any, streams: Any = ...): ...
+def walk_propagation_tree(logger: Any) -> None: ...
+
+class BasicFormatter(logging.Formatter):
+    def formatTime(self, record: Any, datefmt: Optional[Any] = ...): ...
+
+class ColoredFormatter(BasicFormatter):
+    nn: Any = ...
+    log_record_factory: Any = ...
+    level_styles: Any = ...
+    field_styles: Any = ...
+    def __init__(self, fmt: Optional[Any] = ..., datefmt: Optional[Any] = ..., level_styles: Optional[Any] = ..., field_styles: Optional[Any] = ..., style: Any = ...) -> None: ...
+    def colorize_format(self, fmt: Any, style: Any = ...): ...
+    def format(self, record: Any): ...
+
+class Empty: ...
+
+class HostNameFilter(logging.Filter):
+    @classmethod
+    def install(cls, handler: Any, fmt: Optional[Any] = ..., use_chroot: bool = ..., style: Any = ...): ...
+    hostname: Any = ...
+    def __init__(self, use_chroot: bool = ...) -> None: ...
+    def filter(self, record: Any): ...
+
+class ProgramNameFilter(logging.Filter):
+    @classmethod
+    def install(cls, handler: Any, fmt: Any, programname: Optional[Any] = ..., style: Any = ...): ...
+    programname: Any = ...
+    def __init__(self, programname: Optional[Any] = ...) -> None: ...
+    def filter(self, record: Any): ...
+
+class StandardErrorHandler(logging.StreamHandler):
+    def __init__(self, level: Any = ...) -> None: ...
+    @property
+    def stream(self): ...
+
+class FormatStringParser:
+    style: Any = ...
+    capturing_pattern: Any = ...
+    raw_pattern: Any = ...
+    tokenize_pattern: Any = ...
+    name_pattern: Any = ...
+    def __init__(self, style: Any = ...) -> None: ...
+    def contains_field(self, format_string: Any, field_name: Any): ...
+    def get_field_names(self, format_string: Any): ...
+    def get_grouped_pairs(self, format_string: Any): ...
+    def get_pairs(self, format_string: Any) -> None: ...
+    def get_pattern(self, field_name: Any): ...
+    def get_tokens(self, format_string: Any): ...
+
+class FormatStringToken: ...
+
+class NameNormalizer:
+    aliases: Any = ...
+    def __init__(self) -> None: ...
+    def normalize_name(self, name: Any): ...
+    def normalize_keys(self, value: Any): ...
+    def get(self, normalized_dict: Any, name: Any): ...