ayon_info
extract_ayon_info_to_file(dirpath, filename=None)
Extract all current info to a file.
It is possible to define only directory path. Filename is concatenated with AYON version, workstation site id and timestamp.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dirpath | str | Path to directory where file will be stored. | required |
filename | Optional[str] | Filename. If not defined, it is generated. | None |
Returns:
| Name | Type | Description |
|---|---|---|
filepath | str | Full path to file where data were extracted. |
Source code in client/ayon_core/lib/ayon_info.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | |
get_all_current_info()
All information about current process in one dictionary.
Source code in client/ayon_core/lib/ayon_info.py
157 158 159 160 161 162 163 164 | |
get_ayon_launcher_version()
Get AYON launcher version.
Returns:
| Name | Type | Description |
|---|---|---|
str | Version string. |
Source code in client/ayon_core/lib/ayon_info.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 | |
get_settings_variant()
Get AYON settings variant.
Returns:
| Name | Type | Description |
|---|---|---|
str | str | Settings variant. |
Source code in client/ayon_core/lib/ayon_info.py
109 110 111 112 113 114 115 116 117 118 119 120 121 122 | |
get_workstation_info()
Basic information about workstation.
Source code in client/ayon_core/lib/ayon_info.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | |
is_dev_mode_enabled()
Dev mode is enabled in AYON.
Returns:
| Name | Type | Description |
|---|---|---|
bool | bool | True if dev mode is enabled. |
Source code in client/ayon_core/lib/ayon_info.py
99 100 101 102 103 104 105 106 | |
is_in_ayon_launcher_process()
Determine if current process is running from AYON launcher.
Returns:
| Name | Type | Description |
|---|---|---|
bool | True if running from AYON launcher. |
Source code in client/ayon_core/lib/ayon_info.py
29 30 31 32 33 34 35 36 37 38 | |
is_in_tests()
Process is running in automatic tests mode.
Returns:
| Name | Type | Description |
|---|---|---|
bool | bool | True if running in tests. |
Source code in client/ayon_core/lib/ayon_info.py
89 90 91 92 93 94 95 96 | |
is_running_from_build()
Determine if current process is running from build or code.
Returns:
| Name | Type | Description |
|---|---|---|
bool | True if running from build. |
Source code in client/ayon_core/lib/ayon_info.py
41 42 43 44 45 46 47 48 49 50 51 52 | |
is_using_ayon_console()
AYON launcher console executable is used.
This function make sense only on Windows platform. For other platforms always returns True. True is also returned if process is running from code.
AYON launcher on windows has 2 executable files. First 'ayon_console.exe' works as 'python.exe' executable, the second 'ayon.exe' works as 'pythonw.exe' executable. The difference is way how stdout/stderr is handled (especially when calling subprocess).
Returns:
| Name | Type | Description |
|---|---|---|
bool | True if console executable is used. |
Source code in client/ayon_core/lib/ayon_info.py
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | |