Skip to content

Store own attributes dictionary in 'own_attributes' #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iLLiCiTiT merged 4 commits into from
Oct 26, 2026
Merged

Store own attributes dictionary in 'own_attributes' #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
64f66f5
Store own attributes dictionary in 'own_attrib'
iLLiCiTiT Oct 26, 2026
53fe104
Rename 'own_attrib' key to 'own_attributes'
iLLiCiTiT Oct 26, 2026
68a3748
Add 'own_attributes' argument to user getters
iLLiCiTiT Oct 26, 2026
0835e95
Use 'bool' type in 'own_attributes' docstrings
iLLiCiTiT Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 51 additions & 24 deletions ayon_api/_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,7 @@ def get_users(
usernames: Iterable[str] | None = None,
emails: Iterable[str] | None = None,
fields: Iterable[str] | None = None,
own_attributes: bool = False,
) -> Generator[dict[str, Any], None, None]:
"""Get Users.

Expand All @@ -814,6 +815,9 @@ def get_users(
emails (Iterable[str] | None): Filter by emails.
fields (Iterable[str] | None): Fields to be queried
for users.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on user, other
attributes have 'None' value.

Returns:
Generator[dict[str, Any], None, None]: Queried users.
Expand All @@ -825,13 +829,15 @@ def get_users(
usernames=usernames,
emails=emails,
fields=fields,
own_attributes=own_attributes,
)


def get_user_by_name(
username: str,
project_name: str | None = None,
fields: Iterable[str] | None = None,
own_attributes: bool = False,
) -> dict[str, Any] | None:
"""Get user by name using GraphQl.

Expand All @@ -842,6 +848,9 @@ def get_user_by_name(
username (str): Username.
project_name (str | None): Define scope of project.
fields (Iterable[str] | None): Fields to be queried for users.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on user, other
attributes have 'None' value.

Returns:
dict[str, Any] | None: User info or None if user is not found.
Expand All @@ -852,18 +861,23 @@ def get_user_by_name(
username=username,
project_name=project_name,
fields=fields,
own_attributes=own_attributes,
)


def get_user(
username: str | None = None,
own_attributes: bool = False,
) -> dict[str, Any] | None:
"""Get user info using REST endpoint.

User contains only explicitly set attributes in 'attrib'.

Args:
username (str | None): Username.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on user, other
attributes have 'None' value.

Returns:
dict[str, Any] | None: User info or None if user is not
Expand All @@ -873,6 +887,7 @@ def get_user(
con = get_server_api_connection()
return con.get_user(
username=username,
own_attributes=own_attributes,
)


Expand Down Expand Up @@ -5173,8 +5188,9 @@ def get_projects(
include_skeleton (bool): Include skeleton projects.
fields (Optional[Iterable[str]]): fields to be queried
for project.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Generator[ProjectDict, None, None]: Queried projects.
Expand All @@ -5201,8 +5217,9 @@ def get_project(
project_name (str): Name of project.
fields (Optional[Iterable[str]]): fields to be queried
for project.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[ProjectDict]: Project entity data or None
Expand Down Expand Up @@ -6128,8 +6145,9 @@ def get_folders(
fields (Optional[Iterable[str]]): Fields to be queried for
folder. All possible folder fields are returned
if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Generator[FolderDict, None, None]: Queried folder entities.
Expand Down Expand Up @@ -6172,8 +6190,9 @@ def get_folder_by_id(
folder_id (str): Folder id.
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[FolderDict]: Folder entity data or None
Expand Down Expand Up @@ -6205,8 +6224,9 @@ def get_folder_by_path(
folder_path (str): Folder path.
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[FolderDict]: Folder entity data or None
Expand Down Expand Up @@ -6240,8 +6260,9 @@ def get_folder_by_name(
folder_name (str): Folder name.
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[FolderDict]: Folder entity data or None
Expand Down Expand Up @@ -6552,8 +6573,9 @@ def get_tasks(
fields (Optional[Iterable[str]]): Fields to be queried for
folder. All possible folder fields are returned
if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Generator[TaskDict, None, None]: Queried task entities.
Expand Down Expand Up @@ -6593,8 +6615,9 @@ def get_task_by_name(
task_name (str): Task name
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[TaskDict]: Task entity data or None if was not found.
Expand Down Expand Up @@ -6624,8 +6647,9 @@ def get_task_by_id(
task_id (str): Task id.
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[TaskDict]: Task entity data or None if was not found.
Expand Down Expand Up @@ -6677,8 +6701,9 @@ def get_tasks_by_folder_paths(
fields (Optional[Iterable[str]]): Fields to be queried for
folder. All possible folder fields are returned
if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
dict[str, list[TaskDict]]: Task entities by
Expand Down Expand Up @@ -6737,8 +6762,9 @@ def get_tasks_by_folder_path(
fields (Optional[Iterable[str]]): Fields to be queried for
folder. All possible folder fields are returned
if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

"""
con = get_server_api_connection()
Expand Down Expand Up @@ -6772,8 +6798,9 @@ def get_task_by_folder_path(
task_name (str): Task name.
fields (Optional[Iterable[str]]): Task fields that should
be returned.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[TaskDict]: Task entity data or None if was not found.
Expand Down
4 changes: 3 additions & 1 deletion ayon_api/_api_helpers/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,9 @@ def get_project(
raise NotImplementedError()

def get_user(
self, username: Optional[str] = None
self,
username: Optional[str] = None,
own_attributes: bool = False,
) -> Optional[dict[str, Any]]:
raise NotImplementedError()

Expand Down
20 changes: 12 additions & 8 deletions ayon_api/_api_helpers/folders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,9 @@ def get_folders(
fields (Optional[Iterable[str]]): Fields to be queried for
folder. All possible folder fields are returned
if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Generator[FolderDict, None, None]: Queried folder entities.
Expand Down Expand Up @@ -360,8 +361,9 @@ def get_folder_by_id(
folder_id (str): Folder id.
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[FolderDict]: Folder entity data or None
Expand Down Expand Up @@ -396,8 +398,9 @@ def get_folder_by_path(
folder_path (str): Folder path.
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[FolderDict]: Folder entity data or None
Expand Down Expand Up @@ -434,8 +437,9 @@ def get_folder_by_name(
folder_name (str): Folder name.
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[FolderDict]: Folder entity data or None
Expand Down
10 changes: 6 additions & 4 deletions ayon_api/_api_helpers/projects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,8 +369,9 @@ def get_projects(
include_skeleton (bool): Include skeleton projects.
fields (Optional[Iterable[str]]): fields to be queried
for project.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Generator[ProjectDict, None, None]: Queried projects.
Expand Down Expand Up @@ -430,8 +431,9 @@ def get_project(
project_name (str): Name of project.
fields (Optional[Iterable[str]]): fields to be queried
for project.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[ProjectDict]: Project entity data or None
Expand Down
30 changes: 18 additions & 12 deletions ayon_api/_api_helpers/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,9 @@ def get_tasks(
fields (Optional[Iterable[str]]): Fields to be queried for
folder. All possible folder fields are returned
if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Generator[TaskDict, None, None]: Queried task entities.
Expand Down Expand Up @@ -137,8 +138,9 @@ def get_task_by_name(
task_name (str): Task name
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[TaskDict]: Task entity data or None if was not found.
Expand Down Expand Up @@ -170,8 +172,9 @@ def get_task_by_id(
task_id (str): Task id.
fields (Optional[Iterable[str]]): Fields that should be returned.
All fields are returned if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[TaskDict]: Task entity data or None if was not found.
Expand Down Expand Up @@ -225,8 +228,9 @@ def get_tasks_by_folder_paths(
fields (Optional[Iterable[str]]): Fields to be queried for
folder. All possible folder fields are returned
if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
dict[str, list[TaskDict]]: Task entities by
Expand Down Expand Up @@ -312,8 +316,9 @@ def get_tasks_by_folder_path(
fields (Optional[Iterable[str]]): Fields to be queried for
folder. All possible folder fields are returned
if 'None' is passed.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

"""
return self.get_tasks_by_folder_paths(
Expand Down Expand Up @@ -346,8 +351,9 @@ def get_task_by_folder_path(
task_name (str): Task name.
fields (Optional[Iterable[str]]): Task fields that should
be returned.
own_attributes (Optional[bool]): Attribute values that are
not explicitly set on entity will have 'None' value.
own_attributes (bool): Fill 'own_attributes' with
attribute values that are explicitly set on entity, other
attributes have 'None' value.

Returns:
Optional[TaskDict]: Task entity data or None if was not found.
Expand Down
Loading
Loading