Merge pull request #262 from dephell/feature/colored-json-output

Colored JSON output

dephell/actions/_json.py

@@ -4,6 +4,9 @@
 from functools import reduce
 from typing import Optional
 
+# external
+from pygments import formatters, highlight, lexers
+
 
 def _each(value):
     if isinstance(value, list):
@@ -82,20 +85,27 @@ def getitem(value, key):
     return value[key]
 
 
-def make_json(data, key: str = None, sep: Optional[str] = '-') -> str:
+def _jsonify(data, colors: bool = False) -> str:
     json_params = dict(indent=2, sort_keys=True, ensure_ascii=False)
+    dumped = json.dumps(data, **json_params)
+    if not colors:
+        return dumped
+    return highlight(dumped, lexers.JsonLexer(), formatters.TerminalFormatter())
+
+
+def make_json(data, key: str = None, sep: Optional[str] = '-', colors: bool = True) -> str:
     # print all config
     if not key:
-        return json.dumps(data, **json_params)  # type: ignore
+        return _jsonify(data=data, colors=colors)
 
     if sep is None:
-        return json.dumps(data[key], **json_params)  # type: ignore
+        return _jsonify(data=data[key], colors=colors)
 
     keys = key.replace('.', sep).split(sep)
     value = reduce(getitem, keys, data)
     # print config section
     if isinstance(value, (dict, list)):
-        return json.dumps(value, **json_params)  # type: ignore
+        return _jsonify(data=value, colors=colors)
 
     # print one value
     return str(value)

dephell/commands/deps_audit.py

@@ -66,7 +66,11 @@ def __call__(self) -> bool:
                 ))
 
         if data:
-            print(make_json(data=data, key=self.config.get('filter')))
+            print(make_json(
+                data=data,
+                key=self.config.get('filter'),
+                colors=not self.config['nocolors'],
+            ))
             return False
 
         self.logger.info('dependencies has no known vulnerabilities (yet)')

dephell/commands/deps_check.py

@@ -74,7 +74,11 @@ def __call__(self) -> bool:
             ))
 
         if data:
-            print(make_json(data=data, key=self.config.get('filter')))
+            print(make_json(
+                data=data,
+                key=self.config.get('filter'),
+                colors=not self.config['nocolors'],
+            ))
             return False
 
         self.logger.info('all packages is up-to-date')

dephell/commands/deps_licenses.py

@@ -36,5 +36,10 @@ def __call__(self) -> bool:
             else:
                 licenses['Unknown'].add(dep.name)
         licenses = {name: sorted(deps) for name, deps in licenses.items()}
-        print(make_json(data=licenses, key=self.config.get('filter'), sep=None))
+        print(make_json(
+            data=licenses,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+            sep=None,
+        ))
         return True

dephell/commands/deps_outdated.py

@@ -41,7 +41,11 @@ def __call__(self) -> bool:
             ))
 
         if data:
-            print(make_json(data=data, key=self.config.get('filter')))
+            print(make_json(
+                data=data,
+                key=self.config.get('filter'),
+                colors=not self.config['nocolors'],
+            ))
             return False
 
         self.logger.info('all dependencies is up-to-date')

dephell/commands/deps_tree.py

@@ -49,7 +49,11 @@ def __call__(self) -> bool:
                     latest=str(dep.groups.releases[0].version),
                     dependencies=[subdep.name for subdep in dep.dependencies],
                 ))
-            print(make_json(result, key=self.config.get('filter')))
+            print(make_json(
+                data=result,
+                key=self.config.get('filter'),
+                colors=not self.config['nocolors'],
+            ))
             return True
 
         if self.args.type == 'graph':

dephell/commands/docker_tags.py

@@ -21,5 +21,9 @@ def get_parser(cls) -> ArgumentParser:
 
     def __call__(self) -> bool:
         container = get_docker_container(config=self.config)
-        print(make_json(data=container.tags, key=self.config.get('filter')))
+        print(make_json(
+            data=container.tags,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/inspect_auth.py

@@ -18,5 +18,9 @@ def get_parser(cls) -> ArgumentParser:
         return parser
 
     def __call__(self) -> bool:
-        print(make_json(data=self.config['auth'], key=self.config.get('filter')))
+        print(make_json(
+            data=self.config['auth'],
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/inspect_config.py

@@ -26,5 +26,9 @@ def get_parser(cls) -> ArgumentParser:
     def __call__(self) -> bool:
         config = self.config._data.copy()
         del config['auth']  # do not show credentials
-        print(make_json(data=config, key=self.config.get('filter')))
+        print(make_json(
+            data=config,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/inspect_self.py

@@ -36,5 +36,9 @@ def __call__(self) -> bool:
             versions=versions,
             cache=format_size(get_path_size(Path(self.config['cache']['path']))),
         )
-        print(make_json(data=data, key=self.config.get('filter')))
+        print(make_json(
+            data=data,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/inspect_venv.py

@@ -40,5 +40,9 @@ def __call__(self) -> bool:
                 lib_size=format_size(get_path_size(venv.lib_path)),
                 python=str(venv.python_path),
             ))
-        print(make_json(data=data, key=self.config.get('filter')))
+        print(make_json(
+            data=data,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/jail_list.py

@@ -32,5 +32,10 @@ def __call__(self) -> bool:
             if venv_path.match(venvs_path):
                 entrypoints[venv_path.name].append(entrypoint.name)
 
-        print(make_json(data=dict(entrypoints), key=self.config.get('filter'), sep=None))
+        print(make_json(
+            data=dict(entrypoints),
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+            sep=None,
+        ))
         return True

dephell/commands/package_downloads.py

@@ -32,5 +32,9 @@ def __call__(self) -> bool:
             systems=get_downloads_by_category(category='systems', name=name),
         )
 
-        print(make_json(data=data, key=self.config.get('filter')))
+        print(make_json(
+            data=data,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/package_list.py

@@ -47,5 +47,9 @@ def __call__(self) -> bool:
                 authors=[str(author) for author in dep.authors],
                 updated=str(releases[0].time.date()),
             ))
-        print(make_json(data=data, key=self.config.get('filter')))
+        print(make_json(
+            data=data,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/package_releases.py

@@ -35,5 +35,9 @@ def __call__(self) -> bool:
         if not data:
             self.logger.error('no releases')
             return False
-        print(make_json(data=data, key=self.config.get('filter')))
+        print(make_json(
+            data=data,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/package_search.py

@@ -27,5 +27,9 @@ def __call__(self) -> bool:
         if not results:
             self.logger.error('no results')
             return False
-        print(make_json(data=results, key=self.config.get('filter')))
+        print(make_json(
+            data=results,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

dephell/commands/package_show.py

@@ -54,5 +54,9 @@ def __call__(self) -> bool:
                 size=format_size(sum(get_path_size(place) for place in local_places)),
             ))
 
-        print(make_json(data=data, key=self.config.get('filter')))
+        print(make_json(
+            data=data,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+        ))
         return True

pyproject.toml

@@ -147,6 +147,7 @@ jinja2 = "*"
 m2r = "*"
 packaging = "*"
 pip = ">=18.0"
+pygments = "*"
 pyyaml = "*"  # TODO: replace by ruamel.yaml when migrate from poetry format to flit
 requests = "*"
 setuptools = "*"

setup.py

@@ -62,7 +62,7 @@
         'fissix; python_version >= "3.6"',
         'fissix-py35; python_version < "3.6"', 'html5lib', 'jinja2', 'm2r',
         'packaging', 'pip>=18.0', 'pyyaml', 'requests', 'setuptools', 'tomlkit',
-        'yaspin'
+        'yaspin','Pygments'
     ],
     extras_require={
         'full': ['aiofiles', 'autopep8', 'colorama', 'graphviz', 'yapf'],

tests/test_commands/test_deps_licenses.py

@@ -20,6 +20,7 @@ def test_deps_licenses_command(temp_path: Path, capsys):
         'from': dict(format='pip', path=str(reqs_path)),
         'level': 'WARNING',
         'silent': True,
+        'nocolors': True,
     })
 
     command = DepsLicensesCommand(argv=[], config=config)

tests/test_commands/test_deps_outdated.py

@@ -22,6 +22,7 @@ def test_deps_outdated_command_file(temp_path: Path, capsys):
         'from': dict(format='piplock', path=str(reqs_path)),
         'level': 'WARNING',
         'silent': True,
+        'nocolors': True,
     })
 
     command = DepsOutdatedCommand(argv=[], config=config)
@@ -49,6 +50,7 @@ def test_deps_outdated_command_venv(temp_path: Path, capsys):
         'venv': str(venv_path),
         'level': 'WARNING',
         'silent': True,
+        'nocolors': True,
     })
 
     command = DepsOutdatedCommand(argv=[], config=config)

tests/test_commands/test_deps_tree.py

@@ -16,6 +16,7 @@ def test_deps_tree_command(temp_path: Path, capsys):
     config.attach({
         'level': 'WARNING',
         'silent': True,
+        'nocolors': True,
     })
 
     command = DepsTreeCommand(argv=['--type=json', 'autopep8==1.4.3'], config=config)

tests/test_commands/test_inspect_config.py

@@ -13,6 +13,7 @@ def test_inspect_config_command(temp_path: Path, capsys):
         'level': 'WARNING',
         'silent': True,
         'project': 'nani',
+        'nocolors': True,
     })
     command = InspectConfigCommand(argv=[], config=config)
     result = command()

tests/test_commands/test_inspect_venv.py

@@ -19,6 +19,7 @@ def test_inspect_venv_command(temp_path: Path, capsys):
     config.attach({
         'project': str(temp_path),
         'venv': str(temp_path),
+        'nocolors': True,
     })
 
     command = InspectVenvCommand(argv=[], config=config)

tests/test_commands/test_package_downloads.py

@@ -16,6 +16,7 @@ def test_package_downloads_command(capsys):
     config.attach({
         'level': 'WARNING',
         'silent': True,
+        'nocolors': True,
     })
 
     command = PackageDownloadsCommand(argv=['DJANGO'], config=config)

tests/test_commands/test_package_search.py

@@ -15,6 +15,7 @@ def test_package_search_command(capsys):
     config.attach({
         'level': 'WARNING',
         'silent': True,
+        'nocolors': True,
     })
 
     command = PackageSearchCommand(argv=['textdistance'], config=config)

tests/test_commands/test_package_show.py

@@ -15,6 +15,7 @@ def test_package_show_command(capsys):
     config.attach({
         'level': 'WARNING',
         'silent': True,
+        'nocolors': True,
     })
 
     command = PackageShowCommand(argv=['textdistance'], config=config)