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

added some docstring to handler

Browse source
This commit is contained in:
iLLiCiTiT 2021-02-23 19:12:03 +01:00
parent 818a7c457e
commit de0fdcd012
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
pype/settings/handlers.py
View file

@ -516,7 +516,17 @@ class MongoSettingsHandler(SettingsHandler):
class MongoLocalSettingsHandler(LocalSettingsHandler):
"""Settings handler that use mongo for store and load local settings."""
"""Settings handler that use mongo for store and load local settings.
Data have 2 query criteria. First is key "type" stored in constant
`LOCAL_SETTING_KEY`. Second is key "site_id" which value can be obstained
with `get_local_site_id` function.
Because project specific values are stored by project name the default
project would have key `None` which is not allowed. Because of that is
`None` replaced with `default_project_key` value on save and the key
is replaced with `None` of load.
"""
default_project_key = "__default_project__"
def __init__(self, local_site_id=None):