Added stationarypad, closes #47

Author: RhetTbull

README.md

@@ -1,10 +1,7 @@
 # osxmetadata 
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
-
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat)](#contributors-)
 
 
 ## What is osxmetadata?
@@ -35,7 +32,7 @@ The command line tool can also be run via `python -m osxmetadata`.  Running it w
 
 ```
 Usage: osxmetadata [OPTIONS] FILE
-  
+
   Read/write metadata from file(s).
 
 Options:
@@ -189,7 +186,13 @@ rating          kMDItemStarRating, com.apple.metadata:kMDItemStarRating;
                 an iTunes track. An integer.
 stationary      kMDItemFSIsStationery,
                 com.apple.metadata:kMDItemFSIsStationery; Boolean indicating
-                if this file is stationery.
+                if this file is stationery. Note: this is not what the
+                Finder uses for Stationary Pad flag.  See also
+                'stationarypad'.
+stationarypad   stationarypad, com.apple.FinderInfo; Marks the file as
+                stationary (a template that can be re-used). Setting this to
+                True is the same as checking the 'Stationary Pad' box in
+                Finder Info.
 tags            _kMDItemUserTags, com.apple.metadata:_kMDItemUserTags;
                 Finder tags; searchable in Spotlight using "tag:tag_name".
                 If you want tags/keywords visible in the Finder, use this
@@ -225,7 +228,8 @@ Information about commonly used MacOS metadata attributes is available from [App
 |kMDItemParticipants|participants|com.apple.metadata:kMDItemParticipants|The list of people who are visible in an image or movie or written about in a document. A list of strings.|
 |kMDItemProjects|projects|com.apple.metadata:kMDItemProjects|The list of projects that this file is part of. For example, if you were working on a movie all of the files could be marked as belonging to the project “My Movie”. A list of strings.|
 |kMDItemStarRating|rating|com.apple.metadata:kMDItemStarRating|User rating of this item. For example, the stars rating of an iTunes track. An integer.|
-|kMDItemFSIsStationery|stationary|com.apple.metadata:kMDItemFSIsStationery|Boolean indicating if this file is stationery.|
+|kMDItemFSIsStationery|stationary|com.apple.metadata:kMDItemFSIsStationery|Boolean indicating if this file is stationery. Note: this is not what the Finder uses for Stationary Pad flag.  See also 'stationarypad'.|
+|stationarypad|stationarypad|com.apple.FinderInfo|Marks the file as stationary (a template that can be re-used). Setting this to True is the same as checking the 'Stationary Pad' box in Finder Info.|
 |_kMDItemUserTags|tags|com.apple.metadata:_kMDItemUserTags|Finder tags; searchable in Spotlight using "tag:tag_name".  If you want tags/keywords visible in the Finder, use this instead of kMDItemKeywords.  A list of Tag objects.|
 |kMDItemVersion|version|com.apple.metadata:kMDItemVersion|The version number of this file. A string.|
 |kMDItemWhereFroms|wherefroms|com.apple.metadata:kMDItemWhereFroms|Describes where the file was obtained from (e.g. URL downloaded from).  A list of strings.|

osxmetadata/_version.py

@@ -1,3 +1,3 @@
 """ osxmetadata version """
 
-__version__ = "0.99.22"
+__version__ = "0.99.23"

osxmetadata/attributes.py

@@ -5,8 +5,9 @@
 from collections import namedtuple  # pylint: disable=syntax-error
 
 from .classes import (
-    _AttributeFinderColor,
     _AttributeFinderInfo,
+    _AttributeFinderInfoColor,
+    _AttributeFinderInfoStationaryPad,
     _AttributeList,
     _AttributeTagsList,
 )
@@ -327,7 +328,7 @@
         append=False,
         update=False,
         help="Boolean indicating if this file is stationery. "
-        + "Note: this is not what the Finder uses for Stationary Pad flag.",
+        + "Note: this is not what the Finder uses for Stationary Pad flag.  See also 'stationarypad'.",
         api_help=None,
     ),
     "findercolor": Attribute(
@@ -337,7 +338,7 @@
         type_=str,
         list=False,
         as_list=False,
-        class_=_AttributeFinderColor,
+        class_=_AttributeFinderInfoColor,
         append=False,
         update=False,
         help="Color tag set by the Finder.  Colors can also be set by _kMDItemUserTags.  "
@@ -346,20 +347,20 @@
         + "processing of FinderInfo color tag.",
         api_help=None,
     ),
-    # "stationarypad": Attribute(
-    #     name="stationarypad",
-    #     short_constant="stationarypad",
-    #     constant=FinderInfo,
-    #     type_=str,
-    #     list=False,
-    #     as_list=False,
-    #     class_=_AttributeFinderStationaryPad,
-    #     append=False,
-    #     update=False,
-    #     help="Marks the file as stationary (a template that can be re-used). "
-    #     +"Setting this to True is the same as checking the Stationary Pad box in Finder Info.",
-    #     api_help=None,
-    # ),
+    "stationarypad": Attribute(
+        name="stationarypad",
+        short_constant="stationarypad",
+        constant=FinderInfo,
+        type_=str,
+        list=False,
+        as_list=False,
+        class_=_AttributeFinderInfoStationaryPad,
+        append=False,
+        update=False,
+        help="Marks the file as stationary (a template that can be re-used). "
+        + "Setting this to True is the same as checking the 'Stationary Pad' box in Finder Info.",
+        api_help=None,
+    ),
 }
 
 # used for formatting output of --list

osxmetadata/classes.py

@@ -152,6 +152,9 @@ def __eq__(self, other):
         self._load_data()
         return self.data == other
 
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
 
 class _AttributeFinderInfo:
     """represents info stored in com.apple.FinderInfo"""
@@ -301,7 +304,7 @@ def set_finderinfo_stationarypad(self, value):
         """set the Stationary Pad flag of com.apple.FinderInfo"""
 
         value = 1 if value_to_bool(value) else 0
-
+        
         # stationary pad is encoded as a single bit
         bit = bitstring.BitArray(uint=value, length=1)
 
@@ -341,7 +344,7 @@ def __getitem__(self, key):
         return self.data[key]
 
 
-class _AttributeFinderColor(_AttributeFinderInfo):
+class _AttributeFinderInfoColor(_AttributeFinderInfo):
     def __init__(self, attribute, xattr_, osxmetadata_obj):
         super().__init__(attribute, xattr_, osxmetadata_obj)
 
@@ -363,6 +366,35 @@ def __eq__(self, other):
         self._load_data()
         return self.data.get("color") == other
 
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+
+class _AttributeFinderInfoStationaryPad(_AttributeFinderInfo):
+    def __init__(self, attribute, xattr_, osxmetadata_obj):
+        super().__init__(attribute, xattr_, osxmetadata_obj)
+
+    def set_value(self, value):
+        self.data = {"stationarypad": value_to_bool(value)}
+        self._write_data()
+
+    def get_value(self):
+        self._load_data()
+        return self.data.get("stationarypad", None)
+
+    def __repr__(self):
+        return repr(self.get_value())
+
+    def __eq__(self, other):
+        self._load_data()
+        return self.data.get("stationarypad") == other
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __bool__(self):
+        return bool(self.data.get("stationarypad", None))
+
 
 class _AttributeTagsList(_AttributeList, _AttributeFinderInfo):
     """represents a _kMDItemUserTag attribute list"""

osxmetadata/osxmetadata.py

@@ -91,6 +91,19 @@
 # TODO: check what happens if OSXMetaData.__init__ called with invalid file--should result in error but saw one case where it didn't
 # TODO: cleartags does not always clear colors--this is a new behavior, did Mac OS change something in implementation of colors?
 
+# all attributes that are part of com.apple.FinderInfo
+_FINDERINFO_ATTRIBUTES = ["finderinfo", "findercolor", "stationarypad"]
+
+# all attributes that use an Attribute class (defined in attributes.py)
+_ATTRIBUTE_CLASS_ATTRIBUTES = ["tags", *_FINDERINFO_ATTRIBUTES]
+
+# all attributes related to stationary pad
+_FINDERINFO_STATIONARYPAD_ATTRIBUTES = ["finderinfo", "stationarypad"]
+
+# all attributes related to Finder color
+_FINDERINFO_COLOR_ATTRIBUTES = ["finderinfo", "findercolor"]
+
+
 # AppleScript for manipulating Finder comments
 _scpt_set_finder_comment = applescript.AppleScript(
     """
@@ -117,37 +130,38 @@ class OSXMetaData:
     """Create an OSXMetaData object to access file metadata"""
 
     __slots__ = [
+        "__init",
+        "_attrs",
         "_fname",
         "_posix_name",
-        "_attrs",
         "_tz_aware",
-        "__init",
         "authors",
         "comment",
         "copyright",
         "creator",
         "description",
         "downloadeddate",
+        "duedate",
+        "findercolor",
         "findercomment",
+        "finderinfo",
         "headline",
         "keywords",
-        "tags",
-        "wherefroms",
-        "finderinfo",
-        "duedate",
-        "rating",
         "participants",
         "projects",
-        "version",
+        "rating",
         "stationary",
-        "findercolor",
+        "stationarypad",
+        "tags",
+        "version",
+        "wherefroms",
     ]
 
     def __init__(self, fname, tz_aware=False):
         """Create an OSXMetaData object to access file metadata
         fname: filename to operate on
         timezone_aware: bool; if True, date/time attributes will return
-                  timezone aware datetime.dateime attributes; if False (default)
+                  timezone aware datetime.datetime attributes; if False (default)
                   date/time attributes will return timezone naive objects"""
         self._fname = pathlib.Path(fname)
         self._posix_name = self._fname.resolve().as_posix()
@@ -293,7 +307,7 @@ def get_attribute(self, attribute_name):
         attribute = ATTRIBUTES[attribute_name]
 
         # user tags and finderinfo need special processing
-        if attribute.name in ["tags", "finderinfo", "findercolor"]:
+        if attribute.name in _ATTRIBUTE_CLASS_ATTRIBUTES:
             return getattr(self, attribute.name).get_value()
 
         # must be a "normal" metadata attribute
@@ -363,7 +377,7 @@ def set_attribute(self, attribute_name, value):
         attribute = ATTRIBUTES[attribute_name]
 
         # user tags and Finder info need special processing
-        if attribute.name in ["tags", "finderinfo", "findercolor"]:
+        if attribute.name in _ATTRIBUTE_CLASS_ATTRIBUTES:
             return getattr(self, attribute.name).set_value(value)
 
         # verify type is correct
@@ -414,7 +428,7 @@ def append_attribute(self, attribute_name, value, update=False):
             else:
                 new_value.extend(value)
             return self.tags.set_value(new_value)
-        if attribute.name in ["finderinfo", "findercolor"]:
+        if attribute.name in _FINDERINFO_ATTRIBUTES:
             raise ValueError(f"cannot append or update {attribute.name}")
 
         value = validate_attribute_value(attribute, value)
@@ -505,14 +519,14 @@ def clear_attribute(self, attribute_name):
                 # code following will also clear the attribute for Finder Comment
                 self.clear_finder_comment(self._posix_name)
 
-            if attribute.name in ["finderinfo", "findercolor", "tags"]:
+            if attribute.name in ["tags", *_FINDERINFO_COLOR_ATTRIBUTES]:
                 # don't clear the entire FinderInfo attribute, just delete the bits we know about
                 self.finderinfo.set_finderinfo_color(FINDER_COLOR_NONE)
 
-            if attribute.name in ["finderinfo", "stationarypad"]:
+            if attribute.name in _FINDERINFO_STATIONARYPAD_ATTRIBUTES:
                 self.finderinfo.set_finderinfo_stationarypad(False)
 
-            if attribute.name not in ["finderinfo", "findercolor"]:
+            if attribute.name not in _FINDERINFO_ATTRIBUTES:
                 # remove the entire attribute
                 self._attrs.remove(attribute.constant)
         except (IOError, OSError):

tests/test_finderinfo.py

@@ -187,3 +187,27 @@ def test_finderinfo_stationarypad_and_color(temp_file):
     meta.finderinfo = {"stationarypad": False}
     assert meta.finderinfo.color == FINDER_COLOR_GREEN
     assert not meta.finderinfo.stationarypad
+
+
+def test_stationarypad(temp_file):
+    """Test stationarypad attribute"""
+    from osxmetadata import OSXMetaData
+
+    meta = OSXMetaData(temp_file)
+    assert not meta.stationarypad
+
+    meta.stationarypad = True
+    assert meta.stationarypad
+
+    meta.stationarypad = 0
+    assert not meta.stationarypad
+
+    meta.stationarypad = 1
+    assert meta.stationarypad
+
+    meta.stationarypad = False
+    assert not meta.stationarypad
+    assert not meta.get_attribute("stationarypad")
+    
+    meta.set_attribute("stationarypad", True)
+    assert meta.get_attribute("stationarypad")