[16] add delete_collections_named

VERSION

@@ -1 +1 @@
-1.18.2-develop15
+1.18.2-develop16

defaults/award/golden.yml

@@ -28,6 +28,8 @@ collections:
         collection_order: release.desc
       - name: translation
         translation_key: golden_best
+    delete_collections_named:
+      - Golden Globe Best Motion Pictures
     tmdb_list: 
       - 8191011 # Drama
       - 8191022 # Musical or Comedy

docs/metadata/details/definition.md

@@ -33,4 +33,5 @@ All the following attributes serve various functions as how the definition funct
 | `allowed_library_types`      | **Description:** Used to specify the types of libraries that this definition can work with.<br>Multiple can be used for one definition as a list or comma separated string. One `false` will cause it to fail.<br>**Values:** `movie`, `show`, `artist`, `true`, `false`                                                                                                                           |
 | `default_percent`            | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](../filters.md#special-filters). Default is 50.<br>**Values:** Integer between 1 and 100                                                                                                                                                                                   |
 | `ignore_blank_results`       | **Description:** Used to not have Errors resulting from blank results from builders.<br>**Default:** `false`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                      |
-| `only_run_on_create`         | **Description:** Used to only run the collection definition if the collection doesn't already exist.<br>**Default:** `false`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                      |
+| `only_run_on_create`         | **Description:** Used to only run the collection definition if the collection doesn't already exist.<br>**Default:** `false`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                      |
+| `delete_collections_named`   | **Description:** Used to delete any collections in your plex named one of the given collections.<br>**Values:** List of Collection Names to delete                                                                                                                                                                                                                                                 |

modules/builder.py

@@ -42,7 +42,7 @@ ignored_details = [
     "smart_filter", "smart_label", "smart_url", "run_again", "schedule", "sync_mode", "template", "variables", "test", "suppress_overlays",
     "delete_not_scheduled", "tmdb_person", "build_collection", "collection_order", "builder_level", "overlay",
     "validate_builders", "libraries", "sync_to_users", "exclude_users", "collection_name", "playlist_name", "name",
-    "blank_collection", "allowed_library_types", "delete_playlist", "ignore_blank_results", "only_run_on_create"
+    "blank_collection", "allowed_library_types", "delete_playlist", "ignore_blank_results", "only_run_on_create", "delete_collections_named"
 ]
 details = [
     "ignore_ids", "ignore_imdb_ids", "server_preroll", "changes_webhooks", "collection_filtering", "collection_mode", "limit", "url_theme",
@@ -502,6 +502,19 @@ class CollectionBuilder:
             logger.debug(f"Value: {data[methods['delete_not_scheduled']]}")
             self.details["delete_not_scheduled"] = util.parse(self.Type, "delete_not_scheduled", self.data, datatype="bool", methods=methods, default=False)
 
+        if "delete_collections_named" in methods and not self.overlay and not self.playlist:
+            logger.debug("")
+            logger.debug("Validating Method: delete_collections_named")
+            logger.debug(f"Value: {data[methods['delete_collections_named']]}")
+            for del_col in util.parse(self.Type, "delete_collections_named", self.data, datatype="strlist", methods=methods):
+                try:
+                    del_obj = self.library.get_collection(del_col, force_search=True)
+                    self.library.delete(del_obj)
+                    logger.info(f"Collection: {del_obj.title} deleted")
+                except Failed as e:
+                    if str(e).startswith("Plex Error: Failed to delete"):
+                        logger.error(e)
+
         if "schedule" in methods and not self.config.requested_collections and not self.overlay:
             logger.debug("")
             logger.debug("Validating Method: schedule")

modules/plex.py

@@ -843,7 +843,7 @@ class Plex(Library):
         except NotFound:
             raise Failed(f"Plex Error: Playlist {title} not found")
 
-    def get_collection(self, data, force_search=False):
+    def get_collection(self, data, force_search=False, debug=True):
         if isinstance(data, Collection):
             return data
         elif isinstance(data, int) and not force_search:
@@ -853,10 +853,11 @@ class Plex(Library):
             for d in cols:
                 if d.title == data:
                     return d
-            logger.debug("")
-            for d in cols:
-                logger.debug(f"Found: {d.title}")
-            logger.debug(f"Looking for: {data}")
+            if debug:
+                logger.debug("")
+                for d in cols:
+                    logger.debug(f"Found: {d.title}")
+                logger.debug(f"Looking for: {data}")
         raise Failed(f"Plex Error: Collection {data} not found")
 
     def validate_collections(self, collections):