Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2026-01-01 16:34:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

define 'EnumItemsInputType' for EnumDef input items

Browse source
This commit is contained in:
Jakub Trllo 2024-11-06 12:44:32 +01:00
parent 443ebf8523
commit 586d29f219
1 changed files with 18 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

25
client/ayon_core/lib/attribute_definitions.py
View file

@ -8,13 +8,22 @@ import warnings
from abc import ABCMeta, abstractmethod
import typing
from typing import (
Any, Optional, List, Set, Dict, Iterable, TypedDict, TypeVar,
Any,
Optional,
Tuple,
List,
Set,
Dict,
Iterable,
TypedDict,
TypeVar,
)
import clique
if typing.TYPE_CHECKING:
from typing import Self, Union, Pattern
# Global variable which store attribute definitions by type
# - default types are registered on import
_attr_defs_by_type = {}
@ -28,6 +37,9 @@ class EnumItemDict(TypedDict):
value: Any
EnumItemsInputType = "Union[Dict[Any, str], List[Tuple[Any, str]], List[Any], List[EnumItemDict]]" # noqa: E501
class FileDefItemDict(TypedDict):
directory: str
filenames: List[str]
@ -526,8 +538,8 @@ class EnumDef(AbstractAttrDef):
Args:
key (str): Key under which value is stored.
items (Union[Dict[Any, str], List[Any], List[EnumItemDict]]): Items
definition that can be converted using 'prepare_enum_items'.
items (EnumItemsInputType): Items definition that can be converted
using 'prepare_enum_items'.
default (Optional[Any]): Default value. Must be one key(value) from
passed items or list of values for multiselection.
multiselection (Optional[bool]): If True, multiselection is allowed.
@ -539,7 +551,7 @@ class EnumDef(AbstractAttrDef):
def __init__(
self,
key: str,
items: "Union[Dict[Any, str], List[Any], List[EnumItemDict]]",
items: EnumItemsInputType,
default: "Union[str, List[Any]]" = None,
multiselection: Optional[bool] = False,
**kwargs
@ -598,7 +610,7 @@ class EnumDef(AbstractAttrDef):
return data
@staticmethod
def prepare_enum_items(items) -> List[EnumItemDict]:
def prepare_enum_items(items: EnumItemsInputType) -> List[EnumItemDict]:
"""Convert items to unified structure.
Output is a list where each item is dictionary with 'value'
@ -614,8 +626,7 @@ class EnumDef(AbstractAttrDef):
```
Args:
items (Union[Dict[Any, str], List[Any], List[EnumItemDict]]): The
items to convert.
items (EnumItemsInputType): The items to convert.
Returns:
List[EnumItemDict]: Unified structure of items.