Added --files-only option to CLI

osxmetadata/__main__.py

@@ -267,6 +267,13 @@ def get_help(self, ctx):
     multiple=False,
     required=False,
 )
+FILES_ONLY_OPTION = click.option(
+    "--files-only",
+    help="Do not apply metadata commands to directories themselves, only files in a directory.",
+    is_flag=True,
+    default=False,
+    required=False,
+)
 
 
 @click.command(cls=MyClickCommand)
@@ -289,6 +296,7 @@ def get_help(self, ctx):
 @RESTORE_OPTION
 @VERBOSE_OPTION
 @COPY_FROM_OPTION
+@FILES_ONLY_OPTION
 @click.pass_context
 def cli(
     ctx,
@@ -310,6 +318,7 @@ def cli(
     restore,
     verbose,
     copyfrom,
+    files_only,
 ):
     """ Read/write metadata from file(s). """
 
@@ -412,6 +421,7 @@ def cli(
             backup,
             restore,
             walk,
+            files_only,
         )
 
         if walk and os.path.isdir(filename):
@@ -434,7 +444,8 @@ def cli(
                     copyfrom,
                     backup,
                     restore,
-                    walk
+                    walk,
+                    files_only,
                 )
 
 
@@ -456,6 +467,7 @@ def process_files(
     backup,
     restore,
     walk,
+    files_only,
 ):
     """ process list of files, calls process_single_file to process each file
         options processed in this order: wipe, copyfrom, clear, set, append, remove, mirror, get, list
@@ -465,6 +477,11 @@ def process_files(
         fpath = pathlib.Path(filename).resolve()
         backup_file = pathlib.Path(pathlib.Path(filename).parent) / _BACKUP_FILENAME
 
+        if files_only and fpath.is_dir():
+            if verbose:
+                click.echo(f"Skipping directory: {fpath}")
+            continue
+
         if verbose:
             click.echo(f"Processing file: {fpath}")
 

osxmetadata/_version.py

@@ -1 +1 @@
-__version__ = "0.99.7"
+__version__ = "0.99.8"

tests/test_cli.py

@@ -47,6 +47,12 @@
 ]
 
 
+def create_file(filepath):
+    """ create an empty file at filepath """
+    fd = open(filepath, "w+")
+    fd.close()
+
+
 @pytest.fixture(params=["file", "dir"])
 def temp_file(request):
 
@@ -66,6 +72,18 @@ def temp_file(request):
         tempdir.cleanup()
 
 
+@pytest.fixture
+def temp_dir():
+    # TESTDIR for temporary files usually defaults to "/tmp",
+    # which may not have XATTR support (e.g. tmpfs);
+    # manual override here.
+    TESTDIR = None
+    tempdir = TemporaryDirectory(dir=TESTDIR)
+    tempdirname = tempdir.name
+    yield tempdirname
+    tempdir.cleanup()
+
+
 def parse_cli_output(output):
     """ helper for testing
         parse the CLI --list output and return value of all set attributes as dict """
@@ -773,3 +791,83 @@ def test_cli_downloadeddate(temp_file):
     meta.tz_aware = True
     assert meta.get_attribute(kMDItemDownloadedDate) == [utc_time]
     assert meta.downloadeddate == [utc_time]
+
+
+def test_cli_walk(temp_dir):
+    """ test --walk """
+    import os
+    import pathlib
+    from osxmetadata import OSXMetaData, Tag
+    from osxmetadata.__main__ import cli
+
+    dirname = pathlib.Path(temp_dir)
+    os.makedirs(dirname / "temp" / "subfolder1")
+    os.makedirs(dirname / "temp" / "subfolder2")
+    create_file(dirname / "temp" / "temp1.txt")
+    create_file(dirname / "temp" / "subfolder1" / "sub1.txt")
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["--set", "tags", "FOO", "--walk", temp_dir])
+    assert result.exit_code == 0
+
+    md = OSXMetaData(dirname / "temp" / "subfolder1" / "sub1.txt")
+    assert md.tags == [Tag("FOO")]
+
+    md = OSXMetaData(dirname / "temp" / "subfolder2")
+    assert md.tags == [Tag("FOO")]
+
+
+def test_cli_walk_files_only(temp_dir):
+    """ test --walk with --files-only """
+    import os
+    import pathlib
+    from osxmetadata import OSXMetaData, Tag
+    from osxmetadata.__main__ import cli
+
+    dirname = pathlib.Path(temp_dir)
+    os.makedirs(dirname / "temp" / "subfolder1")
+    os.makedirs(dirname / "temp" / "subfolder2")
+    create_file(dirname / "temp" / "temp1.txt")
+    create_file(dirname / "temp" / "subfolder1" / "sub1.txt")
+
+    runner = CliRunner()
+    result = runner.invoke(
+        cli, ["--set", "tags", "FOO", "--walk", "--files-only", temp_dir]
+    )
+    assert result.exit_code == 0
+
+    md = OSXMetaData(dirname / "temp" / "subfolder1" / "sub1.txt")
+    assert md.tags == [Tag("FOO")]
+
+    md = OSXMetaData(dirname / "temp" / "subfolder2")
+    assert not md.tags
+
+
+def test_cli_files_only(temp_dir):
+    """ test --files-only without --walk """
+    import glob
+    import os
+    import pathlib
+    from osxmetadata import OSXMetaData, Tag
+    from osxmetadata.__main__ import cli
+
+    dirname = pathlib.Path(temp_dir)
+    os.makedirs(dirname / "temp" / "subfolder1")
+    os.makedirs(dirname / "temp" / "subfolder2")
+    create_file(dirname / "temp" / "temp1.txt")
+    create_file(dirname / "temp" / "subfolder1" / "sub1.txt")
+
+    files = glob.glob(str(dirname / "temp" / "*"))
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["--set", "tags", "FOO", "--files-only", *files])
+    assert result.exit_code == 0
+
+    md = OSXMetaData(dirname / "temp" / "temp1.txt")
+    assert md.tags == [Tag("FOO")]
+
+    md = OSXMetaData(dirname / "temp" / "subfolder1")
+    assert not md.tags
+
+    md = OSXMetaData(dirname / "temp" / "subfolder1" / "sub1.txt")
+    assert not md.tags