Expose the components kwarg in the CLI and API

news/253-components-list

@@ -0,0 +1,19 @@
+### Enhancements
+
+* Expose API and CLI for which components will be listed as part of `cph list`. (#253)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>

src/conda_package_handling/api.py

@@ -9,7 +9,7 @@
 from .exceptions import ConversionError, InvalidArchiveError  # NOQA
 from .interface import AbstractBaseFormat
 from .tarball import CondaTarBZ2 as _CondaTarBZ2
-from .utils import filter_info_files
+from .utils import ensure_list, filter_info_files
 from .utils import get_executor as _get_executor
 from .utils import rm_rf as _rm_rf
 
@@ -227,8 +227,9 @@ def get_pkg_details(in_file):
     raise ValueError(f"Don't know what to do with file {in_file}")
 
 
-def list_contents(in_file, verbose=False):
+def list_contents(in_file, verbose=False, components=None):
+    components = ensure_list(components or ("info", "pkg"))
     for format in SUPPORTED_EXTENSIONS.values():
         if format.supported(in_file):
-            return format.list_contents(in_file, verbose=verbose)
+            return format.list_contents(in_file, verbose=verbose, components=components)
     raise ValueError(f"Don't know what to do with file {in_file}")

src/conda_package_handling/cli.py

@@ -116,6 +116,13 @@ def build_parser():
         action="store_true",
         help="Report more details, similar to 'ls -l'. Otherwise, only the filenames are printed.",
     )
+    list_parser.add_argument(
+        "--components",
+        dest="components",
+        default="info,pkg",
+        help="Comma-separated list of components to read (.conda artifacts only; "
+        "ignored for .tar.bz2). Allowed values: info, pkg.",
+    )
 
     return parser
 
@@ -148,7 +155,10 @@ def main(args=None):
             pprint(failed_files)
             sys.exit(1)
     elif args.subcommand in ("list", "l"):
-        api.list_contents(args.archive_path, verbose=args.verbose)
+        components = [
+            component.strip() for component in (args.components or "info,pkg").split(",")
+        ]
+        api.list_contents(args.archive_path, verbose=args.verbose, components=components)
 
 
 if __name__ == "__main__":  # pragma: no cover

tests/test_cli.py

@@ -82,3 +82,11 @@ def test_list(artifact, n_files, capsys):
 
     with pytest.raises(ValueError):
         cli.main(["list", "setup.py"])
+
+    cli.main(["list", os.path.join(data_dir, artifact), "--components=pkg"])
+    stdout, stderr = capsys.readouterr()
+    listed_files = sum(bool(line.strip()) for line in stdout.splitlines())
+    if artifact.endswith(".conda"):
+        assert listed_files < n_files  # info folder filtered out
+    else:
+        assert listed_files == n_files  # no info filtering in tar.bz2