Fixed #584 - Add support for the special '-' FILE

 * The `inventory` can now used `-` to print result to stdout.
 * Updated docs and changelog.

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

-

@@ -0,0 +1,27 @@
+[
+  {
+    "about_resource": "/aboutcode-toolkit/",
+    "name": "AboutCode-toolkit",
+    "version": "11.1.0",
+    "description": "AboutCode Toolkit is a tool to process ABOUT files. An ABOUT file\nprovides a simple way to document the provenance (origin and license)\n'about' a software component. This is a small text file stored in the\ncodebase side-by-side with the documented software component.",
+    "homepage_url": "http://www.nexb.com/community.html",
+    "license_expression": "apache-2.0",
+    "spdx_license_key": [
+      "Apache-2.0"
+    ],
+    "copyright": "Copyright (c) nexB Inc.",
+    "notice_file": "NOTICE",
+    "owner": "nexB Inc.",
+    "author": "Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez",
+    "vcs_tool": "git",
+    "vcs_repository": "https://github.com/nexB/aboutcode-toolkit.git",
+    "licenses": [
+      {
+        "key": "apache-2.0",
+        "name": "Apache License 2.0",
+        "file": "apache-2.0.LICENSE",
+        "url": "https://enterprise.dejacode.com/urn/?urn=urn:dje:license:apache-2.0"
+      }
+    ]
+  }
+]

CHANGELOG.rst

@@ -6,6 +6,7 @@ xxxx-xx-xx
 
     * Drop support for python version earlier than 3.9
     * Add ability to "exclude" path in the check and inventory #583
+    * Add support for the special '-' FILE to print to on screen/to stdout in inventory #584
 
 2024-09-16
     Release 11.0.2

docs/source/reference.rst

@@ -586,7 +586,9 @@ Syntax
                 about inventory [OPTIONS] LOCATION OUTPUT
 
                 LOCATION: Path to an ABOUT file or a directory with ABOUT files.
-                OUTPUT: Path to the CSV/JSON/XLSX inventory file to create.
+                OUTPUT: Path to the CSV/JSON/XLSX inventory file to create, or using '-' to
+                print result on screen/to stdout (Excel-formatted output cannot be used in
+                stdout).
 
 Options
 -------
@@ -603,19 +605,27 @@ Options
 Purpose
 -------
 
-Create a JSON/CSV/XLSX inventory of components from ABOUT files.
+Create a JSON/CSV/XLSX inventory of components from ABOUT files, or use `-` to print result to stdout.
 
 Details
 ^^^^^^^
 
         ..  code-block:: none
 
+                --exclude PATTERN
+
+                    Exclude the processing of the specified input pattern
+
+                $ about inventory --exclude "tests*" LOCATION OUTPUT
+
                 -f, --format [json|csv|excel]
 
                     Set OUTPUT file format.  [default: csv]
 
                 $ about inventory -f json LOCATION OUTPUT
 
+                $ about inventory -f json LOCATION -
+
                 --verbose
 
                     This option tells the tool to show all errors found.

src/attributecode/cmd.py

@@ -143,16 +143,15 @@ def validate_extensions(ctx, param, value, extensions=tuple(('.csv', '.json',)))
 
 
 @about.command(cls=AboutCommand,
-               short_help='Collect the inventory of .ABOUT files to a CSV/JSON/XLSX file.')
+               short_help='Collect the inventory of .ABOUT files to a CSV/JSON/XLSX file or stdout.')
 @click.argument('location',
                 required=True,
                 metavar='LOCATION',
                 type=click.Path(
                     exists=True, file_okay=True, dir_okay=True, readable=True, resolve_path=True))
 @click.argument('output',
                 required=True,
-                metavar='OUTPUT',
-                type=click.Path(exists=False, dir_okay=False, writable=True, resolve_path=True))
+                metavar='OUTPUT')
 @click.option('--exclude',
               multiple=True,
               metavar='PATTERN',
@@ -176,8 +175,25 @@ def inventory(location, output, exclude, format, quiet, verbose):  # NOQA
 
 LOCATION: Path to an ABOUT file or a directory with ABOUT files.
 
-OUTPUT: Path to the CSV/JSON/XLSX inventory file to create.
+OUTPUT: Path to the CSV/JSON/XLSX inventory file to create, or
+using '-' to print result on screen/to stdout (Excel-formatted output
+cannot be used in stdout).
     """
+    # We are not using type=click.Path() to validate the output location as
+    # it does not support `-` , which is used to print the result to stdout.
+    if not output == '-':
+        parent_dir = os.path.dirname(output)
+        if not os.path.exists(parent_dir):
+            msg = 'The OUTPUT directory: {parent_dir} does not exist.'.format(**locals())
+            msg += '\nPlease correct and re-run'
+            click.echo(msg)
+            sys.exit(1)
+    else:
+        # Check the format if output is stdout as xlsx format cannot be displayed.
+        if format == 'excel':
+            msg = 'Excel-formatted output cannot be used in stdout.'
+            click.echo(msg)
+            sys.exit(0)
     if not quiet:
         print_version()
         click.echo('Collecting inventory from ABOUT files...')
@@ -188,9 +204,13 @@ def inventory(location, output, exclude, format, quiet, verbose):  # NOQA
     errors, abouts = collect_inventory(location, exclude)
     write_output(abouts=abouts, location=output, format=format)
 
+    if output == '-':
+        log_file_loc = None
+    else:
+        log_file_loc = output + '-error.log'
     errors_count = report_errors(
-        errors, quiet, verbose, log_file_loc=output + '-error.log')
-    if not quiet:
+        errors, quiet, verbose, log_file_loc)
+    if not quiet and not output == '-':
         msg = 'Inventory collected in {output}.'.format(**locals())
         click.echo(msg)
     sys.exit(errors_count)

src/attributecode/model.py

@@ -28,6 +28,7 @@
 import os
 import posixpath
 from requests import get, head, exceptions
+import sys
 import traceback
 from itertools import zip_longest
 
@@ -1849,7 +1850,8 @@ def write_output(abouts, location, format):  # NOQA
     Return a list of Error objects.
     """
     about_dicts = about_object_to_list_of_dictionary(abouts)
-    location = add_unc(location)
+    if not location == '-':
+        location = add_unc(location)
     if format == 'csv':
         save_as_csv(location, about_dicts, get_field_names(abouts))
     elif format == 'json':
@@ -1859,21 +1861,40 @@ def write_output(abouts, location, format):  # NOQA
 
 
 def save_as_json(location, about_dicts):
-    with open(location, mode='w') as output_file:
-        data = util.format_about_dict_for_json_output(about_dicts)
-        output_file.write(json.dumps(data, indent=2))
+    """
+    Save the given data as a JSON file or print it to standard output.
+    """
+    data = util.format_about_dict_for_json_output(about_dicts)
+    if location == '-':
+        json.dump(data, sys.stdout, indent=2)
+    else:
+        with open(location, mode='w') as output_file:
+            output_file.write(json.dumps(data, indent=2))
 
 
 def save_as_csv(location, about_dicts, field_names):
-    with open(location, mode='w', encoding='utf-8', newline='', errors='replace') as output_file:
-        writer = csv.DictWriter(output_file, field_names)
+    """
+    Save the given data as a CSV file or print it to standard output.
+    """
+    if location == '-':
+        writer = csv.DictWriter(sys.stdout, field_names)
         writer.writeheader()
         csv_formatted_list = util.format_about_dict_output(about_dicts)
         for row in csv_formatted_list:
             writer.writerow(row)
+    else:
+        with open(location, mode='w', encoding='utf-8', newline='', errors='replace') as output_file:
+            writer = csv.DictWriter(output_file, field_names)
+            writer.writeheader()
+            csv_formatted_list = util.format_about_dict_output(about_dicts)
+            for row in csv_formatted_list:
+                writer.writerow(row)
 
 
 def save_as_excel(location, about_dicts):
+    """
+    Save the given data as a Excel file.
+    """
     formatted_list = util.format_about_dict_output(about_dicts)
     write_excel(location, formatted_list)
 

tests/test_cmd.py

@@ -334,7 +334,6 @@ def check_about_stdout(options, expected_loc, regen=False):
     with open(expected_file, 'r') as ef:
         expected = ef.read()
 
-    print("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
     print(result.output)
     assert expected.splitlines(False) == result.output.splitlines(False)
 

tests/testdata/test_cmd/help/about_help.txt

@@ -22,6 +22,6 @@ Commands:
   gen-license         Fetch and save all the licenses in the license_expression
                       field to a directory.
   inventory           Collect the inventory of .ABOUT files to a CSV/JSON/XLSX
-                      file.
+                      file or stdout.
   transform           Transform a CSV/JSON/XLSX by applying renamings, filters
-                      and checks.
+                      and checks.

tests/testdata/test_cmd/help/about_inventory_help.txt

@@ -4,7 +4,9 @@ Usage: about inventory [OPTIONS] LOCATION OUTPUT
 
   LOCATION: Path to an ABOUT file or a directory with ABOUT files.
 
-  OUTPUT: Path to the CSV/JSON/XLSX inventory file to create.
+  OUTPUT: Path to the CSV/JSON/XLSX inventory file to create, or using '-' to
+  print result on screen/to stdout (Excel-formatted output cannot be used in
+  stdout).
 
 Options:
   --exclude PATTERN              Exclude the processing of the specified input