Merge pull request #112 from RhetTbull/fix_tag_color_remove_106

Fix tag color remove 106

Author: RhetTbull

.gitignore

@@ -17,4 +17,4 @@ scratch/
 venv/
 .python-version
 .coverage
-working/
+pyrightconfig.json

README.md

@@ -51,7 +51,7 @@ Once you've installed osxmetadata with pip, to upgrade to the latest version:
 OSXMetaData uses setuptools, thus simply run:
 
     git clone https://github.com/RhetTbull/osxmetadata.git
-    cd osxmetadata 
+    cd osxmetadata
     pip install poetry
     poetry install
 
@@ -137,9 +137,14 @@ True
 
 The class attributes are handled dynamically which, unfortunately, means that IDEs like PyCharm and Visual Studio Code cannot provide tab-completion for them.
 
+> [!NOTE]
+> When writing or updating metadata with OSXMetaData, the OS will take some time to update the metadata on disk; in my testing, this can be as short as 100ms or as long as 3s. This means that if you read the metadata immediately after writing it, you may not see the updated metadata. If your use case requires the use of immediate read after write, you may need to implement a delay in your code to allow the OS time to update the metadata on disk. This appears to be an OS limitation and not something that can be controlled by osxmetadata.
+
+```pycon
+
 ## Finder Tags
 
-Unlike other attributes, which are mapped to native Python types appropriate for the source Objective C type, Finder tags (`_kMDItemUserTags` or `tags`) have two components: a name (str) and a color ID (unsigned int in range 0 to 7) representing a color tag in the Finder.  Reading tags returns a list of `Tag` namedtuples and setting tags requires a list of `Tag` namedtuples.  
+Unlike other attributes, which are mapped to native Python types appropriate for the source Objective C type, Finder tags (`_kMDItemUserTags` or `tags`) have two components: a name (str) and a color ID (unsigned int in range 0 to 7) representing a color tag in the Finder.  Reading tags returns a list of `Tag` namedtuples and setting tags requires a list of `Tag` namedtuples.
 
 ```pycon
 >>> from osxmetadata import *
@@ -149,7 +154,7 @@ Unlike other attributes, which are mapped to native Python types appropriate for
 [Tag(name='Test', color=0), Tag(name='ToDo', color=6)]
 >>> md.get("_kMDItemUserTags")
 [Tag(name='Test', color=0), Tag(name='ToDo', color=6)]
->>> 
+>>>
 ```
 
 Tag names (but not colors) can also be accessed through the [NSURLTagNamesKey](https://developer.apple.com/documentation/foundation/nsurltagnameskey) resource key and the label color ID is accessible through `NSURLLabelNumberKey`; the localized label color name is accessible through `NSURLLocalizedLabelKey` though these latter two resource keys only return a single color whereas a file may have more than one color tag. For most purposes, I recommend using the `tags` attribute as it is more convenient and provides access to both the name and color ID of the tag.
@@ -224,7 +229,7 @@ Metadata attributes which return date/times such as `kMDItemDueDate` or `kMDItem
 >>> md.kMDItemDueDate
 datetime.datetime(2022, 10, 1, 0, 0)
 >>> md.kMDItemDownloadedDate = datetime.datetime(2022, 10, 1, tzinfo=datetime.timezone.utc)
->>> 
+>>>
 ```
 
 ## Extended Attributes

osxmetadata/__main__.py

@@ -84,13 +84,15 @@ def get_attribute_type(attr: str) -> t.Optional[str]:
     return (
         "list"
         if attr in _TAGS_NAMES
-        else MDITEM_ATTRIBUTE_DATA[attr]["python_type"]
-        if attr in MDITEM_ATTRIBUTE_DATA
-        else "int"
-        if attr == _kFinderColor
-        else "bool"
-        if attr == _kFinderStationeryPad
-        else None
+        else (
+            MDITEM_ATTRIBUTE_DATA[attr]["python_type"]
+            if attr in MDITEM_ATTRIBUTE_DATA
+            else (
+                "int"
+                if attr == _kFinderColor
+                else "bool" if attr == _kFinderStationeryPad else None
+            )
+        )
     )
 
 
@@ -396,6 +398,7 @@ def md_remove_metadata_with_error(
             return f"remove is not a valid operation for single-value attribute {attr}"
 
         if attr in _TAGS_NAMES:
+            val = md_tag_value_from_file(md, val)
             val = tag_factory(val)
         elif attr in MDITEM_ATTRIBUTE_DATA or attr in MDITEM_ATTRIBUTE_SHORT_NAMES:
             val = str_to_mditem_type(attr, val)
@@ -413,6 +416,24 @@ def md_remove_metadata_with_error(
             raise e
 
 
+def md_tag_value_from_file(md: OSXMetaData, value: str) -> str:
+    """Given a tag value, return the tag + color if tag value contains color.
+    If not, check if file has the same tag and if so, return the tag + color from the file
+
+    Returns the new tag value
+    """
+    values = value.split(",")
+    if len(values) > 2:
+        raise ValueError(f"More than one value found after comma: {value}")
+    if len(values) == 2:
+        return value
+    if file_tags := md.get(_kMDItemUserTags):
+        for tag in file_tags:
+            if tag.name.lower() == value.lower():
+                return f"{value},{tag.color}"
+    return value
+
+
 def md_mirror_metadata_with_error(
     md: OSXMetaData, attributes: t.Tuple[t.Tuple[str, str]], verbose: bool
 ) -> t.Optional[str]:
@@ -668,6 +689,18 @@ def get_help(self, ctx):
             # add to list
             attr_tuples.append((short_name, attr_help))
 
+        # add findercolor which isn't a standard kMDx item
+        attr_tuples.append(
+            (
+                "findercolor",
+                "findercolor; Finder color tag value. "
+                + "The value can be either a number or the name of the color as follows: "
+                + f"{', '.join([f'{colorid}: {color}' for color, colorid in _COLORNAMES_LOWER.items() if colorid != FINDER_COLOR_NONE])}; "
+                + "integer or string.",
+            )
+        )
+        attr_tuples = sorted(attr_tuples)
+
         formatter.write("\n\n")
         formatter.write_text(
             "Valid attributes for ATTRIBUTE: "
@@ -704,12 +737,7 @@ def get_help(self, ctx):
             + f"{', '.join([color for color, colorid in _COLORNAMES_LOWER.items() if colorid != FINDER_COLOR_NONE])}. "
             + "If color is not specified but a tag of the same name has already been assigned a color "
             + "in the Finder, the same color will automatically be assigned. "
-        )
-        formatter.write("\n")
-        formatter.write_text(
-            "com.apple.FinderInfo (finderinfo) value is a key:value dictionary. "
-            + "To set finderinfo, pass value in format key1:value1,key2:value2,etc. "
-            + "For example: 'osxmetadata --set finderinfo color:2 file.ext'."
+            + "See also findercolor."
         )
         formatter.write("\n")
 
@@ -1086,7 +1114,8 @@ def process_single_file(
 ):
     """process a single file to apply the options
     options processed in this order: wipe, copyfrom, clear, set, append, remove, mirror, get, list
-    Note: expects all attributes passed in parameters to be validated as valid attributes"""
+    Note: expects all attributes passed in parameters to be validated as valid attributes
+    """
 
     md = OSXMetaData(fpath)
 

tests/conftest.py

@@ -17,6 +17,7 @@
 SNOOZE_TIME = 0.5 if os.environ.get("GITHUB_ACTION") else 0.1
 # Finder comments need more time to be written to disk
 FINDER_COMMENT_SNOOZE = 2.0
+LONG_SNOOZE = 3.0  # some tests need a longer snooze time
 
 
 def snooze(seconds: float = SNOOZE_TIME) -> None:

tests/test_cli.py

@@ -2,6 +2,7 @@
 
 import datetime
 import glob
+import json
 import os
 import pathlib
 
@@ -13,7 +14,7 @@
 from osxmetadata.__main__ import BACKUP_FILENAME, cli
 from osxmetadata.backup import load_backup_file
 
-from .conftest import FINDER_COMMENT_SNOOZE, snooze
+from .conftest import FINDER_COMMENT_SNOOZE, LONG_SNOOZE, snooze
 
 
 def parse_cli_output(output):
@@ -264,8 +265,13 @@ def test_cli_remove(test_file):
     md = OSXMetaData(test_file.name)
     md.authors = ["John Doe", "Jane Doe"]
     md.tags = [Tag("test", 0)]
+    snooze()
 
     runner = CliRunner()
+    result = runner.invoke(cli, ["--list", "--json", test_file.name])
+    data = json.loads(result.output)
+    assert sorted(data["kMDItemAuthors"]) == ["Jane Doe", "John Doe"]
+
     result = runner.invoke(
         cli,
         [
@@ -275,14 +281,40 @@ def test_cli_remove(test_file):
             "--remove",
             "tags",
             "test,0",
+            "--verbose",
             test_file.name,
         ],
     )
-    snooze()
     assert result.exit_code == 0
+    assert "Removing John Doe from authors" in result.output
+    # for some reason this test fails without an additional delay
+    # for the removed metadata to be updated on disk
+    # without the additional delay, reading the metadata reads the previous value
+    snooze(LONG_SNOOZE)
+
+    result = runner.invoke(cli, ["--list", "--json", test_file.name])
+    data = json.loads(result.output)
+    assert data["kMDItemAuthors"] == ["Jane Doe"]
+
+
+def test_cli_remove_tags_without_color(test_file):
+    """Test --remove tags without specifying color (#106)"""
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["--set", "tags", ".Test,red", test_file.name])
+    snooze(LONG_SNOOZE)
 
     md = OSXMetaData(test_file.name)
-    assert md.authors == ["Jane Doe"]
+    assert md.tags == [Tag(".Test", 6)]
+
+    result = runner.invoke(
+        cli,
+        ["--remove", "tags", ".Test", test_file.name],
+    )
+    assert result.exit_code == 0
+
+    snooze(LONG_SNOOZE)
+    md = OSXMetaData(test_file.name)
     assert not md.tags
 
 
@@ -495,14 +527,15 @@ def test_cli_backup_restore(test_dir):
 
     # wipe the data
     result = runner.invoke(cli, ["--wipe", test_file.as_posix()])
-    snooze()
+    snooze(LONG_SNOOZE)
     md = OSXMetaData(test_file)
     assert not md.tags
     assert not md.authors
     assert not md.stationerypad
 
     # restore the data
     result = runner.invoke(cli, ["--restore", test_file.as_posix()])
+    snooze(LONG_SNOOZE)
     assert result.exit_code == 0
     assert md.tags == [Tag("test", 0)]
     assert md.authors == ["John Doe", "Jane Doe"]
@@ -556,6 +589,7 @@ def test_cli_order(test_dir):
     md.wherefroms = ["http://www.apple.com"]
     md.downloadeddate = [datetime.datetime(2019, 1, 1, 0, 0, 0)]
     md.findercomment = "Hello World"
+    snooze(LONG_SNOOZE)
 
     runner = CliRunner()
 
@@ -564,7 +598,7 @@ def test_cli_order(test_dir):
 
     # wipe the data
     runner.invoke(cli, ["--wipe", test_file.as_posix()])
-    snooze()
+    snooze(LONG_SNOOZE)
 
     # restore the data and check order of operations
     result = runner.invoke(
@@ -602,7 +636,7 @@ def test_cli_order(test_dir):
     output = parse_cli_output(result.output)
     assert output["comment"] == "Hello World"
 
-    snooze()
+    snooze(LONG_SNOOZE)
     md = OSXMetaData(test_file)
     assert md.authors == ["John Smith", "Jane Smith"]
     assert md.findercomment == "Hello World"

tests/test_datetime_utils.py

@@ -1,4 +1,5 @@
 """Test datetime_utils """
+
 import datetime
 import os
 from datetime import date, timezone

tests/test_mditem_attributes.py

@@ -173,3 +173,19 @@ def test_get_set_mditem_attribute_value(test_file):
     snooze()
     assert md.get_mditem_attribute_value("kMDItemComment") == "foo,bar"
     assert md.comment == "foo,bar"
+
+
+def test_attribute_get_set(test_file):
+    """Test direct access get/set attribute values"""
+
+    md = OSXMetaData(test_file.name)
+    assert not md.authors
+    md.authors = ["foo", "bar"]
+    snooze()
+    assert md.authors == ["foo", "bar"]
+    md.authors = ["bar"]
+    snooze()
+    assert md.authors == ["bar"]
+    md.set("authors", ["foo"])
+    snooze()
+    assert md.authors == ["foo"]