added some docstring to OpenPypeSecureRegistry

This commit is contained in:
iLLiCiTiT 2021-04-08 16:54:32 +02:00
parent 3785e9b53c
commit ee93c229fe
2 changed files with 22 additions and 0 deletions

View file

@ -32,6 +32,17 @@ _PLACEHOLDER = object()
class OpenPypeSecureRegistry:
"""Store information using keyring.
Registry should be used for private data that should be available only for
user.
All passed registry names will have added prefix `OpenPype/` to easier
identify which data were created by OpenPype.
Args:
name(str): Name of registry used as identifier for data.
"""
def __init__(self, name):
try:
import keyring

View file

@ -35,6 +35,17 @@ _PLACEHOLDER = object()
class OpenPypeSecureRegistry:
"""Store information using keyring.
Registry should be used for private data that should be available only for
user.
All passed registry names will have added prefix `OpenPype/` to easier
identify which data were created by OpenPype.
Args:
name(str): Name of registry used as identifier for data.
"""
def __init__(self, name):
try:
import keyring