From de0fdcd01281b1db29451aafd56153f34686c6ed Mon Sep 17 00:00:00 2001 From: iLLiCiTiT Date: Tue, 23 Feb 2021 19:12:03 +0100 Subject: [PATCH] added some docstring to handler --- pype/settings/handlers.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/pype/settings/handlers.py b/pype/settings/handlers.py index f905759bc8..64bb34e24e 100644 --- a/pype/settings/handlers.py +++ b/pype/settings/handlers.py @@ -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):