Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[8] add `custom_keys` dynamic attribute

Browse Source
pull/1169/head
meisnate12 2 years ago
parent b3059eacfc
commit 902d0c1746
4 changed files with 48 additions and 20 deletions
Show Stats Download Patch File Download Diff File

2
VERSION
Unescape View File

@ -1 +1 @@
1.18.0-develop7 1.18.0-develop8

1
defaults/movie/franchise.yml
Unescape View File

@ -62,6 +62,7 @@ dynamic_collections:
type: tmdb_collection type: tmdb_collection
remove_suffix: "Collection" remove_suffix: "Collection"
template: collection template: collection
custom_keys: false
addons: addons:
8091: # Alien 8091: # Alien
- 135416 # Prometheus - 135416 # Prometheus

15
docs/metadata/dynamic.md
Unescape View File

@ -94,6 +94,7 @@ dynamic_collections:
| [`title_format`](#title-format) | This is the format for the collection titles. | ❌ | | [`title_format`](#title-format) | This is the format for the collection titles. | ❌ |
| [`key_name_override`](#key-name-override) | Defines how key names can be overridden before they are formatted into collection titles. | ❌ | | [`key_name_override`](#key-name-override) | Defines how key names can be overridden before they are formatted into collection titles. | ❌ |
| [`title_override`](#title-override) | Defines how collection titles can be overridden ignoring title formatting. | ❌ | | [`title_override`](#title-override) | Defines how collection titles can be overridden ignoring title formatting. | ❌ |
| [`custom_keys`](#custom-keys) | Defines if custom keys are allowed. | ❌ |
| [`test`](#test) | Will add `test: true` to all collections for test runs. | ❌ | | [`test`](#test) | Will add `test: true` to all collections for test runs. | ❌ |
| [`sync`](#sync) | Will remove dynamic collections that are no longer in the creation list. | ❌ | | [`sync`](#sync) | Will remove dynamic collections that are no longer in the creation list. | ❌ |
| [`include`](#include) | Define a list of keys to be made into collections. | ❌ | | [`include`](#include) | Define a list of keys to be made into collections. | ❌ |
@ -1995,6 +1996,20 @@ dynamic_collections:
10: Star Wars Universe 10: Star Wars Universe
``` ```
## Custom Keys
Defines if custom keys are allowed. Can be `true` or `false`. Defaults to `true`.
Here's an example using `custom_keys`.
```yaml
dynamic_collections:
TMDb Collections: # mapping name does not matter, just needs to be unique
type: tmdb_collection
remove_suffix: "Collection"
custom_keys: false
```
## Test ## Test
Will add `test: true` to all collections for test runs. Will add `test: true` to all collections for test runs.

50
modules/meta.py
Unescape View File

@ -596,7 +596,11 @@ class MetadataFile(DataFile):
include = [i for i in util.parse("Config", "include", dynamic, parent=map_name, methods=methods, datatype="strlist") if i not in og_exclude] include = [i for i in util.parse("Config", "include", dynamic, parent=map_name, methods=methods, datatype="strlist") if i not in og_exclude]
if "append_include" in self.temp_vars: if "append_include" in self.temp_vars:
include.extend(util.parse("Config", "append_include", self.temp_vars["append_include"], parent="template_variable", datatype="strlist")) include.extend(util.parse("Config", "append_include", self.temp_vars["append_include"], parent="template_variable", datatype="strlist"))
addons = util.parse("Config", "addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr") if "addons" in methods else {} addons = {}
if "addons" in self.temp_vars:
addons = util.parse("Config", "addons", self.temp_vars["addons"], parent="template_variable", datatype="dictliststr")
elif "addons" in methods:
addons = util.parse("Config", "addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr")
if "append_addons" in self.temp_vars: if "append_addons" in self.temp_vars:
append_addons = util.parse("Config", "append_addons", self.temp_vars["append_addons"], parent=map_name, methods=methods, datatype="dictliststr") append_addons = util.parse("Config", "append_addons", self.temp_vars["append_addons"], parent=map_name, methods=methods, datatype="dictliststr")
for k, v in append_addons.items(): for k, v in append_addons.items():
@ -611,11 +615,11 @@ class MetadataFile(DataFile):
default_title_format = "<<key_name>>" default_title_format = "<<key_name>>"
default_template = None default_template = None
auto_list = {} auto_list = {}
all_keys = [] all_keys = {}
dynamic_data = None dynamic_data = None
def _check_dict(check_dict): def _check_dict(check_dict):
for ck, cv in check_dict.items(): for ck, cv in check_dict.items():
all_keys.append(ck) all_keys[str(ck)] = cv
if str(ck) not in exclude and str(cv) not in exclude: if str(ck) not in exclude and str(cv) not in exclude:
auto_list[str(ck)] = cv auto_list[str(ck)] = cv
if auto_type == "decade" and library.is_show: if auto_type == "decade" and library.is_show:
@ -623,7 +627,7 @@ class MetadataFile(DataFile):
if addons: if addons:
raise Failed(f"Config Error: addons cannot be used with show decades") raise Failed(f"Config Error: addons cannot be used with show decades")
addons = {} addons = {}
all_keys = [] all_keys = {}
for i, item in enumerate(all_items, 1): for i, item in enumerate(all_items, 1):
logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}")
if item.year: if item.year:
@ -632,7 +636,7 @@ class MetadataFile(DataFile):
addons[decade] = [] addons[decade] = []
if item.year not in addons[decade]: if item.year not in addons[decade]:
addons[decade].append(item.year) addons[decade].append(item.year)
all_keys.append(item.year) all_keys[str(item.year)] = str(item.year)
auto_list = {str(k): f"{k}s" for k in addons if str(k) not in exclude and f"{k}s" not in exclude} auto_list = {str(k): f"{k}s" for k in addons if str(k) not in exclude and f"{k}s" not in exclude}
default_template = {"smart_filter": {"limit": 50, "sort_by": "critic_rating.desc", "any": {"year": f"<<value>>"}}} default_template = {"smart_filter": {"limit": 50, "sort_by": "critic_rating.desc", "any": {"year": f"<<value>>"}}}
default_title_format = "Best <<library_type>>s of <<key_name>>" default_title_format = "Best <<library_type>>s of <<key_name>>"
@ -643,18 +647,18 @@ class MetadataFile(DataFile):
else: else:
tags = library.get_tags(search_tag) tags = library.get_tags(search_tag)
if auto_type in ["subtitle_language", "audio_language"]: if auto_type in ["subtitle_language", "audio_language"]:
all_keys = [] all_keys = {}
auto_list = {} auto_list = {}
for i in tags: for i in tags:
all_keys.append(str(i.key))
final_title = self.config.TMDb.TMDb._iso_639_1[str(i.key)].english_name if str(i.key) in self.config.TMDb.TMDb._iso_639_1 else str(i.title) final_title = self.config.TMDb.TMDb._iso_639_1[str(i.key)].english_name if str(i.key) in self.config.TMDb.TMDb._iso_639_1 else str(i.title)
all_keys[str(i.key)] = final_title
if all([x not in exclude for x in [final_title, str(i.title), str(i.key)]]): if all([x not in exclude for x in [final_title, str(i.title), str(i.key)]]):
auto_list[str(i.key)] = final_title auto_list[str(i.key)] = final_title
elif auto_type in ["resolution", "decade"]: elif auto_type in ["resolution", "decade"]:
all_keys = [str(i.key) for i in tags] all_keys = {str(i.key): i.title for i in tags}
auto_list = {str(i.key): i.title for i in tags if str(i.title) not in exclude and str(i.key) not in exclude} auto_list = {str(i.key): i.title for i in tags if str(i.title) not in exclude and str(i.key) not in exclude}
else: else:
all_keys = [str(i.title) for i in tags] all_keys = {str(i.title): i.title for i in tags}
auto_list = {str(i.title): i.title for i in tags if str(i.title) not in exclude} auto_list = {str(i.title): i.title for i in tags if str(i.title) not in exclude}
if library.is_music: if library.is_music:
final_var = auto_type if auto_type.startswith("album") else f"artist_{auto_type}" final_var = auto_type if auto_type.startswith("album") else f"artist_{auto_type}"
@ -675,7 +679,7 @@ class MetadataFile(DataFile):
tmdb_id, tvdb_id, imdb_id = library.get_ids(item) tmdb_id, tvdb_id, imdb_id = library.get_ids(item)
tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=True) tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=True)
if tmdb_item and tmdb_item.collection_id and tmdb_item.collection_name: if tmdb_item and tmdb_item.collection_id and tmdb_item.collection_name:
all_keys.append(str(tmdb_item.collection_id)) all_keys[str(tmdb_item.collection_id)] = tmdb_item.collection_name
if str(tmdb_item.collection_id) not in exclude and tmdb_item.collection_name not in exclude: if str(tmdb_item.collection_id) not in exclude and tmdb_item.collection_name not in exclude:
auto_list[str(tmdb_item.collection_id)] = tmdb_item.collection_name auto_list[str(tmdb_item.collection_id)] = tmdb_item.collection_name
logger.exorcise() logger.exorcise()
@ -686,7 +690,7 @@ class MetadataFile(DataFile):
tmdb_id, tvdb_id, imdb_id = library.get_ids(item) tmdb_id, tvdb_id, imdb_id = library.get_ids(item)
tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=library.type == "Movie") tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=library.type == "Movie")
if tmdb_item and tmdb_item.language_iso: if tmdb_item and tmdb_item.language_iso:
all_keys.append(tmdb_item.language_iso) all_keys[tmdb_item.language_iso] = tmdb_item.language_name
if tmdb_item.language_iso not in exclude and tmdb_item.language_name not in exclude: if tmdb_item.language_iso not in exclude and tmdb_item.language_name not in exclude:
auto_list[tmdb_item.language_iso] = tmdb_item.language_name auto_list[tmdb_item.language_iso] = tmdb_item.language_name
logger.exorcise() logger.exorcise()
@ -699,7 +703,7 @@ class MetadataFile(DataFile):
tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=library.type == "Movie") tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=library.type == "Movie")
if tmdb_item and tmdb_item.countries: if tmdb_item and tmdb_item.countries:
for country in tmdb_item.countries: for country in tmdb_item.countries:
all_keys.append(country.iso_3166_1.lower()) all_keys[country.iso_3166_1.lower()] = country.name
if country.iso_3166_1.lower() not in exclude and country.name not in exclude: if country.iso_3166_1.lower() not in exclude and country.name not in exclude:
auto_list[country.iso_3166_1.lower()] = country.name auto_list[country.iso_3166_1.lower()] = country.name
logger.exorcise() logger.exorcise()
@ -743,7 +747,7 @@ class MetadataFile(DataFile):
for role in roles: for role in roles:
if person_count < person_limit and role["count"] >= person_minimum and role["name"] not in exclude: if person_count < person_limit and role["count"] >= person_minimum and role["name"] not in exclude:
auto_list[role["name"]] = role["name"] auto_list[role["name"]] = role["name"]
all_keys.append(role["name"]) all_keys[role["name"]] = role["name"]
person_count += 1 person_count += 1
default_template = {"plex_search": {"any": {auto_type: "<<value>>"}}} default_template = {"plex_search": {"any": {auto_type: "<<value>>"}}}
elif auto_type == "number": elif auto_type == "number":
@ -775,7 +779,7 @@ class MetadataFile(DataFile):
raise Failed(f"Config Error: {map_name} data ending must be greater than starting") raise Failed(f"Config Error: {map_name} data ending must be greater than starting")
current = starting current = starting
while current <= ending: while current <= ending:
all_keys.append(str(current)) all_keys[str(current)] = str(current)
if str(current) not in exclude and current not in exclude: if str(current) not in exclude and current not in exclude:
auto_list[str(current)] = str(current) auto_list[str(current)] = str(current)
current += increment current += increment
@ -783,7 +787,7 @@ class MetadataFile(DataFile):
if "data" not in methods: if "data" not in methods:
raise Failed(f"Config Error: {map_name} data attribute not found") raise Failed(f"Config Error: {map_name} data attribute not found")
for k, v in util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="strdict").items(): for k, v in util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="strdict").items():
all_keys.append(k) all_keys[k] = v
if k not in exclude and v not in exclude: if k not in exclude and v not in exclude:
auto_list[k] = v auto_list[k] = v
elif auto_type == "trakt_user_lists": elif auto_type == "trakt_user_lists":
@ -804,20 +808,27 @@ class MetadataFile(DataFile):
if "append_data" in self.temp_vars: if "append_data" in self.temp_vars:
for k, v in util.parse("Config", "append_data", self.temp_vars["append_data"], parent=map_name, methods=methods, datatype="strdict").items(): for k, v in util.parse("Config", "append_data", self.temp_vars["append_data"], parent=map_name, methods=methods, datatype="strdict").items():
all_keys.append(k) all_keys[k] = v
if k not in exclude and v not in exclude: if k not in exclude and v not in exclude:
auto_list[k] = v auto_list[k] = v
custom_keys = True
if "custom_keys" in self.temp_vars:
custom_keys = util.parse("Config", "custom_keys", self.temp_vars["custom_keys"], parent="template_variable", default=custom_keys)
elif "custom_keys" in methods:
custom_keys = util.parse("Config", "custom_keys", dynamic, parent=map_name, methods=methods, default=custom_keys)
for add_key, combined_keys in addons.items(): for add_key, combined_keys in addons.items():
if add_key not in all_keys and add_key not in og_exclude: if add_key not in all_keys and add_key not in og_exclude:
final_keys = [ck for ck in combined_keys if ck in all_keys] final_keys = [ck for ck in combined_keys if ck in all_keys]
if final_keys: if custom_keys and final_keys:
if include: if include:
include.append(add_key) include.append(add_key)
auto_list[add_key] = add_key auto_list[add_key] = add_key
addons[add_key] = final_keys addons[add_key] = final_keys
else: elif custom_keys:
logger.warning(f"Config Warning: {add_key} Custom Key must have at least one Key") logger.warning(f"Config Warning: {add_key} Custom Key must have at least one Key")
else:
for final_key in final_keys:
auto_list[final_key] = all_keys[final_key]
title_format = default_title_format title_format = default_title_format
if "title_format" in self.temp_vars: if "title_format" in self.temp_vars:
title_format = util.parse("Config", "title_format", self.temp_vars["title_format"], parent="template_variable", default=default_title_format) title_format = util.parse("Config", "title_format", self.temp_vars["title_format"], parent="template_variable", default=default_title_format)
@ -901,6 +912,7 @@ class MetadataFile(DataFile):
logger.debug(f"Title Format: {title_format}") logger.debug(f"Title Format: {title_format}")
logger.debug(f"Key Name Override: {key_name_override}") logger.debug(f"Key Name Override: {key_name_override}")
logger.debug(f"Title Override: {title_override}") logger.debug(f"Title Override: {title_override}")
logger.debug(f"Custom Keys: {custom_keys}")
logger.debug(f"Test: {test}") logger.debug(f"Test: {test}")
logger.debug(f"Sync: {sync}") logger.debug(f"Sync: {sync}")
logger.debug(f"Include: {include}") logger.debug(f"Include: {include}")

Write Preview
Loading…
Cancel
Save