feat: add PlexPartialObject.isLocked method (#1293)

Co-authored-by: JonnyWong16 <[email protected]>

Author: ReenigneArcher

plexapi/base.py

@@ -565,6 +565,14 @@ def isPartialObject(self):
         """ Returns True if this is not a full object. """
         return not self.isFullObject()
 
+    def isLocked(self, field: str):
+        """ Returns True if the specified field is locked, otherwise False.
+
+            Parameters:
+                field (str): The name of the field.
+        """
+        return next((f.locked for f in self.fields if f.name == field), False)
+
     def _edit(self, **kwargs):
         """ Actually edit an object. """
         if isinstance(self._edits, dict):

tests/test_collection.py

@@ -190,6 +190,8 @@ def test_Collection_edit(collection, movies):
     assert collection.summary == newSummary
     lockedFields = [f.locked for f in collection.fields if f.name in fields]
     assert all(lockedFields)
+    for f in fields:
+        assert collection.isLocked(field=f)
 
     collection.edit(
         title=title,
@@ -210,6 +212,8 @@ def test_Collection_edit(collection, movies):
     assert collection.summary == summary
     lockedFields = [f.locked for f in collection.fields if f.name in fields]
     assert not any(lockedFields)
+    for f in fields:
+        assert not collection.isLocked(field=f)
 
 
 def test_Collection_create(plex, tvshows):

tests/test_video.py

@@ -1411,6 +1411,7 @@ def test_video_edits_locked(movie, episode):
         if field.name == 'titleSort':
             assert movie.titleSort == 'New Title Sort'
             assert field.locked is True
+            assert movie.isLocked(field=field.name)
     movie.edit(**{'titleSort.value': movieTitleSort, 'titleSort.locked': 0})
 
     episodeTitleSort = episode.titleSort
@@ -1420,6 +1421,7 @@ def test_video_edits_locked(movie, episode):
         if field.name == 'titleSort':
             assert episode.titleSort == 'New Title Sort'
             assert field.locked is True
+            assert episode.isLocked(field=field.name)
     episode.edit(**{'titleSort.value': episodeTitleSort, 'titleSort.locked': 0})