ayon_applications
 Application 
 Hold information about application.
Object by itself does nothing special.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| data | dict | Data for the version containing information about executables, variant label or if is enabled. Only required key is  | required | 
| group | ApplicationGroup | App group object that created the application and under which application belongs. | required | 
Source code in client/ayon_applications/defs.py
 | 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |  | 
 find_executable() 
 Try to find existing executable for application.
Returns (str): Path to executable from executables or None if any exists.
Source code in client/ayon_applications/defs.py
 | 298 299 300 301 302 303 304 305 306 307 |  | 
 launch(*args, **kwargs) 
 Launch the application.
For this purpose is used manager's launch method to keep logic at one place.
Arguments must match with manager's launch method. That's why args *kwargs are used.
Returns:
| Type | Description | 
|---|---|
| Optional[Popen] | subprocess.Popen: Return executed process as Popen object. | 
Source code in client/ayon_applications/defs.py
 | 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |  | 
 ApplicationExecutable 
 Representation of executable loaded from settings.
Source code in client/ayon_applications/defs.py
 | 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 81 82 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 |  | 
 macos_executable_prep(executable)  staticmethod  
 Try to find full path to executable file.
Real executable is stored in '*.app/Contents/MacOS/
Having path to '*.app' gives ability to read it's plist info and use "CFBundleExecutable" key from plist to know what is "executable."
Plist is stored in '*.app/Contents/Info.plist'.
This is because some '*.app' directories don't have same permissions as real executable.
Source code in client/ayon_applications/defs.py
 | 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |  | 
 ApplicationExecutableNotFound 
  Bases: Exception
Defined executable paths are not available on the machine.
Source code in client/ayon_applications/exceptions.py
 | 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |  | 
 ApplicationGroup 
 Hold information about application group.
Application group wraps different versions(variants) of application. e.g. "maya" is group and "maya_2020" is variant.
Group hold host_name which is implementation name used in AYON. Also holds enabled if whole app group is enabled or icon for application icon path in resources.
Group has also environment which hold same environments for all variants.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| name | str | Groups' name. | required | 
| data | dict | Group defying data loaded from settings. | required | 
| manager | ApplicationManager | Manager that created the group. | required | 
Source code in client/ayon_applications/defs.py
 | 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |  | 
 ApplicationLaunchContext 
 Context of launching application.
Main purpose of context is to prepare launch arguments and keyword arguments for new process. Most important part of keyword arguments preparations are environment variables.
During the whole process is possible to use data attribute to store object usable in multiple places.
Launch arguments are strings in list. It is possible to "chain" argument when order of them matters. That is possible to do with adding list where order is right and should not change. NOTE: This is recommendation, not requirement. e.g.: ["nuke.exe", "--NukeX"] -> In this case any part of process may insert argument between nuke.exe and --NukeX. To keep them together it is better to wrap them in another list: [["nuke.exe", "--NukeX"]].
Notes
It is possible to use launch context only to prepare environment variables. In that case executable may be None and can be used 'run_prelaunch_hooks' method to run prelaunch hooks which prepare them.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| application | Application | Application definition. | required | 
| executable | ApplicationExecutable | Object with path to executable. | required | 
| env_group | Optional[str] | Environment variable group. If not set 'DEFAULT_ENV_SUBGROUP' is used. | None | 
| launch_type | Optional[str] | Launch type. If not set 'local' is used. | None | 
| **data | dict | Any additional data. Data may be used during preparation to store objects usable in multiple places. | {} | 
Source code in client/ayon_applications/manager.py
 | 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 |  | 
 modules_manager  property  
 Deprecated
Use 'addons_manager' instead.
 clear_launch_args(args)  staticmethod  
 Collect launch arguments to final order.
Launch argument should be a list that may contain another lists this function will upack inner lists and keep ordering.
```
source
[ [ arg1, [ arg2, arg3 ] ], arg4, [arg5, arg6]]
result
[ arg1, arg2, arg3, arg4, arg5, arg6]
Args: args (list): Source arguments in list may contain inner lists.
Returns: list: Unpacked arguments.
Source code in client/ayon_applications/manager.py
 | 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 |  | 
 discover_launch_hooks(force=False) 
 Load and prepare launch hooks.
Source code in client/ayon_applications/manager.py
 | 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 |  | 
 launch() 
 Collect data for new process and then create it.
This method must not be executed more than once.
Returns:
| Type | Description | 
|---|---|
| Optional[Popen] | subprocess.Popen: Created process as Popen object. | 
Source code in client/ayon_applications/manager.py
 | 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 |  | 
 paths_to_launch_hooks() 
 Directory paths where to look for launch hooks.
Source code in client/ayon_applications/manager.py
 | 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 |  | 
 run_prelaunch_hooks() 
 Run prelaunch hooks.
This method will be executed only once, any future calls will skip the processing.
Raises:
| Type | Description | 
|---|---|
| RuntimeError | When prelaunch hooks were already executed. | 
Source code in client/ayon_applications/manager.py
 | 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 |  | 
 ApplicationLaunchFailed 
  Bases: Exception
Application launch failed due to known reason.
Message should be self explanatory as traceback won't be shown.
Source code in client/ayon_applications/exceptions.py
 | 41 42 43 44 45 46 |  | 
 ApplicationManager 
 Load applications and tools and store them by their full name.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| studio_settings | dict | Preloaded studio settings. When passed manager will always use these values. Gives ability to create manager using different settings. | None | 
Source code in client/ayon_applications/manager.py
 | 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 81 82 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 157 158 159 160 161 162 163 164 165 166 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 193 |  | 
 create_launch_context(app_name, **data) 
 Prepare launch context for application.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| app_name | str | Name of application that should be launched. | required | 
| **data | Any | Any additional data. Data may be used during | {} | 
Returns:
| Name | Type | Description | 
|---|---|---|
| ApplicationLaunchContext | 'ApplicationLaunchContext' | Launch context for application. | 
Raises:
| Type | Description | 
|---|---|
| ApplicationNotFound | Application was not found by entered name. | 
Source code in client/ayon_applications/manager.py
 | 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 |  | 
 launch(app_name, **data) 
 Launch procedure.
For host application it's expected to contain "project_name", "folder_path" and "task_name".
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| app_name | str | Name of application that should be launched. | required | 
| **data | Any | Any additional data. Data may be used during preparation to store objects usable in multiple places. | {} | 
Raises:
| Type | Description | 
|---|---|
| ApplicationNotFound | Application was not found by entered argument  | 
| ApplicationExecutableNotFound | Executables in application definition were not found on this machine. | 
| ApplicationLaunchFailed | Something important for application launch failed. Exception should contain an explanation message, traceback should not be needed. | 
Source code in client/ayon_applications/manager.py
 | 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |  | 
 launch_with_context(launch_context) 
 Launch application using existing launch context.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| launch_context | ApplicationLaunchContext | Prepared launch context. | required | 
Source code in client/ayon_applications/manager.py
 | 157 158 159 160 161 162 163 164 165 166 167 168 169 |  | 
 refresh() 
 Refresh applications from settings.
Source code in client/ayon_applications/manager.py
 | 75 76 77 78 79 80 81 82 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 |  | 
 set_studio_settings(studio_settings) 
 Ability to change init system settings.
This will trigger refresh of manager.
Source code in client/ayon_applications/manager.py
 | 66 67 68 69 70 71 72 73 |  | 
 ApplicationNotFound 
  Bases: Exception
Application was not found in ApplicationManager by name.
Source code in client/ayon_applications/exceptions.py
 | 1 2 3 4 5 6 7 8 |  | 
 ApplicationsAddon 
  Bases: AYONAddon, IPluginPaths, ITrayAction
Source code in client/ayon_applications/addon.py
 | 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 81 82 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 157 158 159 160 161 162 163 164 165 166 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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 |  | 
 get_app_environments_for_context(project_name, folder_path, task_name, full_app_name, env_group=None, launch_type=None, env=None) 
 Calculate environment variables for launch context.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| project_name | str | Project name. | required | 
| folder_path | str | Folder path. | required | 
| task_name | str | Task name. | required | 
| full_app_name | str | Full application name. | required | 
| env_group | Optional[str] | Environment group. | None | 
| launch_type | Optional[str] | Launch type. | None | 
| env | Optional[dict[str, str]] | Environment variables to update. | None | 
Returns:
| Type | Description | 
|---|---|
| dict[str, str] | dict[str, str]: Environment variables for context. | 
Source code in client/ayon_applications/addon.py
 | 72 73 74 75 76 77 78 79 80 81 82 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 |  | 
 get_app_icon_path(icon_filename) 
 Get icon path.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| icon_filename | str | Icon filename. | required | 
Returns:
| Type | Description | 
|---|---|
| str | Optional[str]: Icon path or None if not found. | 
Source code in client/ayon_applications/addon.py
 | 175 176 177 178 179 180 181 182 183 184 185 |  | 
 get_app_icon_url(icon_filename, server=False) 
 Get icon path.
Method does not validate if icon filename exist on server.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| icon_filename | str | Icon name. | required | 
| server | Optional[bool] | Return url to AYON server. | False | 
Returns:
| Type | Description | 
|---|---|
| Optional[str] | Union[str, None]: Icon path or None is server url is not available. | 
Source code in client/ayon_applications/addon.py
 | 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |  | 
 get_applications_manager(settings=None) 
 Get applications manager.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| settings | Optional[dict] | Studio/project settings. | None | 
Returns:
| Name | Type | Description | 
|---|---|---|
| ApplicationManager | 'ApplicationManager' | Applications manager. | 
Source code in client/ayon_applications/addon.py
 | 148 149 150 151 152 153 154 155 156 157 158 159 160 |  | 
 get_farm_publish_environment_variables(project_name, folder_path, task_name, full_app_name=None, env_group=None) 
 Calculate environment variables for farm publish.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| project_name | str | Project name. | required | 
| folder_path | str | Folder path. | required | 
| task_name | str | Task name. | required | 
| env_group | Optional[str] | Environment group. | None | 
| full_app_name | Optional[str] | Full application name. Value from environment variable 'AYON_APP_NAME' is used if 'None' is passed. | None | 
Returns:
| Type | Description | 
|---|---|
| dict[str, str] | dict[str, str]: Environment variables for farm publish. | 
Source code in client/ayon_applications/addon.py
 | 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 |  | 
 launch_application(app_name, project_name, folder_path, task_name, workfile_path=None, use_last_workfile=None) 
 Launch application.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| app_name | str | Full application name e.g. 'maya/2024'. | required | 
| project_name | str | Project name. | required | 
| folder_path | str | Folder path. | required | 
| task_name | str | Task name. | required | 
| workfile_path | Optional[str] | Workfile path to use. | None | 
| use_last_workfile | Optional[bool] | Explicitly tell to use or not use last workfile. Ignored if 'workfile_path' is passed. | None | 
Source code in client/ayon_applications/addon.py
 | 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |  | 
 on_action_trigger() 
 Action triggered when the tray icon is clicked.
Source code in client/ayon_applications/addon.py
 | 60 61 62 63 64 65 66 67 68 69 70 |  | 
 tray_init() 
 Initialize the tray action.
Source code in client/ayon_applications/addon.py
 | 52 53 54 |  | 
 webserver_initialization(manager) 
 Initialize webserver.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| manager | WebServerManager | Webserver manager. | required | 
Source code in client/ayon_applications/addon.py
 | 307 308 309 310 311 312 313 314 315 316 317 |  | 
 EnvironmentTool 
 Hold information about application tool.
Structure of tool information.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| variant_data | dict | Variant data with environments and host and app variant filters. | required | 
| group | EnvironmentToolGroup | Name of group which wraps tool. | required | 
Source code in client/ayon_applications/defs.py
 | 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 |  | 
 is_valid_for_app(app) 
 Is tool valid for an application.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| app | Application | Application for which are prepared environments. | required | 
Source code in client/ayon_applications/defs.py
 | 425 426 427 428 429 430 431 432 433 434 435 436 437 |  | 
 EnvironmentToolGroup 
 Hold information about environment tool group.
Environment tool group may hold different variants of same tool and set environments that are same for all of them.
e.g. "mtoa" may have different versions but all environments except one are same.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| data | dict | Group information with variants. | required | 
| manager | ApplicationManager | Manager that creates the group. | required | 
Source code in client/ayon_applications/defs.py
 | 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |  | 
 LaunchTypes 
 Launch types are filters for pre/post-launch hooks.
Please use these variables in case they'll change values.
Source code in client/ayon_applications/defs.py
 | 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |  | 
 UndefinedApplicationExecutable 
  Bases: ApplicationExecutable
Some applications do not require executable path from settings.
In that case this class is used to "fake" existing executable.
Source code in client/ayon_applications/defs.py
 | 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |  |