Add --include and --exclude filters to the ls and rm commands

b2/_internal/_utils/uri.py

@@ -165,10 +165,10 @@ def list_file_versions_by_uri(self, uri, *args, **kwargs):
         raise NotImplementedError(f"Unsupported URI type: {type(uri)}")
 
     @list_file_versions_by_uri.register
-    def _(self, uri: B2URI, *args, **kwargs):
+    def _(self, uri: B2URI, *args, filters=(), **kwargs):
         bucket = self.api.get_bucket_by_name(uri.bucket_name)
         try:
-            yield from bucket.ls(uri.path, *args, **kwargs)
+            yield from bucket.ls(uri.path, *args, filters=filters, **kwargs)
         except ValueError as error:
             # Wrap these errors into B2Error. At the time of writing there's
             # exactly one – `with_wildcard` being passed without `recursive` option.

b2/_internal/console_tool.py

@@ -79,6 +79,7 @@
     EncryptionSetting,
     FileRetentionSetting,
     FileVersion,
+    Filter,
     KeepOrDeleteMode,
     LegalHold,
     LifecycleRule,
@@ -2175,6 +2176,8 @@ def _setup_parser(cls, parser):
         parser.add_argument('--versions', action='store_true')
         parser.add_argument('-r', '--recursive', action='store_true')
         parser.add_argument('--withWildcard', action='store_true')
+        parser.add_argument('--include', dest='filters', action='append', type=Filter.include)
+        parser.add_argument('--exclude', dest='filters', action='append', type=Filter.exclude)
         super()._setup_parser(parser)
 
     def _print_files(self, args):
@@ -2198,6 +2201,7 @@ def _get_ls_generator(self, args):
             latest_only=not args.versions,
             recursive=args.recursive,
             with_wildcard=args.withWildcard,
+            filters=args.filters or (),
         )
 
     def get_b2_uri_from_arg(self, args: argparse.Namespace) -> B2URI:

changelog.d/+ls-rm-filters.added.md

@@ -0,0 +1 @@
+Add `--include` and `--exclude` filters to the `ls` and `rm` commands.

test/unit/test_console_tool.py

@@ -2445,6 +2445,64 @@ def test_ls_b2id(self):
                 '''
         self._run_command(['ls', f'b2id://{file_version.id_}'], expected_stdout, '', 0)
 
+    def test_ls_filters(self):
+        self._authorize_account()
+        self._create_my_bucket()
+
+        # Create some files, including files in a folder
+        bucket = self.b2_api.get_bucket_by_name('my-bucket')
+        data = UploadSourceBytes(b'test-data')
+        bucket.upload(data, 'a/test.csv')
+        bucket.upload(data, 'a/test.tsv')
+        bucket.upload(data, 'b/b/test.csv')
+        bucket.upload(data, 'c/test.csv')
+        bucket.upload(data, 'c/test.tsv')
+        bucket.upload(data, 'test.csv')
+        bucket.upload(data, 'test.tsv')
+
+        expected_stdout = '''
+            a/
+            b/
+            c/
+            test.csv
+            '''
+        self._run_command(
+            ['ls', *self.b2_uri_args('my-bucket'), '--include', '*.csv'],
+            expected_stdout,
+        )
+        self._run_command(
+            ['ls', *self.b2_uri_args('my-bucket'), '--exclude', '*.tsv'],
+            expected_stdout,
+        )
+
+        expected_stdout = '''
+            a/test.csv
+            b/b/test.csv
+            c/test.csv
+            test.csv
+            '''
+        self._run_command(
+            ['ls', *self.b2_uri_args('my-bucket'), '--recursive', '--include', '*.csv'],
+            expected_stdout,
+        )
+        self._run_command(
+            ['ls', *self.b2_uri_args('my-bucket'), '--recursive', '--exclude', '*.tsv'],
+            expected_stdout,
+        )
+
+        expected_stdout = '''
+            b/b/test.csv
+            c/test.csv
+            test.csv
+            '''
+        self._run_command(
+            [
+                'ls', *self.b2_uri_args('my-bucket'), '--recursive', '--exclude', '*', '--include',
+                '*.csv', '--exclude', 'a/*'
+            ],
+            expected_stdout,
+        )
+
 
 class TestConsoleToolWithV1(BaseConsoleToolTest):
     """These tests use v1 interface to perform various setups before running CLI commands"""