Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2026-01-02 00:44:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Refactor overriden -> overridden + hightlight -> highlight

Browse source
This commit is contained in:
Roy Nieterau 2022-01-30 23:05:17 +01:00
parent c6eb14ab62
commit f9209be519
31 changed files with 84 additions and 84 deletions
Download patch file Download diff file Expand all files Collapse all files

6
openpype/settings/constants.py
View file

@ -2,14 +2,14 @@ import re
# Metadata keys for work with studio and project overrides
M_OVERRIDEN_KEY = "__overriden_keys__"
M_OVERRIDDEN_KEY = "__overridden_keys__"
# Metadata key for storing information about environments
M_ENVIRONMENT_KEY = "__environment_keys__"
# Metadata key for storing dynamic created labels
M_DYNAMIC_KEY_LABEL = "__dynamic_keys_labels__"
METADATA_KEYS = (
M_OVERRIDEN_KEY,
M_OVERRIDDEN_KEY,
M_ENVIRONMENT_KEY,
M_DYNAMIC_KEY_LABEL
)
@ -32,7 +32,7 @@ KEY_REGEX = re.compile(r"^[{}]+$".format(KEY_ALLOWED_SYMBOLS))
__all__ = (
"M_OVERRIDEN_KEY",
"M_OVERRIDDEN_KEY",
"M_ENVIRONMENT_KEY",
"M_DYNAMIC_KEY_LABEL",

4
openpype/settings/entities/base_entity.py
View file

@ -752,7 +752,7 @@ class BaseItemEntity(BaseEntity):
@abstractmethod
def _add_to_project_override(self, on_change_trigger):
"""Item's implementation to set values as overriden for project.
"""Item's implementation to set values as overridden for project.
Mark item and all it's children to be stored as project overrides.
"""
@ -794,7 +794,7 @@ class BaseItemEntity(BaseEntity):
"""Item's implementation to remove project overrides.
Mark item as does not have project overrides. Must not change
`was_overriden` attribute value.
`was_overridden` attribute value.
Args:
on_change_trigger (list): Callbacks of `on_change` should be stored

14
openpype/settings/entities/dict_conditional.py
View file

@ -6,7 +6,7 @@ from .lib import (
)
from openpype.settings.constants import (
METADATA_KEYS,
M_OVERRIDEN_KEY,
M_OVERRIDDEN_KEY,
KEY_REGEX
)
from . import (
@ -119,7 +119,7 @@ class DictConditionalEntity(ItemEntity):
# `current_metadata` are still when schema is loaded
# - only metadata stored with dict item are gorup overrides in
# M_OVERRIDEN_KEY
# M_OVERRIDDEN_KEY
self._current_metadata = {}
self._metadata_are_modified = False
@ -377,9 +377,9 @@ class DictConditionalEntity(ItemEntity):
):
continue
if M_OVERRIDEN_KEY not in current_metadata:
current_metadata[M_OVERRIDEN_KEY] = []
current_metadata[M_OVERRIDEN_KEY].append(key)
if M_OVERRIDDEN_KEY not in current_metadata:
current_metadata[M_OVERRIDDEN_KEY] = []
current_metadata[M_OVERRIDDEN_KEY].append(key)
# Define if current metadata are avaialble for current override state
metadata = NOT_SET
@ -535,7 +535,7 @@ class DictConditionalEntity(ItemEntity):
enum_value = value.get(self.enum_key)
old_metadata = metadata.get(M_OVERRIDEN_KEY)
old_metadata = metadata.get(M_OVERRIDDEN_KEY)
if old_metadata:
old_metadata_set = set(old_metadata)
new_metadata = []
@ -547,7 +547,7 @@ class DictConditionalEntity(ItemEntity):
for key in old_metadata_set:
new_metadata.append(key)
metadata[M_OVERRIDEN_KEY] = new_metadata
metadata[M_OVERRIDDEN_KEY] = new_metadata
return value, metadata

14
openpype/settings/entities/dict_immutable_keys_entity.py
View file

@ -9,7 +9,7 @@ from .lib import (
)
from openpype.settings.constants import (
METADATA_KEYS,
M_OVERRIDEN_KEY,
M_OVERRIDDEN_KEY,
KEY_REGEX
)
from . import (
@ -183,7 +183,7 @@ class DictImmutableKeysEntity(ItemEntity):
# `current_metadata` are still when schema is loaded
# - only metadata stored with dict item are gorup overrides in
# M_OVERRIDEN_KEY
# M_OVERRIDDEN_KEY
self._current_metadata = {}
self._metadata_are_modified = False
@ -257,9 +257,9 @@ class DictImmutableKeysEntity(ItemEntity):
):
continue
if M_OVERRIDEN_KEY not in current_metadata:
current_metadata[M_OVERRIDEN_KEY] = []
current_metadata[M_OVERRIDEN_KEY].append(key)
if M_OVERRIDDEN_KEY not in current_metadata:
current_metadata[M_OVERRIDDEN_KEY] = []
current_metadata[M_OVERRIDDEN_KEY].append(key)
# Define if current metadata are avaialble for current override state
metadata = NOT_SET
@ -399,7 +399,7 @@ class DictImmutableKeysEntity(ItemEntity):
if key in value:
metadata[key] = value.pop(key)
old_metadata = metadata.get(M_OVERRIDEN_KEY)
old_metadata = metadata.get(M_OVERRIDDEN_KEY)
if old_metadata:
old_metadata_set = set(old_metadata)
new_metadata = []
@ -410,7 +410,7 @@ class DictImmutableKeysEntity(ItemEntity):
for key in old_metadata_set:
new_metadata.append(key)
metadata[M_OVERRIDEN_KEY] = new_metadata
metadata[M_OVERRIDDEN_KEY] = new_metadata
return value, metadata

2
openpype/settings/entities/dict_mutable_keys_entity.py
View file

@ -222,7 +222,7 @@ class DictMutableKeysEntity(EndpointEntity):
self.required_keys = self.schema_data.get("required_keys") or []
self.collapsible_key = self.schema_data.get("collapsible_key") or False
# GUI attributes
self.hightlight_content = (
self.highlight_content = (
self.schema_data.get("highlight_content") or False
)

2
openpype/settings/entities/lib.py
View file

@ -101,7 +101,7 @@ class OverrideState:
- DEFAULTS - Entity cares only about default values. It is not
possible to set higher state if any entity does not have filled
default value.
- STUDIO - First layer of overrides. Hold only studio overriden values
- STUDIO - First layer of overrides. Hold only studio overridden values
that are applied on top of defaults.
- PROJECT - Second layer of overrides. Hold only project overrides that are
applied on top of defaults and studio overrides.

4
openpype/settings/entities/schemas/README.md
View file

@ -10,7 +10,7 @@
- `"is_file"` - this key is for storing openpype defaults in `openpype` repo
- reasons of existence: developing new schemas does not require to create defaults manually
- key is validated, must be once in hierarchy else it won't be possible to store openpype defaults
- `"is_group"` - define that all values under key in hierarchy will be overriden if any value is modified, this information is also stored to overrides
- `"is_group"` - define that all values under key in hierarchy will be overridden if any value is modified, this information is also stored to overrides
- this keys is not allowed for all inputs as they may have not reason for that
- key is validated, can be only once in hierarchy but is not required
- currently there are `system settings` and `project settings`
@ -767,7 +767,7 @@ Anatomy represents data stored on project document.
### anatomy
- entity works similarly to `dict`
- anatomy has always all keys overriden with overrides
- anatomy has always all keys overridden with overrides
- overrides are not applied as all anatomy data must be available from project document
- all children must be groups

8
openpype/settings/entities/schemas/system_schema/example_schema.json
View file

@ -11,13 +11,13 @@
},
{
"type": "dict-conditional",
"key": "overriden_value",
"label": "Overriden value",
"enum_key": "overriden",
"key": "overridden_value",
"label": "Overridden value",
"enum_key": "overridden",
"enum_is_horizontal": true,
"enum_children": [
{
"key": "overriden",
"key": "overridden",
"label": "Override value",
"children": [
{

20
openpype/settings/handlers.py
View file

@ -13,7 +13,7 @@ from .constants import (
PROJECT_SETTINGS_KEY,
PROJECT_ANATOMY_KEY,
LOCAL_SETTING_KEY,
M_OVERRIDEN_KEY
M_OVERRIDDEN_KEY
)
from .lib import load_json_file
@ -254,12 +254,12 @@ class MongoSettingsHandler(SettingsHandler):
continue
# Pop key from values
output[key] = general_data.pop(key)
# Pop key from overriden metadata
# Pop key from overridden metadata
if (
M_OVERRIDEN_KEY in general_data
and key in general_data[M_OVERRIDEN_KEY]
M_OVERRIDDEN_KEY in general_data
and key in general_data[M_OVERRIDDEN_KEY]
):
general_data[M_OVERRIDEN_KEY].remove(key)
general_data[M_OVERRIDDEN_KEY].remove(key)
return output
def _apply_global_settings(
@ -319,17 +319,17 @@ class MongoSettingsHandler(SettingsHandler):
system_general = {}
system_settings_data["general"] = system_general
overriden_keys = system_general.get(M_OVERRIDEN_KEY) or []
overridden_keys = system_general.get(M_OVERRIDDEN_KEY) or []
for key in self.global_general_keys:
if key not in globals_data:
continue
system_general[key] = globals_data[key]
if key not in overriden_keys:
overriden_keys.append(key)
if key not in overridden_keys:
overridden_keys.append(key)
if overriden_keys:
system_general[M_OVERRIDEN_KEY] = overriden_keys
if overridden_keys:
system_general[M_OVERRIDDEN_KEY] = overridden_keys
return system_settings_document

14
openpype/settings/lib.py
View file

@ -8,7 +8,7 @@ from .exceptions import (
SaveWarningExc
)
from .constants import (
M_OVERRIDEN_KEY,
M_OVERRIDDEN_KEY,
M_ENVIRONMENT_KEY,
METADATA_KEYS,
@ -546,13 +546,13 @@ def subkey_merge(_dict, value, keys):
def merge_overrides(source_dict, override_dict):
"""Merge data from override_dict to source_dict."""
if M_OVERRIDEN_KEY in override_dict:
overriden_keys = set(override_dict.pop(M_OVERRIDEN_KEY))
if M_OVERRIDDEN_KEY in override_dict:
overridden_keys = set(override_dict.pop(M_OVERRIDDEN_KEY))
else:
overriden_keys = set()
overridden_keys = set()
for key, value in override_dict.items():
if (key in overriden_keys or key not in source_dict):
if (key in overridden_keys or key not in source_dict):
source_dict[key] = value
elif isinstance(value, dict) and isinstance(source_dict[key], dict):
@ -574,7 +574,7 @@ def apply_local_settings_on_system_settings(system_settings, local_settings):
"""Apply local settings on studio system settings.
ATM local settings can modify only application executables. Executable
values are not overriden but prepended.
values are not overridden but prepended.
"""
if not local_settings or "applications" not in local_settings:
return
@ -914,7 +914,7 @@ def get_environments():
"""Calculated environment based on defaults and system settings.
Any default environment also found in the system settings will be fully
overriden by the one from the system settings.
overridden by the one from the system settings.
Returns:
dict: Output should be ready for `acre` module.