Deprecate --csv command line option #3047

Reference: #3047
Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

CHANGELOG.rst

@@ -2,7 +2,20 @@ Changelog
 =========
 
 
-31.0.0 (next, roadmap)
+
+32.0.0 (next next, roadmap)
+---------------------------
+
+Package detection:
+~~~~~~~~~~~~~~~~~~
+
+- We now support new package manifest formats:
+  - OpenWRT packages.
+  - Yocto/BitBake .bb recipes.
+
+
+
+31.0.0 (next)
 -----------------------
 
 This is a major release with important bug and security fixes, new and improved
@@ -151,10 +164,6 @@ License detection:
 Package detection:
 ~~~~~~~~~~~~~~~~~~
 
-- We now support new package manifest formats:
-  - OpenWRT packages.
-  - Yocto/BitBake .bb recipes.
-
 - Major changes in package detection and reporting, codebase-level attribute `packages`
   with one or more `package_data` and files for the packages are reported.
   The specific changes made are:
@@ -189,9 +198,8 @@ Package detection:
 - For Pypi packages, python_requires is treated as a package dependency.
 
 
-
-License Clarity Scoring Update
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+License Clarity Scoring Update:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - We are moving away from the original license clarity scoring designed for
   ClearlyDefined in the license clarity score plugin. The previous license
@@ -251,8 +259,8 @@ License Clarity Scoring Update
     - Scoring Weight = -20
 
 
-Summary Plugin Update
-~~~~~~~~~~~~~~~~~~~~~
+Summary Plugin Update:
+~~~~~~~~~~~~~~~~~~~~~~
 
 - The summary plugin's behavior has been changed. Previously, it provided a
   count of the detected license expressions, copyrights, holders, authors, and
@@ -276,11 +284,16 @@ All summary information is provided at the codebase-level attribute named ``summ
 Outputs:
 ~~~~~~~~
 
- - Added new outputs for the CycloneDx format.
-   The CLI now exposes options to produce CycloneDx BOMs in either JSON or XML format
+- Added new outputs for the CycloneDx format.
+  The CLI now exposes options to produce CycloneDx BOMs in either JSON or XML format
+
+- A new field ``warnings`` has been added to the headers of ScanCode toolkit output
+  that contains any warning messages that occur during a scan.
 
- - A new field ``warnings`` has been added to the headers of ScanCode toolkit output
-   that contains any warning messages that occur during a scan.
+- The CSV output format --csv option is now deprecated. It will be replaced by
+  new CSV and tabular output formats in the next ScanCode release.
+  Visit https://github.com/nexB/scancode-toolkit/issues/3047 to provide inputs
+  and feedback.
 
 
 Output version
@@ -299,16 +312,19 @@ Changes:
 - The fields of the license clarity scoring plugin have been replaced with the
   following fields. An overview of the new fields can be found in the "License
   Clarity Scoring Update" section above.
+
     - `score`
     - `declared_license`
     - `identification_precision`
     - `has_license_text`
     - `declared_copyrights`
     - `conflicting_license_categories`
     - `ambigious_compound_licensing`
+
 - The fields of the summary plugin have been replaced with the following fields.
   An overview of the new fields can be found in the "Summary Plugin Update"
   section above.
+
     - `declared_license_expression`
     - `license_clarity_score`
     - `declared_holder`

src/formattedcode/output_csv.py

@@ -8,6 +8,7 @@
 #
 import attr
 import csv
+import warnings
 
 import saneyaml
 
@@ -38,6 +39,12 @@ def logger_debug(*args):
         return logger.debug(' '.join(isinstance(a, str)
                                      and a or repr(a) for a in args))
 
+DEPRECATED_MSG = (
+    'The --csv option is deprecated and will be replaced by new CSV and '
+    'tabular output formats in the next ScanCode release. '
+    'Visit https://github.com/nexB/scancode-toolkit/issues/3047 to provide inputs and feedback.'
+)
+
 
 @output_impl
 class CsvOutput(OutputPlugin):
@@ -46,7 +53,7 @@ class CsvOutput(OutputPlugin):
         PluggableCommandLineOption(('--csv',),
             type=FileOptionType(mode='w', encoding='utf-8', lazy=True),
             metavar='FILE',
-            help='Write scan output as CSV to FILE.',
+            help='[DEPRECATED] Write scan output as CSV to FILE. ' + DEPRECATED_MSG,
             help_group=OUTPUT_GROUP,
             sort_order=30),
     ]
@@ -55,6 +62,14 @@ def is_enabled(self, csv, **kwargs):
         return csv
 
     def process_codebase(self, codebase, csv, **kwargs):
+        warnings.warn(
+            DEPRECATED_MSG,
+            DeprecationWarning,
+            stacklevel=1
+        )
+        import click
+        click.secho('[DEPRECATION WARNING] ' + DEPRECATED_MSG, err=True)
+
         results = self.get_files(codebase, **kwargs)
         write_csv(results, csv)
 

tests/scancode/data/help/help.txt

@@ -45,7 +45,11 @@ Options:
     --json-pp FILE          Write scan output as pretty-printed JSON to FILE.
     --json-lines FILE       Write scan output as JSON Lines to FILE.
     --yaml FILE             Write scan output as YAML to FILE.
-    --csv FILE              Write scan output as CSV to FILE.
+    --csv FILE              [DEPRECATED] Write scan output as CSV to FILE. The
+                            --csv option is deprecated and will be replaced by new
+                            CSV and tabular output formats in the next ScanCode
+                            release. Visit https://github.com/nexB/scancode-
+                            toolkit/issues/3047 to provide inputs and feedback.
     --html FILE             Write scan output as HTML to FILE.
     --custom-output FILE    Write scan output to FILE formatted with the custom
                             Jinja template file.