Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 12:54:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

grammar fixes

Browse source
This commit is contained in:
Jakub Trllo 2025-07-31 11:19:39 +02:00
parent d4092c8e31
commit 473cf8b0c1
1 changed files with 19 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

37
client/ayon_core/lib/local_settings.py
View file

@ -18,7 +18,7 @@ _PLACEHOLDER = object()
# TODO should use 'KeyError' or 'Exception' as base # TODO should use 'KeyError' or 'Exception' as base
class RegistryItemNotFound(ValueError): class RegistryItemNotFound(ValueError):
"""Raised when the item is not found in keyring.""" """Raised when the item is not found in the keyring."""
class _Cache: class _Cache:
@ -37,10 +37,10 @@ def get_ayon_appdirs(*args: str) -> str:
Deprecated: Deprecated:
Use 'get_launcher_local_dir' or 'get_launcher_storage_dir' based on Use 'get_launcher_local_dir' or 'get_launcher_storage_dir' based on
use-case. Deprecation added 24/08/09 (0.4.4-dev.1). a use-case. Deprecation added 24/08/09 (0.4.4-dev.1).
Args: Args:
*args (Iterable[str]): Subdirectories/files in local app data dir. *args (Iterable[str]): Subdirectories/files in the local app data dir.
Returns: Returns:
str: Path to directory/file in local app data dir. str: Path to directory/file in local app data dir.
@ -58,7 +58,7 @@ def get_ayon_appdirs(*args: str) -> str:
def get_launcher_storage_dir(*subdirs: str) -> str: def get_launcher_storage_dir(*subdirs: str) -> str:
"""Get storage directory for launcher. """Get a storage directory for launcher.
Storage directory is used for storing shims, addons, dependencies, etc. Storage directory is used for storing shims, addons, dependencies, etc.
@ -83,14 +83,14 @@ def get_launcher_storage_dir(*subdirs: str) -> str:
def get_launcher_local_dir(*subdirs: str) -> str: def get_launcher_local_dir(*subdirs: str) -> str:
"""Get local directory for launcher. """Get a local directory for launcher.
Local directory is used for storing machine or user specific data. Local directory is used for storing machine or user-specific data.
The location is user specific. The location is user-specific.
Note: Note:
This function should be called at least once on bootstrap. This function should be called at least once on the bootstrap.
Args: Args:
*subdirs (str): Subdirectories relative to local dir. *subdirs (str): Subdirectories relative to local dir.
@ -107,7 +107,7 @@ def get_launcher_local_dir(*subdirs: str) -> str:
def get_addons_resources_dir(addon_name: str, *args) -> str: def get_addons_resources_dir(addon_name: str, *args) -> str:
"""Get directory for storing resources for addons. """Get a directory for storing resources for addons.
Some addons might need to store ad-hoc resources that are not part of Some addons might need to store ad-hoc resources that are not part of
addon client package (e.g. because of size). Studio might define addon client package (e.g. because of size). Studio might define
@ -117,7 +117,7 @@ def get_addons_resources_dir(addon_name: str, *args) -> str:
Args: Args:
addon_name (str): Addon name. addon_name (str): Addon name.
*args (str): Subfolders in resources directory. *args (str): Subfolders in the resources directory.
Returns: Returns:
str: Path to resources directory. str: Path to resources directory.
@ -140,7 +140,7 @@ class AYONSecureRegistry:
identify which data were created by AYON. identify which data were created by AYON.
Args: Args:
name(str): Name of registry used as identifier for data. name(str): Name of registry used as the identifier for data.
""" """
def __init__(self, name: str) -> None: def __init__(self, name: str) -> None:
@ -162,9 +162,9 @@ class AYONSecureRegistry:
self._name = f"AYON/{name}" self._name = f"AYON/{name}"
def set_item(self, name: str, value: str) -> None: def set_item(self, name: str, value: str) -> None:
"""Set sensitive item into system's keyring. """Set sensitive item into the system's keyring.
This uses `Keyring module`_ to save sensitive stuff into system's This uses `Keyring module`_ to save sensitive stuff into the system's
keyring. keyring.
Args: Args:
@ -184,19 +184,20 @@ class AYONSecureRegistry:
def get_item( def get_item(
self, name: str, default: Any = _PLACEHOLDER self, name: str, default: Any = _PLACEHOLDER
) -> Optional[str]: ) -> Optional[str]:
"""Get value of sensitive item from system's keyring. """Get value of sensitive item from the system's keyring.
See also `Keyring module`_ See also `Keyring module`_
Args: Args:
name (str): Name of the item. name (str): Name of the item.
default (Any): Default value if item is not available. default (Any): Default value if the item is not available.
Returns: Returns:
value (str): Value of the item. value (str): Value of the item.
Raises: Raises:
RegistryItemNotFound: If item doesn't exist and default is not defined. RegistryItemNotFound: If the item doesn't exist and default
is not defined.
.. _Keyring module: .. _Keyring module:
https://github.com/jaraco/keyring https://github.com/jaraco/keyring
@ -216,7 +217,7 @@ class AYONSecureRegistry:
) )
def delete_item(self, name: str) -> None: def delete_item(self, name: str) -> None:
"""Delete value stored in system's keyring. """Delete value stored in the system's keyring.
See also `Keyring module`_ See also `Keyring module`_
@ -446,7 +447,7 @@ class IniSettingRegistry(ASettingRegistry):
class JSONSettingRegistry(ASettingRegistry): class JSONSettingRegistry(ASettingRegistry):
"""Class using json file as storage.""" """Class using a json file as storage."""
def __init__(self, name: str, path: str) -> None: def __init__(self, name: str, path: str) -> None:
super().__init__(name) super().__init__(name)