Skip to content

lib

get_ayon_settings(project_name=None)

AYON studio settings.

Raw AYON settings values.

Parameters:

Name Type Description Default
project_name Optional[str]

Project name.

None

Returns:

Type Description

dict[str, Any]: AYON settings.

Source code in client/ayon_core/settings/lib.py
171
172
173
174
175
176
177
178
179
180
181
182
183
def get_ayon_settings(project_name=None):
    """AYON studio settings.

    Raw AYON settings values.

    Args:
        project_name (Optional[str]): Project name.

    Returns:
        dict[str, Any]: AYON settings.
    """

    return _AyonSettingsCache.get_value_by_project(project_name)

get_current_project_settings()

DEPRECATE Project settings for current context project.

Function requires access to pipeline context which is in 'ayon_core.pipeline'.

Returns:

Type Description

dict[str, Any]: Project settings for current context project.

Source code in client/ayon_core/settings/lib.py
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
def get_current_project_settings():
    """DEPRECATE Project settings for current context project.

    Function requires access to pipeline context which is in
        'ayon_core.pipeline'.

    Returns:
        dict[str, Any]: Project settings for current context project.

    """
    warnings.warn(
        "Used deprecated function 'get_current_project_settings' in"
        " 'ayon_core.settings'. The function was moved to"
        " 'ayon_core.pipeline.context_tools'.",
        DeprecationWarning,
        stacklevel=2
    )
    from ayon_core.pipeline.context_tools import get_current_project_settings

    return get_current_project_settings()

get_general_environments(studio_settings=None)

General studio environment variables.

Parameters:

Name Type Description Default
studio_settings Optional[dict]

Pre-queried studio settings.

None

Returns:

Type Description

dict[str, Any]: General studio environment variables.

Source code in client/ayon_core/settings/lib.py
194
195
196
197
198
199
200
201
202
203
204
205
206
def get_general_environments(studio_settings=None):
    """General studio environment variables.

    Args:
        studio_settings (Optional[dict]): Pre-queried studio settings.

    Returns:
        dict[str, Any]: General studio environment variables.

    """
    if studio_settings is None:
        studio_settings = get_ayon_settings()
    return json.loads(studio_settings["core"]["environments"])

get_project_environments(project_name, project_settings=None)

Project environment variables.

Parameters:

Name Type Description Default
project_name str

Project name.

required
project_settings Optional[dict]

Pre-queried project settings.

None

Returns:

Type Description

dict[str, Any]: Project environment variables.

Source code in client/ayon_core/settings/lib.py
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
def get_project_environments(project_name, project_settings=None):
    """Project environment variables.

    Args:
        project_name (str): Project name.
        project_settings (Optional[dict]): Pre-queried project settings.

    Returns:
        dict[str, Any]: Project environment variables.

    """
    if project_settings is None:
        project_settings = get_project_settings(project_name)
    return json.loads(
        project_settings["core"]["project_environments"]
    )