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

add docstring

Browse source
This commit is contained in:
Jakub Trllo 2025-10-22 14:59:30 +02:00
parent b094cbd0cb
commit db11ba7437
1 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -584,7 +584,19 @@ def _get_ayon_service_username() -> Optional[str]:
def get_ayon_user_entity(username: Optional[str] = None) -> dict[str, Any]:
"""AYON user entity used for templates and publishing."""
"""AYON user entity used for templates and publishing.
Note:
Usually only service and admin users can receive the full user entity.
Args:
username (Optional[str]): Username of the user. If not passed, then
the current user in 'ayon_api' is used.
Returns:
dict[str, Any]: User entity.
"""
service_username = _get_ayon_service_username()
# Handle service user handling first
if service_username: