utils
Utils for ftrack.
Whereas lib.py contains utils for general use, this module contains utils for certain situations, or functions that would cause circular import when implemented in lib.py.
It is possible that some functions will be moved from lib.py to this module to keep consistency.
get_datetime_data(datetime_obj=None)
Returns current datetime data as dictionary.
Note
This function is copied from 'ayon_core.lib'.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
datetime_obj | datetime | Specific datetime object | None |
Returns:
Name | Type | Description |
---|---|---|
dict | prepared date & time data |
Available keys
"d" - Mon
, ... "dddd" - Monday
, ... "m" - 1
if January "mm" - Jan
, ... "mmmm" - January
, ... "yy" - 19
, 20
, ... "yyyy" - 2019
, 2020
, ... "H" -
Source code in client/ayon_ftrack/common/utils.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
|
get_folder_path_for_entities(session, entities, path_cust_attr_id=None, allow_use_link=True)
Get folder path for ftrack entities.
Folder path is received from custom attribute, or from entity link which contains name of parent entities.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session | Session | Connected ftrack session. | required |
entities | List[dict] | List of ftrack entities. | required |
path_cust_attr_id | Union[str, None] | Custom attribute configuration id which stores entity path. | None |
allow_use_link | bool | Use 'link' value if path is not found in custom attributes. | True |
Returns:
Type | Description |
---|---|
dict[str, Union[str, None]]: Entity path by ftrack entity id. Output will always contain all entity ids from input. |
Source code in client/ayon_ftrack/common/utils.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
|