diff --git a/.github/workflows/project_actions.yml b/.github/workflows/project_actions.yml
new file mode 100644
index 0000000000..26bc2b8a1f
--- /dev/null
+++ b/.github/workflows/project_actions.yml
@@ -0,0 +1,22 @@
+name: project-actions
+
+on:
+ pull_request:
+ types: [review_requested]
+ pull_request_review:
+ types: [submitted]
+
+jobs:
+ pr_review_requested:
+ name: pr_review_requested
+ runs-on: ubuntu-latest
+ if: github.event_name == 'pull_request_review' && github.event.review.state == 'changes_requested'
+ steps:
+ - name: Move PR to 'Change Requested'
+ uses: leonsteinhaeuser/project-beta-automations@v2.1.0
+ with:
+ gh_token: ${{ secrets.YNPUT_BOT_TOKEN }}
+ organization: ynput
+ project_id: 11
+ resource_node_id: ${{ github.event.pull_request.node_id }}
+ status_value: Change Requested
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
new file mode 100644
index 0000000000..912780d803
--- /dev/null
+++ b/ARCHITECTURE.md
@@ -0,0 +1,77 @@
+# Architecture
+
+OpenPype is a monolithic Python project that bundles several parts, this document will try to give a birds eye overview of the project and, to a certain degree, each of the sub-projects.
+The current file structure looks like this:
+
+```
+.
+├── common - Code in this folder is backend portion of Addon distribution logic for v4 server.
+├── docs - Documentation of the source code.
+├── igniter - The OpenPype bootstrapper, deals with running version resolution and setting up the connection to the mongodb.
+├── openpype - The actual OpenPype core package.
+├── schema - Collection of JSON files describing schematics of objects. This follows Avalon's convention.
+├── tests - Integration and unit tests.
+├── tools - Conveninece scripts to perform common actions (in both bash and ps1).
+├── vendor - When using the igniter, it deploys third party tools in here, such as ffmpeg.
+└── website - Source files for https://openpype.io/ which is Docusaursus (https://docusaurus.io/).
+```
+
+The core functionality of the pipeline can be found in `igniter` and `openpype`, which in turn rely on the `schema` files, whenever you build (or download a pre-built) version of OpenPype, these two are bundled in there, and `Igniter` is the entry point.
+
+
+## Igniter
+
+It's the setup and update tool for OpenPype, unless you want to package `openpype` separately and deal with all the config manually, this will most likely be your entry point.
+
+```
+igniter/
+├── bootstrap_repos.py - Module that will find or install OpenPype versions in the system.
+├── __init__.py - Igniter entry point.
+├── install_dialog.py- Show dialog for choosing central pype repository.
+├── install_thread.py - Threading helpers for the install process.
+├── __main__.py - Like `__init__.py` ?
+├── message_dialog.py - Qt Dialog with a message and "Ok" button.
+├── nice_progress_bar.py - Fancy Qt progress bar.
+├── splash.txt - ASCII art for the terminal installer.
+├── stylesheet.css - Installer Qt styles.
+├── terminal_splash.py - Terminal installer animation, relies in `splash.txt`.
+├── tools.py - Collection of methods that don't fit in other modules.
+├── update_thread.py - Threading helper to update existing OpenPype installs.
+├── update_window.py - Qt UI to update OpenPype installs.
+├── user_settings.py - Interface for the OpenPype user settings.
+└── version.py - Igniter's version number.
+```
+
+## OpenPype
+
+This is the main package of the OpenPype logic, it could be loosely described as a combination of [Avalon](https://getavalon.github.io), [Pyblish](https://pyblish.com/) and glue around those with custom OpenPype only elements, things are in progress of being moved around to better prepare for V4, which will be released under a new name AYON.
+
+```
+openpype/
+├── client - Interface for the MongoDB.
+├── hooks - Hooks to be executed on certain OpenPype Applications defined in `openpype.lib.applications`.
+├── host - Base class for the different hosts.
+├── hosts - Integration with the different DCCs (hosts) using the `host` base class.
+├── lib - Libraries that stitch together the package, some have been moved into other parts.
+├── modules - OpenPype modules should contain separated logic of specific kind of implementation, such as Ftrack connection and its python API.
+├── pipeline - Core of the OpenPype pipeline, handles creation of data, publishing, etc.
+├── plugins - Global/core plugins for loader and publisher tool.
+├── resources - Icons, fonts, etc.
+├── scripts - Loose scipts that get run by tools/publishers.
+├── settings - OpenPype settings interface.
+├── style - Qt styling.
+├── tests - Unit tests.
+├── tools - Core tools, check out https://openpype.io/docs/artist_tools.
+├── vendor - Vendoring of needed required Python packes.
+├── widgets - Common re-usable Qt Widgets.
+├── action.py - LEGACY: Lives now in `openpype.pipeline.publish.action` Pyblish actions.
+├── cli.py - Command line interface, leverages `click`.
+├── __init__.py - Sets two constants.
+├── __main__.py - Entry point, calls the `cli.py`
+├── plugin.py - Pyblish plugins.
+├── pype_commands.py - Implementation of OpenPype commands.
+└── version.py - Current version number.
+```
+
+
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c7ecbc83bf..4e22b783c4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,1779 @@
# Changelog
+## [3.15.3](https://github.com/ynput/OpenPype/tree/3.15.3)
+
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/3.15.2...3.15.3)
+
+### **🆕 New features**
+
+
+
+Blender: Extract Review #3616
+
+Added Review to Blender.
+
+This implementation is based on #3508 but made compatible for the current implementation of OpenPype for Blender.
+
+
+___
+
+
+
+
+
+Data Exchanges: Point Cloud for 3dsMax #4532
+
+Publish PRT format with tyFlow in 3dsmax
+
+Publish PRT format with tyFlow in 3dsmax and possibly set up loader to load the format too.
+- [x] creator
+- [x] extractor
+- [x] validator
+- [x] loader
+
+
+___
+
+
+
+
+
+Global: persistent staging directory for renders #4583
+
+Allows configure if staging directory (`stagingDir`) should be persistent with use of profiles.
+
+With this feature, users can specify a transient data folder path based on presets, which can be used during the creation and publishing stages. In some cases, these DCCs automatically add a rendering path during the creation stage, which is then used in publishing.One of the key advantages of this feature is that it allows users to take advantage of faster storages for rendering, which can help improve workflow efficiency. Additionally, this feature allows users to keep their rendered data persistent, and use their own infrastructure for regular cleaning.However, it should be noted that some productions may want to use this feature without persistency. Furthermore, there may be a need for retargeting the rendering folder to faster storages, which is also not supported at the moment.It is studio responsibility to clean up obsolete folders with data.Location of the folder is configured in `project_anatomy/templates/others`. ('transient' key is expected, with 'folder' key, could be more templates)Which family/task type/subset is applicable is configured in:`project_settings/global/tools/publish/transient_dir_profiles`
+
+
+___
+
+
+
+
+
+Kitsu custom comment template #4599
+
+Kitsu allows to write markdown in its comment field. This can be something very powerful to deliver dynamic comments with the help the data from the instance.This feature is defaults to off so the admin have to manually set up the comment field the way they want.I have added a basic example on how the comment can look like as the comment-fields default value.To this I want to add some documentation also but that's on its way when the code itself looks good for the reviewers.
+
+
+___
+
+
+
+
+
+MaxScene Family #4615
+
+Introduction of the Max Scene Family
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+Maya: Multiple values on single render attribute - OP-4131 #4631
+
+When validating render attributes, this adds support for multiple values. When repairing first value in list is used.
+
+
+___
+
+
+
+
+
+Maya: enable 2D Pan/Zoom for playblasts - OP-5213 #4687
+
+Setting for enabling 2D Pan/Zoom on reviews.
+
+
+___
+
+
+
+
+
+Copy existing or generate new Fusion profile on prelaunch #4572
+
+Fusion preferences will be copied to the predefined `~/.openpype/hosts/fusion/prefs` folder (or any other folder set in system settings) on launch.
+
+The idea is to create a copy of existing Fusion profile, adding an OpenPype menu to the Fusion instance.By default the copy setting is turned off, so no file copying is performed. Instead the clean Fusion profile is created by Fusion in the predefined folder. The default locaion is set to `~/.openpype/hosts/fusion/prefs`, to better comply with the other os platforms. After creating the default profile, some modifications are applied:
+- forced Python3
+- forced English interface
+- setup Openpype specific path maps.If the `copy_prefs` checkbox is toggled, a copy of existing Fusion profile folder will be placed in the mentioned location. Then they are altered the same way as described above. The operation is run only once, on the first launch, unless the `force_sync [Resync profile on each launch]` is toggled.English interface is forced because the `FUSION16_PROFILE_DIR` environment variable is not read otherwise (seems to be a Fusion bug).
+
+
+___
+
+
+
+
+
+Houdini: Create button open new publisher's "create" tab #4601
+
+During a talk with @maxpareschi he mentioned that the new publisher in Houdini felt super confusing due to "Create" going to the older creator but now being completely empty and the publish button directly went to the publish tab.This resolves that by fixing the Create button to now open the new publisher but on the Create tab.Also made publish button enforce going to the "publish" tab for consistency in usage.@antirotor I think changing the Create button's callback was just missed in this commit or was there a specific reason to not change that around yet?
+
+
+___
+
+
+
+
+
+Clockify: refresh and fix the integration #4607
+
+Due to recent API changes, Clockify requires `user_id` to operate with the timers. I updated this part and currently it is a WIP for making it fully functional. Most functions, such as start and stop timer, and projects sync are currently working. For the rate limiting task new dependency is added: https://pypi.org/project/ratelimiter/
+
+
+___
+
+
+
+
+
+Fusion publish existing frames #4611
+
+This PR adds the function to publish existing frames instead of having to re-render all of them for each new publish.I have split the render_locally plugin so the review-part is its own plugin now.I also change the saver-creator-plugin's label from Saver to Render (saver) as I intend to add a Prerender creator like in Nuke.
+
+
+___
+
+
+
+
+
+Resolution settings referenced from DB record for 3dsMax #4652
+
+- Add Callback for setting the resolution according to DB after the new scene is created.
+- Add a new Action into openpype menu which allows the user to reset the resolution in 3dsMax
+
+
+___
+
+
+
+
+
+3dsmax: render instance settings in Publish tab #4658
+
+Allows user preset the pools, group and use_published settings in Render Creator in the Max Hosts.User can set the settings before or after creating instance in the new publisher
+
+
+___
+
+
+
+
+
+scene length setting referenced from DB record for 3dsMax #4665
+
+Setting the timeline length based on DB record in 3dsMax Hosts
+
+
+___
+
+
+
+
+
+Publisher: Windows reduce command window pop-ups during Publishing #4672
+
+Reduce the command line pop-ups that show on Windows during publishing.
+
+
+___
+
+
+
+
+
+Publisher: Explicit save #4676
+
+Publisher have explicit button to save changes, so reset can happen without saving any changes. Save still happens automatically when publishing is started or on publisher window close. But a popup is shown if context of host has changed. Important context was enhanced by workfile path (if host integration supports it) so workfile changes are captured too. In that case a dialog with confirmation is shown to user. All callbacks that may require save of context were moved to main window to be able handle dialog show at one place. Save changes now returns success so the rest of logic is skipped -> publishing won't start, when save of instances fails.Save and reset buttons have shortcuts (Ctrl + s and Ctrls + r).
+
+
+___
+
+
+
+
+
+CelAction: conditional workfile parameters from settings #4677
+
+Since some productions were requesting excluding some workfile parameters from publishing submission, we needed to move them to settings so those could be altered per project.
+
+
+___
+
+
+
+
+
+Improve logging of used app + tool envs on application launch #4682
+
+Improve logging of what apps + tool environments got loaded for an application launch.
+
+
+___
+
+
+
+
+
+Fix name and docstring for Create Workdir Extra Folders prelaunch hook #4683
+
+Fix class name and docstring for Create Workdir Extra Folders prelaunch hookThe class name and docstring were originally copied from another plug-in and didn't match the plug-in logic.This also fixes potentially seeing this twice in your logs. Before:After:Where it was actually running both this prelaunch hook and the actual `AddLastWorkfileToLaunchArgs` plugin.
+
+
+___
+
+
+
+
+
+Application launch context: Include app group name in logger #4684
+
+Clarify in logs better what app group the ApplicationLaunchContext belongs to and what application is being launched.Before:After:
+
+
+___
+
+
+
+
+
+increment workfile version 3dsmax #4685
+
+increment workfile version in 3dsmax as if in blender and maya hosts.
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+Maya: Fix getting non-active model panel. #2968
+
+When capturing multiple cameras with image planes that have file sequences playing, only the active (first) camera will play through the file sequence.
+
+
+___
+
+
+
+
+
+Maya: Fix broken review publishing. #4549
+
+Resolves #4547
+
+
+___
+
+
+
+
+
+Maya: Avoid error on right click in Loader if `mtoa` is not loaded #4616
+
+Fix an error on right clicking in the Loader when `mtoa` is not a loaded plug-in.Additionally if `mtoa` isn't loaded the loader will now load the plug-in before trying to create the arnold standin.
+
+
+___
+
+
+
+
+
+Maya: Fix extract look colorspace detection #4618
+
+Fix the logic which guesses the colorspace using `arnold` python library.
+- Previously it'd error if `mtoa` was not available on path so it still required `mtoa` to be available.
+- The guessing colorspace logic doesn't actually require `mtoa` to be loaded, but just the `arnold` python library to be available. This changes the logic so it doesn't require the `mtoa` plugin to get loaded to guess the colorspace.
+- The if/else branch was likely not doing what was intended `cmds.loadPlugin("mtoa", quiet=True)` returns None if the plug-in was already loaded. So this would only ever be true if it ends up loading the `mtoa` plugin the first time.
+```python
+# Tested in Maya 2022.1
+print(cmds.loadPlugin("mtoa", quiet=True))
+# ['mtoa']
+print(cmds.loadPlugin("mtoa", quiet=True))
+# None
+```
+
+
+___
+
+
+
+
+
+Maya: Maya Playblast Options overrides - OP-3847 #4634
+
+When publishing a review in Maya, the extractor would fail due to wrong (long) panel name.
+
+
+___
+
+
+
+
+
+Bugfix/op 2834 fix extract playblast #4701
+
+Paragraphs contain detailed information on the changes made to the product or service, providing an in-depth description of the updates and enhancements. They can be used to explain the reasoning behind the changes, or to highlight the importance of the new features. Paragraphs can often include links to further information or support documentation.
+
+
+___
+
+
+
+
+
+Bugfix/op 2834 fix extract playblast #4704
+
+Paragraphs contain detailed information on the changes made to the product or service, providing an in-depth description of the updates and enhancements. They can be used to explain the reasoning behind the changes, or to highlight the importance of the new features. Paragraphs can often include links to further information or support documentation.
+
+
+___
+
+
+
+
+
+Maya: bug fix for passing zoom settings if review is attached to subset #4716
+
+Fix for attaching review to subset with pan/zoom option.
+
+
+___
+
+
+
+
+
+Maya: tile assembly fail in draft - OP-4820 #4416
+
+Tile assembly in Deadline was broken.
+
+Initial bug report revealed other areas of the tile assembly that needed fixing.
+
+
+___
+
+
+
+
+
+Maya: Yeti Validate Rig Input - OP-3454 #4554
+
+Fix Yeti Validate Rig Input
+
+Existing workflow was broken due to this #3297.
+
+
+___
+
+
+
+
+
+Scene inventory: Fix code errors when "not found" entries are found #4594
+
+Whenever a "NOT FOUND" entry is present a lot of errors happened in the Scene Inventory:
+- It started spamming a lot of errors for the VersionDelegate since it had no numeric version (no version at all).Error reported on Discord:
+```python
+Traceback (most recent call last):
+ File "C:\Users\videopro\Documents\github\OpenPype\openpype\tools\utils\delegates.py", line 65, in paint
+ text = self.displayText(
+ File "C:\Users\videopro\Documents\github\OpenPype\openpype\tools\utils\delegates.py", line 33, in displayText
+ assert isinstance(value, numbers.Integral), (
+AssertionError: Version is not integer. "None"
+```
+- Right click menu would error on NOT FOUND entries, and thus not show. With this PR it will now _disregard_ not found items for "Set version" and "Remove" but still allow actions.This PR resolves those.
+
+
+___
+
+
+
+
+
+Kitsu: Sync OP with zou, make sure value-data is int or float #4596
+
+Currently the data zou pulls is a string and not a value causing some bugs in the pipe where a value is expected (like `Set frame range` in Fusion).
+
+
+
+This PR makes sure each value is set with int() or float() so these bugs can't happen later on.
+
+
+
+_(A request to cgwire has also bin sent to allow force values only for some metadata columns, but currently the user can enter what ever they want in there)_
+
+
+___
+
+
+
+
+
+Max: fix the bug of removing an instance #4617
+
+fix the bug of removing an instance in 3dsMax
+
+
+___
+
+
+
+
+
+Global | Nuke: fixing farm publishing workflow #4623
+
+After Nuke had adopted new publisher with new creators new issues were introduced. Those issues were addressed with this PR. Those are for example broken reviewable video files publishing if published via farm. Also fixed local publishing.
+
+
+___
+
+
+
+
+
+Ftrack: Ftrack additional families filtering #4633
+
+Ftrack family collector makes sure the subset family is also in instance families for additional families filtering.
+
+
+___
+
+
+
+
+
+Ftrack: Hierarchical <> Non-Hierarchical attributes sync fix #4635
+
+Sync between hierarchical and non-hierarchical attributes should be fixed and work as expected. Action should sync the values as expected and event handler should do it too and only on newly created entities.
+
+
+___
+
+
+
+
+
+bugfix for 3dsmax publishing error #4637
+
+fix the bug of failing publishing job in 3dsMax
+
+
+___
+
+
+
+
+
+General: Use right validation for ffmpeg executable #4640
+
+Use ffmpeg exec validation for ffmpeg executables instead of oiio exec validation. The validation is used as last possible source of ffmpeg from `PATH` environment variables, which is an edge case but can cause issues.
+
+
+___
+
+
+
+
+
+3dsmax: opening last workfile #4644
+
+Supports opening last saved workfile in 3dsmax host.
+
+
+___
+
+
+
+
+
+Fixed a bug where a QThread in the splash screen could be destroyed before finishing execution #4647
+
+This should fix the occasional behavior of the QThread being destroyed before even its worker returns from the `run()` function.After quiting, it should wait for the QThread object to properly close itself.
+
+
+___
+
+
+
+
+
+General: Use right plugin class for Collect Comment #4653
+
+Collect Comment plugin is instance plugin so should inherit from `InstancePlugin` instead of `ContextPlugin`.
+
+
+___
+
+
+
+
+
+Global: add tags field to thumbnail representation #4660
+
+Thumbnail representation might be missing tags field.
+
+
+___
+
+
+
+
+
+Integrator: Enforce unique destination transfers, disallow overwrites in queued transfers #4662
+
+Fix #4656 by enforcing unique destination transfers in the Integrator. It's now disallowed to a destination in the file transaction queue with a new source path during the publish.
+
+
+___
+
+
+
+
+
+Hiero: Creator with correct workfile numeric padding input #4666
+
+Creator was showing 99 in workfile input for long time, even if users set default value to 1001 in studio settings. This has been fixed now.
+
+
+___
+
+
+
+
+
+Nuke: Nukenodes family instance without frame range #4669
+
+No need to add frame range data into `nukenodes` (backdrop) family publishes - since those are timeless.
+
+
+___
+
+
+
+
+
+TVPaint: Optional Validation plugins can be de/activated by user #4674
+
+Added `OptionalPyblishPluginMixin` to TVpaint plugins that can be optional.
+
+
+___
+
+
+
+
+
+Kitsu: Slightly less strict with instance data #4678
+
+- Allow to take task name from context if asset doesn't have any. Fixes an issue with Photoshop's review instance not having `task` in data.
+- Allow to match "review" against both `instance.data["family"]` and `instance.data["families"]` because some instances don't have the primary family in families, e.g. in Photoshop and TVPaint.
+- Do not error on Integrate Kitsu Review whenever for whatever reason Integrate Kitsu Note did not created a comment but just log the message that it was unable to connect a review.
+
+
+___
+
+
+
+
+
+Publisher: Fix reset shortcut sequence #4694
+
+Fix bug created in https://github.com/ynput/OpenPype/pull/4676 where key sequence is checked using unsupported method. The check was changed to convert event into `QKeySequence` object which can be compared to prepared sequence.
+
+
+___
+
+
+
+
+
+Refactor _capture #4702
+
+Paragraphs contain detailed information on the changes made to the product or service, providing an in-depth description of the updates and enhancements. They can be used to explain the reasoning behind the changes, or to highlight the importance of the new features. Paragraphs can often include links to further information or support documentation.
+
+
+___
+
+
+
+
+
+Hiero: correct container colors if UpToDate #4708
+
+Colors on loaded containers are now correctly identifying real state of version. `Red` for out of date and `green` for up to date.
+
+
+___
+
+
+
+### **🔀 Refactored code**
+
+
+
+Look Assigner: Move Look Assigner tool since it's Maya only #4604
+
+Fix #4357: Move Look Assigner tool to maya since it's Maya only
+
+
+___
+
+
+
+
+
+Maya: Remove unused functions from Extract Look #4671
+
+Remove unused functions from Maya Extract Look plug-in
+
+
+___
+
+
+
+
+
+Extract Review code refactor #3930
+
+Trying to reduce complexity of Extract Review plug-in
+- Re-use profile filtering from lib
+- Remove "combination families" additional filtering which supposedly was from OP v2
+- Simplify 'formatting' for filling gaps
+- Use `legacy_io.Session` over `os.environ`
+
+
+___
+
+
+
+
+
+Maya: Replace last usages of Qt module #4610
+
+Replace last usage of `Qt` module with `qtpy`. This change is needed for `PySide6` support. All changes happened in Maya loader plugins.
+
+
+___
+
+
+
+
+
+Update tests and documentation for `ColormanagedPyblishPluginMixin` #4612
+
+Refactor `ExtractorColormanaged` to `ColormanagedPyblishPluginMixin` in tests and documentation.
+
+
+___
+
+
+
+
+
+Improve logging of used app + tool envs on application launch (minor tweak) #4686
+
+Use `app.full_name` for change done in #4682
+
+
+___
+
+
+
+### **📃 Documentation**
+
+
+
+Docs/add architecture document #4344
+
+Add `ARCHITECTURE.md` document.
+
+his document attemps to give a quick overview of the project to help onboarding, it's not an extensive documentation but more of a elevator pitch one-line descriptions of files/directories and what the attempt to do.
+
+
+___
+
+
+
+
+
+Documentation: Tweak grammar and fix some typos #4613
+
+This resolves some grammar and typos in the documentation.Also fixes the extension of some images in after effects docs which used uppercase extension even though files were lowercase extension.
+
+
+___
+
+
+
+
+
+Docs: Fix some minor grammar/typos #4680
+
+Typo/grammar fixes in documentation.
+
+
+___
+
+
+
+### **Merged pull requests**
+
+
+
+Maya: Implement image file node loader #4313
+
+Implements a loader for loading texture image into a `file` node in Maya.
+
+Similar to Maya's hypershade creation of textures on load you have the option to choose for three modes of creating:
+- Texture
+- Projection
+- StencilThese should match what Maya generates if you create those in Maya.
+- [x] Load and manage file nodes
+- [x] Apply color spaces after #4195
+- [x] Support for _either_ UDIM or image sequence - currently it seems to always load sequences as UDIM automatically.
+- [ ] Add support for animation sequences of UDIM textures using the `..exr` path format?
+
+
+___
+
+
+
+
+
+Maya Look Assigner: Don't rely on containers for get all assets #4600
+
+This resolves #4044 by not actually relying on containers in the scene but instead just rely on finding nodes with `cbId` attributes. As such, imported nodes would also be found and a shader can be assigned (similar to when using get from selection).**Please take into consideration the potential downsides below**Potential downsides would be:
+- IF an already loaded look has any dagNodes, say a 3D Projection node - then that will also show up as a loaded asset where previously nodes from loaded looks were ignored.
+- If any dag nodes were created locally - they would have gotten `cbId` attributes on scene save and thus the current asset would almost always show?
+
+
+___
+
+
+
+
+
+Maya: Unify menu labels for "Set Frame Range" and "Set Resolution" #4605
+
+Fix #4109: Unify menu labels for "Set Frame Range" and "Set Resolution"This also tweaks it in Houdini from Reset Frame Range to Set Frame Range.
+
+
+___
+
+
+
+
+
+Resolve missing OPENPYPE_MONGO in deadline global job preload #4484
+
+In the GlobalJobPreLoad plugin, we propose to replace the SpawnProcess by a sub-process and to pass the environment variables in the parameters, since the SpawnProcess under Centos Linux does not pass the environment variables.
+
+In the GlobalJobPreLoad plugin, the Deadline SpawnProcess is used to start the OpenPype process. The problem is that the SpawnProcess does not pass environment variables, including OPENPYPE_MONGO, to the process when it is under Centos7 linux, and the process gets stuck. We propose to replace it by a subprocess and to pass the variable in the parameters.
+
+
+___
+
+
+
+
+
+Tests: Added setup_only to tests #4591
+
+Allows to download test zip, unzip and restore DB in preparation for new test.
+
+
+___
+
+
+
+
+
+Maya: Arnold don't reset maya timeline frame range on render creation (or setting render settings) #4603
+
+Fix #4429: Do not reset fps or playback timeline on applying or creating render settings
+
+
+___
+
+
+
+
+
+Bump @sideway/formula from 3.0.0 to 3.0.1 in /website #4609
+
+Bumps [@sideway/formula](https://github.com/sideway/formula) from 3.0.0 to 3.0.1.
+
+Commits
+
This version was pushed to npm by marsup, a new releaser for @sideway/formula since your current version.
+
+
+
+
+[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
+
+Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
+
+[//]: # (dependabot-automerge-start)
+[//]: # (dependabot-automerge-end)
+
+---
+
+
+Dependabot commands and options
+
+
+You can trigger Dependabot actions by commenting on this PR:
+- `@dependabot rebase` will rebase this PR
+- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
+- `@dependabot merge` will merge this PR after your CI passes on it
+- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
+- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
+- `@dependabot reopen` will reopen this PR if it is closed
+- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
+- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
+- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
+- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
+- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
+- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
+- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
+- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
+
+You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/ynput/OpenPype/network/alerts).
+
+
+___
+
+
+
+
+
+Update artist_hosts_maya_arnold.md #4626
+
+Correct Arnold docs.
+___
+
+
+
+
+
+Maya: Add "Include Parent Hierarchy" option in animation creator plugin #4645
+
+Add an option in Project Settings > Maya > Creator Plugins > Create Animation to include (or not) parent hierarchy. This is to avoid artists to check manually the option for all create animation.
+
+
+___
+
+
+
+
+
+General: Filter available applications #4667
+
+Added option to filter applications that don't have valid executable available in settings in launcher and ftrack actions. This option can be disabled in new settings category `Applications`. The filtering is by default disabled.
+
+
+___
+
+
+
+
+
+3dsmax: make sure that startup script executes #4695
+
+Fixing reliability of OpenPype startup in 3dsmax.
+
+
+___
+
+
+
+
+
+Project Manager: Change minimum frame start/end to '0' #4719
+
+Project manager can have frame start/end set to `0`.
+
+
+___
+
+
+
+
+
+## [3.15.2](https://github.com/ynput/OpenPype/tree/3.15.2)
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/3.15.1...3.15.2)
+
+### **🆕 New features**
+
+
+
+maya gltf texture convertor and validator #4261
+
+Continuity of the gltf extractor implementation
+
+Continuity of the gltf extractor https://github.com/pypeclub/OpenPype/pull/4192UPDATE:**Validator for GLSL Shader**: Validate whether the mesh uses GLSL Shader. If not it will error out. The user can choose to perform the repair action and it will help to assign glsl shader. If the mesh with Stringray PBS, the repair action will also check to see if there is any linked texture such as Color, Occulsion, and Normal Map. If yes, it will help to relink the related textures to the glsl shader.*****If the mesh uses the PBS Shader,
+
+
+___
+
+
+
+
+
+Unreal: New Publisher #4370
+
+Implementation of the new publisher for Unreal.
+
+The implementation of the new publisher for Unreal. This PR includes the changes for all the existing creators to be compatible with the new publisher.The basic creator has been split in two distinct creators:
+- `UnrealAssetCreator`, works with assets in the Content Browser.
+- `UnrealActorCreator` that works with actors in the scene.
+
+
+___
+
+
+
+
+
+Implementation of a new splash screen #4592
+
+Implemented a new splash screen widget to reflect a process running in the background. This widget can be used for other tasks than UE. **Also fixed the compilation error of the AssetContainer.cpp when trying to build the plugin in UE 5.0**
+
+
+___
+
+
+
+
+
+Deadline for 3dsMax #4439
+
+Setting up deadline for 3dsmax
+
+Setting up deadline for 3dsmax by setting render outputs and viewport camera
+
+
+___
+
+
+
+
+
+Nuke: adding nukeassist #4494
+
+Adding support for NukeAssist
+
+For support of NukeAssist we had to limit some Nuke features since NukeAssist itself Nuke with limitations. We do not support Creator and Publisher. User can only Load versions with version control. User can also set Framerange and Colorspace.
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+Maya: OP-2630 acescg maya #4340
+
+Resolves #2712
+
+
+___
+
+
+
+
+
+Default Ftrack Family on RenderLayer #4458
+
+With default settings, renderlayers in Maya were not being tagged with the Ftrack family leading to confusion when doing reviews.
+
+
+___
+
+
+
+
+
+Maya: Maya Playblast Options - OP-3783 #4487
+
+Replacement PR for #3912. Adds more options for playblasts to preferences/settings.
+
+Adds the following as options in generating playblasts, matching viewport settings.
+- Use default material
+- Wireframe on shaded
+- X-ray
+- X-ray Joints
+- X-ray active component
+
+
+___
+
+
+
+
+
+Maya: Passing custom attributes to alembic - OP-4111 #4516
+
+Passing custom attributes to alembic
+
+This PR makes it possible to pass all user defined attributes along to the alembic representation.
+
+
+___
+
+
+
+
+
+Maya: Options for VrayProxy output - OP-2010 #4525
+
+Options for output of VrayProxy.
+
+Client requested more granular control of output from VrayProxy instance. Exposed options on the instance and settings for vrmesh and alembic.
+
+
+___
+
+
+
+
+
+Maya: Validate missing instance attributes #4559
+
+Validate missing instance attributes.
+
+New attributes can be introduced as new features come in. Old instances will need to be updated with these attributes for the documentation to make sense, and users do not have to recreate the instances.
+
+
+___
+
+
+
+
+
+Refactored Generation of UE Projects, installation of plugins moved to the engine #4369
+
+Improved the way how OpenPype works with generation of UE projects. Also the installation of the plugin has been altered to install into the engine
+
+OpenPype now uses the appropriate tools to generate UE projects. Unreal Build Tool (UBT) and a "Commandlet Project" is needed to properly generate a BP project, or C++ code in case that `dev_mode = True`, folders, the .uproject file and many other resources.On the plugin's side, it is built seperately with the UnrealAutomationTool (UAT) and then it's contents are moved under the `Engine/Plugins/Marketplace/OpenPype` directory.
+
+
+___
+
+
+
+
+
+Unreal: Use client functions in Layout loader #4578
+
+Use 'get_representations' instead of 'legacy_io' query in layout loader.
+
+This is removing usage of `find_one` called on `legacy_io` and use rather client functions as preparation for AYON connection. Also all representations are queried at once instead of one by one.
+
+
+___
+
+
+
+
+
+General: Support for extensions filtering in loaders #4492
+
+Added extensions filtering support to loader plugins.
+
+To avoid possible backwards compatibility break is filtering exactly the same and filtering by extensions is enabled only if class attribute 'extensions' is set.
+
+
+___
+
+
+
+
+
+Nuke: multiple reformat in baking review profiles #4514
+
+Added support for multiple reformat nodes in baking profiles.
+
+Old settings for single reformat node is supported and prioritised just in case studios are using it and backward compatibility is needed. Warnings in Nuke terminal are notifying users to switch settings to new workflow. Settings are also explaining the migration way.
+
+
+___
+
+
+
+
+
+Nuke: Add option to use new creating system in workfile template builder #4545
+
+Nuke workfile template builder can use new creators instead of legacy creators.
+
+Modified workfile template builder to have option to say if legacy creators should be used or new creators. Legacy creators are disabled by default, so Maya has changed the value.
+
+
+___
+
+
+
+
+
+Global, Nuke: Workfile first version with template processing #4579
+
+Supporting new template workfile builder with toggle for creation of first version of workfile in case there is none yet.
+
+
+___
+
+
+
+
+
+Fusion: New Publisher #4523
+
+This is an updated PR for @BigRoy 's old PR (https://github.com/ynput/OpenPype/pull/3892).I have merged it with code from OP 3.15.1-nightly.6 and made sure it works as expected.This converts the old publishing system to the new one. It implements Fusion as a new host addon.
+
+
+- Create button removed in OpenPype menu in favor of the new Publisher
+- Draft refactor validations to raise PublishValidationError
+- Implement Creator for New Publisher
+- Implement Fusion as Host addon
+
+
+___
+
+
+
+
+
+TVPaint: Use Publisher tool #4471
+
+Use Publisher tool and new creation system in TVPaint integration.
+
+Using new creation system makes TVPaint integration a little bit easier to maintain for artists. Removed unneeded tools Creator and Subset Manager tools. Goal is to keep the integration work as close as possible to previous integration. Some changes were made but primarilly because they were not right using previous system.All creators create instance with final family instead of changing the family during extraction. Render passes are not related to group id but to render layer instance. Render layer is still related to group. Workfile, review and scene render instances are created using autocreators instead of auto-collection during publishing. Subset names are fully filled during publishing but instance labels are filled on refresh with the last known right value. Implemented basic of legacy convertor which should convert render layers and render passes.
+
+
+___
+
+
+
+
+
+TVPaint: Auto-detect render creation #4496
+
+Create plugin which will create Render Layer and Render Pass instances based on information in the scene.
+
+Added new creator that must be triggered by artist. The create plugin will first create Render Layer instances if were not created yet. For variant is used color group name. The creator has option to rename color groups by template defined in settings -> Template may use index of group by it's usage in scene (from bottom to top). After Render Layers will create Render Passes. Render Pass is created for each individual TVPaint layer in any group that had created Render Layer. It's name is used as variant (pass).
+
+
+___
+
+
+
+
+
+TVPaint: Small enhancements #4501
+
+Small enhancements in TVPaint integration which did not get to https://github.com/ynput/OpenPype/pull/4471.
+
+It was found out that `opacity` returned from `tv_layerinfo` is always empty and is dangerous to add it to layer information. Added information about "current" layer to layers information. Disable review of Render Layer and Render Pass instances by default. In most of productions is used only "scene review". Skip usage of `"enabled"` key from settings in automated layer/pass creation.
+
+
+___
+
+
+
+
+
+Global: color v3 global oiio transcoder plugin #4291
+
+Implements possibility to use `oiiotool` to transcode image sequences from one color space to another(s).
+
+Uses collected `colorspaceData` information about source color spaces, these information needs to be collected previously in each DCC interested in color management.Uses profiles configured in Settings to create single or multiple new representations (and file extensions) with different color spaces.New representations might replace existing one, each new representation might contain different tags and custom tags to control its integration step.
+
+
+___
+
+
+
+
+
+Deadline: Added support for multiple install dirs in Deadline #4451
+
+SearchDirectoryList returns FIRST existing so if you would have multiple OP install dirs, it won't search for appropriate version in later ones.
+
+
+___
+
+
+
+
+
+Ftrack: Upload reviewables with original name #4483
+
+Ftrack can integrate reviewables with original filenames.
+
+As ftrack have restrictions about names of components the only way how to achieve the result was to upload the same file twice, one with required name and one with origin name.
+
+
+___
+
+
+
+
+
+TVPaint: Ignore transparency in Render Pass #4499
+
+It is possible to ignore layers transparency during Render Pass extraction.
+
+Render pass extraction does not respect opacity of TVPaint layers set in scene during extraction. It can be enabled/disabled in settings.
+
+
+___
+
+
+
+
+
+Anatomy: Preparation for different root overrides #4521
+
+Prepare Anatomy to handle only 'studio' site override on it's own.
+
+Change how Anatomy fill root overrides based on requested site name. The logic which decide what is active site was moved to sync server addon and the same for receiving root overrides of local site. The Anatomy resolve only studio site overrides anything else is handled by sync server. BaseAnatomy only expect root overrides value and does not need site name. Validation of site name happens in sync server same as resolving if site name is local or not.
+
+
+___
+
+
+
+
+
+Nuke | Global: colormanaged plugin in collection #4556
+
+Colormanaged extractor had changed to Mixin class so it can be added to any stage of publishing rather then just to Exctracting.Nuke is no collecting colorspaceData to representation collected on already rendered images.
+
+Mixin class can no be used as secondary parent in publishing plugins.
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+look publishing and srgb colorspace in maya #4276
+
+Check the OCIO color management is enabled before doing linearize colorspace for converting the texture maps into tx files.
+
+Check whether the OCIO color management is enabled before the condition of converting the texture to tx extension.
+
+
+___
+
+
+
+
+
+Maya: extract Thumbnail "No active model panel found" - OP-3849 #4421
+
+Error when extracting playblast with no model panel.
+
+If `project_settings/maya/publish/ExtractPlayblast/capture_preset/Viewport Options/override_viewport_options` were off and publishing without showing any model panel, the extraction would fail.
+
+
+___
+
+
+
+
+
+Maya: Fix setting scene fps with float input #4488
+
+Returned value of float fps on integer values would return float.
+
+This PR fixes the case when switching between integer fps values for example 24 > 25. Issue was when setting the scene fps, the original float value was used which makes it unpredictable whether the value is float or integer when mapping the fps values.
+
+
+___
+
+
+
+
+
+Maya: Multipart fix #4497
+
+Fix multipart logic in render products.
+
+Each renderer has a different way of defining whether output images is multipart, so we need to define it for each renderer. Also before the `multipart` class variable was defined multiple times in several places, which made it tricky to debug where `multipart` was defined. Now its created on initialization and referenced as `self.multipart`
+
+
+___
+
+
+
+
+
+Maya: Set pool on tile assembly - OP-2012 #4520
+
+Set pool on tile assembly
+
+Pool for publishing and tiling jobs, need to use the settings (`project_settings/deadline/publish/ProcessSubmittedJobOnFarm/deadline_pool`) else fallback on primary pool (`project_settings/deadline/publish/CollectDeadlinePools/primary_pool`)
+
+
+___
+
+
+
+
+
+Maya: Extract review with handles #4527
+
+Review was not extracting properly with/without handles.
+
+Review instance was not created properly resulting in the frame range on the instance including handles.
+
+
+___
+
+
+
+
+
+Maya: Fix broken lib. #4529
+
+Fix broken lib.
+
+This commit from this PR broke the Maya lib module.
+
+
+___
+
+
+
+
+
+Maya: Validate model name - OP-4983 #4539
+
+Validate model name issues.
+
+Couple of issues with validate model name;
+- missing platform extraction from settings
+- map function should be list comprehension
+- code cosmetics
+
+
+___
+
+
+
+
+
+Maya: SkeletalMesh family loadable as reference #4573
+
+In Maya, fix the SkeletalMesh family not loadable as reference.
+
+
+___
+
+
+
+
+
+Unreal: fix loaders because of missing AssetContainer #4536
+
+Fixing Unreal loaders, where changes in OpenPype Unreal integration plugin deleted AssetContainer.
+
+`AssetContainer` and `AssetContainerFactory` are still used to mark loaded instances. Because of optimizations in Integration plugin we've accidentally removed them but that broke loader.
+
+
+___
+
+
+
+
+
+3dsmax unable to delete loaded asset in the scene inventory #4507
+
+Fix the bug of being unable to delete loaded asset in the Scene Inventory
+
+Fix the bug of being unable to delete loaded asset in the Scene Inventory
+
+
+___
+
+
+
+
+
+Hiero/Nuke: originalBasename editorial publishing and loading #4453
+
+Publishing and loading `originalBasename` is working as expected
+
+Frame-ranges on version document is now correctly defined to fit original media frame range which is published. It means loading is now correctly identifying frame start and end on clip loader in Nuke.
+
+
+___
+
+
+
+
+
+Nuke: Fix workfile template placeholder creation #4512
+
+Template placeholder creation was erroring out in Nuke due to the Workfile template builder not being able to find any of the plugins for the Nuke host.
+
+Move `get_workfile_build_placeholder_plugins` function to NukeHost class as workfile template builder expects.
+
+
+___
+
+
+
+
+
+Nuke: creator farm attributes from deadline submit plugin settings #4519
+
+Defaults in farm attributes are sourced from settings.
+
+Settings for deadline nuke submitter are now used during nuke render and prerender creator plugins.
+
+
+___
+
+
+
+
+
+Nuke: fix clip sequence loading #4574
+
+Nuke is loading correctly clip from image sequence created without "{originalBasename}" token in anatomy template.
+
+
+___
+
+
+
+
+
+Fusion: Fix files collection and small bug-fixes #4423
+
+Fixed Fusion review-representation and small bug-fixes
+
+This fixes the problem with review-file generation that stopped the publishing on second publish before the fix.The problem was that Fusion simply looked at all the files in the render-folder instead of only gathering the needed frames for the review.Also includes a fix to get the handle start/end that before throw an error if the data didn't exist (like from a kitsu sync).
+
+
+___
+
+
+
+
+
+Fusion: Updated render_local.py to not only process the first instance #4522
+
+Moved the `__hasRun` to `render_once()` so the check only happens with the rendering. Currently only the first render node gets the representations added.Critical PR
+
+
+___
+
+
+
+
+
+Fusion: Load sequence fix filepath resolving from representation #4580
+
+Resolves issue mentioned on discord by @movalex:The loader was incorrectly trying to find the file in the publish folder which resulted in just picking 'any first file'.
+
+This gets the filepath from representation instead of taking the first file from listing files from publish folder.
+
+
+___
+
+
+
+
+
+Fusion: Fix review burnin start and end frame #4590
+
+Fix the burnin start and end frame for reviews. Without this the asset document's start and end handle would've been added to the _burnin_ frame range even though that would've been incorrect since the handles are based on the comp saver's render range instead.
+
+
+___
+
+
+
+
+
+Harmony: missing set of frame range when opening scene #4485
+
+Frame range gets set from DB everytime scene is opened.
+
+Added also check for not up-to-date loaded containers.
+
+
+___
+
+
+
+
+
+Photoshop: context is not changed in publisher #4570
+
+When PS is already open and artists launch new task, it should keep only opened PS open, but change context.
+
+Problem were occurring in Workfile app where under new task files from old task were shown. This fixes this and adds opening of last workfile for new context if workfile exists.
+
+
+___
+
+
+
+
+
+hiero: fix effect item node class #4543
+
+Collected effect name after renaming is saving correct class name.
+
+
+___
+
+
+
+
+
+Bugfix/OP-4616 vray multipart #4297
+
+This fixes a bug where multipart vray renders would not make a review in Ftrack.
+
+
+___
+
+
+
+
+
+Maya: Fix changed location of reset_frame_range #4491
+
+Location in commands caused cyclic import
+
+
+___
+
+
+
+
+
+global: source template fixed frame duplication #4503
+
+Duplication is not happening.
+
+Template is using `originalBasename` which already assume all necessary elements are part of the file name so there was no need for additional optional name elements.
+
+
+___
+
+
+
+
+
+Deadline: Hint to use Python 3 #4518
+
+Added shebank to give deadline hint which python should be used.
+
+Deadline has issues with Python 2 (especially with `os.scandir`). When a shebank is added to file header deadline will use python 3 mode instead of python 2 which fix the issue.
+
+
+___
+
+
+
+
+
+Publisher: Prevent access to create tab after publish start #4528
+
+Prevent access to create tab after publish start.
+
+Disable create button in instance view on publish start and enable it again on reset. Even with that make sure that it is not possible to go to create tab if the tab is disabled.
+
+
+___
+
+
+
+
+
+Color Transcoding: store target_colorspace as new colorspace #4544
+
+When transcoding into new colorspace, representation must carry this information instead original color space.
+
+
+___
+
+
+
+
+
+Deadline: fix submit_publish_job #4552
+
+Fix submit_publish_job
+
+Resolves #4541
+
+
+___
+
+
+
+
+
+Kitsu: Fix task itteration in update-op-with-zou #4577
+
+From the last PR (https://github.com/ynput/OpenPype/pull/4425) a comment-commit last second messed up the code and resulted in two lines being the same, crashing the script. This PR fixes that.
+___
+
+
+
+
+
+AttrDefs: Fix type for PySide6 #4584
+
+Use right type in signal emit for value change of attribute definitions.
+
+Changed `UUID` type to `str`. This is not an issue with PySide2 but it is with PySide6.
+
+
+___
+
+
+
+### **🔀 Refactored code**
+
+
+
+Scene Inventory: Avoid using ObjectId #4524
+
+Avoid using conversion to ObjectId type in scene inventory tool.
+
+Preparation for AYON compatibility where ObjectId won't be used for ids. Representation ids from loaded containers are not converted to ObjectId but kept as strings which also required some changes when working with representation documents.
+
+
+___
+
+
+
+### **Merged pull requests**
+
+
+
+SiteSync: host dirmap is not working properly #4563
+
+If artists uses SiteSync with real remote (gdrive, dropbox, sftp) drive, Local Settings were throwing error `string indices must be integers`.
+
+Logic was reworked to provide only `local_drive` values to be overrriden by Local Settings. If remote site is `gdrive` etc. mapping to `studio` is provided as it is expected that workfiles will have imported from `studio` location and not from `gdrive` folder.Also Nuke dirmap was reworked to be less verbose and much faster.
+
+
+___
+
+
+
+
+
+General: Input representation ids are not ObjectIds #4576
+
+Don't use `ObjectId` as representation ids during publishing.
+
+Representation ids are kept as strings during publishing instead of converting them to `ObjectId`. This change is pre-requirement for AYON connection.Inputs are used for integration of links and for farm publishing (or at least it looks like).
+
+
+___
+
+
+
+
+
+Shotgrid: Fixes on Deadline submissions #4498
+
+A few other bug fixes for getting Nuke submission to Deadline work smoothly using Shotgrid integration.
+
+Continuing on the work done on this other PR this fixes a few other bugs I came across with further tests.
+
+
+___
+
+
+
+
+
+Fusion: New Publisher #3892
+
+This converts the old publishing system to the new one. It implements Fusion as a new host addon.
+
+
+- Create button removed in OpenPype menu in favor of the new Publisher
+- Draft refactor validations to raise `PublishValidationError`
+- Implement Creator for New Publisher
+- Implement Fusion as Host addon
+
+
+___
+
+
+
+
+
+Make Kitsu work with Tray Publisher, added kitsureview tag, fixed sync-problems. #4425
+
+Make Kitsu work with Tray Publisher, added kitsureview tag, fixed sync-problems.
+
+This PR updates the way the module gather info for the current publish so it now works with Tray Publisher.It fixes the data that gets synced from Kitsu to OP so all needed data gets registered even if it doesn't exist on Kitsus side.It also adds the tag "Add review to Kitsu" and adds it to Burn In so previews gets generated by default to Kitsu.
+
+
+___
+
+
+
+
+
+Maya: V-Ray Set Image Format from settings #4566
+
+Resolves #4565
+
+Set V-Ray Image Format using settings.
+
+
+___
+
+
+
+
+
## [3.15.1](https://github.com/ynput/OpenPype/tree/3.15.1)
diff --git a/openpype/cli.py b/openpype/cli.py
index 5c47088a44..a650a9fdcc 100644
--- a/openpype/cli.py
+++ b/openpype/cli.py
@@ -367,11 +367,15 @@ def run(script):
"--timeout",
help="Provide specific timeout value for test case",
default=None)
+@click.option("-so",
+ "--setup_only",
+ help="Only create dbs, do not run tests",
+ default=None)
def runtests(folder, mark, pyargs, test_data_folder, persist, app_variant,
- timeout):
+ timeout, setup_only):
"""Run all automatic tests after proper initialization via start.py"""
PypeCommands().run_tests(folder, mark, pyargs, test_data_folder,
- persist, app_variant, timeout)
+ persist, app_variant, timeout, setup_only)
@main.command()
diff --git a/openpype/hooks/pre_add_last_workfile_arg.py b/openpype/hooks/pre_add_last_workfile_arg.py
index 1c8746c559..2558daef30 100644
--- a/openpype/hooks/pre_add_last_workfile_arg.py
+++ b/openpype/hooks/pre_add_last_workfile_arg.py
@@ -14,6 +14,7 @@ class AddLastWorkfileToLaunchArgs(PreLaunchHook):
# Execute after workfile template copy
order = 10
app_groups = [
+ "3dsmax",
"maya",
"nuke",
"nukex",
diff --git a/openpype/hooks/pre_create_extra_workdir_folders.py b/openpype/hooks/pre_create_extra_workdir_folders.py
index c5af620c87..8856281120 100644
--- a/openpype/hooks/pre_create_extra_workdir_folders.py
+++ b/openpype/hooks/pre_create_extra_workdir_folders.py
@@ -3,10 +3,13 @@ from openpype.lib import PreLaunchHook
from openpype.pipeline.workfile import create_workdir_extra_folders
-class AddLastWorkfileToLaunchArgs(PreLaunchHook):
- """Add last workfile path to launch arguments.
+class CreateWorkdirExtraFolders(PreLaunchHook):
+ """Create extra folders for the work directory.
+
+ Based on setting `project_settings/global/tools/Workfiles/extra_folders`
+ profile filtering will decide whether extra folders need to be created in
+ the work directory.
- This is not possible to do for all applications the same way.
"""
# Execute after workfile template copy
diff --git a/openpype/hooks/pre_foundry_apps.py b/openpype/hooks/pre_foundry_apps.py
index 2092d5025d..21ec8e7881 100644
--- a/openpype/hooks/pre_foundry_apps.py
+++ b/openpype/hooks/pre_foundry_apps.py
@@ -7,7 +7,7 @@ class LaunchFoundryAppsWindows(PreLaunchHook):
Nuke is executed "like" python process so it is required to pass
`CREATE_NEW_CONSOLE` flag on windows to trigger creation of new console.
- At the same time the newly created console won't create it's own stdout
+ At the same time the newly created console won't create its own stdout
and stderr handlers so they should not be redirected to DEVNULL.
"""
@@ -18,7 +18,7 @@ class LaunchFoundryAppsWindows(PreLaunchHook):
def execute(self):
# Change `creationflags` to CREATE_NEW_CONSOLE
- # - on Windows will nuke create new window using it's console
+ # - on Windows nuke will create new window using its console
# Set `stdout` and `stderr` to None so new created console does not
# have redirected output to DEVNULL in build
self.launch_context.kwargs.update({
diff --git a/openpype/host/dirmap.py b/openpype/host/dirmap.py
index 347c5fbf85..1d084cccad 100644
--- a/openpype/host/dirmap.py
+++ b/openpype/host/dirmap.py
@@ -39,7 +39,6 @@ class HostDirmap(object):
self._project_settings = project_settings
self._sync_module = sync_module # to limit reinit of Modules
self._log = None
- self._mapping = None # cache mapping
@property
def sync_module(self):
@@ -70,29 +69,28 @@ class HostDirmap(object):
"""Run host dependent remapping from source_path to destination_path"""
pass
- def process_dirmap(self):
+ def process_dirmap(self, mapping=None):
# type: (dict) -> None
"""Go through all paths in Settings and set them using `dirmap`.
If artists has Site Sync enabled, take dirmap mapping directly from
Local Settings when artist is syncing workfile locally.
- Args:
- project_settings (dict): Settings for current project.
"""
- if not self._mapping:
- self._mapping = self.get_mappings(self.project_settings)
- if not self._mapping:
+ if not mapping:
+ mapping = self.get_mappings()
+ if not mapping:
return
- self.log.info("Processing directory mapping ...")
self.on_enable_dirmap()
- self.log.info("mapping:: {}".format(self._mapping))
- for k, sp in enumerate(self._mapping["source-path"]):
- dst = self._mapping["destination-path"][k]
+ for k, sp in enumerate(mapping["source-path"]):
+ dst = mapping["destination-path"][k]
try:
+ # add trailing slash if missing
+ sp = os.path.join(sp, '')
+ dst = os.path.join(dst, '')
print("{} -> {}".format(sp, dst))
self.dirmap_routine(sp, dst)
except IndexError:
@@ -110,28 +108,24 @@ class HostDirmap(object):
)
continue
- def get_mappings(self, project_settings):
+ def get_mappings(self):
"""Get translation from source-path to destination-path.
It checks if Site Sync is enabled and user chose to use local
site, in that case configuration in Local Settings takes precedence
"""
- local_mapping = self._get_local_sync_dirmap(project_settings)
dirmap_label = "{}-dirmap".format(self.host_name)
- if (
- not self.project_settings[self.host_name].get(dirmap_label)
- and not local_mapping
- ):
- return {}
- mapping_settings = self.project_settings[self.host_name][dirmap_label]
- mapping_enabled = mapping_settings["enabled"] or bool(local_mapping)
+ mapping_sett = self.project_settings[self.host_name].get(dirmap_label,
+ {})
+ local_mapping = self._get_local_sync_dirmap()
+ mapping_enabled = mapping_sett.get("enabled") or bool(local_mapping)
if not mapping_enabled:
return {}
mapping = (
local_mapping
- or mapping_settings["paths"]
+ or mapping_sett["paths"]
or {}
)
@@ -141,28 +135,27 @@ class HostDirmap(object):
or not mapping.get("source-path")
):
return {}
+ self.log.info("Processing directory mapping ...")
+ self.log.info("mapping:: {}".format(mapping))
return mapping
- def _get_local_sync_dirmap(self, project_settings):
+ def _get_local_sync_dirmap(self):
"""
Returns dirmap if synch to local project is enabled.
Only valid mapping is from roots of remote site to local site set
in Local Settings.
- Args:
- project_settings (dict)
Returns:
dict : { "source-path": [XXX], "destination-path": [YYYY]}
"""
+ project_name = os.getenv("AVALON_PROJECT")
mapping = {}
-
- if not project_settings["global"]["sync_server"]["enabled"]:
+ if (not self.sync_module.enabled or
+ project_name not in self.sync_module.get_enabled_projects()):
return mapping
- project_name = os.getenv("AVALON_PROJECT")
-
active_site = self.sync_module.get_local_normalized_site(
self.sync_module.get_active_site(project_name))
remote_site = self.sync_module.get_local_normalized_site(
@@ -171,11 +164,7 @@ class HostDirmap(object):
"active {} - remote {}".format(active_site, remote_site)
)
- if (
- active_site == "local"
- and project_name in self.sync_module.get_enabled_projects()
- and active_site != remote_site
- ):
+ if active_site == "local" and active_site != remote_site:
sync_settings = self.sync_module.get_sync_project_setting(
project_name,
exclude_locals=False,
@@ -188,7 +177,15 @@ class HostDirmap(object):
self.log.debug("local overrides {}".format(active_overrides))
self.log.debug("remote overrides {}".format(remote_overrides))
+
current_platform = platform.system().lower()
+ remote_provider = self.sync_module.get_provider_for_site(
+ project_name, remote_site
+ )
+ # dirmap has sense only with regular disk provider, in the workfile
+ # wont be root on cloud or sftp provider
+ if remote_provider != "local_drive":
+ remote_site = "studio"
for root_name, active_site_dir in active_overrides.items():
remote_site_dir = (
remote_overrides.get(root_name)
diff --git a/openpype/hosts/blender/api/__init__.py b/openpype/hosts/blender/api/__init__.py
index e017d74d91..75a11affde 100644
--- a/openpype/hosts/blender/api/__init__.py
+++ b/openpype/hosts/blender/api/__init__.py
@@ -31,10 +31,13 @@ from .lib import (
lsattrs,
read,
maintained_selection,
+ maintained_time,
get_selection,
# unique_name,
)
+from .capture import capture
+
__all__ = [
"install",
@@ -56,9 +59,11 @@ __all__ = [
# Utility functions
"maintained_selection",
+ "maintained_time",
"lsattr",
"lsattrs",
"read",
"get_selection",
+ "capture",
# "unique_name",
]
diff --git a/openpype/hosts/blender/api/capture.py b/openpype/hosts/blender/api/capture.py
new file mode 100644
index 0000000000..849f8ee629
--- /dev/null
+++ b/openpype/hosts/blender/api/capture.py
@@ -0,0 +1,278 @@
+
+"""Blender Capture
+Playblasting with independent viewport, camera and display options
+"""
+import contextlib
+import bpy
+
+from .lib import maintained_time
+from .plugin import deselect_all, create_blender_context
+
+
+def capture(
+ camera=None,
+ width=None,
+ height=None,
+ filename=None,
+ start_frame=None,
+ end_frame=None,
+ step_frame=None,
+ sound=None,
+ isolate=None,
+ maintain_aspect_ratio=True,
+ overwrite=False,
+ image_settings=None,
+ display_options=None
+):
+ """Playblast in an independent windows
+ Arguments:
+ camera (str, optional): Name of camera, defaults to "Camera"
+ width (int, optional): Width of output in pixels
+ height (int, optional): Height of output in pixels
+ filename (str, optional): Name of output file path. Defaults to current
+ render output path.
+ start_frame (int, optional): Defaults to current start frame.
+ end_frame (int, optional): Defaults to current end frame.
+ step_frame (int, optional): Defaults to 1.
+ sound (str, optional): Specify the sound node to be used during
+ playblast. When None (default) no sound will be used.
+ isolate (list): List of nodes to isolate upon capturing
+ maintain_aspect_ratio (bool, optional): Modify height in order to
+ maintain aspect ratio.
+ overwrite (bool, optional): Whether or not to overwrite if file
+ already exists. If disabled and file exists and error will be
+ raised.
+ image_settings (dict, optional): Supplied image settings for render,
+ using `ImageSettings`
+ display_options (dict, optional): Supplied display options for render
+ """
+
+ scene = bpy.context.scene
+ camera = camera or "Camera"
+
+ # Ensure camera exists.
+ if camera not in scene.objects and camera != "AUTO":
+ raise RuntimeError("Camera does not exist: {0}".format(camera))
+
+ # Ensure resolution.
+ if width and height:
+ maintain_aspect_ratio = False
+ width = width or scene.render.resolution_x
+ height = height or scene.render.resolution_y
+ if maintain_aspect_ratio:
+ ratio = scene.render.resolution_x / scene.render.resolution_y
+ height = round(width / ratio)
+
+ # Get frame range.
+ if start_frame is None:
+ start_frame = scene.frame_start
+ if end_frame is None:
+ end_frame = scene.frame_end
+ if step_frame is None:
+ step_frame = 1
+ frame_range = (start_frame, end_frame, step_frame)
+
+ if filename is None:
+ filename = scene.render.filepath
+
+ render_options = {
+ "filepath": "{}.".format(filename.rstrip(".")),
+ "resolution_x": width,
+ "resolution_y": height,
+ "use_overwrite": overwrite,
+ }
+
+ with _independent_window() as window:
+
+ applied_view(window, camera, isolate, options=display_options)
+
+ with contextlib.ExitStack() as stack:
+ stack.enter_context(maintain_camera(window, camera))
+ stack.enter_context(applied_frame_range(window, *frame_range))
+ stack.enter_context(applied_render_options(window, render_options))
+ stack.enter_context(applied_image_settings(window, image_settings))
+ stack.enter_context(maintained_time())
+
+ bpy.ops.render.opengl(
+ animation=True,
+ render_keyed_only=False,
+ sequencer=False,
+ write_still=False,
+ view_context=True
+ )
+
+ return filename
+
+
+ImageSettings = {
+ "file_format": "FFMPEG",
+ "color_mode": "RGB",
+ "ffmpeg": {
+ "format": "QUICKTIME",
+ "use_autosplit": False,
+ "codec": "H264",
+ "constant_rate_factor": "MEDIUM",
+ "gopsize": 18,
+ "use_max_b_frames": False,
+ },
+}
+
+
+def isolate_objects(window, objects):
+ """Isolate selection"""
+ deselect_all()
+
+ for obj in objects:
+ obj.select_set(True)
+
+ context = create_blender_context(selected=objects, window=window)
+
+ bpy.ops.view3d.view_axis(context, type="FRONT")
+ bpy.ops.view3d.localview(context)
+
+ deselect_all()
+
+
+def _apply_options(entity, options):
+ for option, value in options.items():
+ if isinstance(value, dict):
+ _apply_options(getattr(entity, option), value)
+ else:
+ setattr(entity, option, value)
+
+
+def applied_view(window, camera, isolate=None, options=None):
+ """Apply view options to window."""
+ area = window.screen.areas[0]
+ space = area.spaces[0]
+
+ area.ui_type = "VIEW_3D"
+
+ meshes = [obj for obj in window.scene.objects if obj.type == "MESH"]
+
+ if camera == "AUTO":
+ space.region_3d.view_perspective = "ORTHO"
+ isolate_objects(window, isolate or meshes)
+ else:
+ isolate_objects(window, isolate or meshes)
+ space.camera = window.scene.objects.get(camera)
+ space.region_3d.view_perspective = "CAMERA"
+
+ if isinstance(options, dict):
+ _apply_options(space, options)
+ else:
+ space.shading.type = "SOLID"
+ space.shading.color_type = "MATERIAL"
+ space.show_gizmo = False
+ space.overlay.show_overlays = False
+
+
+@contextlib.contextmanager
+def applied_frame_range(window, start, end, step):
+ """Context manager for setting frame range."""
+ # Store current frame range
+ current_frame_start = window.scene.frame_start
+ current_frame_end = window.scene.frame_end
+ current_frame_step = window.scene.frame_step
+ # Apply frame range
+ window.scene.frame_start = start
+ window.scene.frame_end = end
+ window.scene.frame_step = step
+ try:
+ yield
+ finally:
+ # Restore frame range
+ window.scene.frame_start = current_frame_start
+ window.scene.frame_end = current_frame_end
+ window.scene.frame_step = current_frame_step
+
+
+@contextlib.contextmanager
+def applied_render_options(window, options):
+ """Context manager for setting render options."""
+ render = window.scene.render
+
+ # Store current settings
+ original = {}
+ for opt in options.copy():
+ try:
+ original[opt] = getattr(render, opt)
+ except ValueError:
+ options.pop(opt)
+
+ # Apply settings
+ _apply_options(render, options)
+
+ try:
+ yield
+ finally:
+ # Restore previous settings
+ _apply_options(render, original)
+
+
+@contextlib.contextmanager
+def applied_image_settings(window, options):
+ """Context manager to override image settings."""
+
+ options = options or ImageSettings.copy()
+ ffmpeg = options.pop("ffmpeg", {})
+ render = window.scene.render
+
+ # Store current image settings
+ original = {}
+ for opt in options.copy():
+ try:
+ original[opt] = getattr(render.image_settings, opt)
+ except ValueError:
+ options.pop(opt)
+
+ # Store current ffmpeg settings
+ original_ffmpeg = {}
+ for opt in ffmpeg.copy():
+ try:
+ original_ffmpeg[opt] = getattr(render.ffmpeg, opt)
+ except ValueError:
+ ffmpeg.pop(opt)
+
+ # Apply image settings
+ for opt, value in options.items():
+ setattr(render.image_settings, opt, value)
+
+ # Apply ffmpeg settings
+ for opt, value in ffmpeg.items():
+ setattr(render.ffmpeg, opt, value)
+
+ try:
+ yield
+ finally:
+ # Restore previous settings
+ for opt, value in original.items():
+ setattr(render.image_settings, opt, value)
+ for opt, value in original_ffmpeg.items():
+ setattr(render.ffmpeg, opt, value)
+
+
+@contextlib.contextmanager
+def maintain_camera(window, camera):
+ """Context manager to override camera."""
+ current_camera = window.scene.camera
+ if camera in window.scene.objects:
+ window.scene.camera = window.scene.objects.get(camera)
+ try:
+ yield
+ finally:
+ window.scene.camera = current_camera
+
+
+@contextlib.contextmanager
+def _independent_window():
+ """Create capture-window context."""
+ context = create_blender_context()
+ current_windows = set(bpy.context.window_manager.windows)
+ bpy.ops.wm.window_new(context)
+ window = list(set(bpy.context.window_manager.windows) - current_windows)[0]
+ context["window"] = window
+ try:
+ yield window
+ finally:
+ bpy.ops.wm.window_close(context)
diff --git a/openpype/hosts/blender/api/lib.py b/openpype/hosts/blender/api/lib.py
index 05912885f7..6526f1fb87 100644
--- a/openpype/hosts/blender/api/lib.py
+++ b/openpype/hosts/blender/api/lib.py
@@ -284,3 +284,13 @@ def maintained_selection():
# This could happen if the active node was deleted during the
# context.
log.exception("Failed to set active object.")
+
+
+@contextlib.contextmanager
+def maintained_time():
+ """Maintain current frame during context."""
+ current_time = bpy.context.scene.frame_current
+ try:
+ yield
+ finally:
+ bpy.context.scene.frame_current = current_time
diff --git a/openpype/hosts/blender/api/ops.py b/openpype/hosts/blender/api/ops.py
index 481c199db2..158c32fb5a 100644
--- a/openpype/hosts/blender/api/ops.py
+++ b/openpype/hosts/blender/api/ops.py
@@ -84,11 +84,11 @@ class MainThreadItem:
self.kwargs = kwargs
def execute(self):
- """Execute callback and store it's result.
+ """Execute callback and store its result.
Method must be called from main thread. Item is marked as `done`
when callback execution finished. Store output of callback of exception
- information when callback raise one.
+ information when callback raises one.
"""
print("Executing process in main thread")
if self.done:
@@ -382,8 +382,8 @@ class TOPBAR_MT_avalon(bpy.types.Menu):
layout.operator(LaunchLibrary.bl_idname, text="Library...")
layout.separator()
layout.operator(LaunchWorkFiles.bl_idname, text="Work Files...")
- # TODO (jasper): maybe add 'Reload Pipeline', 'Reset Frame Range' and
- # 'Reset Resolution'?
+ # TODO (jasper): maybe add 'Reload Pipeline', 'Set Frame Range' and
+ # 'Set Resolution'?
def draw_avalon_menu(self, context):
diff --git a/openpype/hosts/blender/api/plugin.py b/openpype/hosts/blender/api/plugin.py
index c59be8d7ff..1274795c6b 100644
--- a/openpype/hosts/blender/api/plugin.py
+++ b/openpype/hosts/blender/api/plugin.py
@@ -62,7 +62,8 @@ def prepare_data(data, container_name=None):
def create_blender_context(active: Optional[bpy.types.Object] = None,
- selected: Optional[bpy.types.Object] = None,):
+ selected: Optional[bpy.types.Object] = None,
+ window: Optional[bpy.types.Window] = None):
"""Create a new Blender context. If an object is passed as
parameter, it is set as selected and active.
"""
@@ -72,7 +73,9 @@ def create_blender_context(active: Optional[bpy.types.Object] = None,
override_context = bpy.context.copy()
- for win in bpy.context.window_manager.windows:
+ windows = [window] if window else bpy.context.window_manager.windows
+
+ for win in windows:
for area in win.screen.areas:
if area.type == 'VIEW_3D':
for region in area.regions:
diff --git a/openpype/hosts/blender/plugins/create/create_review.py b/openpype/hosts/blender/plugins/create/create_review.py
new file mode 100644
index 0000000000..bf4ea6a7cd
--- /dev/null
+++ b/openpype/hosts/blender/plugins/create/create_review.py
@@ -0,0 +1,47 @@
+"""Create review."""
+
+import bpy
+
+from openpype.pipeline import legacy_io
+from openpype.hosts.blender.api import plugin, lib, ops
+from openpype.hosts.blender.api.pipeline import AVALON_INSTANCES
+
+
+class CreateReview(plugin.Creator):
+ """Single baked camera"""
+
+ name = "reviewDefault"
+ label = "Review"
+ family = "review"
+ icon = "video-camera"
+
+ def process(self):
+ """ Run the creator on Blender main thread"""
+ mti = ops.MainThreadItem(self._process)
+ ops.execute_in_main_thread(mti)
+
+ def _process(self):
+ # Get Instance Container or create it if it does not exist
+ instances = bpy.data.collections.get(AVALON_INSTANCES)
+ if not instances:
+ instances = bpy.data.collections.new(name=AVALON_INSTANCES)
+ bpy.context.scene.collection.children.link(instances)
+
+ # Create instance object
+ asset = self.data["asset"]
+ subset = self.data["subset"]
+ name = plugin.asset_name(asset, subset)
+ asset_group = bpy.data.collections.new(name=name)
+ instances.children.link(asset_group)
+ self.data['task'] = legacy_io.Session.get('AVALON_TASK')
+ lib.imprint(asset_group, self.data)
+
+ if (self.options or {}).get("useSelection"):
+ selected = lib.get_selection()
+ for obj in selected:
+ asset_group.objects.link(obj)
+ elif (self.options or {}).get("asset_group"):
+ obj = (self.options or {}).get("asset_group")
+ asset_group.objects.link(obj)
+
+ return asset_group
diff --git a/openpype/hosts/blender/plugins/publish/collect_review.py b/openpype/hosts/blender/plugins/publish/collect_review.py
new file mode 100644
index 0000000000..d6abd9d967
--- /dev/null
+++ b/openpype/hosts/blender/plugins/publish/collect_review.py
@@ -0,0 +1,64 @@
+import bpy
+
+import pyblish.api
+from openpype.pipeline import legacy_io
+
+
+class CollectReview(pyblish.api.InstancePlugin):
+ """Collect Review data
+
+ """
+
+ order = pyblish.api.CollectorOrder + 0.3
+ label = "Collect Review Data"
+ families = ["review"]
+
+ def process(self, instance):
+
+ self.log.debug(f"instance: {instance}")
+
+ # get cameras
+ cameras = [
+ obj
+ for obj in instance
+ if isinstance(obj, bpy.types.Object) and obj.type == "CAMERA"
+ ]
+
+ assert len(cameras) == 1, (
+ f"Not a single camera found in extraction: {cameras}"
+ )
+ camera = cameras[0].name
+ self.log.debug(f"camera: {camera}")
+
+ # get isolate objects list from meshes instance members .
+ isolate_objects = [
+ obj
+ for obj in instance
+ if isinstance(obj, bpy.types.Object) and obj.type == "MESH"
+ ]
+
+ if not instance.data.get("remove"):
+
+ task = legacy_io.Session.get("AVALON_TASK")
+
+ instance.data.update({
+ "subset": f"{task}Review",
+ "review_camera": camera,
+ "frameStart": instance.context.data["frameStart"],
+ "frameEnd": instance.context.data["frameEnd"],
+ "fps": instance.context.data["fps"],
+ "isolate": isolate_objects,
+ })
+
+ self.log.debug(f"instance data: {instance.data}")
+
+ # TODO : Collect audio
+ audio_tracks = []
+ instance.data["audio"] = []
+ for track in audio_tracks:
+ instance.data["audio"].append(
+ {
+ "offset": track.offset.get(),
+ "filename": track.filename.get(),
+ }
+ )
diff --git a/openpype/hosts/blender/plugins/publish/extract_playblast.py b/openpype/hosts/blender/plugins/publish/extract_playblast.py
new file mode 100644
index 0000000000..8dc2f66c22
--- /dev/null
+++ b/openpype/hosts/blender/plugins/publish/extract_playblast.py
@@ -0,0 +1,123 @@
+import os
+import clique
+
+import bpy
+
+import pyblish.api
+from openpype.pipeline import publish
+from openpype.hosts.blender.api import capture
+from openpype.hosts.blender.api.lib import maintained_time
+
+
+class ExtractPlayblast(publish.Extractor):
+ """
+ Extract viewport playblast.
+
+ Takes review camera and creates review Quicktime video based on viewport
+ capture.
+ """
+
+ label = "Extract Playblast"
+ hosts = ["blender"]
+ families = ["review"]
+ optional = True
+ order = pyblish.api.ExtractorOrder + 0.01
+
+ def process(self, instance):
+ self.log.info("Extracting capture..")
+
+ self.log.info(instance.data)
+
+ # get scene fps
+ fps = instance.data.get("fps")
+ if fps is None:
+ fps = bpy.context.scene.render.fps
+ instance.data["fps"] = fps
+
+ self.log.info(f"fps: {fps}")
+
+ # If start and end frames cannot be determined,
+ # get them from Blender timeline.
+ start = instance.data.get("frameStart", bpy.context.scene.frame_start)
+ end = instance.data.get("frameEnd", bpy.context.scene.frame_end)
+
+ self.log.info(f"start: {start}, end: {end}")
+ assert end > start, "Invalid time range !"
+
+ # get cameras
+ camera = instance.data("review_camera", None)
+
+ # get isolate objects list
+ isolate = instance.data("isolate", None)
+
+ # get ouput path
+ stagingdir = self.staging_dir(instance)
+ filename = instance.name
+ path = os.path.join(stagingdir, filename)
+
+ self.log.info(f"Outputting images to {path}")
+
+ project_settings = instance.context.data["project_settings"]["blender"]
+ presets = project_settings["publish"]["ExtractPlayblast"]["presets"]
+ preset = presets.get("default")
+ preset.update({
+ "camera": camera,
+ "start_frame": start,
+ "end_frame": end,
+ "filename": path,
+ "overwrite": True,
+ "isolate": isolate,
+ })
+ preset.setdefault(
+ "image_settings",
+ {
+ "file_format": "PNG",
+ "color_mode": "RGB",
+ "color_depth": "8",
+ "compression": 15,
+ },
+ )
+
+ with maintained_time():
+ path = capture(**preset)
+
+ self.log.debug(f"playblast path {path}")
+
+ collected_files = os.listdir(stagingdir)
+ collections, remainder = clique.assemble(
+ collected_files,
+ patterns=[f"{filename}\\.{clique.DIGITS_PATTERN}\\.png$"],
+ )
+
+ if len(collections) > 1:
+ raise RuntimeError(
+ f"More than one collection found in stagingdir: {stagingdir}"
+ )
+ elif len(collections) == 0:
+ raise RuntimeError(
+ f"No collection found in stagingdir: {stagingdir}"
+ )
+
+ frame_collection = collections[0]
+
+ self.log.info(f"We found collection of interest {frame_collection}")
+
+ instance.data.setdefault("representations", [])
+
+ tags = ["review"]
+ if not instance.data.get("keepImages"):
+ tags.append("delete")
+
+ representation = {
+ "name": "png",
+ "ext": "png",
+ "files": list(frame_collection),
+ "stagingDir": stagingdir,
+ "frameStart": start,
+ "frameEnd": end,
+ "fps": fps,
+ "preview": True,
+ "tags": tags,
+ "camera_name": camera
+ }
+ instance.data["representations"].append(representation)
diff --git a/openpype/hosts/blender/plugins/publish/extract_thumbnail.py b/openpype/hosts/blender/plugins/publish/extract_thumbnail.py
new file mode 100644
index 0000000000..65c3627375
--- /dev/null
+++ b/openpype/hosts/blender/plugins/publish/extract_thumbnail.py
@@ -0,0 +1,99 @@
+import os
+import glob
+
+import pyblish.api
+from openpype.pipeline import publish
+from openpype.hosts.blender.api import capture
+from openpype.hosts.blender.api.lib import maintained_time
+
+import bpy
+
+
+class ExtractThumbnail(publish.Extractor):
+ """Extract viewport thumbnail.
+
+ Takes review camera and creates a thumbnail based on viewport
+ capture.
+
+ """
+
+ label = "Extract Thumbnail"
+ hosts = ["blender"]
+ families = ["review"]
+ order = pyblish.api.ExtractorOrder + 0.01
+ presets = {}
+
+ def process(self, instance):
+ self.log.info("Extracting capture..")
+
+ stagingdir = self.staging_dir(instance)
+ filename = instance.name
+ path = os.path.join(stagingdir, filename)
+
+ self.log.info(f"Outputting images to {path}")
+
+ camera = instance.data.get("review_camera", "AUTO")
+ start = instance.data.get("frameStart", bpy.context.scene.frame_start)
+ family = instance.data.get("family")
+ isolate = instance.data("isolate", None)
+
+ preset = self.presets.get(family, {})
+
+ preset.update({
+ "camera": camera,
+ "start_frame": start,
+ "end_frame": start,
+ "filename": path,
+ "overwrite": True,
+ "isolate": isolate,
+ })
+ preset.setdefault(
+ "image_settings",
+ {
+ "file_format": "JPEG",
+ "color_mode": "RGB",
+ "quality": 100,
+ },
+ )
+
+ with maintained_time():
+ path = capture(**preset)
+
+ thumbnail = os.path.basename(self._fix_output_path(path))
+
+ self.log.info(f"thumbnail: {thumbnail}")
+
+ instance.data.setdefault("representations", [])
+
+ representation = {
+ "name": "thumbnail",
+ "ext": "jpg",
+ "files": thumbnail,
+ "stagingDir": stagingdir,
+ "thumbnail": True
+ }
+ instance.data["representations"].append(representation)
+
+ def _fix_output_path(self, filepath):
+ """"Workaround to return correct filepath.
+
+ To workaround this we just glob.glob() for any file extensions and
+ assume the latest modified file is the correct file and return it.
+
+ """
+ # Catch cancelled playblast
+ if filepath is None:
+ self.log.warning(
+ "Playblast did not result in output path. "
+ "Playblast is probably interrupted."
+ )
+ return None
+
+ if not os.path.exists(filepath):
+ files = glob.glob(f"{filepath}.*.jpg")
+
+ if not files:
+ raise RuntimeError(f"Couldn't find playblast from: {filepath}")
+ filepath = max(files, key=os.path.getmtime)
+
+ return filepath
diff --git a/openpype/hosts/celaction/hooks/pre_celaction_setup.py b/openpype/hosts/celaction/hooks/pre_celaction_setup.py
index 62cebf99ed..96e784875c 100644
--- a/openpype/hosts/celaction/hooks/pre_celaction_setup.py
+++ b/openpype/hosts/celaction/hooks/pre_celaction_setup.py
@@ -38,8 +38,9 @@ class CelactionPrelaunchHook(PreLaunchHook):
)
path_to_cli = os.path.join(CELACTION_SCRIPTS_DIR, "publish_cli.py")
- subproces_args = get_openpype_execute_args("run", path_to_cli)
- openpype_executable = subproces_args.pop(0)
+ subprocess_args = get_openpype_execute_args("run", path_to_cli)
+ openpype_executable = subprocess_args.pop(0)
+ workfile_settings = self.get_workfile_settings()
winreg.SetValueEx(
hKey,
@@ -49,20 +50,34 @@ class CelactionPrelaunchHook(PreLaunchHook):
openpype_executable
)
- parameters = subproces_args + [
- "--currentFile", "*SCENE*",
- "--chunk", "*CHUNK*",
- "--frameStart", "*START*",
- "--frameEnd", "*END*",
- "--resolutionWidth", "*X*",
- "--resolutionHeight", "*Y*"
+ # add required arguments for workfile path
+ parameters = subprocess_args + [
+ "--currentFile", "*SCENE*"
]
+ # Add custom parameters from workfile settings
+ if "render_chunk" in workfile_settings["submission_overrides"]:
+ parameters += [
+ "--chunk", "*CHUNK*"
+ ]
+ if "resolution" in workfile_settings["submission_overrides"]:
+ parameters += [
+ "--resolutionWidth", "*X*",
+ "--resolutionHeight", "*Y*"
+ ]
+ if "frame_range" in workfile_settings["submission_overrides"]:
+ parameters += [
+ "--frameStart", "*START*",
+ "--frameEnd", "*END*"
+ ]
+
winreg.SetValueEx(
hKey, "SubmitParametersTitle", 0, winreg.REG_SZ,
subprocess.list2cmdline(parameters)
)
+ self.log.debug(f"__ parameters: \"{parameters}\"")
+
# setting resolution parameters
path_submit = "\\".join([
path_user_settings, "Dialogs", "SubmitOutput"
@@ -135,3 +150,6 @@ class CelactionPrelaunchHook(PreLaunchHook):
self.log.info(f"Workfile to open: \"{workfile_path}\"")
return workfile_path
+
+ def get_workfile_settings(self):
+ return self.data["project_settings"]["celaction"]["workfile"]
diff --git a/openpype/hosts/celaction/plugins/publish/collect_celaction_cli_kwargs.py b/openpype/hosts/celaction/plugins/publish/collect_celaction_cli_kwargs.py
index 43b81b83e7..54dea15dff 100644
--- a/openpype/hosts/celaction/plugins/publish/collect_celaction_cli_kwargs.py
+++ b/openpype/hosts/celaction/plugins/publish/collect_celaction_cli_kwargs.py
@@ -39,7 +39,7 @@ class CollectCelactionCliKwargs(pyblish.api.Collector):
passing_kwargs[key] = value
if missing_kwargs:
- raise RuntimeError("Missing arguments {}".format(
+ self.log.debug("Missing arguments {}".format(
", ".join(
[f'"{key}"' for key in missing_kwargs]
)
diff --git a/openpype/hosts/fusion/__init__.py b/openpype/hosts/fusion/__init__.py
index ddae01890b..1da11ba9d1 100644
--- a/openpype/hosts/fusion/__init__.py
+++ b/openpype/hosts/fusion/__init__.py
@@ -1,10 +1,14 @@
from .addon import (
+ get_fusion_version,
FusionAddon,
FUSION_HOST_DIR,
+ FUSION_VERSIONS_DICT,
)
__all__ = (
+ "get_fusion_version",
"FusionAddon",
"FUSION_HOST_DIR",
+ "FUSION_VERSIONS_DICT",
)
diff --git a/openpype/hosts/fusion/addon.py b/openpype/hosts/fusion/addon.py
index d1bd1566b7..45683cfbde 100644
--- a/openpype/hosts/fusion/addon.py
+++ b/openpype/hosts/fusion/addon.py
@@ -1,8 +1,52 @@
import os
+import re
from openpype.modules import OpenPypeModule, IHostAddon
+from openpype.lib import Logger
FUSION_HOST_DIR = os.path.dirname(os.path.abspath(__file__))
+# FUSION_VERSIONS_DICT is used by the pre-launch hooks
+# The keys correspond to all currently supported Fusion versions
+# Each value is a list of corresponding Python home variables and a profile
+# number, which is used by the profile hook to set Fusion profile variables.
+FUSION_VERSIONS_DICT = {
+ 9: ("FUSION_PYTHON36_HOME", 9),
+ 16: ("FUSION16_PYTHON36_HOME", 16),
+ 17: ("FUSION16_PYTHON36_HOME", 16),
+ 18: ("FUSION_PYTHON3_HOME", 16),
+}
+
+
+def get_fusion_version(app_name):
+ """
+ The function is triggered by the prelaunch hooks to get the fusion version.
+
+ `app_name` is obtained by prelaunch hooks from the
+ `launch_context.env.get("AVALON_APP_NAME")`.
+
+ To get a correct Fusion version, a version number should be present
+ in the `applications/fusion/variants` key
+ of the Blackmagic Fusion Application Settings.
+ """
+
+ log = Logger.get_logger(__name__)
+
+ if not app_name:
+ return
+
+ app_version_candidates = re.findall(r"\d+", app_name)
+ if not app_version_candidates:
+ return
+ for app_version in app_version_candidates:
+ if int(app_version) in FUSION_VERSIONS_DICT:
+ return int(app_version)
+ else:
+ log.info(
+ "Unsupported Fusion version: {app_version}".format(
+ app_version=app_version
+ )
+ )
+
class FusionAddon(OpenPypeModule, IHostAddon):
name = "fusion"
@@ -14,15 +58,11 @@ class FusionAddon(OpenPypeModule, IHostAddon):
def get_launch_hook_paths(self, app):
if app.host_name != self.host_name:
return []
- return [
- os.path.join(FUSION_HOST_DIR, "hooks")
- ]
+ return [os.path.join(FUSION_HOST_DIR, "hooks")]
def add_implementation_envs(self, env, _app):
# Set default values if are not already set via settings
- defaults = {
- "OPENPYPE_LOG_NO_COLORS": "Yes"
- }
+ defaults = {"OPENPYPE_LOG_NO_COLORS": "Yes"}
for key, value in defaults.items():
if not env.get(key):
env[key] = value
diff --git a/openpype/hosts/fusion/api/action.py b/openpype/hosts/fusion/api/action.py
index 1750920950..ff5dd14caa 100644
--- a/openpype/hosts/fusion/api/action.py
+++ b/openpype/hosts/fusion/api/action.py
@@ -6,12 +6,13 @@ from openpype.pipeline.publish import get_errored_instances_from_context
class SelectInvalidAction(pyblish.api.Action):
- """Select invalid nodes in Maya when plug-in failed.
+ """Select invalid nodes in Fusion when plug-in failed.
To retrieve the invalid nodes this assumes a static `get_invalid()`
method is available on the plugin.
"""
+
label = "Select invalid"
on = "failed" # This action is only available on a failed plug-in
icon = "search" # Icon from Awesome Icon
@@ -31,8 +32,10 @@ class SelectInvalidAction(pyblish.api.Action):
if isinstance(invalid_nodes, (list, tuple)):
invalid.extend(invalid_nodes)
else:
- self.log.warning("Plug-in returned to be invalid, "
- "but has no selectable nodes.")
+ self.log.warning(
+ "Plug-in returned to be invalid, "
+ "but has no selectable nodes."
+ )
if not invalid:
# Assume relevant comp is current comp and clear selection
@@ -51,4 +54,6 @@ class SelectInvalidAction(pyblish.api.Action):
for tool in invalid:
flow.Select(tool, True)
names.add(tool.Name)
- self.log.info("Selecting invalid tools: %s" % ", ".join(sorted(names)))
+ self.log.info(
+ "Selecting invalid tools: %s" % ", ".join(sorted(names))
+ )
diff --git a/openpype/hosts/fusion/api/lib.py b/openpype/hosts/fusion/api/lib.py
index 88a3f0b49b..40cc4d2963 100644
--- a/openpype/hosts/fusion/api/lib.py
+++ b/openpype/hosts/fusion/api/lib.py
@@ -303,10 +303,18 @@ def get_frame_path(path):
return filename, padding, ext
-def get_current_comp():
- """Hack to get current comp in this session"""
+def get_fusion_module():
+ """Get current Fusion instance"""
fusion = getattr(sys.modules["__main__"], "fusion", None)
- return fusion.CurrentComp if fusion else None
+ return fusion
+
+
+def get_current_comp():
+ """Get current comp in this session"""
+ fusion = get_fusion_module()
+ if fusion is not None:
+ comp = fusion.CurrentComp
+ return comp
@contextlib.contextmanager
diff --git a/openpype/hosts/fusion/api/menu.py b/openpype/hosts/fusion/api/menu.py
index 343f5f803a..92f38a64c2 100644
--- a/openpype/hosts/fusion/api/menu.py
+++ b/openpype/hosts/fusion/api/menu.py
@@ -6,7 +6,6 @@ from openpype.tools.utils import host_tools
from openpype.style import load_stylesheet
from openpype.lib import register_event_callback
from openpype.hosts.fusion.scripts import (
- set_rendermode,
duplicate_with_inputs,
)
from openpype.hosts.fusion.api.lib import (
@@ -60,7 +59,6 @@ class OpenPypeMenu(QtWidgets.QWidget):
publish_btn = QtWidgets.QPushButton("Publish...", self)
manager_btn = QtWidgets.QPushButton("Manage...", self)
libload_btn = QtWidgets.QPushButton("Library...", self)
- rendermode_btn = QtWidgets.QPushButton("Set render mode...", self)
set_framerange_btn = QtWidgets.QPushButton("Set Frame Range", self)
set_resolution_btn = QtWidgets.QPushButton("Set Resolution", self)
duplicate_with_inputs_btn = QtWidgets.QPushButton(
@@ -91,7 +89,6 @@ class OpenPypeMenu(QtWidgets.QWidget):
layout.addWidget(set_framerange_btn)
layout.addWidget(set_resolution_btn)
- layout.addWidget(rendermode_btn)
layout.addSpacing(20)
@@ -108,7 +105,6 @@ class OpenPypeMenu(QtWidgets.QWidget):
load_btn.clicked.connect(self.on_load_clicked)
manager_btn.clicked.connect(self.on_manager_clicked)
libload_btn.clicked.connect(self.on_libload_clicked)
- rendermode_btn.clicked.connect(self.on_rendermode_clicked)
duplicate_with_inputs_btn.clicked.connect(
self.on_duplicate_with_inputs_clicked
)
@@ -162,15 +158,6 @@ class OpenPypeMenu(QtWidgets.QWidget):
def on_libload_clicked(self):
host_tools.show_library_loader()
- def on_rendermode_clicked(self):
- if self.render_mode_widget is None:
- window = set_rendermode.SetRenderMode()
- window.setStyleSheet(load_stylesheet())
- window.show()
- self.render_mode_widget = window
- else:
- self.render_mode_widget.show()
-
def on_duplicate_with_inputs_clicked(self):
duplicate_with_inputs.duplicate_with_input_connections()
diff --git a/openpype/hosts/fusion/deploy/fusion_shared.prefs b/openpype/hosts/fusion/deploy/fusion_shared.prefs
index 998c6a6d66..b379ea7c66 100644
--- a/openpype/hosts/fusion/deploy/fusion_shared.prefs
+++ b/openpype/hosts/fusion/deploy/fusion_shared.prefs
@@ -1,19 +1,19 @@
{
Locked = true,
Global = {
- Paths = {
- Map = {
- ["OpenPype:"] = "$(OPENPYPE_FUSION)/deploy",
- ["Reactor:"] = "$(REACTOR)",
-
- ["Config:"] = "UserPaths:Config;OpenPype:Config",
- ["Scripts:"] = "UserPaths:Scripts;Reactor:System/Scripts;OpenPype:Scripts",
- ["UserPaths:"] = "UserData:;AllData:;Fusion:;Reactor:Deploy"
- },
- },
- Script = {
- PythonVersion = 3,
- Python3Forced = true
- },
+ Paths = {
+ Map = {
+ ["OpenPype:"] = "$(OPENPYPE_FUSION)/deploy",
+ ["Config:"] = "UserPaths:Config;OpenPype:Config",
+ ["Scripts:"] = "UserPaths:Scripts;Reactor:System/Scripts;OpenPype:Scripts",
},
-}
\ No newline at end of file
+ },
+ Script = {
+ PythonVersion = 3,
+ Python3Forced = true
+ },
+ UserInterface = {
+ Language = "en_US"
+ },
+ },
+}
diff --git a/openpype/hosts/fusion/hooks/pre_fusion_profile_hook.py b/openpype/hosts/fusion/hooks/pre_fusion_profile_hook.py
new file mode 100644
index 0000000000..fd726ccda1
--- /dev/null
+++ b/openpype/hosts/fusion/hooks/pre_fusion_profile_hook.py
@@ -0,0 +1,161 @@
+import os
+import shutil
+import platform
+from pathlib import Path
+from openpype.lib import PreLaunchHook, ApplicationLaunchFailed
+from openpype.hosts.fusion import (
+ FUSION_HOST_DIR,
+ FUSION_VERSIONS_DICT,
+ get_fusion_version,
+)
+
+
+class FusionCopyPrefsPrelaunch(PreLaunchHook):
+ """
+ Prepares local Fusion profile directory, copies existing Fusion profile.
+ This also sets FUSION MasterPrefs variable, which is used
+ to apply Master.prefs file to override some Fusion profile settings to:
+ - enable the OpenPype menu
+ - force Python 3 over Python 2
+ - force English interface
+ Master.prefs is defined in openpype/hosts/fusion/deploy/fusion_shared.prefs
+ """
+
+ app_groups = ["fusion"]
+ order = 2
+
+ def get_fusion_profile_name(self, profile_version) -> str:
+ # Returns 'Default', unless FUSION16_PROFILE is set
+ return os.getenv(f"FUSION{profile_version}_PROFILE", "Default")
+
+ def get_fusion_profile_dir(self, profile_version) -> Path:
+ # Get FUSION_PROFILE_DIR variable
+ fusion_profile = self.get_fusion_profile_name(profile_version)
+ fusion_var_prefs_dir = os.getenv(
+ f"FUSION{profile_version}_PROFILE_DIR"
+ )
+
+ # Check if FUSION_PROFILE_DIR exists
+ if fusion_var_prefs_dir and Path(fusion_var_prefs_dir).is_dir():
+ fu_prefs_dir = Path(fusion_var_prefs_dir, fusion_profile)
+ self.log.info(f"{fusion_var_prefs_dir} is set to {fu_prefs_dir}")
+ return fu_prefs_dir
+
+ def get_profile_source(self, profile_version) -> Path:
+ """Get Fusion preferences profile location.
+ See Per-User_Preferences_and_Paths on VFXpedia for reference.
+ """
+ fusion_profile = self.get_fusion_profile_name(profile_version)
+ profile_source = self.get_fusion_profile_dir(profile_version)
+ if profile_source:
+ return profile_source
+ # otherwise get default location of the profile folder
+ fu_prefs_dir = f"Blackmagic Design/Fusion/Profiles/{fusion_profile}"
+ if platform.system() == "Windows":
+ profile_source = Path(os.getenv("AppData"), fu_prefs_dir)
+ elif platform.system() == "Darwin":
+ profile_source = Path(
+ "~/Library/Application Support/", fu_prefs_dir
+ ).expanduser()
+ elif platform.system() == "Linux":
+ profile_source = Path("~/.fusion", fu_prefs_dir).expanduser()
+ self.log.info(
+ f"Locating source Fusion prefs directory: {profile_source}"
+ )
+ return profile_source
+
+ def get_copy_fusion_prefs_settings(self):
+ # Get copy preferences options from the global application settings
+
+ copy_fusion_settings = self.data["project_settings"]["fusion"].get(
+ "copy_fusion_settings", {}
+ )
+ if not copy_fusion_settings:
+ self.log.error("Copy prefs settings not found")
+ copy_status = copy_fusion_settings.get("copy_status", False)
+ force_sync = copy_fusion_settings.get("force_sync", False)
+ copy_path = copy_fusion_settings.get("copy_path") or None
+ if copy_path:
+ copy_path = Path(copy_path).expanduser()
+ return copy_status, copy_path, force_sync
+
+ def copy_fusion_profile(
+ self, copy_from: Path, copy_to: Path, force_sync: bool
+ ) -> None:
+ """On the first Fusion launch copy the contents of Fusion profile
+ directory to the working predefined location. If the Openpype profile
+ folder exists, skip copying, unless re-sync is checked.
+ If the prefs were not copied on the first launch,
+ clean Fusion profile will be created in fu_profile_dir.
+ """
+ if copy_to.exists() and not force_sync:
+ self.log.info(
+ "Destination Fusion preferences folder already exists: "
+ f"{copy_to} "
+ )
+ return
+ self.log.info("Starting copying Fusion preferences")
+ self.log.debug(f"force_sync option is set to {force_sync}")
+ try:
+ copy_to.mkdir(exist_ok=True, parents=True)
+ except PermissionError:
+ self.log.warning(f"Creating the folder not permitted at {copy_to}")
+ return
+ if not copy_from.exists():
+ self.log.warning(f"Fusion preferences not found in {copy_from}")
+ return
+ for file in copy_from.iterdir():
+ if file.suffix in (
+ ".prefs",
+ ".def",
+ ".blocklist",
+ ".fu",
+ ".toolbars",
+ ):
+ # convert Path to str to be compatible with Python 3.6+
+ shutil.copy(str(file), str(copy_to))
+ self.log.info(
+ f"Successfully copied preferences: {copy_from} to {copy_to}"
+ )
+
+ def execute(self):
+ (
+ copy_status,
+ fu_profile_dir,
+ force_sync,
+ ) = self.get_copy_fusion_prefs_settings()
+
+ # Get launched application context and return correct app version
+ app_name = self.launch_context.env.get("AVALON_APP_NAME")
+ app_version = get_fusion_version(app_name)
+ if app_version is None:
+ version_names = ", ".join(str(x) for x in FUSION_VERSIONS_DICT)
+ raise ApplicationLaunchFailed(
+ "Unable to detect valid Fusion version number from app "
+ f"name: {app_name}.\nMake sure to include at least a digit "
+ "to indicate the Fusion version like '18'.\n"
+ f"Detectable Fusion versions are: {version_names}"
+ )
+
+ _, profile_version = FUSION_VERSIONS_DICT[app_version]
+ fu_profile = self.get_fusion_profile_name(profile_version)
+
+ # do a copy of Fusion profile if copy_status toggle is enabled
+ if copy_status and fu_profile_dir is not None:
+ profile_source = self.get_profile_source(profile_version)
+ dest_folder = Path(fu_profile_dir, fu_profile)
+ self.copy_fusion_profile(profile_source, dest_folder, force_sync)
+
+ # Add temporary profile directory variables to customize Fusion
+ # to define where it can read custom scripts and tools from
+ fu_profile_dir_variable = f"FUSION{profile_version}_PROFILE_DIR"
+ self.log.info(f"Setting {fu_profile_dir_variable}: {fu_profile_dir}")
+ self.launch_context.env[fu_profile_dir_variable] = str(fu_profile_dir)
+
+ # Add custom Fusion Master Prefs and the temporary
+ # profile directory variables to customize Fusion
+ # to define where it can read custom scripts and tools from
+ master_prefs_variable = f"FUSION{profile_version}_MasterPrefs"
+ master_prefs = Path(FUSION_HOST_DIR, "deploy", "fusion_shared.prefs")
+ self.log.info(f"Setting {master_prefs_variable}: {master_prefs}")
+ self.launch_context.env[master_prefs_variable] = str(master_prefs)
diff --git a/openpype/hosts/fusion/hooks/pre_fusion_setup.py b/openpype/hosts/fusion/hooks/pre_fusion_setup.py
index 323b8b0029..f27cd1674b 100644
--- a/openpype/hosts/fusion/hooks/pre_fusion_setup.py
+++ b/openpype/hosts/fusion/hooks/pre_fusion_setup.py
@@ -1,32 +1,43 @@
import os
from openpype.lib import PreLaunchHook, ApplicationLaunchFailed
-from openpype.hosts.fusion import FUSION_HOST_DIR
+from openpype.hosts.fusion import (
+ FUSION_HOST_DIR,
+ FUSION_VERSIONS_DICT,
+ get_fusion_version,
+)
class FusionPrelaunch(PreLaunchHook):
- """Prepares OpenPype Fusion environment
-
- Requires FUSION_PYTHON3_HOME to be defined in the environment for Fusion
- to point at a valid Python 3 build for Fusion. That is Python 3.3-3.10
- for Fusion 18 and Fusion 3.6 for Fusion 16 and 17.
-
- This also sets FUSION16_MasterPrefs to apply the fusion master prefs
- as set in openpype/hosts/fusion/deploy/fusion_shared.prefs to enable
- the OpenPype menu and force Python 3 over Python 2.
-
"""
+ Prepares OpenPype Fusion environment.
+ Requires correct Python home variable to be defined in the environment
+ settings for Fusion to point at a valid Python 3 build for Fusion.
+ Python3 versions that are supported by Fusion:
+ Fusion 9, 16, 17 : Python 3.6
+ Fusion 18 : Python 3.6 - 3.10
+ """
+
app_groups = ["fusion"]
+ order = 1
def execute(self):
# making sure python 3 is installed at provided path
# Py 3.3-3.10 for Fusion 18+ or Py 3.6 for Fu 16-17
- py3_var = "FUSION_PYTHON3_HOME"
+ app_data = self.launch_context.env.get("AVALON_APP_NAME")
+ app_version = get_fusion_version(app_data)
+ if not app_version:
+ raise ApplicationLaunchFailed(
+ "Fusion version information not found in System settings.\n"
+ "The key field in the 'applications/fusion/variants' should "
+ "consist a number, corresponding to major Fusion version."
+ )
+ py3_var, _ = FUSION_VERSIONS_DICT[app_version]
fusion_python3_home = self.launch_context.env.get(py3_var, "")
- self.log.info(f"Looking for Python 3 in: {fusion_python3_home}")
for path in fusion_python3_home.split(os.pathsep):
- # Allow defining multiple paths to allow "fallback" to other
- # path. But make to set only a single path as final variable.
+ # Allow defining multiple paths, separated by os.pathsep,
+ # to allow "fallback" to other path.
+ # But make to set only a single path as final variable.
py3_dir = os.path.normpath(path)
if os.path.isdir(py3_dir):
break
@@ -43,19 +54,10 @@ class FusionPrelaunch(PreLaunchHook):
self.launch_context.env[py3_var] = py3_dir
# Fusion 18+ requires FUSION_PYTHON3_HOME to also be on PATH
- self.launch_context.env["PATH"] += ";" + py3_dir
+ if app_version >= 18:
+ self.launch_context.env["PATH"] += os.pathsep + py3_dir
- # Fusion 16 and 17 use FUSION16_PYTHON36_HOME instead of
- # FUSION_PYTHON3_HOME and will only work with a Python 3.6 version
- # TODO: Detect Fusion version to only set for specific Fusion build
- self.launch_context.env["FUSION16_PYTHON36_HOME"] = py3_dir
+ self.launch_context.env[py3_var] = py3_dir
- # Add our Fusion Master Prefs which is the only way to customize
- # Fusion to define where it can read custom scripts and tools from
self.log.info(f"Setting OPENPYPE_FUSION: {FUSION_HOST_DIR}")
self.launch_context.env["OPENPYPE_FUSION"] = FUSION_HOST_DIR
-
- pref_var = "FUSION16_MasterPrefs" # used by Fusion 16, 17 and 18
- prefs = os.path.join(FUSION_HOST_DIR, "deploy", "fusion_shared.prefs")
- self.log.info(f"Setting {pref_var}: {prefs}")
- self.launch_context.env[pref_var] = prefs
diff --git a/openpype/hosts/fusion/plugins/create/create_saver.py b/openpype/hosts/fusion/plugins/create/create_saver.py
index e581bac20f..56085b0a06 100644
--- a/openpype/hosts/fusion/plugins/create/create_saver.py
+++ b/openpype/hosts/fusion/plugins/create/create_saver.py
@@ -4,29 +4,34 @@ import qtawesome
from openpype.hosts.fusion.api import (
get_current_comp,
- comp_lock_and_undo_chunk
+ comp_lock_and_undo_chunk,
)
-from openpype.lib import BoolDef
+from openpype.lib import (
+ BoolDef,
+ EnumDef,
+)
from openpype.pipeline import (
legacy_io,
Creator,
- CreatedInstance
+ CreatedInstance,
+)
+from openpype.client import (
+ get_asset_by_name,
)
-from openpype.client import get_asset_by_name
class CreateSaver(Creator):
identifier = "io.openpype.creators.fusion.saver"
- name = "saver"
- label = "Saver"
+ label = "Render (saver)"
+ name = "render"
family = "render"
- default_variants = ["Main"]
-
+ default_variants = ["Main", "Mask"]
description = "Fusion Saver to generate image sequence"
- def create(self, subset_name, instance_data, pre_create_data):
+ instance_attributes = ["reviewable"]
+ def create(self, subset_name, instance_data, pre_create_data):
# TODO: Add pre_create attributes to choose file format?
file_format = "OpenEXRFormat"
@@ -58,7 +63,8 @@ class CreateSaver(Creator):
family=self.family,
subset_name=subset_name,
data=instance_data,
- creator=self)
+ creator=self,
+ )
# Insert the transient data
instance.transient_data["tool"] = saver
@@ -68,11 +74,9 @@ class CreateSaver(Creator):
return instance
def collect_instances(self):
-
comp = get_current_comp()
tools = comp.GetToolList(False, "Saver").values()
for tool in tools:
-
data = self.get_managed_tool_data(tool)
if not data:
data = self._collect_unmanaged_saver(tool)
@@ -90,7 +94,6 @@ class CreateSaver(Creator):
def update_instances(self, update_list):
for created_inst, _changes in update_list:
-
new_data = created_inst.data_to_store()
tool = created_inst.transient_data["tool"]
self._update_tool_with_data(tool, new_data)
@@ -139,7 +142,6 @@ class CreateSaver(Creator):
tool.SetAttrs({"TOOLS_Name": subset})
def _collect_unmanaged_saver(self, tool):
-
# TODO: this should not be done this way - this should actually
# get the data as stored on the tool explicitly (however)
# that would disallow any 'regular saver' to be collected
@@ -153,8 +155,7 @@ class CreateSaver(Creator):
asset = legacy_io.Session["AVALON_ASSET"]
task = legacy_io.Session["AVALON_TASK"]
- asset_doc = get_asset_by_name(project_name=project,
- asset_name=asset)
+ asset_doc = get_asset_by_name(project_name=project, asset_name=asset)
path = tool["Clip"][comp.TIME_UNDEFINED]
fname = os.path.basename(path)
@@ -178,21 +179,20 @@ class CreateSaver(Creator):
"variant": variant,
"active": not passthrough,
"family": self.family,
-
# Unique identifier for instance and this creator
"id": "pyblish.avalon.instance",
- "creator_identifier": self.identifier
+ "creator_identifier": self.identifier,
}
def get_managed_tool_data(self, tool):
"""Return data of the tool if it matches creator identifier"""
- data = tool.GetData('openpype')
+ data = tool.GetData("openpype")
if not isinstance(data, dict):
return
required = {
"id": "pyblish.avalon.instance",
- "creator_identifier": self.identifier
+ "creator_identifier": self.identifier,
}
for key, value in required.items():
if key not in data or data[key] != value:
@@ -205,11 +205,40 @@ class CreateSaver(Creator):
return data
- def get_instance_attr_defs(self):
- return [
- BoolDef(
- "review",
- default=True,
- label="Review"
- )
+ def get_pre_create_attr_defs(self):
+ """Settings for create page"""
+ attr_defs = [
+ self._get_render_target_enum(),
+ self._get_reviewable_bool(),
]
+ return attr_defs
+
+ def get_instance_attr_defs(self):
+ """Settings for publish page"""
+ attr_defs = [
+ self._get_render_target_enum(),
+ self._get_reviewable_bool(),
+ ]
+ return attr_defs
+
+ # These functions below should be moved to another file
+ # so it can be used by other plugins. plugin.py ?
+
+ def _get_render_target_enum(self):
+ rendering_targets = {
+ "local": "Local machine rendering",
+ "frames": "Use existing frames",
+ }
+ if "farm_rendering" in self.instance_attributes:
+ rendering_targets["farm"] = "Farm rendering"
+
+ return EnumDef(
+ "render_target", items=rendering_targets, label="Render target"
+ )
+
+ def _get_reviewable_bool(self):
+ return BoolDef(
+ "review",
+ default=("reviewable" in self.instance_attributes),
+ label="Review",
+ )
diff --git a/openpype/hosts/fusion/plugins/publish/collect_expected_frames.py b/openpype/hosts/fusion/plugins/publish/collect_expected_frames.py
new file mode 100644
index 0000000000..0ba777629f
--- /dev/null
+++ b/openpype/hosts/fusion/plugins/publish/collect_expected_frames.py
@@ -0,0 +1,50 @@
+import pyblish.api
+from openpype.pipeline import publish
+import os
+
+
+class CollectFusionExpectedFrames(
+ pyblish.api.InstancePlugin, publish.ColormanagedPyblishPluginMixin
+):
+ """Collect all frames needed to publish expected frames"""
+
+ order = pyblish.api.CollectorOrder + 0.5
+ label = "Collect Expected Frames"
+ hosts = ["fusion"]
+ families = ["render"]
+
+ def process(self, instance):
+ context = instance.context
+
+ frame_start = context.data["frameStartHandle"]
+ frame_end = context.data["frameEndHandle"]
+ path = instance.data["path"]
+ output_dir = instance.data["outputDir"]
+
+ basename = os.path.basename(path)
+ head, ext = os.path.splitext(basename)
+ files = [
+ f"{head}{str(frame).zfill(4)}{ext}"
+ for frame in range(frame_start, frame_end + 1)
+ ]
+ repre = {
+ "name": ext[1:],
+ "ext": ext[1:],
+ "frameStart": f"%0{len(str(frame_end))}d" % frame_start,
+ "files": files,
+ "stagingDir": output_dir,
+ }
+
+ self.set_representation_colorspace(
+ representation=repre,
+ context=context,
+ )
+
+ # review representation
+ if instance.data.get("review", False):
+ repre["tags"] = ["review"]
+
+ # add the repre to the instance
+ if "representations" not in instance.data:
+ instance.data["representations"] = []
+ instance.data["representations"].append(repre)
diff --git a/openpype/hosts/fusion/plugins/publish/collect_render_target.py b/openpype/hosts/fusion/plugins/publish/collect_render_target.py
deleted file mode 100644
index 39017f32e0..0000000000
--- a/openpype/hosts/fusion/plugins/publish/collect_render_target.py
+++ /dev/null
@@ -1,44 +0,0 @@
-import pyblish.api
-
-
-class CollectFusionRenderMode(pyblish.api.InstancePlugin):
- """Collect current comp's render Mode
-
- Options:
- local
- farm
-
- Note that this value is set for each comp separately. When you save the
- comp this information will be stored in that file. If for some reason the
- available tool does not visualize which render mode is set for the
- current comp, please run the following line in the console (Py2)
-
- comp.GetData("openpype.rendermode")
-
- This will return the name of the current render mode as seen above under
- Options.
-
- """
-
- order = pyblish.api.CollectorOrder + 0.4
- label = "Collect Render Mode"
- hosts = ["fusion"]
- families = ["render"]
-
- def process(self, instance):
- """Collect all image sequence tools"""
- options = ["local", "farm"]
-
- comp = instance.context.data.get("currentComp")
- if not comp:
- raise RuntimeError("No comp previously collected, unable to "
- "retrieve Fusion version.")
-
- rendermode = comp.GetData("openpype.rendermode") or "local"
- assert rendermode in options, "Must be supported render mode"
-
- self.log.info("Render mode: {0}".format(rendermode))
-
- # Append family
- family = "render.{0}".format(rendermode)
- instance.data["families"].append(family)
diff --git a/openpype/hosts/fusion/plugins/publish/collect_renders.py b/openpype/hosts/fusion/plugins/publish/collect_renders.py
new file mode 100644
index 0000000000..7f38e68447
--- /dev/null
+++ b/openpype/hosts/fusion/plugins/publish/collect_renders.py
@@ -0,0 +1,25 @@
+import pyblish.api
+
+
+class CollectFusionRenders(pyblish.api.InstancePlugin):
+ """Collect current saver node's render Mode
+
+ Options:
+ local (Render locally)
+ frames (Use existing frames)
+
+ """
+
+ order = pyblish.api.CollectorOrder + 0.4
+ label = "Collect Renders"
+ hosts = ["fusion"]
+ families = ["render"]
+
+ def process(self, instance):
+ render_target = instance.data["render_target"]
+ family = instance.data["family"]
+
+ # add targeted family to families
+ instance.data["families"].append(
+ "{}.{}".format(family, render_target)
+ )
diff --git a/openpype/hosts/fusion/plugins/publish/extract_render_local.py b/openpype/hosts/fusion/plugins/publish/extract_render_local.py
new file mode 100644
index 0000000000..5a0140c525
--- /dev/null
+++ b/openpype/hosts/fusion/plugins/publish/extract_render_local.py
@@ -0,0 +1,109 @@
+import logging
+import contextlib
+import pyblish.api
+from openpype.hosts.fusion.api import comp_lock_and_undo_chunk
+
+
+log = logging.getLogger(__name__)
+
+
+@contextlib.contextmanager
+def enabled_savers(comp, savers):
+ """Enable only the `savers` in Comp during the context.
+
+ Any Saver tool in the passed composition that is not in the savers list
+ will be set to passthrough during the context.
+
+ Args:
+ comp (object): Fusion composition object.
+ savers (list): List of Saver tool objects.
+
+ """
+ passthrough_key = "TOOLB_PassThrough"
+ original_states = {}
+ enabled_save_names = {saver.Name for saver in savers}
+ try:
+ all_savers = comp.GetToolList(False, "Saver").values()
+ for saver in all_savers:
+ original_state = saver.GetAttrs()[passthrough_key]
+ original_states[saver] = original_state
+
+ # The passthrough state we want to set (passthrough != enabled)
+ state = saver.Name not in enabled_save_names
+ if state != original_state:
+ saver.SetAttrs({passthrough_key: state})
+ yield
+ finally:
+ for saver, original_state in original_states.items():
+ saver.SetAttrs({"TOOLB_PassThrough": original_state})
+
+
+class FusionRenderLocal(pyblish.api.InstancePlugin):
+ """Render the current Fusion composition locally."""
+
+ order = pyblish.api.ExtractorOrder - 0.2
+ label = "Render Local"
+ hosts = ["fusion"]
+ families = ["render.local"]
+
+ def process(self, instance):
+ context = instance.context
+
+ # Start render
+ self.render_once(context)
+
+ # Log render status
+ self.log.info(
+ "Rendered '{nm}' for asset '{ast}' under the task '{tsk}'".format(
+ nm=instance.data["name"],
+ ast=instance.data["asset"],
+ tsk=instance.data["task"],
+ )
+ )
+
+ def render_once(self, context):
+ """Render context comp only once, even with more render instances"""
+
+ # This plug-in assumes all render nodes get rendered at the same time
+ # to speed up the rendering. The check below makes sure that we only
+ # execute the rendering once and not for each instance.
+ key = f"__hasRun{self.__class__.__name__}"
+
+ savers_to_render = [
+ # Get the saver tool from the instance
+ instance[0] for instance in context if
+ # Only active instances
+ instance.data.get("publish", True) and
+ # Only render.local instances
+ "render.local" in instance.data["families"]
+ ]
+
+ if key not in context.data:
+ # We initialize as false to indicate it wasn't successful yet
+ # so we can keep track of whether Fusion succeeded
+ context.data[key] = False
+
+ current_comp = context.data["currentComp"]
+ frame_start = context.data["frameStartHandle"]
+ frame_end = context.data["frameEndHandle"]
+
+ self.log.info("Starting Fusion render")
+ self.log.info(f"Start frame: {frame_start}")
+ self.log.info(f"End frame: {frame_end}")
+ saver_names = ", ".join(saver.Name for saver in savers_to_render)
+ self.log.info(f"Rendering tools: {saver_names}")
+
+ with comp_lock_and_undo_chunk(current_comp):
+ with enabled_savers(current_comp, savers_to_render):
+ result = current_comp.Render(
+ {
+ "Start": frame_start,
+ "End": frame_end,
+ "Wait": True,
+ }
+ )
+
+ context.data[key] = bool(result)
+
+ if context.data[key] is False:
+ raise RuntimeError("Comp render failed")
diff --git a/openpype/hosts/fusion/plugins/publish/render_local.py b/openpype/hosts/fusion/plugins/publish/render_local.py
deleted file mode 100644
index 7d5f1a40c7..0000000000
--- a/openpype/hosts/fusion/plugins/publish/render_local.py
+++ /dev/null
@@ -1,100 +0,0 @@
-import os
-import pyblish.api
-from openpype.pipeline import publish
-from openpype.hosts.fusion.api import comp_lock_and_undo_chunk
-
-
-class Fusionlocal(pyblish.api.InstancePlugin,
- publish.ColormanagedPyblishPluginMixin):
- """Render the current Fusion composition locally.
-
- Extract the result of savers by starting a comp render
- This will run the local render of Fusion.
-
- """
-
- order = pyblish.api.ExtractorOrder - 0.1
- label = "Render Local"
- hosts = ["fusion"]
- families = ["render.local"]
-
- def process(self, instance):
- context = instance.context
-
- # Start render
- self.render_once(context)
-
- # Log render status
- self.log.info(
- "Rendered '{nm}' for asset '{ast}' under the task '{tsk}'".format(
- nm=instance.data["name"],
- ast=instance.data["asset"],
- tsk=instance.data["task"],
- )
- )
-
- frame_start = context.data["frameStartHandle"]
- frame_end = context.data["frameEndHandle"]
- path = instance.data["path"]
- output_dir = instance.data["outputDir"]
-
- basename = os.path.basename(path)
- head, ext = os.path.splitext(basename)
- files = [
- f"{head}{str(frame).zfill(4)}{ext}"
- for frame in range(frame_start, frame_end + 1)
- ]
- repre = {
- "name": ext[1:],
- "ext": ext[1:],
- "frameStart": f"%0{len(str(frame_end))}d" % frame_start,
- "files": files,
- "stagingDir": output_dir,
- }
-
- self.set_representation_colorspace(
- representation=repre,
- context=context,
- )
-
- if "representations" not in instance.data:
- instance.data["representations"] = []
- instance.data["representations"].append(repre)
-
- # review representation
- if instance.data.get("review", False):
- repre["tags"] = ["review", "ftrackreview"]
-
- def render_once(self, context):
- """Render context comp only once, even with more render instances"""
-
- # This plug-in assumes all render nodes get rendered at the same time
- # to speed up the rendering. The check below makes sure that we only
- # execute the rendering once and not for each instance.
- key = f"__hasRun{self.__class__.__name__}"
- if key not in context.data:
- # We initialize as false to indicate it wasn't successful yet
- # so we can keep track of whether Fusion succeeded
- context.data[key] = False
-
- current_comp = context.data["currentComp"]
- frame_start = context.data["frameStartHandle"]
- frame_end = context.data["frameEndHandle"]
-
- self.log.info("Starting Fusion render")
- self.log.info(f"Start frame: {frame_start}")
- self.log.info(f"End frame: {frame_end}")
-
- with comp_lock_and_undo_chunk(current_comp):
- result = current_comp.Render(
- {
- "Start": frame_start,
- "End": frame_end,
- "Wait": True,
- }
- )
-
- context.data[key] = bool(result)
-
- if context.data[key] is False:
- raise RuntimeError("Comp render failed")
diff --git a/openpype/hosts/fusion/plugins/publish/validate_create_folder_checked.py b/openpype/hosts/fusion/plugins/publish/validate_create_folder_checked.py
index ba943abacb..8a91f23578 100644
--- a/openpype/hosts/fusion/plugins/publish/validate_create_folder_checked.py
+++ b/openpype/hosts/fusion/plugins/publish/validate_create_folder_checked.py
@@ -14,22 +14,19 @@ class ValidateCreateFolderChecked(pyblish.api.InstancePlugin):
"""
order = pyblish.api.ValidatorOrder
- actions = [RepairAction]
label = "Validate Create Folder Checked"
families = ["render"]
hosts = ["fusion"]
- actions = [SelectInvalidAction]
+ actions = [RepairAction, SelectInvalidAction]
@classmethod
def get_invalid(cls, instance):
- active = instance.data.get("active", instance.data.get("publish"))
- if not active:
- return []
-
tool = instance[0]
create_dir = tool.GetInput("CreateDir")
if create_dir == 0.0:
- cls.log.error("%s has Create Folder turned off" % instance[0].Name)
+ cls.log.error(
+ "%s has Create Folder turned off" % instance[0].Name
+ )
return [tool]
def process(self, instance):
@@ -37,7 +34,8 @@ class ValidateCreateFolderChecked(pyblish.api.InstancePlugin):
if invalid:
raise PublishValidationError(
"Found Saver with Create Folder During Render checked off",
- title=self.label)
+ title=self.label,
+ )
@classmethod
def repair(cls, instance):
diff --git a/openpype/hosts/fusion/plugins/publish/validate_expected_frames_existence.py b/openpype/hosts/fusion/plugins/publish/validate_expected_frames_existence.py
new file mode 100644
index 0000000000..c208b8ef15
--- /dev/null
+++ b/openpype/hosts/fusion/plugins/publish/validate_expected_frames_existence.py
@@ -0,0 +1,78 @@
+import os
+import pyblish.api
+
+from openpype.pipeline.publish import RepairAction
+from openpype.pipeline import PublishValidationError
+
+from openpype.hosts.fusion.api.action import SelectInvalidAction
+
+
+class ValidateLocalFramesExistence(pyblish.api.InstancePlugin):
+ """Checks if files for savers that's set
+ to publish expected frames exists
+ """
+
+ order = pyblish.api.ValidatorOrder
+ label = "Validate Expected Frames Exists"
+ families = ["render"]
+ hosts = ["fusion"]
+ actions = [RepairAction, SelectInvalidAction]
+
+ @classmethod
+ def get_invalid(cls, instance, non_existing_frames=None):
+ if non_existing_frames is None:
+ non_existing_frames = []
+
+ if instance.data.get("render_target") == "frames":
+ tool = instance[0]
+
+ frame_start = instance.data["frameStart"]
+ frame_end = instance.data["frameEnd"]
+ path = instance.data["path"]
+ output_dir = instance.data["outputDir"]
+
+ basename = os.path.basename(path)
+ head, ext = os.path.splitext(basename)
+ files = [
+ f"{head}{str(frame).zfill(4)}{ext}"
+ for frame in range(frame_start, frame_end + 1)
+ ]
+
+ for file in files:
+ if not os.path.exists(os.path.join(output_dir, file)):
+ cls.log.error(
+ f"Missing file: {os.path.join(output_dir, file)}"
+ )
+ non_existing_frames.append(file)
+
+ if len(non_existing_frames) > 0:
+ cls.log.error(f"Some of {tool.Name}'s files does not exist")
+ return [tool]
+
+ def process(self, instance):
+ non_existing_frames = []
+ invalid = self.get_invalid(instance, non_existing_frames)
+ if invalid:
+ raise PublishValidationError(
+ "{} is set to publish existing frames but "
+ "some frames are missing. "
+ "The missing file(s) are:\n\n{}".format(
+ invalid[0].Name,
+ "\n\n".join(non_existing_frames),
+ ),
+ title=self.label,
+ )
+
+ @classmethod
+ def repair(cls, instance):
+ invalid = cls.get_invalid(instance)
+ if invalid:
+ tool = invalid[0]
+
+ # Change render target to local to render locally
+ tool.SetData("openpype.creator_attributes.render_target", "local")
+
+ cls.log.info(
+ f"Reload the publisher and {tool.Name} "
+ "will be set to render locally"
+ )
diff --git a/openpype/hosts/fusion/scripts/set_rendermode.py b/openpype/hosts/fusion/scripts/set_rendermode.py
deleted file mode 100644
index 9d2bfef310..0000000000
--- a/openpype/hosts/fusion/scripts/set_rendermode.py
+++ /dev/null
@@ -1,112 +0,0 @@
-from qtpy import QtWidgets
-import qtawesome
-from openpype.hosts.fusion.api import get_current_comp
-
-
-_help = {"local": "Render the comp on your own machine and publish "
- "it from that the destination folder",
- "farm": "Submit a Fusion render job to a Render farm to use all other"
- " computers and add a publish job"}
-
-
-class SetRenderMode(QtWidgets.QWidget):
-
- def __init__(self, parent=None):
- QtWidgets.QWidget.__init__(self, parent)
-
- self._comp = get_current_comp()
- self._comp_name = self._get_comp_name()
-
- self.setWindowTitle("Set Render Mode")
- self.setFixedSize(300, 175)
-
- layout = QtWidgets.QVBoxLayout()
-
- # region comp info
- comp_info_layout = QtWidgets.QHBoxLayout()
-
- update_btn = QtWidgets.QPushButton(qtawesome.icon("fa.refresh",
- color="white"), "")
- update_btn.setFixedWidth(25)
- update_btn.setFixedHeight(25)
-
- comp_information = QtWidgets.QLineEdit()
- comp_information.setEnabled(False)
-
- comp_info_layout.addWidget(comp_information)
- comp_info_layout.addWidget(update_btn)
- # endregion comp info
-
- # region modes
- mode_options = QtWidgets.QComboBox()
- mode_options.addItems(_help.keys())
-
- mode_information = QtWidgets.QTextEdit()
- mode_information.setReadOnly(True)
- # endregion modes
-
- accept_btn = QtWidgets.QPushButton("Accept")
-
- layout.addLayout(comp_info_layout)
- layout.addWidget(mode_options)
- layout.addWidget(mode_information)
- layout.addWidget(accept_btn)
-
- self.setLayout(layout)
-
- self.comp_information = comp_information
- self.update_btn = update_btn
-
- self.mode_options = mode_options
- self.mode_information = mode_information
-
- self.accept_btn = accept_btn
-
- self.connections()
- self.update()
-
- # Force updated render mode help text
- self._update_rendermode_info()
-
- def connections(self):
- """Build connections between code and buttons"""
-
- self.update_btn.clicked.connect(self.update)
- self.accept_btn.clicked.connect(self._set_comp_rendermode)
- self.mode_options.currentIndexChanged.connect(
- self._update_rendermode_info)
-
- def update(self):
- """Update all information in the UI"""
-
- self._comp = get_current_comp()
- self._comp_name = self._get_comp_name()
- self.comp_information.setText(self._comp_name)
-
- # Update current comp settings
- mode = self._get_comp_rendermode()
- index = self.mode_options.findText(mode)
- self.mode_options.setCurrentIndex(index)
-
- def _update_rendermode_info(self):
- rendermode = self.mode_options.currentText()
- self.mode_information.setText(_help[rendermode])
-
- def _get_comp_name(self):
- return self._comp.GetAttrs("COMPS_Name")
-
- def _get_comp_rendermode(self):
- return self._comp.GetData("openpype.rendermode") or "local"
-
- def _set_comp_rendermode(self):
- rendermode = self.mode_options.currentText()
- self._comp.SetData("openpype.rendermode", rendermode)
-
- self._comp.Print("Updated render mode to '%s'\n" % rendermode)
- self.hide()
-
- def _validation(self):
- ui_mode = self.mode_options.currentText()
- comp_mode = self._get_comp_rendermode()
-
- return comp_mode == ui_mode
diff --git a/openpype/hosts/hiero/api/lib.py b/openpype/hosts/hiero/api/lib.py
index bbd1edc14a..0d4368529f 100644
--- a/openpype/hosts/hiero/api/lib.py
+++ b/openpype/hosts/hiero/api/lib.py
@@ -1221,7 +1221,7 @@ def set_track_color(track_item, color):
def check_inventory_versions(track_items=None):
"""
- Actual version color idetifier of Loaded containers
+ Actual version color identifier of Loaded containers
Check all track items and filter only
Loader nodes for its version. It will get all versions from database
@@ -1249,10 +1249,10 @@ def check_inventory_versions(track_items=None):
project_name = legacy_io.active_project()
filter_result = filter_containers(containers, project_name)
for container in filter_result.latest:
- set_track_color(container["_item"], clip_color)
+ set_track_color(container["_item"], clip_color_last)
for container in filter_result.outdated:
- set_track_color(container["_item"], clip_color_last)
+ set_track_color(container["_item"], clip_color)
def selection_changed_timeline(event):
diff --git a/openpype/hosts/hiero/api/plugin.py b/openpype/hosts/hiero/api/plugin.py
index 07457db1a4..5ca901caaa 100644
--- a/openpype/hosts/hiero/api/plugin.py
+++ b/openpype/hosts/hiero/api/plugin.py
@@ -146,6 +146,8 @@ class CreatorWidget(QtWidgets.QDialog):
return " ".join([str(m.group(0)).capitalize() for m in matches])
def create_row(self, layout, type, text, **kwargs):
+ value_keys = ["setText", "setCheckState", "setValue", "setChecked"]
+
# get type attribute from qwidgets
attr = getattr(QtWidgets, type)
@@ -167,14 +169,27 @@ class CreatorWidget(QtWidgets.QDialog):
# assign the created attribute to variable
item = getattr(self, attr_name)
+
+ # set attributes to item which are not values
for func, val in kwargs.items():
+ if func in value_keys:
+ continue
+
if getattr(item, func):
+ log.debug("Setting {} to {}".format(func, val))
func_attr = getattr(item, func)
if isinstance(val, tuple):
func_attr(*val)
else:
func_attr(val)
+ # set values to item
+ for value_item in value_keys:
+ if value_item not in kwargs:
+ continue
+ if getattr(item, value_item):
+ getattr(item, value_item)(kwargs[value_item])
+
# add to layout
layout.addRow(label, item)
@@ -276,8 +291,11 @@ class CreatorWidget(QtWidgets.QDialog):
elif v["type"] == "QSpinBox":
data[k]["value"] = self.create_row(
content_layout, "QSpinBox", v["label"],
- setValue=v["value"], setMinimum=0,
+ setValue=v["value"],
+ setDisplayIntegerBase=10000,
+ setRange=(0, 99999), setMinimum=0,
setMaximum=100000, setToolTip=tool_tip)
+
return data
diff --git a/openpype/hosts/houdini/startup/MainMenuCommon.xml b/openpype/hosts/houdini/startup/MainMenuCommon.xml
index c08114b71b..47a4653d5d 100644
--- a/openpype/hosts/houdini/startup/MainMenuCommon.xml
+++ b/openpype/hosts/houdini/startup/MainMenuCommon.xml
@@ -10,7 +10,7 @@
import hou
from openpype.tools.utils import host_tools
parent = hou.qt.mainWindow()
-host_tools.show_creator(parent)
+host_tools.show_publisher(parent, tab="create")
]]>
@@ -30,7 +30,7 @@ host_tools.show_loader(parent=parent, use_context=True)
import hou
from openpype.tools.utils import host_tools
parent = hou.qt.mainWindow()
-host_tools.show_publisher(parent)
+host_tools.show_publisher(parent, tab="publish")
]]>
@@ -66,8 +66,8 @@ host_tools.show_workfiles(parent)
]]>
-
-
+
+
dict:
+ """Get the current assets frame range and handles.
+
+ Returns:
+ dict: with frame start, frame end, handle start, handle end.
+ """
+ # Set frame start/end
+ asset = get_current_project_asset()
+ frame_start = asset["data"].get("frameStart")
+ frame_end = asset["data"].get("frameEnd")
+ # Backwards compatibility
+ if frame_start is None or frame_end is None:
+ frame_start = asset["data"].get("edit_in")
+ frame_end = asset["data"].get("edit_out")
+ if frame_start is None or frame_end is None:
+ return
+ handles = asset["data"].get("handles") or 0
+ handle_start = asset["data"].get("handleStart")
+ if handle_start is None:
+ handle_start = handles
+ handle_end = asset["data"].get("handleEnd")
+ if handle_end is None:
+ handle_end = handles
+ return {
+ "frameStart": frame_start,
+ "frameEnd": frame_end,
+ "handleStart": handle_start,
+ "handleEnd": handle_end
+ }
+
+
+def reset_frame_range(fps: bool = True):
+ """Set frame range to current asset.
+ This is part of 3dsmax documentation:
+
+ animationRange: A System Global variable which lets you get and
+ set an Interval value that defines the start and end frames
+ of the Active Time Segment.
+ frameRate: A System Global variable which lets you get
+ and set an Integer value that defines the current
+ scene frame rate in frames-per-second.
+ """
+ if fps:
+ data_fps = get_current_project(fields=["data.fps"])
+ fps_number = float(data_fps["data"]["fps"])
+ rt.frameRate = fps_number
+ frame_range = get_frame_range()
+ frame_start = frame_range["frameStart"] - int(frame_range["handleStart"])
+ frame_end = frame_range["frameEnd"] + int(frame_range["handleEnd"])
+ frange_cmd = f"animationRange = interval {frame_start} {frame_end}"
+ rt.execute(frange_cmd)
+
+
+def set_context_setting():
+ """Apply the project settings from the project definition
+
+ Settings can be overwritten by an asset if the asset.data contains
+ any information regarding those settings.
+
+ Examples of settings:
+ frame range
+ resolution
+
+ Returns:
+ None
+ """
+ reset_scene_resolution()
+
+
def get_max_version():
"""
Args:
diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py
index a74a6a7426..350eb97661 100644
--- a/openpype/hosts/max/api/lib_renderproducts.py
+++ b/openpype/hosts/max/api/lib_renderproducts.py
@@ -8,6 +8,7 @@ from openpype.hosts.max.api.lib import (
get_current_renderer,
get_default_render_folder
)
+from openpype.pipeline.context_tools import get_current_project_asset
from openpype.settings import get_project_settings
from openpype.pipeline import legacy_io
@@ -34,14 +35,20 @@ class RenderProducts(object):
filename,
container)
+ context = get_current_project_asset()
+ startFrame = context["data"].get("frameStart")
+ endFrame = context["data"].get("frameEnd") + 1
+
img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"] # noqa
- full_render_list = []
- beauty = self.beauty_render_product(output_file, img_fmt)
- full_render_list.append(beauty)
+ full_render_list = self.beauty_render_product(output_file,
+ startFrame,
+ endFrame,
+ img_fmt)
renderer_class = get_current_renderer()
renderer = str(renderer_class).split(":")[0]
+
if renderer == "VUE_File_Renderer":
return full_render_list
@@ -54,6 +61,8 @@ class RenderProducts(object):
"Quicksilver_Hardware_Renderer",
]:
render_elem_list = self.render_elements_product(output_file,
+ startFrame,
+ endFrame,
img_fmt)
if render_elem_list:
full_render_list.extend(iter(render_elem_list))
@@ -61,18 +70,24 @@ class RenderProducts(object):
if renderer == "Arnold":
aov_list = self.arnold_render_product(output_file,
+ startFrame,
+ endFrame,
img_fmt)
if aov_list:
full_render_list.extend(iter(aov_list))
return full_render_list
- def beauty_render_product(self, folder, fmt):
- beauty_output = f"{folder}.####.{fmt}"
- beauty_output = beauty_output.replace("\\", "/")
- return beauty_output
+ def beauty_render_product(self, folder, startFrame, endFrame, fmt):
+ beauty_frame_range = []
+ for f in range(startFrame, endFrame):
+ beauty_output = f"{folder}.{f}.{fmt}"
+ beauty_output = beauty_output.replace("\\", "/")
+ beauty_frame_range.append(beauty_output)
+
+ return beauty_frame_range
# TODO: Get the arnold render product
- def arnold_render_product(self, folder, fmt):
+ def arnold_render_product(self, folder, startFrame, endFrame, fmt):
"""Get all the Arnold AOVs"""
aovs = []
@@ -85,15 +100,17 @@ class RenderProducts(object):
for i in range(aov_group_num):
# get the specific AOV group
for aov in aov_mgr.drivers[i].aov_list:
- render_element = f"{folder}_{aov.name}.####.{fmt}"
- render_element = render_element.replace("\\", "/")
- aovs.append(render_element)
+ for f in range(startFrame, endFrame):
+ render_element = f"{folder}_{aov.name}.{f}.{fmt}"
+ render_element = render_element.replace("\\", "/")
+ aovs.append(render_element)
+
# close the AOVs manager window
amw.close()
return aovs
- def render_elements_product(self, folder, fmt):
+ def render_elements_product(self, folder, startFrame, endFrame, fmt):
"""Get all the render element output files. """
render_dirname = []
@@ -104,9 +121,10 @@ class RenderProducts(object):
renderlayer_name = render_elem.GetRenderElement(i)
target, renderpass = str(renderlayer_name).split(":")
if renderlayer_name.enabled:
- render_element = f"{folder}_{renderpass}.####.{fmt}"
- render_element = render_element.replace("\\", "/")
- render_dirname.append(render_element)
+ for f in range(startFrame, endFrame):
+ render_element = f"{folder}_{renderpass}.{f}.{fmt}"
+ render_element = render_element.replace("\\", "/")
+ render_dirname.append(render_element)
return render_dirname
diff --git a/openpype/hosts/max/api/menu.py b/openpype/hosts/max/api/menu.py
index 5c273b49b4..066cc90039 100644
--- a/openpype/hosts/max/api/menu.py
+++ b/openpype/hosts/max/api/menu.py
@@ -4,6 +4,7 @@ from qtpy import QtWidgets, QtCore
from pymxs import runtime as rt
from openpype.tools.utils import host_tools
+from openpype.hosts.max.api import lib
class OpenPypeMenu(object):
@@ -107,6 +108,17 @@ class OpenPypeMenu(object):
workfiles_action = QtWidgets.QAction("Work Files...", openpype_menu)
workfiles_action.triggered.connect(self.workfiles_callback)
openpype_menu.addAction(workfiles_action)
+
+ openpype_menu.addSeparator()
+
+ res_action = QtWidgets.QAction("Set Resolution", openpype_menu)
+ res_action.triggered.connect(self.resolution_callback)
+ openpype_menu.addAction(res_action)
+
+ frame_action = QtWidgets.QAction("Set Frame Range", openpype_menu)
+ frame_action.triggered.connect(self.frame_range_callback)
+ openpype_menu.addAction(frame_action)
+
return openpype_menu
def load_callback(self):
@@ -128,3 +140,11 @@ class OpenPypeMenu(object):
def workfiles_callback(self):
"""Callback to show Workfiles tool."""
host_tools.show_workfiles(parent=self.main_widget)
+
+ def resolution_callback(self):
+ """Callback to reset scene resolution"""
+ return lib.reset_scene_resolution()
+
+ def frame_range_callback(self):
+ """Callback to reset frame range"""
+ return lib.reset_frame_range()
diff --git a/openpype/hosts/max/api/pipeline.py b/openpype/hosts/max/api/pipeline.py
index f8a7b8ea5c..dacc402318 100644
--- a/openpype/hosts/max/api/pipeline.py
+++ b/openpype/hosts/max/api/pipeline.py
@@ -50,6 +50,11 @@ class MaxHost(HostBase, IWorkfileHost, ILoadHost, INewPublisher):
self._has_been_setup = True
+ def context_setting():
+ return lib.set_context_setting()
+ rt.callbacks.addScript(rt.Name('systemPostNew'),
+ context_setting)
+
def has_unsaved_changes(self):
# TODO: how to get it from 3dsmax?
return True
diff --git a/openpype/hosts/max/api/plugin.py b/openpype/hosts/max/api/plugin.py
index c16d9e61ec..b54568b360 100644
--- a/openpype/hosts/max/api/plugin.py
+++ b/openpype/hosts/max/api/plugin.py
@@ -101,7 +101,9 @@ class MaxCreator(Creator, MaxCreatorBase):
instance_node = rt.getNodeByName(
instance.data.get("instance_node"))
if instance_node:
- rt.delete(rt.getNodeByName(instance_node))
+ rt.select(instance_node)
+ rt.execute(f'for o in selection do for c in o.children do c.parent = undefined') # noqa
+ rt.delete(instance_node)
self._remove_instance_from_context(instance)
diff --git a/openpype/hosts/max/plugins/create/create_maxScene.py b/openpype/hosts/max/plugins/create/create_maxScene.py
new file mode 100644
index 0000000000..7900336f32
--- /dev/null
+++ b/openpype/hosts/max/plugins/create/create_maxScene.py
@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+"""Creator plugin for creating raw max scene."""
+from openpype.hosts.max.api import plugin
+from openpype.pipeline import CreatedInstance
+
+
+class CreateMaxScene(plugin.MaxCreator):
+ identifier = "io.openpype.creators.max.maxScene"
+ label = "Max Scene"
+ family = "maxScene"
+ icon = "gear"
+
+ def create(self, subset_name, instance_data, pre_create_data):
+ from pymxs import runtime as rt
+ sel_obj = list(rt.selection)
+ instance = super(CreateMaxScene, self).create(
+ subset_name,
+ instance_data,
+ pre_create_data) # type: CreatedInstance
+ container = rt.getNodeByName(instance.data.get("instance_node"))
+ # TODO: Disable "Add to Containers?" Panel
+ # parent the selected cameras into the container
+ for obj in sel_obj:
+ obj.parent = container
+ # for additional work on the node:
+ # instance_node = rt.getNodeByName(instance.get("instance_node"))
diff --git a/openpype/hosts/max/plugins/create/create_pointcloud.py b/openpype/hosts/max/plugins/create/create_pointcloud.py
new file mode 100644
index 0000000000..c83acac3df
--- /dev/null
+++ b/openpype/hosts/max/plugins/create/create_pointcloud.py
@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+"""Creator plugin for creating point cloud."""
+from openpype.hosts.max.api import plugin
+from openpype.pipeline import CreatedInstance
+
+
+class CreatePointCloud(plugin.MaxCreator):
+ identifier = "io.openpype.creators.max.pointcloud"
+ label = "Point Cloud"
+ family = "pointcloud"
+ icon = "gear"
+
+ def create(self, subset_name, instance_data, pre_create_data):
+ from pymxs import runtime as rt
+ sel_obj = list(rt.selection)
+ instance = super(CreatePointCloud, self).create(
+ subset_name,
+ instance_data,
+ pre_create_data) # type: CreatedInstance
+ container = rt.getNodeByName(instance.data.get("instance_node"))
+ # TODO: Disable "Add to Containers?" Panel
+ # parent the selected cameras into the container
+ for obj in sel_obj:
+ obj.parent = container
+ # for additional work on the node:
+ # instance_node = rt.getNodeByName(instance.get("instance_node"))
diff --git a/openpype/hosts/max/plugins/load/load_max_scene.py b/openpype/hosts/max/plugins/load/load_max_scene.py
index b863b9363f..460f4822a6 100644
--- a/openpype/hosts/max/plugins/load/load_max_scene.py
+++ b/openpype/hosts/max/plugins/load/load_max_scene.py
@@ -9,7 +9,8 @@ from openpype.hosts.max.api import lib
class MaxSceneLoader(load.LoaderPlugin):
"""Max Scene Loader"""
- families = ["camera"]
+ families = ["camera",
+ "maxScene"]
representations = ["max"]
order = -8
icon = "code-fork"
@@ -46,8 +47,7 @@ class MaxSceneLoader(load.LoaderPlugin):
path = get_representation_path(representation)
node = rt.getNodeByName(container["instance_node"])
-
- max_objects = self.get_container_children(node)
+ max_objects = node.Children
for max_object in max_objects:
max_object.source = path
diff --git a/openpype/hosts/max/plugins/load/load_pointcloud.py b/openpype/hosts/max/plugins/load/load_pointcloud.py
new file mode 100644
index 0000000000..27bc88b4f3
--- /dev/null
+++ b/openpype/hosts/max/plugins/load/load_pointcloud.py
@@ -0,0 +1,51 @@
+import os
+from openpype.pipeline import (
+ load, get_representation_path
+)
+from openpype.hosts.max.api.pipeline import containerise
+from openpype.hosts.max.api import lib
+
+
+class PointCloudLoader(load.LoaderPlugin):
+ """Point Cloud Loader"""
+
+ families = ["pointcloud"]
+ representations = ["prt"]
+ order = -8
+ icon = "code-fork"
+ color = "green"
+
+ def load(self, context, name=None, namespace=None, data=None):
+ """load point cloud by tyCache"""
+ from pymxs import runtime as rt
+
+ filepath = os.path.normpath(self.fname)
+ obj = rt.tyCache()
+ obj.filename = filepath
+
+ prt_container = rt.getNodeByName(f"{obj.name}")
+
+ return containerise(
+ name, [prt_container], context, loader=self.__class__.__name__)
+
+ def update(self, container, representation):
+ """update the container"""
+ from pymxs import runtime as rt
+
+ path = get_representation_path(representation)
+ node = rt.getNodeByName(container["instance_node"])
+
+ prt_objects = self.get_container_children(node)
+ for prt_object in prt_objects:
+ prt_object.source = path
+
+ lib.imprint(container["instance_node"], {
+ "representation": str(representation["_id"])
+ })
+
+ def remove(self, container):
+ """remove the container"""
+ from pymxs import runtime as rt
+
+ node = rt.getNodeByName(container["instance_node"])
+ rt.delete(node)
diff --git a/openpype/hosts/max/plugins/publish/collect_render.py b/openpype/hosts/max/plugins/publish/collect_render.py
index 7c9e311c2f..63e4108c84 100644
--- a/openpype/hosts/max/plugins/publish/collect_render.py
+++ b/openpype/hosts/max/plugins/publish/collect_render.py
@@ -61,7 +61,7 @@ class CollectRender(pyblish.api.InstancePlugin):
"plugin": "3dsmax",
"frameStart": context.data['frameStart'],
"frameEnd": context.data['frameEnd'],
- "version": version_int
+ "version": version_int,
}
self.log.info("data: {0}".format(data))
instance.data.update(data)
diff --git a/openpype/hosts/max/plugins/publish/extract_max_scene_raw.py b/openpype/hosts/max/plugins/publish/extract_max_scene_raw.py
index cacc84c591..969f87be48 100644
--- a/openpype/hosts/max/plugins/publish/extract_max_scene_raw.py
+++ b/openpype/hosts/max/plugins/publish/extract_max_scene_raw.py
@@ -20,7 +20,8 @@ class ExtractMaxSceneRaw(publish.Extractor,
order = pyblish.api.ExtractorOrder - 0.2
label = "Extract Max Scene (Raw)"
hosts = ["max"]
- families = ["camera"]
+ families = ["camera",
+ "maxScene"]
optional = True
def process(self, instance):
diff --git a/openpype/hosts/max/plugins/publish/extract_pointcloud.py b/openpype/hosts/max/plugins/publish/extract_pointcloud.py
new file mode 100644
index 0000000000..e8d58ab713
--- /dev/null
+++ b/openpype/hosts/max/plugins/publish/extract_pointcloud.py
@@ -0,0 +1,207 @@
+import os
+import pyblish.api
+from openpype.pipeline import publish
+from pymxs import runtime as rt
+from openpype.hosts.max.api import (
+ maintained_selection
+)
+from openpype.settings import get_project_settings
+from openpype.pipeline import legacy_io
+
+
+def get_setting(project_setting=None):
+ project_setting = get_project_settings(
+ legacy_io.Session["AVALON_PROJECT"]
+ )
+ return (project_setting["max"]["PointCloud"])
+
+
+class ExtractPointCloud(publish.Extractor):
+ """
+ Extract PRT format with tyFlow operators
+
+ Notes:
+ Currently only works for the default partition setting
+
+ Args:
+ export_particle(): sets up all job arguments for attributes
+ to be exported in MAXscript
+
+ get_operators(): get the export_particle operator
+
+ get_custom_attr(): get all custom channel attributes from Openpype
+ setting and sets it as job arguments before exporting
+
+ get_files(): get the files with tyFlow naming convention
+ before publishing
+
+ partition_output_name(): get the naming with partition settings.
+ get_partition(): get partition value
+
+ """
+
+ order = pyblish.api.ExtractorOrder - 0.2
+ label = "Extract Point Cloud"
+ hosts = ["max"]
+ families = ["pointcloud"]
+
+ def process(self, instance):
+ start = int(instance.context.data.get("frameStart"))
+ end = int(instance.context.data.get("frameEnd"))
+ container = instance.data["instance_node"]
+ self.log.info("Extracting PRT...")
+
+ stagingdir = self.staging_dir(instance)
+ filename = "{name}.prt".format(**instance.data)
+ path = os.path.join(stagingdir, filename)
+
+ with maintained_selection():
+ job_args = self.export_particle(container,
+ start,
+ end,
+ path)
+ for job in job_args:
+ rt.execute(job)
+
+ self.log.info("Performing Extraction ...")
+ if "representations" not in instance.data:
+ instance.data["representations"] = []
+
+ self.log.info("Writing PRT with TyFlow Plugin...")
+ filenames = self.get_files(container, path, start, end)
+ self.log.debug("filenames: {0}".format(filenames))
+
+ partition = self.partition_output_name(container)
+
+ representation = {
+ 'name': 'prt',
+ 'ext': 'prt',
+ 'files': filenames if len(filenames) > 1 else filenames[0],
+ "stagingDir": stagingdir,
+ "outputName": partition # partition value
+ }
+ instance.data["representations"].append(representation)
+ self.log.info("Extracted instance '%s' to: %s" % (instance.name,
+ path))
+
+ def export_particle(self,
+ container,
+ start,
+ end,
+ filepath):
+ job_args = []
+ opt_list = self.get_operators(container)
+ for operator in opt_list:
+ start_frame = "{0}.frameStart={1}".format(operator,
+ start)
+ job_args.append(start_frame)
+ end_frame = "{0}.frameEnd={1}".format(operator,
+ end)
+ job_args.append(end_frame)
+ filepath = filepath.replace("\\", "/")
+ prt_filename = '{0}.PRTFilename="{1}"'.format(operator,
+ filepath)
+
+ job_args.append(prt_filename)
+ # Partition
+ mode = "{0}.PRTPartitionsMode=2".format(operator)
+ job_args.append(mode)
+
+ additional_args = self.get_custom_attr(operator)
+ for args in additional_args:
+ job_args.append(args)
+
+ prt_export = "{0}.exportPRT()".format(operator)
+ job_args.append(prt_export)
+
+ return job_args
+
+ def get_operators(self, container):
+ """Get Export Particles Operator"""
+
+ opt_list = []
+ node = rt.getNodebyName(container)
+ selection_list = list(node.Children)
+ for sel in selection_list:
+ obj = sel.baseobject
+ # TODO: to see if it can be used maxscript instead
+ anim_names = rt.getsubanimnames(obj)
+ for anim_name in anim_names:
+ sub_anim = rt.getsubanim(obj, anim_name)
+ boolean = rt.isProperty(sub_anim, "Export_Particles")
+ event_name = sub_anim.name
+ if boolean:
+ opt = "${0}.{1}.export_particles".format(sel.name,
+ event_name)
+ opt_list.append(opt)
+
+ return opt_list
+
+ def get_custom_attr(self, operator):
+ """Get Custom Attributes"""
+
+ custom_attr_list = []
+ attr_settings = get_setting()["attribute"]
+ for key, value in attr_settings.items():
+ custom_attr = "{0}.PRTChannels_{1}=True".format(operator,
+ value)
+ self.log.debug(
+ "{0} will be added as custom attribute".format(key)
+ )
+ custom_attr_list.append(custom_attr)
+
+ return custom_attr_list
+
+ def get_files(self,
+ container,
+ path,
+ start_frame,
+ end_frame):
+ """
+ Note:
+ Set the filenames accordingly to the tyFlow file
+ naming extension for the publishing purpose
+
+ Actual File Output from tyFlow:
+ __partof..prt
+ e.g. tyFlow_cloth_CCCS_blobbyFill_001__part1of1_00004.prt
+ """
+ filenames = []
+ filename = os.path.basename(path)
+ orig_name, ext = os.path.splitext(filename)
+ partition_count, partition_start = self.get_partition(container)
+ for frame in range(int(start_frame), int(end_frame) + 1):
+ actual_name = "{}__part{:03}of{}_{:05}".format(orig_name,
+ partition_start,
+ partition_count,
+ frame)
+ actual_filename = path.replace(orig_name, actual_name)
+ filenames.append(os.path.basename(actual_filename))
+
+ return filenames
+
+ def partition_output_name(self, container):
+ """
+ Notes:
+ Partition output name set for mapping
+ the published file output
+
+ todo:
+ Customizes the setting for the output
+ """
+ partition_count, partition_start = self.get_partition(container)
+ partition = "_part{:03}of{}".format(partition_start,
+ partition_count)
+
+ return partition
+
+ def get_partition(self, container):
+ """
+ Get Partition Value
+ """
+ opt_list = self.get_operators(container)
+ for operator in opt_list:
+ count = rt.execute(f'{operator}.PRTPartitionsCount')
+ start = rt.execute(f'{operator}.PRTPartitionsFrom')
+
+ return count, start
diff --git a/openpype/hosts/max/plugins/publish/increment_workfile_version.py b/openpype/hosts/max/plugins/publish/increment_workfile_version.py
new file mode 100644
index 0000000000..3dec214f77
--- /dev/null
+++ b/openpype/hosts/max/plugins/publish/increment_workfile_version.py
@@ -0,0 +1,19 @@
+import pyblish.api
+from openpype.lib import version_up
+from pymxs import runtime as rt
+
+
+class IncrementWorkfileVersion(pyblish.api.ContextPlugin):
+ """Increment current workfile version."""
+
+ order = pyblish.api.IntegratorOrder + 0.9
+ label = "Increment Workfile Version"
+ hosts = ["max"]
+ families = ["workfile"]
+
+ def process(self, context):
+ path = context.data["currentFile"]
+ filepath = version_up(path)
+
+ rt.saveMaxFile(filepath)
+ self.log.info("Incrementing file version")
diff --git a/openpype/hosts/max/plugins/publish/validate_no_max_content.py b/openpype/hosts/max/plugins/publish/validate_no_max_content.py
new file mode 100644
index 0000000000..c20a1968ed
--- /dev/null
+++ b/openpype/hosts/max/plugins/publish/validate_no_max_content.py
@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+import pyblish.api
+from openpype.pipeline import PublishValidationError
+from pymxs import runtime as rt
+
+
+class ValidateMaxContents(pyblish.api.InstancePlugin):
+ """Validates Max contents.
+
+ Check if MaxScene container includes any contents underneath.
+ """
+
+ order = pyblish.api.ValidatorOrder
+ families = ["camera",
+ "maxScene",
+ "maxrender"]
+ hosts = ["max"]
+ label = "Max Scene Contents"
+
+ def process(self, instance):
+ container = rt.getNodeByName(instance.data["instance_node"])
+ if not list(container.Children):
+ raise PublishValidationError("No content found in the container")
diff --git a/openpype/hosts/max/plugins/publish/validate_pointcloud.py b/openpype/hosts/max/plugins/publish/validate_pointcloud.py
new file mode 100644
index 0000000000..f654058648
--- /dev/null
+++ b/openpype/hosts/max/plugins/publish/validate_pointcloud.py
@@ -0,0 +1,191 @@
+import pyblish.api
+from openpype.pipeline import PublishValidationError
+from pymxs import runtime as rt
+from openpype.settings import get_project_settings
+from openpype.pipeline import legacy_io
+
+
+def get_setting(project_setting=None):
+ project_setting = get_project_settings(
+ legacy_io.Session["AVALON_PROJECT"]
+ )
+ return (project_setting["max"]["PointCloud"])
+
+
+class ValidatePointCloud(pyblish.api.InstancePlugin):
+ """Validate that workfile was saved."""
+
+ order = pyblish.api.ValidatorOrder
+ families = ["pointcloud"]
+ hosts = ["max"]
+ label = "Validate Point Cloud"
+
+ def process(self, instance):
+ """
+ Notes:
+
+ 1. Validate the container only include tyFlow objects
+ 2. Validate if tyFlow operator Export Particle exists
+ 3. Validate if the export mode of Export Particle is at PRT format
+ 4. Validate the partition count and range set as default value
+ Partition Count : 100
+ Partition Range : 1 to 1
+ 5. Validate if the custom attribute(s) exist as parameter(s)
+ of export_particle operator
+
+ """
+ invalid = self.get_tyFlow_object(instance)
+ if invalid:
+ raise PublishValidationError("Non tyFlow object "
+ "found: {}".format(invalid))
+ invalid = self.get_tyFlow_operator(instance)
+ if invalid:
+ raise PublishValidationError("tyFlow ExportParticle operator "
+ "not found: {}".format(invalid))
+
+ invalid = self.validate_export_mode(instance)
+ if invalid:
+ raise PublishValidationError("The export mode is not at PRT")
+
+ invalid = self.validate_partition_value(instance)
+ if invalid:
+ raise PublishValidationError("tyFlow Partition setting is "
+ "not at the default value")
+ invalid = self.validate_custom_attribute(instance)
+ if invalid:
+ raise PublishValidationError("Custom Attribute not found "
+ ":{}".format(invalid))
+
+ def get_tyFlow_object(self, instance):
+ invalid = []
+ container = instance.data["instance_node"]
+ self.log.info("Validating tyFlow container "
+ "for {}".format(container))
+
+ con = rt.getNodeByName(container)
+ selection_list = list(con.Children)
+ for sel in selection_list:
+ sel_tmp = str(sel)
+ if rt.classOf(sel) in [rt.tyFlow,
+ rt.Editable_Mesh]:
+ if "tyFlow" not in sel_tmp:
+ invalid.append(sel)
+ else:
+ invalid.append(sel)
+
+ return invalid
+
+ def get_tyFlow_operator(self, instance):
+ invalid = []
+ container = instance.data["instance_node"]
+ self.log.info("Validating tyFlow object "
+ "for {}".format(container))
+
+ con = rt.getNodeByName(container)
+ selection_list = list(con.Children)
+ bool_list = []
+ for sel in selection_list:
+ obj = sel.baseobject
+ anim_names = rt.getsubanimnames(obj)
+ for anim_name in anim_names:
+ # get all the names of the related tyFlow nodes
+ sub_anim = rt.getsubanim(obj, anim_name)
+ # check if there is export particle operator
+ boolean = rt.isProperty(sub_anim, "Export_Particles")
+ bool_list.append(str(boolean))
+ # if the export_particles property is not there
+ # it means there is not a "Export Particle" operator
+ if "True" not in bool_list:
+ self.log.error("Operator 'Export Particles' not found!")
+ invalid.append(sel)
+
+ return invalid
+
+ def validate_custom_attribute(self, instance):
+ invalid = []
+ container = instance.data["instance_node"]
+ self.log.info("Validating tyFlow custom "
+ "attributes for {}".format(container))
+
+ con = rt.getNodeByName(container)
+ selection_list = list(con.Children)
+ for sel in selection_list:
+ obj = sel.baseobject
+ anim_names = rt.getsubanimnames(obj)
+ for anim_name in anim_names:
+ # get all the names of the related tyFlow nodes
+ sub_anim = rt.getsubanim(obj, anim_name)
+ # check if there is export particle operator
+ boolean = rt.isProperty(sub_anim, "Export_Particles")
+ event_name = sub_anim.name
+ if boolean:
+ opt = "${0}.{1}.export_particles".format(sel.name,
+ event_name)
+ attributes = get_setting()["attribute"]
+ for key, value in attributes.items():
+ custom_attr = "{0}.PRTChannels_{1}".format(opt,
+ value)
+ try:
+ rt.execute(custom_attr)
+ except RuntimeError:
+ invalid.add(key)
+
+ return invalid
+
+ def validate_partition_value(self, instance):
+ invalid = []
+ container = instance.data["instance_node"]
+ self.log.info("Validating tyFlow partition "
+ "value for {}".format(container))
+
+ con = rt.getNodeByName(container)
+ selection_list = list(con.Children)
+ for sel in selection_list:
+ obj = sel.baseobject
+ anim_names = rt.getsubanimnames(obj)
+ for anim_name in anim_names:
+ # get all the names of the related tyFlow nodes
+ sub_anim = rt.getsubanim(obj, anim_name)
+ # check if there is export particle operator
+ boolean = rt.isProperty(sub_anim, "Export_Particles")
+ event_name = sub_anim.name
+ if boolean:
+ opt = "${0}.{1}.export_particles".format(sel.name,
+ event_name)
+ count = rt.execute(f'{opt}.PRTPartitionsCount')
+ if count != 100:
+ invalid.append(count)
+ start = rt.execute(f'{opt}.PRTPartitionsFrom')
+ if start != 1:
+ invalid.append(start)
+ end = rt.execute(f'{opt}.PRTPartitionsTo')
+ if end != 1:
+ invalid.append(end)
+
+ return invalid
+
+ def validate_export_mode(self, instance):
+ invalid = []
+ container = instance.data["instance_node"]
+ self.log.info("Validating tyFlow export "
+ "mode for {}".format(container))
+
+ con = rt.getNodeByName(container)
+ selection_list = list(con.Children)
+ for sel in selection_list:
+ obj = sel.baseobject
+ anim_names = rt.getsubanimnames(obj)
+ for anim_name in anim_names:
+ # get all the names of the related tyFlow nodes
+ sub_anim = rt.getsubanim(obj, anim_name)
+ # check if there is export particle operator
+ boolean = rt.isProperty(sub_anim, "Export_Particles")
+ event_name = sub_anim.name
+ if boolean:
+ opt = "${0}.{1}.export_particles".format(sel.name,
+ event_name)
+ export_mode = rt.execute(f'{opt}.exportMode')
+ if export_mode != 1:
+ invalid.append(export_mode)
+
+ return invalid
diff --git a/openpype/hosts/maya/api/customize.py b/openpype/hosts/maya/api/customize.py
index f66858dfb6..f4c4d6ed88 100644
--- a/openpype/hosts/maya/api/customize.py
+++ b/openpype/hosts/maya/api/customize.py
@@ -11,6 +11,7 @@ import maya.mel as mel
from openpype import resources
from openpype.tools.utils import host_tools
from .lib import get_main_window
+from ..tools import show_look_assigner
log = logging.getLogger(__name__)
@@ -112,7 +113,7 @@ def override_toolbox_ui():
annotation="Look Manager",
label="Look Manager",
image=os.path.join(icons, "lookmanager.png"),
- command=host_tools.show_look_assigner,
+ command=show_look_assigner,
width=icon_size,
height=icon_size,
parent=parent
diff --git a/openpype/hosts/maya/api/lib.py b/openpype/hosts/maya/api/lib.py
index 954576f02e..aa1e501578 100644
--- a/openpype/hosts/maya/api/lib.py
+++ b/openpype/hosts/maya/api/lib.py
@@ -2099,29 +2099,40 @@ def get_frame_range():
}
-def reset_frame_range():
- """Set frame range to current asset"""
+def reset_frame_range(playback=True, render=True, fps=True):
+ """Set frame range to current asset
- fps = convert_to_maya_fps(
- float(legacy_io.Session.get("AVALON_FPS", 25))
- )
- set_scene_fps(fps)
+ Args:
+ playback (bool, Optional): Whether to set the maya timeline playback
+ frame range. Defaults to True.
+ render (bool, Optional): Whether to set the maya render frame range.
+ Defaults to True.
+ fps (bool, Optional): Whether to set scene FPS. Defaults to True.
+ """
+
+ if fps:
+ fps = convert_to_maya_fps(
+ float(legacy_io.Session.get("AVALON_FPS", 25))
+ )
+ set_scene_fps(fps)
frame_range = get_frame_range()
frame_start = frame_range["frameStart"] - int(frame_range["handleStart"])
frame_end = frame_range["frameEnd"] + int(frame_range["handleEnd"])
- cmds.playbackOptions(minTime=frame_start)
- cmds.playbackOptions(maxTime=frame_end)
- cmds.playbackOptions(animationStartTime=frame_start)
- cmds.playbackOptions(animationEndTime=frame_end)
- cmds.playbackOptions(minTime=frame_start)
- cmds.playbackOptions(maxTime=frame_end)
- cmds.currentTime(frame_start)
+ if playback:
+ cmds.playbackOptions(minTime=frame_start)
+ cmds.playbackOptions(maxTime=frame_end)
+ cmds.playbackOptions(animationStartTime=frame_start)
+ cmds.playbackOptions(animationEndTime=frame_end)
+ cmds.playbackOptions(minTime=frame_start)
+ cmds.playbackOptions(maxTime=frame_end)
+ cmds.currentTime(frame_start)
- cmds.setAttr("defaultRenderGlobals.startFrame", frame_start)
- cmds.setAttr("defaultRenderGlobals.endFrame", frame_end)
+ if render:
+ cmds.setAttr("defaultRenderGlobals.startFrame", frame_start)
+ cmds.setAttr("defaultRenderGlobals.endFrame", frame_end)
def reset_scene_resolution():
@@ -3576,6 +3587,65 @@ def get_color_management_output_transform():
return colorspace
+def image_info(file_path):
+ # type: (str) -> dict
+ """Based on tha texture path, get its bit depth and format information.
+ Take reference from makeTx.py in Arnold:
+ ImageInfo(filename): Get Image Information for colorspace
+ AiTextureGetFormat(filename): Get Texture Format
+ AiTextureGetBitDepth(filename): Get Texture bit depth
+ Args:
+ file_path (str): Path to the texture file.
+ Returns:
+ dict: Dictionary with the information about the texture file.
+ """
+ from arnold import (
+ AiTextureGetBitDepth,
+ AiTextureGetFormat
+ )
+ # Get Texture Information
+ img_info = {'filename': file_path}
+ if os.path.isfile(file_path):
+ img_info['bit_depth'] = AiTextureGetBitDepth(file_path) # noqa
+ img_info['format'] = AiTextureGetFormat(file_path) # noqa
+ else:
+ img_info['bit_depth'] = 8
+ img_info['format'] = "unknown"
+ return img_info
+
+
+def guess_colorspace(img_info):
+ # type: (dict) -> str
+ """Guess the colorspace of the input image filename.
+ Note:
+ Reference from makeTx.py
+ Args:
+ img_info (dict): Image info generated by :func:`image_info`
+ Returns:
+ str: color space name use in the `--colorconvert`
+ option of maketx.
+ """
+ from arnold import (
+ AiTextureInvalidate,
+ # types
+ AI_TYPE_BYTE,
+ AI_TYPE_INT,
+ AI_TYPE_UINT
+ )
+ try:
+ if img_info['bit_depth'] <= 16:
+ if img_info['format'] in (AI_TYPE_BYTE, AI_TYPE_INT, AI_TYPE_UINT): # noqa
+ return 'sRGB'
+ else:
+ return 'linear'
+ # now discard the image file as AiTextureGetFormat has loaded it
+ AiTextureInvalidate(img_info['filename']) # noqa
+ except ValueError:
+ print(("[maketx] Error: Could not guess"
+ "colorspace for {}").format(img_info["filename"]))
+ return "linear"
+
+
def len_flattened(components):
"""Return the length of the list as if it was flattened.
diff --git a/openpype/hosts/maya/api/lib_rendersettings.py b/openpype/hosts/maya/api/lib_rendersettings.py
index f19deb0351..eaa728a2f6 100644
--- a/openpype/hosts/maya/api/lib_rendersettings.py
+++ b/openpype/hosts/maya/api/lib_rendersettings.py
@@ -158,7 +158,7 @@ class RenderSettings(object):
cmds.setAttr(
"defaultArnoldDriver.mergeAOVs", multi_exr)
self._additional_attribs_setter(additional_options)
- reset_frame_range()
+ reset_frame_range(playback=False, fps=False, render=True)
def _set_redshift_settings(self, width, height):
"""Sets settings for Redshift."""
@@ -336,7 +336,8 @@ class RenderSettings(object):
)
# Set render file format to exr
- cmds.setAttr("{}.imageFormatStr".format(node), "exr", type="string")
+ ext = vray_render_presets["image_format"]
+ cmds.setAttr("{}.imageFormatStr".format(node), ext, type="string")
# animType
cmds.setAttr("{}.animType".format(node), 1)
diff --git a/openpype/hosts/maya/api/menu.py b/openpype/hosts/maya/api/menu.py
index 0f48a133a6..5284c0249d 100644
--- a/openpype/hosts/maya/api/menu.py
+++ b/openpype/hosts/maya/api/menu.py
@@ -12,6 +12,7 @@ from openpype.pipeline.workfile import BuildWorkfile
from openpype.tools.utils import host_tools
from openpype.hosts.maya.api import lib, lib_rendersettings
from .lib import get_main_window, IS_HEADLESS
+from ..tools import show_look_assigner
from .workfile_template_builder import (
create_placeholder,
@@ -111,12 +112,12 @@ def install():
)
cmds.menuItem(
- "Reset Frame Range",
+ "Set Frame Range",
command=lambda *args: lib.reset_frame_range()
)
cmds.menuItem(
- "Reset Resolution",
+ "Set Resolution",
command=lambda *args: lib.reset_scene_resolution()
)
@@ -139,7 +140,7 @@ def install():
cmds.menuItem(
"Look assigner...",
- command=lambda *args: host_tools.show_look_assigner(
+ command=lambda *args: show_look_assigner(
parent_widget
)
)
diff --git a/openpype/hosts/maya/plugins/create/create_animation.py b/openpype/hosts/maya/plugins/create/create_animation.py
index a4b6e86598..f992ff2c1a 100644
--- a/openpype/hosts/maya/plugins/create/create_animation.py
+++ b/openpype/hosts/maya/plugins/create/create_animation.py
@@ -13,6 +13,7 @@ class CreateAnimation(plugin.Creator):
icon = "male"
write_color_sets = False
write_face_sets = False
+ include_parent_hierarchy = False
include_user_defined_attributes = False
def __init__(self, *args, **kwargs):
@@ -37,7 +38,7 @@ class CreateAnimation(plugin.Creator):
self.data["visibleOnly"] = False
# Include the groups above the out_SET content
- self.data["includeParentHierarchy"] = False # Include parent groups
+ self.data["includeParentHierarchy"] = self.include_parent_hierarchy
# Default to exporting world-space
self.data["worldSpace"] = True
diff --git a/openpype/hosts/maya/plugins/create/create_review.py b/openpype/hosts/maya/plugins/create/create_review.py
index f1b626c06b..e709239ae7 100644
--- a/openpype/hosts/maya/plugins/create/create_review.py
+++ b/openpype/hosts/maya/plugins/create/create_review.py
@@ -26,6 +26,7 @@ class CreateReview(plugin.Creator):
"alpha cut"
]
useMayaTimeline = True
+ panZoom = False
def __init__(self, *args, **kwargs):
super(CreateReview, self).__init__(*args, **kwargs)
@@ -45,5 +46,6 @@ class CreateReview(plugin.Creator):
data["keepImages"] = self.keepImages
data["imagePlane"] = self.imagePlane
data["transparency"] = self.transparency
+ data["panZoom"] = self.panZoom
self.data = data
diff --git a/openpype/hosts/maya/plugins/inventory/connect_geometry.py b/openpype/hosts/maya/plugins/inventory/connect_geometry.py
index a12487cf7e..03154b7afe 100644
--- a/openpype/hosts/maya/plugins/inventory/connect_geometry.py
+++ b/openpype/hosts/maya/plugins/inventory/connect_geometry.py
@@ -134,7 +134,7 @@ class ConnectGeometry(InventoryAction):
bool
"""
- from Qt import QtWidgets
+ from qtpy import QtWidgets
accept = QtWidgets.QMessageBox.Ok
if show_cancel:
diff --git a/openpype/hosts/maya/plugins/inventory/connect_xgen.py b/openpype/hosts/maya/plugins/inventory/connect_xgen.py
index 933a1b4025..177971f176 100644
--- a/openpype/hosts/maya/plugins/inventory/connect_xgen.py
+++ b/openpype/hosts/maya/plugins/inventory/connect_xgen.py
@@ -149,7 +149,7 @@ class ConnectXgen(InventoryAction):
bool
"""
- from Qt import QtWidgets
+ from qtpy import QtWidgets
accept = QtWidgets.QMessageBox.Ok
if show_cancel:
diff --git a/openpype/hosts/maya/plugins/inventory/connect_yeti_rig.py b/openpype/hosts/maya/plugins/inventory/connect_yeti_rig.py
new file mode 100644
index 0000000000..924a1a4627
--- /dev/null
+++ b/openpype/hosts/maya/plugins/inventory/connect_yeti_rig.py
@@ -0,0 +1,178 @@
+import os
+import json
+from collections import defaultdict
+
+from maya import cmds
+
+from openpype.pipeline import (
+ InventoryAction, get_representation_context, get_representation_path
+)
+from openpype.hosts.maya.api.lib import get_container_members, get_id
+
+
+class ConnectYetiRig(InventoryAction):
+ """Connect Yeti Rig with an animation or pointcache."""
+
+ label = "Connect Yeti Rig"
+ icon = "link"
+ color = "white"
+
+ def process(self, containers):
+ # Validate selection is more than 1.
+ message = (
+ "Only 1 container selected. 2+ containers needed for this action."
+ )
+ if len(containers) == 1:
+ self.display_warning(message)
+ return
+
+ # Categorize containers by family.
+ containers_by_family = defaultdict(list)
+ for container in containers:
+ family = get_representation_context(
+ container["representation"]
+ )["subset"]["data"]["family"]
+ containers_by_family[family].append(container)
+
+ # Validate to only 1 source container.
+ source_containers = containers_by_family.get("animation", [])
+ source_containers += containers_by_family.get("pointcache", [])
+ source_container_namespaces = [
+ x["namespace"] for x in source_containers
+ ]
+ message = (
+ "{} animation containers selected:\n\n{}\n\nOnly select 1 of type "
+ "\"animation\" or \"pointcache\".".format(
+ len(source_containers), source_container_namespaces
+ )
+ )
+ if len(source_containers) != 1:
+ self.display_warning(message)
+ return
+
+ source_container = source_containers[0]
+ source_ids = self.nodes_by_id(source_container)
+
+ # Target containers.
+ target_ids = {}
+ inputs = []
+
+ yeti_rig_containers = containers_by_family.get("yetiRig")
+ if not yeti_rig_containers:
+ self.display_warning(
+ "Select at least one yetiRig container"
+ )
+ return
+
+ for container in yeti_rig_containers:
+ target_ids.update(self.nodes_by_id(container))
+
+ maya_file = get_representation_path(
+ get_representation_context(
+ container["representation"]
+ )["representation"]
+ )
+ _, ext = os.path.splitext(maya_file)
+ settings_file = maya_file.replace(ext, ".rigsettings")
+ if not os.path.exists(settings_file):
+ continue
+
+ with open(settings_file) as f:
+ inputs.extend(json.load(f)["inputs"])
+
+ # Compare loaded connections to scene.
+ for input in inputs:
+ source_node = source_ids.get(input["sourceID"])
+ target_node = target_ids.get(input["destinationID"])
+
+ if not source_node or not target_node:
+ self.log.debug(
+ "Could not find nodes for input:\n" +
+ json.dumps(input, indent=4, sort_keys=True)
+ )
+ continue
+ source_attr, target_attr = input["connections"]
+
+ if not cmds.attributeQuery(
+ source_attr, node=source_node, exists=True
+ ):
+ self.log.debug(
+ "Could not find attribute {} on node {} for "
+ "input:\n{}".format(
+ source_attr,
+ source_node,
+ json.dumps(input, indent=4, sort_keys=True)
+ )
+ )
+ continue
+
+ if not cmds.attributeQuery(
+ target_attr, node=target_node, exists=True
+ ):
+ self.log.debug(
+ "Could not find attribute {} on node {} for "
+ "input:\n{}".format(
+ target_attr,
+ target_node,
+ json.dumps(input, indent=4, sort_keys=True)
+ )
+ )
+ continue
+
+ source_plug = "{}.{}".format(
+ source_node, source_attr
+ )
+ target_plug = "{}.{}".format(
+ target_node, target_attr
+ )
+ if cmds.isConnected(
+ source_plug, target_plug, ignoreUnitConversion=True
+ ):
+ self.log.debug(
+ "Connection already exists: {} -> {}".format(
+ source_plug, target_plug
+ )
+ )
+ continue
+
+ cmds.connectAttr(source_plug, target_plug, force=True)
+ self.log.debug(
+ "Connected attributes: {} -> {}".format(
+ source_plug, target_plug
+ )
+ )
+
+ def nodes_by_id(self, container):
+ ids = {}
+ for member in get_container_members(container):
+ id = get_id(member)
+ if not id:
+ continue
+ ids[id] = member
+
+ return ids
+
+ def display_warning(self, message, show_cancel=False):
+ """Show feedback to user.
+
+ Returns:
+ bool
+ """
+
+ from qtpy import QtWidgets
+
+ accept = QtWidgets.QMessageBox.Ok
+ if show_cancel:
+ buttons = accept | QtWidgets.QMessageBox.Cancel
+ else:
+ buttons = accept
+
+ state = QtWidgets.QMessageBox.warning(
+ None,
+ "",
+ message,
+ buttons=buttons,
+ defaultButton=accept
+ )
+
+ return state == accept
diff --git a/openpype/hosts/maya/plugins/load/load_arnold_standin.py b/openpype/hosts/maya/plugins/load/load_arnold_standin.py
index ab69d62ef5..11a2bd1966 100644
--- a/openpype/hosts/maya/plugins/load/load_arnold_standin.py
+++ b/openpype/hosts/maya/plugins/load/load_arnold_standin.py
@@ -2,7 +2,6 @@ import os
import clique
import maya.cmds as cmds
-import mtoa.ui.arnoldmenu
from openpype.settings import get_project_settings
from openpype.pipeline import (
@@ -36,6 +35,11 @@ class ArnoldStandinLoader(load.LoaderPlugin):
color = "orange"
def load(self, context, name, namespace, options):
+
+ # Make sure to load arnold before importing `mtoa.ui.arnoldmenu`
+ cmds.loadPlugin("mtoa", quiet=True)
+ import mtoa.ui.arnoldmenu
+
version = context['version']
version_data = version.get("data", {})
diff --git a/openpype/hosts/maya/plugins/load/load_image.py b/openpype/hosts/maya/plugins/load/load_image.py
new file mode 100644
index 0000000000..b464c268fc
--- /dev/null
+++ b/openpype/hosts/maya/plugins/load/load_image.py
@@ -0,0 +1,332 @@
+import os
+import copy
+
+from openpype.lib import EnumDef
+from openpype.pipeline import (
+ load,
+ get_representation_context
+)
+from openpype.pipeline.load.utils import get_representation_path_from_context
+from openpype.pipeline.colorspace import (
+ get_imageio_colorspace_from_filepath,
+ get_imageio_config,
+ get_imageio_file_rules
+)
+from openpype.settings import get_project_settings
+
+from openpype.hosts.maya.api.pipeline import containerise
+from openpype.hosts.maya.api.lib import (
+ unique_namespace,
+ namespaced
+)
+
+from maya import cmds
+
+
+def create_texture():
+ """Create place2dTexture with file node with uv connections
+
+ Mimics Maya "file [Texture]" creation.
+ """
+
+ place = cmds.shadingNode("place2dTexture", asUtility=True, name="place2d")
+ file = cmds.shadingNode("file", asTexture=True, name="file")
+
+ connections = ["coverage", "translateFrame", "rotateFrame", "rotateUV",
+ "mirrorU", "mirrorV", "stagger", "wrapV", "wrapU",
+ "repeatUV", "offset", "noiseUV", "vertexUvThree",
+ "vertexUvTwo", "vertexUvOne", "vertexCameraOne"]
+ for attr in connections:
+ src = "{}.{}".format(place, attr)
+ dest = "{}.{}".format(file, attr)
+ cmds.connectAttr(src, dest)
+
+ cmds.connectAttr(place + '.outUV', file + '.uvCoord')
+ cmds.connectAttr(place + '.outUvFilterSize', file + '.uvFilterSize')
+
+ return file, place
+
+
+def create_projection():
+ """Create texture with place3dTexture and projection
+
+ Mimics Maya "file [Projection]" creation.
+ """
+
+ file, place = create_texture()
+ projection = cmds.shadingNode("projection", asTexture=True,
+ name="projection")
+ place3d = cmds.shadingNode("place3dTexture", asUtility=True,
+ name="place3d")
+
+ cmds.connectAttr(place3d + '.worldInverseMatrix[0]',
+ projection + ".placementMatrix")
+ cmds.connectAttr(file + '.outColor', projection + ".image")
+
+ return file, place, projection, place3d
+
+
+def create_stencil():
+ """Create texture with extra place2dTexture offset and stencil
+
+ Mimics Maya "file [Stencil]" creation.
+ """
+
+ file, place = create_texture()
+
+ place_stencil = cmds.shadingNode("place2dTexture", asUtility=True,
+ name="place2d_stencil")
+ stencil = cmds.shadingNode("stencil", asTexture=True, name="stencil")
+
+ for src_attr, dest_attr in [
+ ("outUV", "uvCoord"),
+ ("outUvFilterSize", "uvFilterSize")
+ ]:
+ src_plug = "{}.{}".format(place_stencil, src_attr)
+ cmds.connectAttr(src_plug, "{}.{}".format(place, dest_attr))
+ cmds.connectAttr(src_plug, "{}.{}".format(stencil, dest_attr))
+
+ return file, place, stencil, place_stencil
+
+
+class FileNodeLoader(load.LoaderPlugin):
+ """File node loader."""
+
+ families = ["image", "plate", "render"]
+ label = "Load file node"
+ representations = ["exr", "tif", "png", "jpg"]
+ icon = "image"
+ color = "orange"
+ order = 2
+
+ options = [
+ EnumDef(
+ "mode",
+ items={
+ "texture": "Texture",
+ "projection": "Projection",
+ "stencil": "Stencil"
+ },
+ default="texture",
+ label="Texture Mode"
+ )
+ ]
+
+ def load(self, context, name, namespace, data):
+
+ asset = context['asset']['name']
+ namespace = namespace or unique_namespace(
+ asset + "_",
+ prefix="_" if asset[0].isdigit() else "",
+ suffix="_",
+ )
+
+ with namespaced(namespace, new=True) as namespace:
+ # Create the nodes within the namespace
+ nodes = {
+ "texture": create_texture,
+ "projection": create_projection,
+ "stencil": create_stencil
+ }[data.get("mode", "texture")]()
+
+ file_node = cmds.ls(nodes, type="file")[0]
+
+ self._apply_representation_context(context, file_node)
+
+ # For ease of access for the user select all the nodes and select
+ # the file node last so that UI shows its attributes by default
+ cmds.select(list(nodes) + [file_node], replace=True)
+
+ return containerise(
+ name=name,
+ namespace=namespace,
+ nodes=nodes,
+ context=context,
+ loader=self.__class__.__name__
+ )
+
+ def update(self, container, representation):
+
+ members = cmds.sets(container['objectName'], query=True)
+ file_node = cmds.ls(members, type="file")[0]
+
+ context = get_representation_context(representation)
+ self._apply_representation_context(context, file_node)
+
+ # Update representation
+ cmds.setAttr(
+ container["objectName"] + ".representation",
+ str(representation["_id"]),
+ type="string"
+ )
+
+ def switch(self, container, representation):
+ self.update(container, representation)
+
+ def remove(self, container):
+ members = cmds.sets(container['objectName'], query=True)
+ cmds.lockNode(members, lock=False)
+ cmds.delete([container['objectName']] + members)
+
+ # Clean up the namespace
+ try:
+ cmds.namespace(removeNamespace=container['namespace'],
+ deleteNamespaceContent=True)
+ except RuntimeError:
+ pass
+
+ def _apply_representation_context(self, context, file_node):
+ """Update the file node to match the context.
+
+ This sets the file node's attributes for:
+ - file path
+ - udim tiling mode (if it is an udim tile)
+ - use frame extension (if it is a sequence)
+ - colorspace
+
+ """
+
+ repre_context = context["representation"]["context"]
+ has_frames = repre_context.get("frame") is not None
+ has_udim = repre_context.get("udim") is not None
+
+ # Set UV tiling mode if UDIM tiles
+ if has_udim:
+ cmds.setAttr(file_node + ".uvTilingMode", 3) # UDIM-tiles
+ else:
+ cmds.setAttr(file_node + ".uvTilingMode", 0) # off
+
+ # Enable sequence if publish has `startFrame` and `endFrame` and
+ # `startFrame != endFrame`
+ if has_frames and self._is_sequence(context):
+ # When enabling useFrameExtension maya automatically
+ # connects an expression to .frameExtension to set
+ # the current frame. However, this expression is generated
+ # with some delay and thus it'll show a warning if frame 0
+ # doesn't exist because we're explicitly setting the
+ # token.
+ cmds.setAttr(file_node + ".useFrameExtension", True)
+ else:
+ cmds.setAttr(file_node + ".useFrameExtension", False)
+
+ # Set the file node path attribute
+ path = self._format_path(context)
+ cmds.setAttr(file_node + ".fileTextureName", path, type="string")
+
+ # Set colorspace
+ colorspace = self._get_colorspace(context)
+ if colorspace:
+ cmds.setAttr(file_node + ".colorSpace", colorspace, type="string")
+ else:
+ self.log.debug("Unknown colorspace - setting colorspace skipped.")
+
+ def _is_sequence(self, context):
+ """Check whether frameStart and frameEnd are not the same."""
+ version = context.get("version", {})
+ representation = context.get("representation", {})
+
+ for doc in [representation, version]:
+ # Frame range can be set on version or representation.
+ # When set on representation it overrides version data.
+ data = doc.get("data", {})
+ start = data.get("frameStartHandle", data.get("frameStart", None))
+ end = data.get("frameEndHandle", data.get("frameEnd", None))
+
+ if start is None or end is None:
+ continue
+
+ if start != end:
+ return True
+ else:
+ return False
+
+ return False
+
+ def _get_colorspace(self, context):
+ """Return colorspace of the file to load.
+
+ Retrieves the explicit colorspace from the publish. If no colorspace
+ data is stored with published content then project imageio settings
+ are used to make an assumption of the colorspace based on the file
+ rules. If no file rules match then None is returned.
+
+ Returns:
+ str or None: The colorspace of the file or None if not detected.
+
+ """
+
+ # We can't apply color spaces if management is not enabled
+ if not cmds.colorManagementPrefs(query=True, cmEnabled=True):
+ return
+
+ representation = context["representation"]
+ colorspace_data = representation.get("data", {}).get("colorspaceData")
+ if colorspace_data:
+ return colorspace_data["colorspace"]
+
+ # Assume colorspace from filepath based on project settings
+ project_name = context["project"]["name"]
+ host_name = os.environ.get("AVALON_APP")
+ project_settings = get_project_settings(project_name)
+
+ config_data = get_imageio_config(
+ project_name, host_name,
+ project_settings=project_settings
+ )
+ file_rules = get_imageio_file_rules(
+ project_name, host_name,
+ project_settings=project_settings
+ )
+
+ path = get_representation_path_from_context(context)
+ colorspace = get_imageio_colorspace_from_filepath(
+ path=path,
+ host_name=host_name,
+ project_name=project_name,
+ config_data=config_data,
+ file_rules=file_rules,
+ project_settings=project_settings
+ )
+
+ return colorspace
+
+ def _format_path(self, context):
+ """Format the path with correct tokens for frames and udim tiles."""
+
+ context = copy.deepcopy(context)
+ representation = context["representation"]
+ template = representation.get("data", {}).get("template")
+ if not template:
+ # No template to find token locations for
+ return get_representation_path_from_context(context)
+
+ def _placeholder(key):
+ # Substitute with a long placeholder value so that potential
+ # custom formatting with padding doesn't find its way into
+ # our formatting, so that wouldn't be padded as 0
+ return "___{}___".format(key)
+
+ # We format UDIM and Frame numbers with their specific tokens. To do so
+ # we in-place change the representation context data to format the path
+ # with our own data
+ tokens = {
+ "frame": "",
+ "udim": ""
+ }
+ has_tokens = False
+ repre_context = representation["context"]
+ for key, _token in tokens.items():
+ if key in repre_context:
+ repre_context[key] = _placeholder(key)
+ has_tokens = True
+
+ # Replace with our custom template that has the tokens set
+ representation["data"]["template"] = template
+ path = get_representation_path_from_context(context)
+
+ if has_tokens:
+ for key, token in tokens.items():
+ if key in repre_context:
+ path = path.replace(_placeholder(key), token)
+
+ return path
diff --git a/openpype/hosts/maya/plugins/load/load_xgen.py b/openpype/hosts/maya/plugins/load/load_xgen.py
index 1600cd49bd..7e6cabc77c 100644
--- a/openpype/hosts/maya/plugins/load/load_xgen.py
+++ b/openpype/hosts/maya/plugins/load/load_xgen.py
@@ -3,7 +3,7 @@ import os
import maya.cmds as cmds
import xgenm
-from Qt import QtWidgets
+from qtpy import QtWidgets
import openpype.hosts.maya.api.plugin
from openpype.hosts.maya.api.lib import (
diff --git a/openpype/hosts/maya/plugins/load/load_yeti_rig.py b/openpype/hosts/maya/plugins/load/load_yeti_rig.py
index 651607de8a..6a13d2e145 100644
--- a/openpype/hosts/maya/plugins/load/load_yeti_rig.py
+++ b/openpype/hosts/maya/plugins/load/load_yeti_rig.py
@@ -1,17 +1,12 @@
-import os
-from collections import defaultdict
+import maya.cmds as cmds
-from openpype.settings import get_project_settings
+from openpype.settings import get_current_project_settings
import openpype.hosts.maya.api.plugin
from openpype.hosts.maya.api import lib
class YetiRigLoader(openpype.hosts.maya.api.plugin.ReferenceLoader):
- """
- This loader will load Yeti rig. You can select something in scene and if it
- has same ID as mesh published with rig, their shapes will be linked
- together.
- """
+ """This loader will load Yeti rig."""
families = ["yetiRig"]
representations = ["ma"]
@@ -22,72 +17,31 @@ class YetiRigLoader(openpype.hosts.maya.api.plugin.ReferenceLoader):
color = "orange"
def process_reference(
- self, context, name=None, namespace=None, options=None):
+ self, context, name=None, namespace=None, options=None
+ ):
- import maya.cmds as cmds
-
- # get roots of selected hierarchies
- selected_roots = []
- for sel in cmds.ls(sl=True, long=True):
- selected_roots.append(sel.split("|")[1])
-
- # get all objects under those roots
- selected_hierarchy = []
- for root in selected_roots:
- selected_hierarchy.append(cmds.listRelatives(
- root,
- allDescendents=True) or [])
-
- # flatten the list and filter only shapes
- shapes_flat = []
- for root in selected_hierarchy:
- shapes = cmds.ls(root, long=True, type="mesh") or []
- for shape in shapes:
- shapes_flat.append(shape)
-
- # create dictionary of cbId and shape nodes
- scene_lookup = defaultdict(list)
- for node in shapes_flat:
- cb_id = lib.get_id(node)
- scene_lookup[cb_id] = node
-
- # load rig
+ group_name = "{}:{}".format(namespace, name)
with lib.maintained_selection():
- file_url = self.prepare_root_value(self.fname,
- context["project"]["name"])
- nodes = cmds.file(file_url,
- namespace=namespace,
- reference=True,
- returnNewNodes=True,
- groupReference=True,
- groupName="{}:{}".format(namespace, name))
+ file_url = self.prepare_root_value(
+ self.fname, context["project"]["name"]
+ )
+ nodes = cmds.file(
+ file_url,
+ namespace=namespace,
+ reference=True,
+ returnNewNodes=True,
+ groupReference=True,
+ groupName=group_name
+ )
- # for every shape node we've just loaded find matching shape by its
- # cbId in selection. If found outMesh of scene shape will connect to
- # inMesh of loaded shape.
- for destination_node in nodes:
- source_node = scene_lookup[lib.get_id(destination_node)]
- if source_node:
- self.log.info("found: {}".format(source_node))
- self.log.info(
- "creating connection to {}".format(destination_node))
-
- cmds.connectAttr("{}.outMesh".format(source_node),
- "{}.inMesh".format(destination_node),
- force=True)
-
- groupName = "{}:{}".format(namespace, name)
-
- settings = get_project_settings(os.environ['AVALON_PROJECT'])
- colors = settings['maya']['load']['colors']
-
- c = colors.get('yetiRig')
+ settings = get_current_project_settings()
+ colors = settings["maya"]["load"]["colors"]
+ c = colors.get("yetiRig")
if c is not None:
- cmds.setAttr(groupName + ".useOutlinerColor", 1)
- cmds.setAttr(groupName + ".outlinerColor",
- (float(c[0])/255),
- (float(c[1])/255),
- (float(c[2])/255)
+ cmds.setAttr(group_name + ".useOutlinerColor", 1)
+ cmds.setAttr(
+ group_name + ".outlinerColor",
+ (float(c[0]) / 255), (float(c[1]) / 255), (float(c[2]) / 255)
)
self[:] = nodes
diff --git a/openpype/hosts/maya/plugins/publish/collect_review.py b/openpype/hosts/maya/plugins/publish/collect_review.py
index eb872c2935..00565c5819 100644
--- a/openpype/hosts/maya/plugins/publish/collect_review.py
+++ b/openpype/hosts/maya/plugins/publish/collect_review.py
@@ -5,6 +5,7 @@ import pyblish.api
from openpype.client import get_subset_by_name
from openpype.pipeline import legacy_io
+from openpype.hosts.maya.api.lib import get_attribute_input
class CollectReview(pyblish.api.InstancePlugin):
@@ -23,6 +24,11 @@ class CollectReview(pyblish.api.InstancePlugin):
task = legacy_io.Session["AVALON_TASK"]
+ # Get panel.
+ instance.data["panel"] = cmds.playblast(
+ activeEditor=True
+ ).split("|")[-1]
+
# get cameras
members = instance.data['setMembers']
cameras = cmds.ls(members, long=True,
@@ -74,6 +80,8 @@ class CollectReview(pyblish.api.InstancePlugin):
data['review_width'] = instance.data['review_width']
data['review_height'] = instance.data['review_height']
data["isolate"] = instance.data["isolate"]
+ data["panZoom"] = instance.data.get("panZoom", False)
+ data["panel"] = instance.data["panel"]
cmds.setAttr(str(instance) + '.active', 1)
self.log.debug('data {}'.format(instance.context[i].data))
instance.context[i].data.update(data)
@@ -139,3 +147,21 @@ class CollectReview(pyblish.api.InstancePlugin):
"filename": node.filename.get()
}
)
+
+ # Collect focal length.
+ attr = camera + ".focalLength"
+ focal_length = None
+ if get_attribute_input(attr):
+ start = instance.data["frameStart"]
+ end = instance.data["frameEnd"] + 1
+ focal_length = [
+ cmds.getAttr(attr, time=t) for t in range(int(start), int(end))
+ ]
+ else:
+ focal_length = cmds.getAttr(attr)
+
+ key = "focalLength"
+ try:
+ instance.data["burninDataMembers"][key] = focal_length
+ except KeyError:
+ instance.data["burninDataMembers"] = {key: focal_length}
diff --git a/openpype/hosts/maya/plugins/publish/extract_look.py b/openpype/hosts/maya/plugins/publish/extract_look.py
index df07a674dc..447c9a615c 100644
--- a/openpype/hosts/maya/plugins/publish/extract_look.py
+++ b/openpype/hosts/maya/plugins/publish/extract_look.py
@@ -1,12 +1,10 @@
# -*- coding: utf-8 -*-
"""Maya look extractor."""
import os
-import sys
import json
import tempfile
import platform
import contextlib
-import subprocess
from collections import OrderedDict
from maya import cmds # noqa
@@ -16,40 +14,20 @@ import pyblish.api
from openpype.lib import source_hash, run_subprocess
from openpype.pipeline import legacy_io, publish
from openpype.hosts.maya.api import lib
+from openpype.hosts.maya.api.lib import image_info, guess_colorspace
# Modes for transfer
COPY = 1
HARDLINK = 2
-def escape_space(path):
- """Ensure path is enclosed by quotes to allow paths with spaces"""
- return '"{}"'.format(path) if " " in path else path
-
-
-def get_ocio_config_path(profile_folder):
- """Path to OpenPype vendorized OCIO.
-
- Vendorized OCIO config file path is grabbed from the specific path
- hierarchy specified below.
-
- "{OPENPYPE_ROOT}/vendor/OpenColorIO-Configs/{profile_folder}/config.ocio"
- Args:
- profile_folder (str): Name of folder to grab config file from.
-
- Returns:
- str: Path to vendorized config file.
- """
-
- return os.path.join(
- os.environ["OPENPYPE_ROOT"],
- "vendor",
- "bin",
- "ocioconfig",
- "OpenColorIOConfigs",
- profile_folder,
- "config.ocio"
- )
+def _has_arnold():
+ """Return whether the arnold package is available and can be imported."""
+ try:
+ import arnold # noqa: F401
+ return True
+ except (ImportError, ModuleNotFoundError):
+ return False
def find_paths_by_hash(texture_hash):
@@ -367,16 +345,25 @@ class ExtractLook(publish.Extractor):
for filepath in files_metadata:
linearize = False
- if do_maketx and files_metadata[filepath]["color_space"].lower() == "srgb": # noqa: E501
- linearize = True
- # set its file node to 'raw' as tx will be linearized
- files_metadata[filepath]["color_space"] = "Raw"
+ # if OCIO color management enabled
+ # it won't take the condition of the files_metadata
+
+ ocio_maya = cmds.colorManagementPrefs(q=True,
+ cmConfigFileEnabled=True,
+ cmEnabled=True)
+
+ if do_maketx and not ocio_maya:
+ if files_metadata[filepath]["color_space"].lower() == "srgb": # noqa: E501
+ linearize = True
+ # set its file node to 'raw' as tx will be linearized
+ files_metadata[filepath]["color_space"] = "Raw"
# if do_maketx:
# color_space = "Raw"
source, mode, texture_hash = self._process_texture(
filepath,
+ resource,
do_maketx,
staging=staging_dir,
linearize=linearize,
@@ -482,7 +469,8 @@ class ExtractLook(publish.Extractor):
resources_dir, basename + ext
)
- def _process_texture(self, filepath, do_maketx, staging, linearize, force):
+ def _process_texture(self, filepath, resource,
+ do_maketx, staging, linearize, force):
"""Process a single texture file on disk for publishing.
This will:
1. Check whether it's already published, if so it will do hardlink
@@ -524,10 +512,47 @@ class ExtractLook(publish.Extractor):
texture_hash
]
if linearize:
- self.log.info("tx: converting sRGB -> linear")
- additional_args.extend(["--colorconvert", "sRGB", "linear"])
+ if cmds.colorManagementPrefs(query=True, cmEnabled=True):
+ render_colorspace = cmds.colorManagementPrefs(query=True,
+ renderingSpaceName=True) # noqa
+ config_path = cmds.colorManagementPrefs(query=True,
+ configFilePath=True) # noqa
+ if not os.path.exists(config_path):
+ raise RuntimeError("No OCIO config path found!")
+
+ color_space_attr = resource["node"] + ".colorSpace"
+ try:
+ color_space = cmds.getAttr(color_space_attr)
+ except ValueError:
+ # node doesn't have color space attribute
+ if _has_arnold():
+ img_info = image_info(filepath)
+ color_space = guess_colorspace(img_info)
+ else:
+ color_space = "Raw"
+ self.log.info("tx: converting {0} -> {1}".format(color_space, render_colorspace)) # noqa
+
+ additional_args.extend(["--colorconvert",
+ color_space,
+ render_colorspace])
+ else:
+
+ if _has_arnold():
+ img_info = image_info(filepath)
+ color_space = guess_colorspace(img_info)
+ if color_space == "sRGB":
+ self.log.info("tx: converting sRGB -> linear")
+ additional_args.extend(["--colorconvert",
+ "sRGB",
+ "Raw"])
+ else:
+ self.log.info("tx: texture's colorspace "
+ "is already linear")
+ else:
+ self.log.warning("cannot guess the colorspace"
+ "color conversion won't be available!") # noqa
+
- config_path = get_ocio_config_path("nuke-default")
additional_args.extend(["--colorconfig", config_path])
# Ensure folder exists
if not os.path.exists(os.path.dirname(converted)):
diff --git a/openpype/hosts/maya/plugins/publish/extract_playblast.py b/openpype/hosts/maya/plugins/publish/extract_playblast.py
index 1966ad7b66..72b1489522 100644
--- a/openpype/hosts/maya/plugins/publish/extract_playblast.py
+++ b/openpype/hosts/maya/plugins/publish/extract_playblast.py
@@ -1,5 +1,6 @@
import os
import json
+import contextlib
import clique
import capture
@@ -11,6 +12,16 @@ from maya import cmds
import pymel.core as pm
+@contextlib.contextmanager
+def panel_camera(panel, camera):
+ original_camera = cmds.modelPanel(panel, query=True, camera=True)
+ try:
+ cmds.modelPanel(panel, edit=True, camera=camera)
+ yield
+ finally:
+ cmds.modelPanel(panel, edit=True, camera=original_camera)
+
+
class ExtractPlayblast(publish.Extractor):
"""Extract viewport playblast.
@@ -25,6 +36,16 @@ class ExtractPlayblast(publish.Extractor):
optional = True
capture_preset = {}
+ def _capture(self, preset):
+ self.log.info(
+ "Using preset:\n{}".format(
+ json.dumps(preset, sort_keys=True, indent=4)
+ )
+ )
+
+ path = capture.capture(log=self.log, **preset)
+ self.log.debug("playblast path {}".format(path))
+
def process(self, instance):
self.log.info("Extracting capture..")
@@ -43,7 +64,7 @@ class ExtractPlayblast(publish.Extractor):
self.log.info("start: {}, end: {}".format(start, end))
# get cameras
- camera = instance.data['review_camera']
+ camera = instance.data["review_camera"]
preset = lib.load_capture_preset(data=self.capture_preset)
# Grab capture presets from the project settings
@@ -57,23 +78,23 @@ class ExtractPlayblast(publish.Extractor):
asset_height = asset_data.get("resolutionHeight")
review_instance_width = instance.data.get("review_width")
review_instance_height = instance.data.get("review_height")
- preset['camera'] = camera
+ preset["camera"] = camera
# Tests if project resolution is set,
# if it is a value other than zero, that value is
# used, if not then the asset resolution is
# used
if review_instance_width and review_instance_height:
- preset['width'] = review_instance_width
- preset['height'] = review_instance_height
+ preset["width"] = review_instance_width
+ preset["height"] = review_instance_height
elif width_preset and height_preset:
- preset['width'] = width_preset
- preset['height'] = height_preset
+ preset["width"] = width_preset
+ preset["height"] = height_preset
elif asset_width and asset_height:
- preset['width'] = asset_width
- preset['height'] = asset_height
- preset['start_frame'] = start
- preset['end_frame'] = end
+ preset["width"] = asset_width
+ preset["height"] = asset_height
+ preset["start_frame"] = start
+ preset["end_frame"] = end
# Enforce persisting camera depth of field
camera_options = preset.setdefault("camera_options", {})
@@ -86,8 +107,8 @@ class ExtractPlayblast(publish.Extractor):
self.log.info("Outputting images to %s" % path)
- preset['filename'] = path
- preset['overwrite'] = True
+ preset["filename"] = path
+ preset["overwrite"] = True
pm.refresh(f=True)
@@ -114,11 +135,11 @@ class ExtractPlayblast(publish.Extractor):
# Disable Pan/Zoom.
pan_zoom = cmds.getAttr("{}.panZoomEnabled".format(preset["camera"]))
- cmds.setAttr("{}.panZoomEnabled".format(preset["camera"]), False)
+ preset.pop("pan_zoom", None)
+ preset["camera_options"]["panZoomEnabled"] = instance.data["panZoom"]
# Need to explicitly enable some viewport changes so the viewport is
# refreshed ahead of playblasting.
- panel = cmds.getPanel(withFocus=True)
keys = [
"useDefaultMaterial",
"wireframeOnShaded",
@@ -129,56 +150,67 @@ class ExtractPlayblast(publish.Extractor):
viewport_defaults = {}
for key in keys:
viewport_defaults[key] = cmds.modelEditor(
- panel, query=True, **{key: True}
+ instance.data["panel"], query=True, **{key: True}
)
if preset["viewport_options"][key]:
- cmds.modelEditor(panel, edit=True, **{key: True})
+ cmds.modelEditor(
+ instance.data["panel"], edit=True, **{key: True}
+ )
override_viewport_options = (
- capture_presets['Viewport Options']['override_viewport_options']
+ capture_presets["Viewport Options"]["override_viewport_options"]
)
- with lib.maintained_time():
- filename = preset.get("filename", "%TEMP%")
- # Force viewer to False in call to capture because we have our own
- # viewer opening call to allow a signal to trigger between
- # playblast and viewer
- preset['viewer'] = False
+ # Force viewer to False in call to capture because we have our own
+ # viewer opening call to allow a signal to trigger between
+ # playblast and viewer
+ preset["viewer"] = False
- # Update preset with current panel setting
- # if override_viewport_options is turned off
- panel = cmds.getPanel(withFocus=True) or ""
- if not override_viewport_options and "modelPanel" in panel:
- panel_preset = capture.parse_active_view()
- panel_preset.pop("camera")
- preset.update(panel_preset)
- cmds.setFocus(panel)
+ # Update preset with current panel setting
+ # if override_viewport_options is turned off
+ if not override_viewport_options:
+ panel_preset = capture.parse_view(instance.data["panel"])
+ panel_preset.pop("camera")
+ preset.update(panel_preset)
- self.log.info(
- "Using preset:\n{}".format(
- json.dumps(preset, sort_keys=True, indent=4)
+ # Need to ensure Python 2 compatibility.
+ # TODO: Remove once dropping Python 2.
+ if getattr(contextlib, "nested", None):
+ # Python 3 compatibility.
+ with contextlib.nested(
+ lib.maintained_time(),
+ panel_camera(instance.data["panel"], preset["camera"])
+ ):
+ self._capture(preset)
+ else:
+ # Python 2 compatibility.
+ with contextlib.ExitStack() as stack:
+ stack.enter_context(lib.maintained_time())
+ stack.enter_context(
+ panel_camera(instance.data["panel"], preset["camera"])
)
- )
- path = capture.capture(log=self.log, **preset)
+ self._capture(preset)
# Restoring viewport options.
- cmds.modelEditor(panel, edit=True, **viewport_defaults)
+ if viewport_defaults:
+ cmds.modelEditor(
+ instance.data["panel"], edit=True, **viewport_defaults
+ )
cmds.setAttr("{}.panZoomEnabled".format(preset["camera"]), pan_zoom)
- self.log.debug("playblast path {}".format(path))
-
collected_files = os.listdir(stagingdir)
patterns = [clique.PATTERNS["frames"]]
collections, remainder = clique.assemble(collected_files,
minimum_items=1,
patterns=patterns)
+ filename = preset.get("filename", "%TEMP%")
self.log.debug("filename {}".format(filename))
frame_collection = None
for collection in collections:
- filebase = collection.format('{head}').rstrip(".")
+ filebase = collection.format("{head}").rstrip(".")
self.log.debug("collection head {}".format(filebase))
if filebase in filename:
frame_collection = collection
@@ -202,15 +234,15 @@ class ExtractPlayblast(publish.Extractor):
collected_files = collected_files[0]
representation = {
- 'name': 'png',
- 'ext': 'png',
- 'files': collected_files,
+ "name": self.capture_preset["Codec"]["compression"],
+ "ext": self.capture_preset["Codec"]["compression"],
+ "files": collected_files,
"stagingDir": stagingdir,
"frameStart": start,
"frameEnd": end,
- 'fps': fps,
- 'preview': True,
- 'tags': tags,
- 'camera_name': camera_node_name
+ "fps": fps,
+ "preview": True,
+ "tags": tags,
+ "camera_name": camera_node_name
}
instance.data["representations"].append(representation)
diff --git a/openpype/hosts/maya/plugins/publish/extract_thumbnail.py b/openpype/hosts/maya/plugins/publish/extract_thumbnail.py
index 1d94bd58c5..f2d084b828 100644
--- a/openpype/hosts/maya/plugins/publish/extract_thumbnail.py
+++ b/openpype/hosts/maya/plugins/publish/extract_thumbnail.py
@@ -26,28 +26,28 @@ class ExtractThumbnail(publish.Extractor):
def process(self, instance):
self.log.info("Extracting capture..")
- camera = instance.data['review_camera']
+ camera = instance.data["review_camera"]
- capture_preset = (
- instance.context.data["project_settings"]['maya']['publish']['ExtractPlayblast']['capture_preset']
- )
+ maya_setting = instance.context.data["project_settings"]["maya"]
+ plugin_setting = maya_setting["publish"]["ExtractPlayblast"]
+ capture_preset = plugin_setting["capture_preset"]
override_viewport_options = (
- capture_preset['Viewport Options']['override_viewport_options']
+ capture_preset["Viewport Options"]["override_viewport_options"]
)
try:
preset = lib.load_capture_preset(data=capture_preset)
except KeyError as ke:
- self.log.error('Error loading capture presets: {}'.format(str(ke)))
+ self.log.error("Error loading capture presets: {}".format(str(ke)))
preset = {}
- self.log.info('Using viewport preset: {}'.format(preset))
+ self.log.info("Using viewport preset: {}".format(preset))
# preset["off_screen"] = False
- preset['camera'] = camera
- preset['start_frame'] = instance.data["frameStart"]
- preset['end_frame'] = instance.data["frameStart"]
- preset['camera_options'] = {
+ preset["camera"] = camera
+ preset["start_frame"] = instance.data["frameStart"]
+ preset["end_frame"] = instance.data["frameStart"]
+ preset["camera_options"] = {
"displayGateMask": False,
"displayResolution": False,
"displayFilmGate": False,
@@ -74,14 +74,14 @@ class ExtractThumbnail(publish.Extractor):
# used, if not then the asset resolution is
# used
if review_instance_width and review_instance_height:
- preset['width'] = review_instance_width
- preset['height'] = review_instance_height
+ preset["width"] = review_instance_width
+ preset["height"] = review_instance_height
elif width_preset and height_preset:
- preset['width'] = width_preset
- preset['height'] = height_preset
+ preset["width"] = width_preset
+ preset["height"] = height_preset
elif asset_width and asset_height:
- preset['width'] = asset_width
- preset['height'] = asset_height
+ preset["width"] = asset_width
+ preset["height"] = asset_height
# Create temp directory for thumbnail
# - this is to avoid "override" of source file
@@ -96,8 +96,8 @@ class ExtractThumbnail(publish.Extractor):
self.log.info("Outputting images to %s" % path)
- preset['filename'] = path
- preset['overwrite'] = True
+ preset["filename"] = path
+ preset["overwrite"] = True
pm.refresh(f=True)
@@ -123,14 +123,14 @@ class ExtractThumbnail(publish.Extractor):
preset["viewport_options"] = {"imagePlane": image_plane}
# Disable Pan/Zoom.
- pan_zoom = cmds.getAttr("{}.panZoomEnabled".format(preset["camera"]))
- cmds.setAttr("{}.panZoomEnabled".format(preset["camera"]), False)
+ preset.pop("pan_zoom", None)
+ preset["camera_options"]["panZoomEnabled"] = instance.data["panZoom"]
with lib.maintained_time():
# Force viewer to False in call to capture because we have our own
# viewer opening call to allow a signal to trigger between
# playblast and viewer
- preset['viewer'] = False
+ preset["viewer"] = False
# Update preset with current panel setting
# if override_viewport_options is turned off
@@ -145,17 +145,15 @@ class ExtractThumbnail(publish.Extractor):
_, thumbnail = os.path.split(playblast)
- cmds.setAttr("{}.panZoomEnabled".format(preset["camera"]), pan_zoom)
-
self.log.info("file list {}".format(thumbnail))
if "representations" not in instance.data:
instance.data["representations"] = []
representation = {
- 'name': 'thumbnail',
- 'ext': 'jpg',
- 'files': thumbnail,
+ "name": "thumbnail",
+ "ext": "jpg",
+ "files": thumbnail,
"stagingDir": dst_staging,
"thumbnail": True
}
diff --git a/openpype/hosts/maya/plugins/publish/validate_look_color_space.py b/openpype/hosts/maya/plugins/publish/validate_look_color_space.py
new file mode 100644
index 0000000000..b1bdeb7541
--- /dev/null
+++ b/openpype/hosts/maya/plugins/publish/validate_look_color_space.py
@@ -0,0 +1,26 @@
+from maya import cmds
+
+import pyblish.api
+from openpype.pipeline.publish import ValidateContentsOrder
+from openpype.pipeline import PublishValidationError
+
+
+class ValidateMayaColorSpace(pyblish.api.InstancePlugin):
+ """
+ Check if the OCIO Color Management and maketx options
+ enabled at the same time
+ """
+
+ order = ValidateContentsOrder
+ families = ['look']
+ hosts = ['maya']
+ label = 'Color Management with maketx'
+
+ def process(self, instance):
+ ocio_maya = cmds.colorManagementPrefs(q=True,
+ cmConfigFileEnabled=True,
+ cmEnabled=True)
+ maketx = instance.data["maketx"]
+
+ if ocio_maya and maketx:
+ raise PublishValidationError("Maya is color managed and maketx option is on. OpenPype doesn't support this combination yet.") # noqa
diff --git a/openpype/hosts/maya/plugins/publish/validate_rendersettings.py b/openpype/hosts/maya/plugins/publish/validate_rendersettings.py
index 94e2633593..53f340cd2c 100644
--- a/openpype/hosts/maya/plugins/publish/validate_rendersettings.py
+++ b/openpype/hosts/maya/plugins/publish/validate_rendersettings.py
@@ -13,6 +13,22 @@ from openpype.pipeline.publish import (
from openpype.hosts.maya.api import lib
+def convert_to_int_or_float(string_value):
+ # Order of types are important here since float can convert string
+ # representation of integer.
+ types = [int, float]
+ for t in types:
+ try:
+ result = t(string_value)
+ except ValueError:
+ continue
+ else:
+ return result
+
+ # Neither integer or float.
+ return string_value
+
+
def get_redshift_image_format_labels():
"""Return nice labels for Redshift image formats."""
var = "$g_redshiftImageFormatLabels"
@@ -242,10 +258,6 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
cls.DEFAULT_PADDING, "0" * cls.DEFAULT_PADDING))
# load validation definitions from settings
- validation_settings = (
- instance.context.data["project_settings"]["maya"]["publish"]["ValidateRenderSettings"].get( # noqa: E501
- "{}_render_attributes".format(renderer)) or []
- )
settings_lights_flag = instance.context.data["project_settings"].get(
"maya", {}).get(
"RenderSettings", {}).get(
@@ -253,17 +265,67 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
instance_lights_flag = instance.data.get("renderSetupIncludeLights")
if settings_lights_flag != instance_lights_flag:
- cls.log.warning('Instance flag for "Render Setup Include Lights" is set to {0} and Settings flag is set to {1}'.format(instance_lights_flag, settings_lights_flag)) # noqa
+ cls.log.warning(
+ "Instance flag for \"Render Setup Include Lights\" is set to "
+ "{} and Settings flag is set to {}".format(
+ instance_lights_flag, settings_lights_flag
+ )
+ )
# go through definitions and test if such node.attribute exists.
# if so, compare its value from the one required.
- for attr, value in OrderedDict(validation_settings).items():
- cls.log.debug("{}: {}".format(attr, value))
- if "." not in attr:
- cls.log.warning("Skipping invalid attribute defined in "
- "validation settings: '{}'".format(attr))
+ for attribute, data in cls.get_nodes(instance, renderer).items():
+ # Validate the settings has values.
+ if not data["values"]:
+ cls.log.error(
+ "Settings for {}.{} is missing values.".format(
+ node, attribute
+ )
+ )
continue
+ for node in data["nodes"]:
+ try:
+ render_value = cmds.getAttr(
+ "{}.{}".format(node, attribute)
+ )
+ except RuntimeError:
+ invalid = True
+ cls.log.error(
+ "Cannot get value of {}.{}".format(node, attribute)
+ )
+ else:
+ if render_value not in data["values"]:
+ invalid = True
+ cls.log.error(
+ "Invalid value {} set on {}.{}. Expecting "
+ "{}".format(
+ render_value, node, attribute, data["values"]
+ )
+ )
+
+ return invalid
+
+ @classmethod
+ def get_nodes(cls, instance, renderer):
+ maya_settings = instance.context.data["project_settings"]["maya"]
+ validation_settings = (
+ maya_settings["publish"]["ValidateRenderSettings"].get(
+ "{}_render_attributes".format(renderer)
+ ) or []
+ )
+ result = {}
+ for attr, values in OrderedDict(validation_settings).items():
+ cls.log.debug("{}: {}".format(attr, values))
+ if "." not in attr:
+ cls.log.warning(
+ "Skipping invalid attribute defined in validation "
+ "settings: \"{}\"".format(attr)
+ )
+ continue
+
+ values = [convert_to_int_or_float(v) for v in values]
+
node_type, attribute_name = attr.split(".", 1)
# first get node of that type
@@ -271,28 +333,13 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
if not nodes:
cls.log.warning(
- "No nodes of type '{}' found.".format(node_type))
+ "No nodes of type \"{}\" found.".format(node_type)
+ )
continue
- for node in nodes:
- try:
- render_value = cmds.getAttr(
- "{}.{}".format(node, attribute_name))
- except RuntimeError:
- invalid = True
- cls.log.error(
- "Cannot get value of {}.{}".format(
- node, attribute_name))
- else:
- if str(value) != str(render_value):
- invalid = True
- cls.log.error(
- ("Invalid value {} set on {}.{}. "
- "Expecting {}").format(
- render_value, node, attribute_name, value)
- )
+ result[attribute_name] = {"nodes": nodes, "values": values}
- return invalid
+ return result
@classmethod
def repair(cls, instance):
@@ -305,6 +352,12 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
"{aov_separator}", instance.data.get("aovSeparator", "_")
)
+ for attribute, data in cls.get_nodes(instance, renderer).items():
+ if not data["values"]:
+ continue
+ for node in data["nodes"]:
+ lib.set_attribute(attribute, data["values"][0], node)
+
with lib.renderlayer(layer_node):
default = lib.RENDER_ATTRS['default']
render_attrs = lib.RENDER_ATTRS.get(renderer, default)
diff --git a/openpype/hosts/maya/plugins/publish/validate_yeti_renderscript_callbacks.py b/openpype/hosts/maya/plugins/publish/validate_yeti_renderscript_callbacks.py
index a864a18cee..06250f5779 100644
--- a/openpype/hosts/maya/plugins/publish/validate_yeti_renderscript_callbacks.py
+++ b/openpype/hosts/maya/plugins/publish/validate_yeti_renderscript_callbacks.py
@@ -48,6 +48,18 @@ class ValidateYetiRenderScriptCallbacks(pyblish.api.InstancePlugin):
yeti_loaded = cmds.pluginInfo("pgYetiMaya", query=True, loaded=True)
+ if not yeti_loaded and not cmds.ls(type="pgYetiMaya"):
+ # The yeti plug-in is available and loaded so at
+ # this point we don't really care whether the scene
+ # has any yeti callback set or not since if the callback
+ # is there it wouldn't error and if it weren't then
+ # nothing happens because there are no yeti nodes.
+ cls.log.info(
+ "Yeti is loaded but no yeti nodes were found. "
+ "Callback validation skipped.."
+ )
+ return False
+
renderer = instance.data["renderer"]
if renderer == "redshift":
cls.log.info("Redshift ignores any pre and post render callbacks")
diff --git a/openpype/hosts/maya/tools/__init__.py b/openpype/hosts/maya/tools/__init__.py
new file mode 100644
index 0000000000..bd1e302cd2
--- /dev/null
+++ b/openpype/hosts/maya/tools/__init__.py
@@ -0,0 +1,27 @@
+from openpype.tools.utils.host_tools import qt_app_context
+
+
+class MayaToolsSingleton:
+ _look_assigner = None
+
+
+def get_look_assigner_tool(parent):
+ """Create, cache and return look assigner tool window."""
+ if MayaToolsSingleton._look_assigner is None:
+ from .mayalookassigner import MayaLookAssignerWindow
+ mayalookassigner_window = MayaLookAssignerWindow(parent)
+ MayaToolsSingleton._look_assigner = mayalookassigner_window
+ return MayaToolsSingleton._look_assigner
+
+
+def show_look_assigner(parent=None):
+ """Look manager is Maya specific tool for look management."""
+
+ with qt_app_context():
+ look_assigner_tool = get_look_assigner_tool(parent)
+ look_assigner_tool.show()
+
+ # Pull window to the front.
+ look_assigner_tool.raise_()
+ look_assigner_tool.activateWindow()
+ look_assigner_tool.showNormal()
diff --git a/openpype/tools/mayalookassigner/LICENSE b/openpype/hosts/maya/tools/mayalookassigner/LICENSE
similarity index 100%
rename from openpype/tools/mayalookassigner/LICENSE
rename to openpype/hosts/maya/tools/mayalookassigner/LICENSE
diff --git a/openpype/tools/mayalookassigner/__init__.py b/openpype/hosts/maya/tools/mayalookassigner/__init__.py
similarity index 100%
rename from openpype/tools/mayalookassigner/__init__.py
rename to openpype/hosts/maya/tools/mayalookassigner/__init__.py
diff --git a/openpype/tools/mayalookassigner/app.py b/openpype/hosts/maya/tools/mayalookassigner/app.py
similarity index 100%
rename from openpype/tools/mayalookassigner/app.py
rename to openpype/hosts/maya/tools/mayalookassigner/app.py
diff --git a/openpype/tools/mayalookassigner/commands.py b/openpype/hosts/maya/tools/mayalookassigner/commands.py
similarity index 93%
rename from openpype/tools/mayalookassigner/commands.py
rename to openpype/hosts/maya/tools/mayalookassigner/commands.py
index 2e7a51efde..3d9746511d 100644
--- a/openpype/tools/mayalookassigner/commands.py
+++ b/openpype/hosts/maya/tools/mayalookassigner/commands.py
@@ -80,21 +80,7 @@ def get_all_asset_nodes():
Returns:
list: list of dictionaries
"""
-
- host = registered_host()
-
- nodes = []
- for container in host.ls():
- # We are not interested in looks but assets!
- if container["loader"] == "LookLoader":
- continue
-
- # Gather all information
- container_name = container["objectName"]
- nodes += lib.get_container_members(container_name)
-
- nodes = list(set(nodes))
- return nodes
+ return cmds.ls(dag=True, noIntermediate=True, long=True)
def create_asset_id_hash(nodes):
diff --git a/openpype/tools/mayalookassigner/models.py b/openpype/hosts/maya/tools/mayalookassigner/models.py
similarity index 100%
rename from openpype/tools/mayalookassigner/models.py
rename to openpype/hosts/maya/tools/mayalookassigner/models.py
diff --git a/openpype/tools/mayalookassigner/views.py b/openpype/hosts/maya/tools/mayalookassigner/views.py
similarity index 100%
rename from openpype/tools/mayalookassigner/views.py
rename to openpype/hosts/maya/tools/mayalookassigner/views.py
diff --git a/openpype/tools/mayalookassigner/vray_proxies.py b/openpype/hosts/maya/tools/mayalookassigner/vray_proxies.py
similarity index 100%
rename from openpype/tools/mayalookassigner/vray_proxies.py
rename to openpype/hosts/maya/tools/mayalookassigner/vray_proxies.py
diff --git a/openpype/tools/mayalookassigner/widgets.py b/openpype/hosts/maya/tools/mayalookassigner/widgets.py
similarity index 100%
rename from openpype/tools/mayalookassigner/widgets.py
rename to openpype/hosts/maya/tools/mayalookassigner/widgets.py
diff --git a/openpype/hosts/nuke/api/lib.py b/openpype/hosts/nuke/api/lib.py
index a5a631cc70..2a14096f0e 100644
--- a/openpype/hosts/nuke/api/lib.py
+++ b/openpype/hosts/nuke/api/lib.py
@@ -2861,10 +2861,10 @@ class NukeDirmap(HostDirmap):
pass
def dirmap_routine(self, source_path, destination_path):
- log.debug("{}: {}->{}".format(self.file_name,
- source_path, destination_path))
source_path = source_path.lower().replace(os.sep, '/')
destination_path = destination_path.lower().replace(os.sep, '/')
+ log.debug("Map: {} with: {}->{}".format(self.file_name,
+ source_path, destination_path))
if platform.system().lower() == "windows":
self.file_name = self.file_name.lower().replace(
source_path, destination_path)
@@ -2878,6 +2878,7 @@ class DirmapCache:
_project_name = None
_project_settings = None
_sync_module = None
+ _mapping = None
@classmethod
def project_name(cls):
@@ -2897,6 +2898,36 @@ class DirmapCache:
cls._sync_module = ModulesManager().modules_by_name["sync_server"]
return cls._sync_module
+ @classmethod
+ def mapping(cls):
+ return cls._mapping
+
+ @classmethod
+ def set_mapping(cls, mapping):
+ cls._mapping = mapping
+
+
+def dirmap_file_name_filter(file_name):
+ """Nuke callback function with single full path argument.
+
+ Checks project settings for potential mapping from source to dest.
+ """
+
+ dirmap_processor = NukeDirmap(
+ file_name,
+ "nuke",
+ DirmapCache.project_name(),
+ DirmapCache.project_settings(),
+ DirmapCache.sync_module(),
+ )
+ if not DirmapCache.mapping():
+ DirmapCache.set_mapping(dirmap_processor.get_mappings())
+
+ dirmap_processor.process_dirmap(DirmapCache.mapping())
+ if os.path.exists(dirmap_processor.file_name):
+ return dirmap_processor.file_name
+ return file_name
+
@contextlib.contextmanager
def node_tempfile():
@@ -2942,25 +2973,6 @@ def duplicate_node(node):
return dupli_node
-def dirmap_file_name_filter(file_name):
- """Nuke callback function with single full path argument.
-
- Checks project settings for potential mapping from source to dest.
- """
-
- dirmap_processor = NukeDirmap(
- file_name,
- "nuke",
- DirmapCache.project_name(),
- DirmapCache.project_settings(),
- DirmapCache.sync_module(),
- )
- dirmap_processor.process_dirmap()
- if os.path.exists(dirmap_processor.file_name):
- return dirmap_processor.file_name
- return file_name
-
-
def get_group_io_nodes(nodes):
"""Get the input and the output of a group of nodes."""
diff --git a/openpype/hosts/nuke/plugins/load/load_backdrop.py b/openpype/hosts/nuke/plugins/load/load_backdrop.py
index f227aa161a..67c7877e60 100644
--- a/openpype/hosts/nuke/plugins/load/load_backdrop.py
+++ b/openpype/hosts/nuke/plugins/load/load_backdrop.py
@@ -54,22 +54,19 @@ class LoadBackdropNodes(load.LoaderPlugin):
version = context['version']
version_data = version.get("data", {})
vname = version.get("name", None)
- first = version_data.get("frameStart", None)
- last = version_data.get("frameEnd", None)
namespace = namespace or context['asset']['name']
colorspace = version_data.get("colorspace", None)
object_name = "{}_{}".format(name, namespace)
# prepare data for imprinting
# add additional metadata from the version to imprint to Avalon knob
- add_keys = ["frameStart", "frameEnd", "handleStart", "handleEnd",
- "source", "author", "fps"]
+ add_keys = ["source", "author", "fps"]
- data_imprint = {"frameStart": first,
- "frameEnd": last,
- "version": vname,
- "colorspaceInput": colorspace,
- "objectName": object_name}
+ data_imprint = {
+ "version": vname,
+ "colorspaceInput": colorspace,
+ "objectName": object_name
+ }
for k in add_keys:
data_imprint.update({k: version_data[k]})
@@ -204,18 +201,13 @@ class LoadBackdropNodes(load.LoaderPlugin):
name = container['name']
version_data = version_doc.get("data", {})
vname = version_doc.get("name", None)
- first = version_data.get("frameStart", None)
- last = version_data.get("frameEnd", None)
namespace = container['namespace']
colorspace = version_data.get("colorspace", None)
object_name = "{}_{}".format(name, namespace)
- add_keys = ["frameStart", "frameEnd", "handleStart", "handleEnd",
- "source", "author", "fps"]
+ add_keys = ["source", "author", "fps"]
data_imprint = {"representation": str(representation["_id"]),
- "frameStart": first,
- "frameEnd": last,
"version": vname,
"colorspaceInput": colorspace,
"objectName": object_name}
diff --git a/openpype/hosts/nuke/plugins/publish/collect_backdrop.py b/openpype/hosts/nuke/plugins/publish/collect_backdrop.py
index 8eaefa6854..7d51af7e9e 100644
--- a/openpype/hosts/nuke/plugins/publish/collect_backdrop.py
+++ b/openpype/hosts/nuke/plugins/publish/collect_backdrop.py
@@ -51,38 +51,10 @@ class CollectBackdrops(pyblish.api.InstancePlugin):
instance.data["label"] = "{0} ({1} nodes)".format(
bckn.name(), len(instance.data["transientData"]["childNodes"]))
- instance.data["families"].append(instance.data["family"])
-
- # Get frame range
- handle_start = instance.context.data["handleStart"]
- handle_end = instance.context.data["handleEnd"]
- first_frame = int(nuke.root()["first_frame"].getValue())
- last_frame = int(nuke.root()["last_frame"].getValue())
-
# get version
version = instance.context.data.get('version')
- if not version:
- raise RuntimeError("Script name has no version in the name.")
+ if version:
+ instance.data['version'] = version
- instance.data['version'] = version
-
- # Add version data to instance
- version_data = {
- "handles": handle_start,
- "handleStart": handle_start,
- "handleEnd": handle_end,
- "frameStart": first_frame + handle_start,
- "frameEnd": last_frame - handle_end,
- "version": int(version),
- "families": [instance.data["family"]] + instance.data["families"],
- "subset": instance.data["subset"],
- "fps": instance.context.data["fps"]
- }
-
- instance.data.update({
- "versionData": version_data,
- "frameStart": first_frame,
- "frameEnd": last_frame
- })
self.log.info("Backdrop instance collected: `{}`".format(instance))
diff --git a/openpype/hosts/nuke/plugins/publish/extract_review_data.py b/openpype/hosts/nuke/plugins/publish/extract_review_data.py
index dee8248295..c221af40fb 100644
--- a/openpype/hosts/nuke/plugins/publish/extract_review_data.py
+++ b/openpype/hosts/nuke/plugins/publish/extract_review_data.py
@@ -25,7 +25,7 @@ class ExtractReviewData(publish.Extractor):
# review can be removed since `ProcessSubmittedJobOnFarm` will create
# reviewable representation if needed
if (
- "render.farm" in instance.data["families"]
+ instance.data.get("farm")
and "review" in instance.data["families"]
):
instance.data["families"].remove("review")
diff --git a/openpype/hosts/nuke/plugins/publish/extract_review_data_lut.py b/openpype/hosts/nuke/plugins/publish/extract_review_data_lut.py
index 67779e9599..e4b7b155cd 100644
--- a/openpype/hosts/nuke/plugins/publish/extract_review_data_lut.py
+++ b/openpype/hosts/nuke/plugins/publish/extract_review_data_lut.py
@@ -49,7 +49,12 @@ class ExtractReviewDataLut(publish.Extractor):
exporter.stagingDir, exporter.file).replace("\\", "/")
instance.data["representations"] += data["representations"]
- if "render.farm" in families:
+ # review can be removed since `ProcessSubmittedJobOnFarm` will create
+ # reviewable representation if needed
+ if (
+ instance.data.get("farm")
+ and "review" in instance.data["families"]
+ ):
instance.data["families"].remove("review")
self.log.debug(
diff --git a/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py b/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py
index 3fcfc2a4b5..956d1a54a3 100644
--- a/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py
+++ b/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py
@@ -105,10 +105,7 @@ class ExtractReviewDataMov(publish.Extractor):
self, instance, o_name, o_data["extension"],
multiple_presets)
- if (
- "render.farm" in families or
- "prerender.farm" in families
- ):
+ if instance.data.get("farm"):
if "review" in instance.data["families"]:
instance.data["families"].remove("review")
diff --git a/openpype/hosts/nuke/plugins/publish/extract_thumbnail.py b/openpype/hosts/nuke/plugins/publish/extract_thumbnail.py
index a1a0e241c0..f391ca1e7c 100644
--- a/openpype/hosts/nuke/plugins/publish/extract_thumbnail.py
+++ b/openpype/hosts/nuke/plugins/publish/extract_thumbnail.py
@@ -31,7 +31,7 @@ class ExtractThumbnail(publish.Extractor):
def process(self, instance):
- if "render.farm" in instance.data["families"]:
+ if instance.data.get("farm"):
return
with napi.maintained_selection():
diff --git a/openpype/hosts/photoshop/api/launch_logic.py b/openpype/hosts/photoshop/api/launch_logic.py
index 89ba6ad4e6..25732446b5 100644
--- a/openpype/hosts/photoshop/api/launch_logic.py
+++ b/openpype/hosts/photoshop/api/launch_logic.py
@@ -66,11 +66,11 @@ class MainThreadItem:
return self._result
def execute(self):
- """Execute callback and store it's result.
+ """Execute callback and store its result.
Method must be called from main thread. Item is marked as `done`
when callback execution finished. Store output of callback of exception
- information when callback raise one.
+ information when callback raises one.
"""
log.debug("Executing process in main thread")
if self.done:
diff --git a/openpype/hosts/resolve/api/menu.py b/openpype/hosts/resolve/api/menu.py
index eeb9e65dec..b3717e01ea 100644
--- a/openpype/hosts/resolve/api/menu.py
+++ b/openpype/hosts/resolve/api/menu.py
@@ -69,7 +69,7 @@ class OpenPypeMenu(QtWidgets.QWidget):
# "Set colorspace from presets", self
# )
# reset_resolution_btn = QtWidgets.QPushButton(
- # "Reset Resolution from peresets", self
+ # "Set Resolution from presets", self
# )
layout = QtWidgets.QVBoxLayout(self)
@@ -108,7 +108,7 @@ class OpenPypeMenu(QtWidgets.QWidget):
libload_btn.clicked.connect(self.on_libload_clicked)
# rename_btn.clicked.connect(self.on_rename_clicked)
# set_colorspace_btn.clicked.connect(self.on_set_colorspace_clicked)
- # reset_resolution_btn.clicked.connect(self.on_reset_resolution_clicked)
+ # reset_resolution_btn.clicked.connect(self.on_set_resolution_clicked)
experimental_btn.clicked.connect(self.on_experimental_clicked)
def on_workfile_clicked(self):
@@ -145,8 +145,8 @@ class OpenPypeMenu(QtWidgets.QWidget):
def on_set_colorspace_clicked(self):
print("Clicked Set Colorspace")
- def on_reset_resolution_clicked(self):
- print("Clicked Reset Resolution")
+ def on_set_resolution_clicked(self):
+ print("Clicked Set Resolution")
def on_experimental_clicked(self):
host_tools.show_experimental_tools_dialog()
diff --git a/openpype/hosts/tvpaint/api/communication_server.py b/openpype/hosts/tvpaint/api/communication_server.py
index e94e64e04a..6f76c25e0c 100644
--- a/openpype/hosts/tvpaint/api/communication_server.py
+++ b/openpype/hosts/tvpaint/api/communication_server.py
@@ -389,11 +389,11 @@ class MainThreadItem:
self.kwargs = kwargs
def execute(self):
- """Execute callback and store it's result.
+ """Execute callback and store its result.
Method must be called from main thread. Item is marked as `done`
when callback execution finished. Store output of callback of exception
- information when callback raise one.
+ information when callback raises one.
"""
log.debug("Executing process in main thread")
if self.done:
diff --git a/openpype/hosts/tvpaint/plugins/create/convert_legacy.py b/openpype/hosts/tvpaint/plugins/create/convert_legacy.py
index 538c6e4c5e..5cfa1faa50 100644
--- a/openpype/hosts/tvpaint/plugins/create/convert_legacy.py
+++ b/openpype/hosts/tvpaint/plugins/create/convert_legacy.py
@@ -55,7 +55,7 @@ class TVPaintLegacyConverted(SubsetConvertorPlugin):
self._convert_render_layers(
to_convert["renderLayer"], current_instances)
self._convert_render_passes(
- to_convert["renderpass"], current_instances)
+ to_convert["renderPass"], current_instances)
self._convert_render_scenes(
to_convert["renderScene"], current_instances)
self._convert_workfiles(
@@ -116,7 +116,7 @@ class TVPaintLegacyConverted(SubsetConvertorPlugin):
render_layers_by_group_id = {}
for instance in current_instances:
if instance.get("creator_identifier") == "render.layer":
- group_id = instance["creator_identifier"]["group_id"]
+ group_id = instance["creator_attributes"]["group_id"]
render_layers_by_group_id[group_id] = instance
for render_pass in render_passes:
diff --git a/openpype/hosts/tvpaint/plugins/create/create_render.py b/openpype/hosts/tvpaint/plugins/create/create_render.py
index 9711024c79..2369c7329f 100644
--- a/openpype/hosts/tvpaint/plugins/create/create_render.py
+++ b/openpype/hosts/tvpaint/plugins/create/create_render.py
@@ -415,11 +415,11 @@ class CreateRenderPass(TVPaintCreator):
.get("creator_attributes", {})
.get("render_layer_instance_id")
)
- render_layer_info = render_layers.get(render_layer_instance_id)
+ render_layer_info = render_layers.get(render_layer_instance_id, {})
self.update_instance_labels(
instance_data,
- render_layer_info["variant"],
- render_layer_info["template_data"]
+ render_layer_info.get("variant"),
+ render_layer_info.get("template_data")
)
instance = CreatedInstance.from_existing(instance_data, self)
self._add_instance_to_context(instance)
@@ -607,11 +607,11 @@ class CreateRenderPass(TVPaintCreator):
current_instances = self.host.list_instances()
render_layers = [
{
- "value": instance["instance_id"],
- "label": instance["subset"]
+ "value": inst["instance_id"],
+ "label": inst["subset"]
}
- for instance in current_instances
- if instance["creator_identifier"] == CreateRenderlayer.identifier
+ for inst in current_instances
+ if inst.get("creator_identifier") == CreateRenderlayer.identifier
]
if not render_layers:
render_layers.append({"value": None, "label": "N/A"})
@@ -697,6 +697,7 @@ class TVPaintAutoDetectRenderCreator(TVPaintCreator):
["create"]
["auto_detect_render"]
)
+ self.enabled = plugin_settings.get("enabled", False)
self.allow_group_rename = plugin_settings["allow_group_rename"]
self.group_name_template = plugin_settings["group_name_template"]
self.group_idx_offset = plugin_settings["group_idx_offset"]
diff --git a/openpype/hosts/tvpaint/plugins/publish/collect_instance_frames.py b/openpype/hosts/tvpaint/plugins/publish/collect_instance_frames.py
index 5eb702a1da..63f04cf3ce 100644
--- a/openpype/hosts/tvpaint/plugins/publish/collect_instance_frames.py
+++ b/openpype/hosts/tvpaint/plugins/publish/collect_instance_frames.py
@@ -22,9 +22,11 @@ class CollectOutputFrameRange(pyblish.api.InstancePlugin):
context = instance.context
frame_start = asset_doc["data"]["frameStart"]
+ fps = asset_doc["data"]["fps"]
frame_end = frame_start + (
context.data["sceneMarkOut"] - context.data["sceneMarkIn"]
)
+ instance.data["fps"] = fps
instance.data["frameStart"] = frame_start
instance.data["frameEnd"] = frame_end
self.log.info(
diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_asset_name.py b/openpype/hosts/tvpaint/plugins/publish/validate_asset_name.py
index 7e35726030..d7984ce971 100644
--- a/openpype/hosts/tvpaint/plugins/publish/validate_asset_name.py
+++ b/openpype/hosts/tvpaint/plugins/publish/validate_asset_name.py
@@ -1,5 +1,8 @@
import pyblish.api
-from openpype.pipeline import PublishXmlValidationError
+from openpype.pipeline import (
+ PublishXmlValidationError,
+ OptionalPyblishPluginMixin,
+)
from openpype.hosts.tvpaint.api.pipeline import (
list_instances,
write_instances,
@@ -31,7 +34,10 @@ class FixAssetNames(pyblish.api.Action):
write_instances(new_instance_items)
-class ValidateAssetNames(pyblish.api.ContextPlugin):
+class ValidateAssetName(
+ OptionalPyblishPluginMixin,
+ pyblish.api.ContextPlugin
+):
"""Validate assset name present on instance.
Asset name on instance should be the same as context's.
@@ -43,6 +49,8 @@ class ValidateAssetNames(pyblish.api.ContextPlugin):
actions = [FixAssetNames]
def process(self, context):
+ if not self.is_active(context.data):
+ return
context_asset_name = context.data["asset"]
for instance in context:
asset_name = instance.data.get("asset")
diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_layers_visibility.py b/openpype/hosts/tvpaint/plugins/publish/validate_layers_visibility.py
index 6a496a2e49..8e52a636f4 100644
--- a/openpype/hosts/tvpaint/plugins/publish/validate_layers_visibility.py
+++ b/openpype/hosts/tvpaint/plugins/publish/validate_layers_visibility.py
@@ -11,7 +11,7 @@ class ValidateLayersVisiblity(pyblish.api.InstancePlugin):
families = ["review", "render"]
def process(self, instance):
- layers = instance.data["layers"]
+ layers = instance.data.get("layers")
# Instance have empty layers
# - it is not job of this validator to check that
if not layers:
diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_marks.py b/openpype/hosts/tvpaint/plugins/publish/validate_marks.py
index 0030b0fd1c..7b2cc62bb5 100644
--- a/openpype/hosts/tvpaint/plugins/publish/validate_marks.py
+++ b/openpype/hosts/tvpaint/plugins/publish/validate_marks.py
@@ -1,7 +1,10 @@
import json
import pyblish.api
-from openpype.pipeline import PublishXmlValidationError
+from openpype.pipeline import (
+ PublishXmlValidationError,
+ OptionalPyblishPluginMixin,
+)
from openpype.hosts.tvpaint.api.lib import execute_george
@@ -23,7 +26,10 @@ class ValidateMarksRepair(pyblish.api.Action):
)
-class ValidateMarks(pyblish.api.ContextPlugin):
+class ValidateMarks(
+ OptionalPyblishPluginMixin,
+ pyblish.api.ContextPlugin
+):
"""Validate mark in and out are enabled and it's duration.
Mark In/Out does not have to match frameStart and frameEnd but duration is
@@ -59,6 +65,9 @@ class ValidateMarks(pyblish.api.ContextPlugin):
}
def process(self, context):
+ if not self.is_active(context.data):
+ return
+
current_data = {
"markIn": context.data["sceneMarkIn"],
"markInState": context.data["sceneMarkInState"],
diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_scene_settings.py b/openpype/hosts/tvpaint/plugins/publish/validate_scene_settings.py
index 4473e4b1b7..0ab8e811f5 100644
--- a/openpype/hosts/tvpaint/plugins/publish/validate_scene_settings.py
+++ b/openpype/hosts/tvpaint/plugins/publish/validate_scene_settings.py
@@ -1,11 +1,17 @@
import json
import pyblish.api
-from openpype.pipeline import PublishXmlValidationError
+from openpype.pipeline import (
+ PublishXmlValidationError,
+ OptionalPyblishPluginMixin,
+)
# TODO @iLliCiTiT add fix action for fps
-class ValidateProjectSettings(pyblish.api.ContextPlugin):
+class ValidateProjectSettings(
+ OptionalPyblishPluginMixin,
+ pyblish.api.ContextPlugin
+):
"""Validate scene settings against database."""
label = "Validate Scene Settings"
@@ -13,6 +19,9 @@ class ValidateProjectSettings(pyblish.api.ContextPlugin):
optional = True
def process(self, context):
+ if not self.is_active(context.data):
+ return
+
expected_data = context.data["assetEntity"]["data"]
scene_data = {
"fps": context.data.get("sceneFps"),
diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_start_frame.py b/openpype/hosts/tvpaint/plugins/publish/validate_start_frame.py
index 066e54c670..229ccfcd18 100644
--- a/openpype/hosts/tvpaint/plugins/publish/validate_start_frame.py
+++ b/openpype/hosts/tvpaint/plugins/publish/validate_start_frame.py
@@ -1,5 +1,8 @@
import pyblish.api
-from openpype.pipeline import PublishXmlValidationError
+from openpype.pipeline import (
+ PublishXmlValidationError,
+ OptionalPyblishPluginMixin,
+)
from openpype.hosts.tvpaint.api.lib import execute_george
@@ -14,7 +17,10 @@ class RepairStartFrame(pyblish.api.Action):
execute_george("tv_startframe 0")
-class ValidateStartFrame(pyblish.api.ContextPlugin):
+class ValidateStartFrame(
+ OptionalPyblishPluginMixin,
+ pyblish.api.ContextPlugin
+):
"""Validate start frame being at frame 0."""
label = "Validate Start Frame"
@@ -24,6 +30,9 @@ class ValidateStartFrame(pyblish.api.ContextPlugin):
optional = True
def process(self, context):
+ if not self.is_active(context.data):
+ return
+
start_frame = execute_george("tv_startframe")
if start_frame == 0:
return
diff --git a/openpype/hosts/unreal/ue_workers.py b/openpype/hosts/unreal/ue_workers.py
index 00f83a7d7a..d1740124a8 100644
--- a/openpype/hosts/unreal/ue_workers.py
+++ b/openpype/hosts/unreal/ue_workers.py
@@ -5,29 +5,38 @@ import re
import subprocess
from distutils import dir_util
from pathlib import Path
-from typing import List
+from typing import List, Union
import openpype.hosts.unreal.lib as ue_lib
from qtpy import QtCore
-def parse_comp_progress(line: str, progress_signal: QtCore.Signal(int)) -> int:
- match = re.search('\[[1-9]+/[0-9]+\]', line)
+def parse_comp_progress(line: str, progress_signal: QtCore.Signal(int)):
+ match = re.search(r"\[[1-9]+/[0-9]+]", line)
if match is not None:
- split: list[str] = match.group().split('/')
+ split: list[str] = match.group().split("/")
curr: float = float(split[0][1:])
total: float = float(split[1][:-1])
progress_signal.emit(int((curr / total) * 100.0))
-def parse_prj_progress(line: str, progress_signal: QtCore.Signal(int)) -> int:
- match = re.search('@progress', line)
+def parse_prj_progress(line: str, progress_signal: QtCore.Signal(int)):
+ match = re.search("@progress", line)
if match is not None:
- percent_match = re.search('\d{1,3}', line)
+ percent_match = re.search(r"\d{1,3}", line)
progress_signal.emit(int(percent_match.group()))
+def retrieve_exit_code(line: str):
+ match = re.search(r"ExitCode=\d+", line)
+ if match is not None:
+ split: list[str] = match.group().split("=")
+ return int(split[1])
+
+ return None
+
+
class UEProjectGenerationWorker(QtCore.QObject):
finished = QtCore.Signal(str)
failed = QtCore.Signal(str)
@@ -77,16 +86,19 @@ class UEProjectGenerationWorker(QtCore.QObject):
if self.dev_mode:
stage_count = 4
- self.stage_begin.emit(f'Generating a new UE project ... 1 out of '
- f'{stage_count}')
+ self.stage_begin.emit(
+ ("Generating a new UE project ... 1 out of "
+ f"{stage_count}"))
- commandlet_cmd = [f'{ue_editor_exe.as_posix()}',
- f'{cmdlet_project.as_posix()}',
- f'-run=OPGenerateProject',
- f'{project_file.resolve().as_posix()}']
+ commandlet_cmd = [
+ f"{ue_editor_exe.as_posix()}",
+ f"{cmdlet_project.as_posix()}",
+ "-run=OPGenerateProject",
+ f"{project_file.resolve().as_posix()}",
+ ]
if self.dev_mode:
- commandlet_cmd.append('-GenerateCode')
+ commandlet_cmd.append("-GenerateCode")
gen_process = subprocess.Popen(commandlet_cmd,
stdout=subprocess.PIPE,
@@ -94,24 +106,27 @@ class UEProjectGenerationWorker(QtCore.QObject):
for line in gen_process.stdout:
decoded_line = line.decode(errors="replace")
- print(decoded_line, end='')
+ print(decoded_line, end="")
self.log.emit(decoded_line)
gen_process.stdout.close()
return_code = gen_process.wait()
if return_code and return_code != 0:
- msg = 'Failed to generate ' + self.project_name \
- + f' project! Exited with return code {return_code}'
+ msg = (
+ f"Failed to generate {self.project_name} "
+ f"project! Exited with return code {return_code}"
+ )
self.failed.emit(msg, return_code)
raise RuntimeError(msg)
print("--- Project has been generated successfully.")
- self.stage_begin.emit(f'Writing the Engine ID of the build UE ... 1'
- f' out of {stage_count}')
+ self.stage_begin.emit(
+ (f"Writing the Engine ID of the build UE ... 1"
+ f" out of {stage_count}"))
if not project_file.is_file():
- msg = "Failed to write the Engine ID into .uproject file! Can " \
- "not read!"
+ msg = ("Failed to write the Engine ID into .uproject file! Can "
+ "not read!")
self.failed.emit(msg)
raise RuntimeError(msg)
@@ -125,13 +140,14 @@ class UEProjectGenerationWorker(QtCore.QObject):
pf.seek(0)
json.dump(pf_json, pf, indent=4)
pf.truncate()
- print(f'--- Engine ID has been written into the project file')
+ print("--- Engine ID has been written into the project file")
self.progress.emit(90)
if self.dev_mode:
# 2nd stage
- self.stage_begin.emit(f'Generating project files ... 2 out of '
- f'{stage_count}')
+ self.stage_begin.emit(
+ (f"Generating project files ... 2 out of "
+ f"{stage_count}"))
self.progress.emit(0)
ubt_path = ue_lib.get_path_to_ubt(self.engine_path,
@@ -154,8 +170,8 @@ class UEProjectGenerationWorker(QtCore.QObject):
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
for line in gen_proc.stdout:
- decoded_line: str = line.decode(errors='replace')
- print(decoded_line, end='')
+ decoded_line: str = line.decode(errors="replace")
+ print(decoded_line, end="")
self.log.emit(decoded_line)
parse_prj_progress(decoded_line, self.progress)
@@ -163,13 +179,13 @@ class UEProjectGenerationWorker(QtCore.QObject):
return_code = gen_proc.wait()
if return_code and return_code != 0:
- msg = 'Failed to generate project files! ' \
- f'Exited with return code {return_code}'
+ msg = ("Failed to generate project files! "
+ f"Exited with return code {return_code}")
self.failed.emit(msg, return_code)
raise RuntimeError(msg)
- self.stage_begin.emit(f'Building the project ... 3 out of '
- f'{stage_count}')
+ self.stage_begin.emit(
+ f"Building the project ... 3 out of {stage_count}")
self.progress.emit(0)
# 3rd stage
build_prj_cmd = [ubt_path.as_posix(),
@@ -177,16 +193,16 @@ class UEProjectGenerationWorker(QtCore.QObject):
arch,
"Development",
"-TargetType=Editor",
- f'-Project={project_file}',
- f'{project_file}',
+ f"-Project={project_file}",
+ f"{project_file}",
"-IgnoreJunk"]
build_prj_proc = subprocess.Popen(build_prj_cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
for line in build_prj_proc.stdout:
- decoded_line: str = line.decode(errors='replace')
- print(decoded_line, end='')
+ decoded_line: str = line.decode(errors="replace")
+ print(decoded_line, end="")
self.log.emit(decoded_line)
parse_comp_progress(decoded_line, self.progress)
@@ -194,16 +210,17 @@ class UEProjectGenerationWorker(QtCore.QObject):
return_code = build_prj_proc.wait()
if return_code and return_code != 0:
- msg = 'Failed to build project! ' \
- f'Exited with return code {return_code}'
+ msg = ("Failed to build project! "
+ f"Exited with return code {return_code}")
self.failed.emit(msg, return_code)
raise RuntimeError(msg)
# ensure we have PySide2 installed in engine
self.progress.emit(0)
- self.stage_begin.emit(f'Checking PySide2 installation... {stage_count}'
- f' out of {stage_count}')
+ self.stage_begin.emit(
+ (f"Checking PySide2 installation... {stage_count} "
+ f" out of {stage_count}"))
python_path = None
if platform.system().lower() == "windows":
python_path = self.engine_path / ("Engine/Binaries/ThirdParty/"
@@ -225,9 +242,30 @@ class UEProjectGenerationWorker(QtCore.QObject):
msg = f"Unreal Python not found at {python_path}"
self.failed.emit(msg, 1)
raise RuntimeError(msg)
- subprocess.check_call(
- [python_path.as_posix(), "-m", "pip", "install", "pyside2"]
- )
+ pyside_cmd = [python_path.as_posix(),
+ "-m",
+ "pip",
+ "install",
+ "pyside2"]
+
+ pyside_install = subprocess.Popen(pyside_cmd,
+ stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE)
+
+ for line in pyside_install.stdout:
+ decoded_line: str = line.decode(errors="replace")
+ print(decoded_line, end="")
+ self.log.emit(decoded_line)
+
+ pyside_install.stdout.close()
+ return_code = pyside_install.wait()
+
+ if return_code and return_code != 0:
+ msg = ("Failed to create the project! "
+ "The installation of PySide2 has failed!")
+ self.failed.emit(msg, return_code)
+ raise RuntimeError(msg)
+
self.progress.emit(100)
self.finished.emit("Project successfully built!")
@@ -266,26 +304,30 @@ class UEPluginInstallWorker(QtCore.QObject):
# in order to successfully build the plugin,
# It must be built outside the Engine directory and then moved
- build_plugin_cmd: List[str] = [f'{uat_path.as_posix()}',
- 'BuildPlugin',
- f'-Plugin={uplugin_path.as_posix()}',
- f'-Package={temp_dir.as_posix()}']
+ build_plugin_cmd: List[str] = [f"{uat_path.as_posix()}",
+ "BuildPlugin",
+ f"-Plugin={uplugin_path.as_posix()}",
+ f"-Package={temp_dir.as_posix()}"]
build_proc = subprocess.Popen(build_plugin_cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
+ return_code: Union[None, int] = None
for line in build_proc.stdout:
- decoded_line: str = line.decode(errors='replace')
- print(decoded_line, end='')
+ decoded_line: str = line.decode(errors="replace")
+ print(decoded_line, end="")
self.log.emit(decoded_line)
+ if return_code is None:
+ return_code = retrieve_exit_code(decoded_line)
parse_comp_progress(decoded_line, self.progress)
build_proc.stdout.close()
- return_code = build_proc.wait()
+ build_proc.wait()
if return_code and return_code != 0:
- msg = 'Failed to build plugin' \
- f' project! Exited with return code {return_code}'
+ msg = ("Failed to build plugin"
+ f" project! Exited with return code {return_code}")
+ dir_util.remove_tree(temp_dir.as_posix())
self.failed.emit(msg, return_code)
raise RuntimeError(msg)
diff --git a/openpype/lib/applications.py b/openpype/lib/applications.py
index 7cc296f47b..127d31d042 100644
--- a/openpype/lib/applications.py
+++ b/openpype/lib/applications.py
@@ -889,7 +889,8 @@ class ApplicationLaunchContext:
self.modules_manager = ModulesManager()
# Logger
- logger_name = "{}-{}".format(self.__class__.__name__, self.app_name)
+ logger_name = "{}-{}".format(self.__class__.__name__,
+ self.application.full_name)
self.log = Logger.get_logger(logger_name)
self.executable = executable
@@ -1246,7 +1247,7 @@ class ApplicationLaunchContext:
args_len_str = " ({})".format(len(args))
self.log.info(
"Launching \"{}\" with args{}: {}".format(
- self.app_name, args_len_str, args
+ self.application.full_name, args_len_str, args
)
)
self.launch_args = args
@@ -1271,7 +1272,9 @@ class ApplicationLaunchContext:
exc_info=True
)
- self.log.debug("Launch of {} finished.".format(self.app_name))
+ self.log.debug("Launch of {} finished.".format(
+ self.application.full_name
+ ))
return self.process
@@ -1508,8 +1511,8 @@ def prepare_app_environments(
if key in source_env:
source_env[key] = value
- # `added_env_keys` has debug purpose
- added_env_keys = {app.group.name, app.name}
+ # `app_and_tool_labels` has debug purpose
+ app_and_tool_labels = [app.full_name]
# Environments for application
environments = [
app.group.environment,
@@ -1532,15 +1535,14 @@ def prepare_app_environments(
for group_name in sorted(groups_by_name.keys()):
group = groups_by_name[group_name]
environments.append(group.environment)
- added_env_keys.add(group_name)
for tool_name in sorted(tool_by_group_name[group_name].keys()):
tool = tool_by_group_name[group_name][tool_name]
environments.append(tool.environment)
- added_env_keys.add(tool.name)
+ app_and_tool_labels.append(tool.full_name)
log.debug(
"Will add environments for apps and tools: {}".format(
- ", ".join(added_env_keys)
+ ", ".join(app_and_tool_labels)
)
)
diff --git a/openpype/lib/execute.py b/openpype/lib/execute.py
index 759a4db0cb..6f9a095285 100644
--- a/openpype/lib/execute.py
+++ b/openpype/lib/execute.py
@@ -8,6 +8,8 @@ import tempfile
from .log import Logger
from .vendor_bin_utils import find_executable
+from .openpype_version import is_running_from_build
+
# MSDN process creation flag (Windows only)
CREATE_NO_WINDOW = 0x08000000
@@ -102,6 +104,10 @@ def run_subprocess(*args, **kwargs):
if (
platform.system().lower() == "windows"
and "creationflags" not in kwargs
+ # shell=True already tries to hide the console window
+ # and passing these creationflags then shows the window again
+ # so we avoid it for shell=True cases
+ and kwargs.get("shell") is not True
):
kwargs["creationflags"] = (
subprocess.CREATE_NEW_PROCESS_GROUP
@@ -196,6 +202,11 @@ def run_openpype_process(*args, **kwargs):
# Skip envs that can affect OpenPype process
# - fill more if you find more
env = clean_envs_for_openpype_process(os.environ)
+
+ # Only keep OpenPype version if we are running from build.
+ if not is_running_from_build():
+ env.pop("OPENPYPE_VERSION", None)
+
return run_subprocess(args, env=env, **kwargs)
diff --git a/openpype/lib/file_transaction.py b/openpype/lib/file_transaction.py
index fe70b37cb1..81332a8891 100644
--- a/openpype/lib/file_transaction.py
+++ b/openpype/lib/file_transaction.py
@@ -13,6 +13,16 @@ else:
from shutil import copyfile
+class DuplicateDestinationError(ValueError):
+ """Error raised when transfer destination already exists in queue.
+
+ The error is only raised if `allow_queue_replacements` is False on the
+ FileTransaction instance and the added file to transfer is of a different
+ src file than the one already detected in the queue.
+
+ """
+
+
class FileTransaction(object):
"""File transaction with rollback options.
@@ -44,7 +54,7 @@ class FileTransaction(object):
MODE_COPY = 0
MODE_HARDLINK = 1
- def __init__(self, log=None):
+ def __init__(self, log=None, allow_queue_replacements=False):
if log is None:
log = logging.getLogger("FileTransaction")
@@ -60,6 +70,8 @@ class FileTransaction(object):
# Backup file location mapping to original locations
self._backup_to_original = {}
+ self._allow_queue_replacements = allow_queue_replacements
+
def add(self, src, dst, mode=MODE_COPY):
"""Add a new file to transfer queue.
@@ -82,6 +94,14 @@ class FileTransaction(object):
src, dst))
return
else:
+ if not self._allow_queue_replacements:
+ raise DuplicateDestinationError(
+ "Transfer to destination is already in queue: "
+ "{} -> {}. It's not allowed to be replaced by "
+ "a new transfer from {}".format(
+ queued_src, dst, src
+ ))
+
self.log.warning("File transfer in queue replaced..")
self.log.debug(
"Removed from queue: {} -> {} replaced by {} -> {}".format(
diff --git a/openpype/lib/vendor_bin_utils.py b/openpype/lib/vendor_bin_utils.py
index b6797dbba0..e5deb7a6b2 100644
--- a/openpype/lib/vendor_bin_utils.py
+++ b/openpype/lib/vendor_bin_utils.py
@@ -224,18 +224,26 @@ def find_tool_in_custom_paths(paths, tool, validation_func=None):
def _check_args_returncode(args):
try:
- # Python 2 compatibility where DEVNULL is not available
+ kwargs = {}
+ if platform.system().lower() == "windows":
+ kwargs["creationflags"] = (
+ subprocess.CREATE_NEW_PROCESS_GROUP
+ | getattr(subprocess, "DETACHED_PROCESS", 0)
+ | getattr(subprocess, "CREATE_NO_WINDOW", 0)
+ )
+
if hasattr(subprocess, "DEVNULL"):
proc = subprocess.Popen(
args,
stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL,
+ **kwargs
)
proc.wait()
else:
with open(os.devnull, "w") as devnull:
proc = subprocess.Popen(
- args, stdout=devnull, stderr=devnull,
+ args, stdout=devnull, stderr=devnull, **kwargs
)
proc.wait()
@@ -375,7 +383,7 @@ def get_ffmpeg_tool_path(tool="ffmpeg"):
# Look to PATH for the tool
if not tool_executable_path:
from_path = find_executable(tool)
- if from_path and _oiio_executable_validation(from_path):
+ if from_path and _ffmpeg_executable_validation(from_path):
tool_executable_path = from_path
CachedToolPaths.cache_executable_path(tool, tool_executable_path)
diff --git a/openpype/modules/clockify/clockify_api.py b/openpype/modules/clockify/clockify_api.py
index 6af911fffc..80979c83ab 100644
--- a/openpype/modules/clockify/clockify_api.py
+++ b/openpype/modules/clockify/clockify_api.py
@@ -6,34 +6,22 @@ import datetime
import requests
from .constants import (
CLOCKIFY_ENDPOINT,
- ADMIN_PERMISSION_NAMES
+ ADMIN_PERMISSION_NAMES,
)
from openpype.lib.local_settings import OpenPypeSecureRegistry
-
-
-def time_check(obj):
- if obj.request_counter < 10:
- obj.request_counter += 1
- return
-
- wait_time = 1 - (time.time() - obj.request_time)
- if wait_time > 0:
- time.sleep(wait_time)
-
- obj.request_time = time.time()
- obj.request_counter = 0
+from openpype.lib import Logger
class ClockifyAPI:
+ log = Logger.get_logger(__name__)
+
def __init__(self, api_key=None, master_parent=None):
self.workspace_name = None
- self.workspace_id = None
self.master_parent = master_parent
self.api_key = api_key
- self.request_counter = 0
- self.request_time = time.time()
-
+ self._workspace_id = None
+ self._user_id = None
self._secure_registry = None
@property
@@ -44,11 +32,19 @@ class ClockifyAPI:
@property
def headers(self):
- return {"X-Api-Key": self.api_key}
+ return {"x-api-key": self.api_key}
+
+ @property
+ def workspace_id(self):
+ return self._workspace_id
+
+ @property
+ def user_id(self):
+ return self._user_id
def verify_api(self):
for key, value in self.headers.items():
- if value is None or value.strip() == '':
+ if value is None or value.strip() == "":
return False
return True
@@ -59,65 +55,55 @@ class ClockifyAPI:
if api_key is not None and self.validate_api_key(api_key) is True:
self.api_key = api_key
self.set_workspace()
+ self.set_user_id()
if self.master_parent:
self.master_parent.signed_in()
return True
return False
def validate_api_key(self, api_key):
- test_headers = {'X-Api-Key': api_key}
- action_url = 'workspaces/'
- time_check(self)
+ test_headers = {"x-api-key": api_key}
+ action_url = "user"
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=test_headers
+ CLOCKIFY_ENDPOINT + action_url, headers=test_headers
)
if response.status_code != 200:
return False
return True
- def validate_workspace_perm(self, workspace_id=None):
- user_id = self.get_user_id()
+ def validate_workspace_permissions(self, workspace_id=None, user_id=None):
if user_id is None:
+ self.log.info("No user_id found during validation")
return False
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = "/workspaces/{}/users/{}/permissions".format(
- workspace_id, user_id
- )
- time_check(self)
+ action_url = f"workspaces/{workspace_id}/users?includeRoles=1"
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
- user_permissions = response.json()
- for perm in user_permissions:
- if perm['name'] in ADMIN_PERMISSION_NAMES:
+ data = response.json()
+ for user in data:
+ if user.get("id") == user_id:
+ roles_data = user.get("roles")
+ for entities in roles_data:
+ if entities.get("role") in ADMIN_PERMISSION_NAMES:
return True
return False
def get_user_id(self):
- action_url = 'v1/user/'
- time_check(self)
+ action_url = "user"
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
- # this regex is neccessary: UNICODE strings are crashing
- # during json serialization
- id_regex = '\"{1}id\"{1}\:{1}\"{1}\w+\"{1}'
- result = re.findall(id_regex, str(response.content))
- if len(result) != 1:
- # replace with log and better message?
- print('User ID was not found (this is a BUG!!!)')
- return None
- return json.loads('{'+result[0]+'}')['id']
+ result = response.json()
+ user_id = result.get("id", None)
+
+ return user_id
def set_workspace(self, name=None):
if name is None:
- name = os.environ.get('CLOCKIFY_WORKSPACE', None)
+ name = os.environ.get("CLOCKIFY_WORKSPACE", None)
self.workspace_name = name
- self.workspace_id = None
if self.workspace_name is None:
return
try:
@@ -125,7 +111,7 @@ class ClockifyAPI:
except Exception:
result = False
if result is not False:
- self.workspace_id = result
+ self._workspace_id = result
if self.master_parent is not None:
self.master_parent.start_timer_check()
return True
@@ -139,6 +125,14 @@ class ClockifyAPI:
return all_workspaces[name]
return False
+ def set_user_id(self):
+ try:
+ user_id = self.get_user_id()
+ except Exception:
+ user_id = None
+ if user_id is not None:
+ self._user_id = user_id
+
def get_api_key(self):
return self.secure_registry.get_item("api_key", None)
@@ -146,11 +140,9 @@ class ClockifyAPI:
self.secure_registry.set_item("api_key", api_key)
def get_workspaces(self):
- action_url = 'workspaces/'
- time_check(self)
+ action_url = "workspaces/"
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
return {
workspace["name"]: workspace["id"] for workspace in response.json()
@@ -159,27 +151,22 @@ class ClockifyAPI:
def get_projects(self, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/projects/'.format(workspace_id)
- time_check(self)
+ action_url = f"workspaces/{workspace_id}/projects"
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
-
- return {
- project["name"]: project["id"] for project in response.json()
- }
+ if response.status_code != 403:
+ result = response.json()
+ return {project["name"]: project["id"] for project in result}
def get_project_by_id(self, project_id, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/projects/{}/'.format(
+ action_url = "workspaces/{}/projects/{}".format(
workspace_id, project_id
)
- time_check(self)
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
return response.json()
@@ -187,32 +174,24 @@ class ClockifyAPI:
def get_tags(self, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/tags/'.format(workspace_id)
- time_check(self)
+ action_url = "workspaces/{}/tags".format(workspace_id)
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
- return {
- tag["name"]: tag["id"] for tag in response.json()
- }
+ return {tag["name"]: tag["id"] for tag in response.json()}
def get_tasks(self, project_id, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/projects/{}/tasks/'.format(
+ action_url = "workspaces/{}/projects/{}/tasks".format(
workspace_id, project_id
)
- time_check(self)
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
- return {
- task["name"]: task["id"] for task in response.json()
- }
+ return {task["name"]: task["id"] for task in response.json()}
def get_workspace_id(self, workspace_name):
all_workspaces = self.get_workspaces()
@@ -236,48 +215,64 @@ class ClockifyAPI:
return None
return all_tasks[tag_name]
- def get_task_id(
- self, task_name, project_id, workspace_id=None
- ):
+ def get_task_id(self, task_name, project_id, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- all_tasks = self.get_tasks(
- project_id, workspace_id
- )
+ all_tasks = self.get_tasks(project_id, workspace_id)
if task_name not in all_tasks:
return None
return all_tasks[task_name]
def get_current_time(self):
- return str(datetime.datetime.utcnow().isoformat())+'Z'
+ return str(datetime.datetime.utcnow().isoformat()) + "Z"
def start_time_entry(
- self, description, project_id, task_id=None, tag_ids=[],
- workspace_id=None, billable=True
+ self,
+ description,
+ project_id,
+ task_id=None,
+ tag_ids=None,
+ workspace_id=None,
+ user_id=None,
+ billable=True,
):
# Workspace
if workspace_id is None:
workspace_id = self.workspace_id
+ # User ID
+ if user_id is None:
+ user_id = self._user_id
+
+ # get running timer to check if we need to start it
+ current_timer = self.get_in_progress()
# Check if is currently run another times and has same values
- current = self.get_in_progress(workspace_id)
- if current is not None:
+ # DO not restart the timer, if it is already running for curent task
+ if current_timer:
+ current_timer_hierarchy = current_timer.get("description")
+ current_project_id = current_timer.get("projectId")
+ current_task_id = current_timer.get("taskId")
if (
- current.get("description", None) == description and
- current.get("projectId", None) == project_id and
- current.get("taskId", None) == task_id
+ description == current_timer_hierarchy
+ and project_id == current_project_id
+ and task_id == current_task_id
):
+ self.log.info(
+ "Timer for the current project is already running"
+ )
self.bool_timer_run = True
return self.bool_timer_run
- self.finish_time_entry(workspace_id)
+ self.finish_time_entry()
# Convert billable to strings
if billable:
- billable = 'true'
+ billable = "true"
else:
- billable = 'false'
+ billable = "false"
# Rest API Action
- action_url = 'workspaces/{}/timeEntries/'.format(workspace_id)
+ action_url = "workspaces/{}/user/{}/time-entries".format(
+ workspace_id, user_id
+ )
start = self.get_current_time()
body = {
"start": start,
@@ -285,169 +280,135 @@ class ClockifyAPI:
"description": description,
"projectId": project_id,
"taskId": task_id,
- "tagIds": tag_ids
+ "tagIds": tag_ids,
}
- time_check(self)
response = requests.post(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers,
- json=body
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers, json=body
)
-
- success = False
if response.status_code < 300:
- success = True
- return success
+ return True
+ return False
- def get_in_progress(self, workspace_id=None):
- if workspace_id is None:
- workspace_id = self.workspace_id
- action_url = 'workspaces/{}/timeEntries/inProgress'.format(
- workspace_id
- )
- time_check(self)
- response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
- )
+ def _get_current_timer_values(self, response):
+ if response is None:
+ return
try:
output = response.json()
except json.decoder.JSONDecodeError:
- output = None
- return output
+ return None
+ if output and isinstance(output, list):
+ return output[0]
+ return None
- def finish_time_entry(self, workspace_id=None):
+ def get_in_progress(self, user_id=None, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- current = self.get_in_progress(workspace_id)
- if current is None:
- return
+ if user_id is None:
+ user_id = self.user_id
- current_id = current["id"]
- action_url = 'workspaces/{}/timeEntries/{}'.format(
- workspace_id, current_id
+ action_url = (
+ f"workspaces/{workspace_id}/user/"
+ f"{user_id}/time-entries?in-progress=1"
)
- body = {
- "start": current["timeInterval"]["start"],
- "billable": current["billable"],
- "description": current["description"],
- "projectId": current["projectId"],
- "taskId": current["taskId"],
- "tagIds": current["tagIds"],
- "end": self.get_current_time()
- }
- time_check(self)
- response = requests.put(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers,
- json=body
+ response = requests.get(
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
+ )
+ return self._get_current_timer_values(response)
+
+ def finish_time_entry(self, workspace_id=None, user_id=None):
+ if workspace_id is None:
+ workspace_id = self.workspace_id
+ if user_id is None:
+ user_id = self.user_id
+ current_timer = self.get_in_progress()
+ if not current_timer:
+ return
+ action_url = "workspaces/{}/user/{}/time-entries".format(
+ workspace_id, user_id
+ )
+ body = {"end": self.get_current_time()}
+ response = requests.patch(
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers, json=body
)
return response.json()
- def get_time_entries(
- self, workspace_id=None, quantity=10
- ):
+ def get_time_entries(self, workspace_id=None, user_id=None, quantity=10):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/timeEntries/'.format(workspace_id)
- time_check(self)
+ if user_id is None:
+ user_id = self.user_id
+ action_url = "workspaces/{}/user/{}/time-entries".format(
+ workspace_id, user_id
+ )
response = requests.get(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
return response.json()[:quantity]
- def remove_time_entry(self, tid, workspace_id=None):
+ def remove_time_entry(self, tid, workspace_id=None, user_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/timeEntries/{}'.format(
- workspace_id, tid
+ action_url = "workspaces/{}/user/{}/time-entries/{}".format(
+ workspace_id, user_id, tid
)
- time_check(self)
response = requests.delete(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers
)
return response.json()
def add_project(self, name, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/projects/'.format(workspace_id)
+ action_url = "workspaces/{}/projects".format(workspace_id)
body = {
"name": name,
"clientId": "",
"isPublic": "false",
- "estimate": {
- "estimate": 0,
- "type": "AUTO"
- },
+ "estimate": {"estimate": 0, "type": "AUTO"},
"color": "#f44336",
- "billable": "true"
+ "billable": "true",
}
- time_check(self)
response = requests.post(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers,
- json=body
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers, json=body
)
return response.json()
def add_workspace(self, name):
- action_url = 'workspaces/'
+ action_url = "workspaces/"
body = {"name": name}
- time_check(self)
response = requests.post(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers,
- json=body
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers, json=body
)
return response.json()
- def add_task(
- self, name, project_id, workspace_id=None
- ):
+ def add_task(self, name, project_id, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/projects/{}/tasks/'.format(
+ action_url = "workspaces/{}/projects/{}/tasks".format(
workspace_id, project_id
)
- body = {
- "name": name,
- "projectId": project_id
- }
- time_check(self)
+ body = {"name": name, "projectId": project_id}
response = requests.post(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers,
- json=body
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers, json=body
)
return response.json()
def add_tag(self, name, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = 'workspaces/{}/tags'.format(workspace_id)
- body = {
- "name": name
- }
- time_check(self)
+ action_url = "workspaces/{}/tags".format(workspace_id)
+ body = {"name": name}
response = requests.post(
- CLOCKIFY_ENDPOINT + action_url,
- headers=self.headers,
- json=body
+ CLOCKIFY_ENDPOINT + action_url, headers=self.headers, json=body
)
return response.json()
- def delete_project(
- self, project_id, workspace_id=None
- ):
+ def delete_project(self, project_id, workspace_id=None):
if workspace_id is None:
workspace_id = self.workspace_id
- action_url = '/workspaces/{}/projects/{}'.format(
+ action_url = "/workspaces/{}/projects/{}".format(
workspace_id, project_id
)
- time_check(self)
response = requests.delete(
CLOCKIFY_ENDPOINT + action_url,
headers=self.headers,
@@ -455,12 +416,12 @@ class ClockifyAPI:
return response.json()
def convert_input(
- self, entity_id, entity_name, mode='Workspace', project_id=None
+ self, entity_id, entity_name, mode="Workspace", project_id=None
):
if entity_id is None:
error = False
error_msg = 'Missing information "{}"'
- if mode.lower() == 'workspace':
+ if mode.lower() == "workspace":
if entity_id is None and entity_name is None:
if self.workspace_id is not None:
entity_id = self.workspace_id
@@ -471,14 +432,14 @@ class ClockifyAPI:
else:
if entity_id is None and entity_name is None:
error = True
- elif mode.lower() == 'project':
+ elif mode.lower() == "project":
entity_id = self.get_project_id(entity_name)
- elif mode.lower() == 'task':
+ elif mode.lower() == "task":
entity_id = self.get_task_id(
task_name=entity_name, project_id=project_id
)
else:
- raise TypeError('Unknown type')
+ raise TypeError("Unknown type")
# Raise error
if error:
raise ValueError(error_msg.format(mode))
diff --git a/openpype/modules/clockify/clockify_module.py b/openpype/modules/clockify/clockify_module.py
index 300d5576e2..200a268ad7 100644
--- a/openpype/modules/clockify/clockify_module.py
+++ b/openpype/modules/clockify/clockify_module.py
@@ -2,24 +2,13 @@ import os
import threading
import time
-from openpype.modules import (
- OpenPypeModule,
- ITrayModule,
- IPluginPaths
-)
+from openpype.modules import OpenPypeModule, ITrayModule, IPluginPaths
+from openpype.client import get_asset_by_name
-from .clockify_api import ClockifyAPI
-from .constants import (
- CLOCKIFY_FTRACK_USER_PATH,
- CLOCKIFY_FTRACK_SERVER_PATH
-)
+from .constants import CLOCKIFY_FTRACK_USER_PATH, CLOCKIFY_FTRACK_SERVER_PATH
-class ClockifyModule(
- OpenPypeModule,
- ITrayModule,
- IPluginPaths
-):
+class ClockifyModule(OpenPypeModule, ITrayModule, IPluginPaths):
name = "clockify"
def initialize(self, modules_settings):
@@ -33,18 +22,23 @@ class ClockifyModule(
self.timer_manager = None
self.MessageWidgetClass = None
self.message_widget = None
-
- self.clockapi = ClockifyAPI(master_parent=self)
+ self._clockify_api = None
# TimersManager attributes
# - set `timers_manager_connector` only in `tray_init`
self.timers_manager_connector = None
self._timers_manager_module = None
+ @property
+ def clockify_api(self):
+ if self._clockify_api is None:
+ from .clockify_api import ClockifyAPI
+
+ self._clockify_api = ClockifyAPI(master_parent=self)
+ return self._clockify_api
+
def get_global_environments(self):
- return {
- "CLOCKIFY_WORKSPACE": self.workspace_name
- }
+ return {"CLOCKIFY_WORKSPACE": self.workspace_name}
def tray_init(self):
from .widgets import ClockifySettings, MessageWidget
@@ -52,7 +46,7 @@ class ClockifyModule(
self.MessageWidgetClass = MessageWidget
self.message_widget = None
- self.widget_settings = ClockifySettings(self.clockapi)
+ self.widget_settings = ClockifySettings(self.clockify_api)
self.widget_settings_required = None
self.thread_timer_check = None
@@ -61,7 +55,7 @@ class ClockifyModule(
self.bool_api_key_set = False
self.bool_workspace_set = False
self.bool_timer_run = False
- self.bool_api_key_set = self.clockapi.set_api()
+ self.bool_api_key_set = self.clockify_api.set_api()
# Define itself as TimersManager connector
self.timers_manager_connector = self
@@ -71,12 +65,11 @@ class ClockifyModule(
self.show_settings()
return
- self.bool_workspace_set = self.clockapi.workspace_id is not None
+ self.bool_workspace_set = self.clockify_api.workspace_id is not None
if self.bool_workspace_set is False:
return
self.start_timer_check()
-
self.set_menu_visibility()
def tray_exit(self, *_a, **_kw):
@@ -85,23 +78,19 @@ class ClockifyModule(
def get_plugin_paths(self):
"""Implementaton of IPluginPaths to get plugin paths."""
actions_path = os.path.join(
- os.path.dirname(os.path.abspath(__file__)),
- "launcher_actions"
+ os.path.dirname(os.path.abspath(__file__)), "launcher_actions"
)
- return {
- "actions": [actions_path]
- }
+ return {"actions": [actions_path]}
def get_ftrack_event_handler_paths(self):
"""Function for Ftrack module to add ftrack event handler paths."""
return {
"user": [CLOCKIFY_FTRACK_USER_PATH],
- "server": [CLOCKIFY_FTRACK_SERVER_PATH]
+ "server": [CLOCKIFY_FTRACK_SERVER_PATH],
}
def clockify_timer_stopped(self):
self.bool_timer_run = False
- # Call `ITimersManager` method
self.timer_stopped()
def start_timer_check(self):
@@ -122,45 +111,44 @@ class ClockifyModule(
def check_running(self):
while self.bool_thread_check_running is True:
bool_timer_run = False
- if self.clockapi.get_in_progress() is not None:
+ if self.clockify_api.get_in_progress() is not None:
bool_timer_run = True
if self.bool_timer_run != bool_timer_run:
if self.bool_timer_run is True:
self.clockify_timer_stopped()
elif self.bool_timer_run is False:
- actual_timer = self.clockapi.get_in_progress()
- if not actual_timer:
+ current_timer = self.clockify_api.get_in_progress()
+ if current_timer is None:
+ continue
+ current_proj_id = current_timer.get("projectId")
+ if not current_proj_id:
continue
- actual_proj_id = actual_timer["projectId"]
- if not actual_proj_id:
- continue
-
- project = self.clockapi.get_project_by_id(actual_proj_id)
+ project = self.clockify_api.get_project_by_id(
+ current_proj_id
+ )
if project and project.get("code") == 501:
continue
- project_name = project["name"]
+ project_name = project.get("name")
- actual_timer_hierarchy = actual_timer["description"]
- hierarchy_items = actual_timer_hierarchy.split("/")
+ current_timer_hierarchy = current_timer.get("description")
+ if not current_timer_hierarchy:
+ continue
+ hierarchy_items = current_timer_hierarchy.split("/")
# Each pype timer must have at least 2 items!
if len(hierarchy_items) < 2:
continue
+
task_name = hierarchy_items[-1]
hierarchy = hierarchy_items[:-1]
- task_type = None
- if len(actual_timer.get("tags", [])) > 0:
- task_type = actual_timer["tags"][0].get("name")
data = {
"task_name": task_name,
"hierarchy": hierarchy,
"project_name": project_name,
- "task_type": task_type
}
- # Call `ITimersManager` method
self.timer_started(data)
self.bool_timer_run = bool_timer_run
@@ -184,6 +172,7 @@ class ClockifyModule(
def tray_menu(self, parent_menu):
# Menu for Tray App
from qtpy import QtWidgets
+
menu = QtWidgets.QMenu("Clockify", parent_menu)
menu.setProperty("submenu", "on")
@@ -204,7 +193,9 @@ class ClockifyModule(
parent_menu.addMenu(menu)
def show_settings(self):
- self.widget_settings.input_api_key.setText(self.clockapi.get_api_key())
+ self.widget_settings.input_api_key.setText(
+ self.clockify_api.get_api_key()
+ )
self.widget_settings.show()
def set_menu_visibility(self):
@@ -218,72 +209,82 @@ class ClockifyModule(
def timer_started(self, data):
"""Tell TimersManager that timer started."""
if self._timers_manager_module is not None:
- self._timers_manager_module.timer_started(self._module.id, data)
+ self._timers_manager_module.timer_started(self.id, data)
def timer_stopped(self):
"""Tell TimersManager that timer stopped."""
if self._timers_manager_module is not None:
- self._timers_manager_module.timer_stopped(self._module.id)
+ self._timers_manager_module.timer_stopped(self.id)
def stop_timer(self):
"""Called from TimersManager to stop timer."""
- self.clockapi.finish_time_entry()
+ self.clockify_api.finish_time_entry()
- def start_timer(self, input_data):
- """Called from TimersManager to start timer."""
- # If not api key is not entered then skip
- if not self.clockapi.get_api_key():
- return
-
- actual_timer = self.clockapi.get_in_progress()
- actual_timer_hierarchy = None
- actual_project_id = None
- if actual_timer is not None:
- actual_timer_hierarchy = actual_timer.get("description")
- actual_project_id = actual_timer.get("projectId")
-
- # Concatenate hierarchy and task to get description
- desc_items = [val for val in input_data.get("hierarchy", [])]
- desc_items.append(input_data["task_name"])
- description = "/".join(desc_items)
-
- # Check project existence
- project_name = input_data["project_name"]
- project_id = self.clockapi.get_project_id(project_name)
+ def _verify_project_exists(self, project_name):
+ project_id = self.clockify_api.get_project_id(project_name)
if not project_id:
- self.log.warning((
- "Project \"{}\" was not found in Clockify. Timer won't start."
- ).format(project_name))
+ self.log.warning(
+ 'Project "{}" was not found in Clockify. Timer won\'t start.'
+ ).format(project_name)
if not self.MessageWidgetClass:
return
msg = (
- "Project \"{}\" is not"
- " in Clockify Workspace \"{}\"."
+ 'Project "{}" is not'
+ ' in Clockify Workspace "{}".'
"
Please inform your Project Manager."
- ).format(project_name, str(self.clockapi.workspace_name))
+ ).format(project_name, str(self.clockify_api.workspace_name))
self.message_widget = self.MessageWidgetClass(
msg, "Clockify - Info Message"
)
self.message_widget.closed.connect(self.on_message_widget_close)
self.message_widget.show()
+ return False
+ return project_id
+ def start_timer(self, input_data):
+ """Called from TimersManager to start timer."""
+ # If not api key is not entered then skip
+ if not self.clockify_api.get_api_key():
return
- if (
- actual_timer is not None and
- description == actual_timer_hierarchy and
- project_id == actual_project_id
- ):
+ task_name = input_data.get("task_name")
+
+ # Concatenate hierarchy and task to get description
+ description_items = list(input_data.get("hierarchy", []))
+ description_items.append(task_name)
+ description = "/".join(description_items)
+
+ # Check project existence
+ project_name = input_data.get("project_name")
+ project_id = self._verify_project_exists(project_name)
+ if not project_id:
return
+ # Setup timer tags
tag_ids = []
- task_tag_id = self.clockapi.get_tag_id(input_data["task_type"])
+ tag_name = input_data.get("task_type")
+ if not tag_name:
+ # no task_type found in the input data
+ # if the timer is restarted by idle time (bug?)
+ asset_name = input_data["hierarchy"][-1]
+ asset_doc = get_asset_by_name(project_name, asset_name)
+ task_info = asset_doc["data"]["tasks"][task_name]
+ tag_name = task_info.get("type", "")
+ if not tag_name:
+ self.log.info("No tag information found for the timer")
+
+ task_tag_id = self.clockify_api.get_tag_id(tag_name)
if task_tag_id is not None:
tag_ids.append(task_tag_id)
- self.clockapi.start_time_entry(
- description, project_id, tag_ids=tag_ids
+ # Start timer
+ self.clockify_api.start_time_entry(
+ description,
+ project_id,
+ tag_ids=tag_ids,
+ workspace_id=self.clockify_api.workspace_id,
+ user_id=self.clockify_api.user_id,
)
diff --git a/openpype/modules/clockify/constants.py b/openpype/modules/clockify/constants.py
index 66f6cb899a..4574f91be1 100644
--- a/openpype/modules/clockify/constants.py
+++ b/openpype/modules/clockify/constants.py
@@ -9,4 +9,4 @@ CLOCKIFY_FTRACK_USER_PATH = os.path.join(
)
ADMIN_PERMISSION_NAMES = ["WORKSPACE_OWN", "WORKSPACE_ADMIN"]
-CLOCKIFY_ENDPOINT = "https://api.clockify.me/api/"
+CLOCKIFY_ENDPOINT = "https://api.clockify.me/api/v1/"
diff --git a/openpype/modules/clockify/ftrack/server/action_clockify_sync_server.py b/openpype/modules/clockify/ftrack/server/action_clockify_sync_server.py
index c6b55947da..985cf49b97 100644
--- a/openpype/modules/clockify/ftrack/server/action_clockify_sync_server.py
+++ b/openpype/modules/clockify/ftrack/server/action_clockify_sync_server.py
@@ -4,7 +4,7 @@ from openpype_modules.ftrack.lib import ServerAction
from openpype_modules.clockify.clockify_api import ClockifyAPI
-class SyncClocifyServer(ServerAction):
+class SyncClockifyServer(ServerAction):
'''Synchronise project names and task types.'''
identifier = "clockify.sync.server"
@@ -14,12 +14,12 @@ class SyncClocifyServer(ServerAction):
role_list = ["Pypeclub", "Administrator", "project Manager"]
def __init__(self, *args, **kwargs):
- super(SyncClocifyServer, self).__init__(*args, **kwargs)
+ super(SyncClockifyServer, self).__init__(*args, **kwargs)
workspace_name = os.environ.get("CLOCKIFY_WORKSPACE")
api_key = os.environ.get("CLOCKIFY_API_KEY")
- self.clockapi = ClockifyAPI(api_key)
- self.clockapi.set_workspace(workspace_name)
+ self.clockify_api = ClockifyAPI(api_key)
+ self.clockify_api.set_workspace(workspace_name)
if api_key is None:
modified_key = "None"
else:
@@ -48,13 +48,16 @@ class SyncClocifyServer(ServerAction):
return True
def launch(self, session, entities, event):
- if self.clockapi.workspace_id is None:
+ self.clockify_api.set_api()
+ if self.clockify_api.workspace_id is None:
return {
"success": False,
"message": "Clockify Workspace or API key are not set!"
}
- if self.clockapi.validate_workspace_perm() is False:
+ if not self.clockify_api.validate_workspace_permissions(
+ self.clockify_api.workspace_id, self.clockify_api.user_id
+ ):
return {
"success": False,
"message": "Missing permissions for this action!"
@@ -88,9 +91,9 @@ class SyncClocifyServer(ServerAction):
task_type["name"] for task_type in task_types
]
try:
- clockify_projects = self.clockapi.get_projects()
+ clockify_projects = self.clockify_api.get_projects()
if project_name not in clockify_projects:
- response = self.clockapi.add_project(project_name)
+ response = self.clockify_api.add_project(project_name)
if "id" not in response:
self.log.warning(
"Project \"{}\" can't be created. Response: {}".format(
@@ -105,7 +108,7 @@ class SyncClocifyServer(ServerAction):
).format(project_name)
}
- clockify_workspace_tags = self.clockapi.get_tags()
+ clockify_workspace_tags = self.clockify_api.get_tags()
for task_type_name in task_type_names:
if task_type_name in clockify_workspace_tags:
self.log.debug(
@@ -113,7 +116,7 @@ class SyncClocifyServer(ServerAction):
)
continue
- response = self.clockapi.add_tag(task_type_name)
+ response = self.clockify_api.add_tag(task_type_name)
if "id" not in response:
self.log.warning(
"Task \"{}\" can't be created. Response: {}".format(
@@ -138,4 +141,4 @@ class SyncClocifyServer(ServerAction):
def register(session, **kw):
- SyncClocifyServer(session).register()
+ SyncClockifyServer(session).register()
diff --git a/openpype/modules/clockify/ftrack/user/action_clockify_sync_local.py b/openpype/modules/clockify/ftrack/user/action_clockify_sync_local.py
index a430791906..0e8cf6bd37 100644
--- a/openpype/modules/clockify/ftrack/user/action_clockify_sync_local.py
+++ b/openpype/modules/clockify/ftrack/user/action_clockify_sync_local.py
@@ -3,7 +3,7 @@ from openpype_modules.ftrack.lib import BaseAction, statics_icon
from openpype_modules.clockify.clockify_api import ClockifyAPI
-class SyncClocifyLocal(BaseAction):
+class SyncClockifyLocal(BaseAction):
'''Synchronise project names and task types.'''
#: Action identifier.
@@ -18,9 +18,9 @@ class SyncClocifyLocal(BaseAction):
icon = statics_icon("app_icons", "clockify-white.png")
def __init__(self, *args, **kwargs):
- super(SyncClocifyLocal, self).__init__(*args, **kwargs)
+ super(SyncClockifyLocal, self).__init__(*args, **kwargs)
#: CLockifyApi
- self.clockapi = ClockifyAPI()
+ self.clockify_api = ClockifyAPI()
def discover(self, session, entities, event):
if (
@@ -31,14 +31,18 @@ class SyncClocifyLocal(BaseAction):
return False
def launch(self, session, entities, event):
- self.clockapi.set_api()
- if self.clockapi.workspace_id is None:
+ self.clockify_api.set_api()
+ if self.clockify_api.workspace_id is None:
return {
"success": False,
"message": "Clockify Workspace or API key are not set!"
}
- if self.clockapi.validate_workspace_perm() is False:
+ if (
+ self.clockify_api.validate_workspace_permissions(
+ self.clockify_api.workspace_id, self.clockify_api.user_id)
+ is False
+ ):
return {
"success": False,
"message": "Missing permissions for this action!"
@@ -74,9 +78,9 @@ class SyncClocifyLocal(BaseAction):
task_type["name"] for task_type in task_types
]
try:
- clockify_projects = self.clockapi.get_projects()
+ clockify_projects = self.clockify_api.get_projects()
if project_name not in clockify_projects:
- response = self.clockapi.add_project(project_name)
+ response = self.clockify_api.add_project(project_name)
if "id" not in response:
self.log.warning(
"Project \"{}\" can't be created. Response: {}".format(
@@ -91,7 +95,7 @@ class SyncClocifyLocal(BaseAction):
).format(project_name)
}
- clockify_workspace_tags = self.clockapi.get_tags()
+ clockify_workspace_tags = self.clockify_api.get_tags()
for task_type_name in task_type_names:
if task_type_name in clockify_workspace_tags:
self.log.debug(
@@ -99,7 +103,7 @@ class SyncClocifyLocal(BaseAction):
)
continue
- response = self.clockapi.add_tag(task_type_name)
+ response = self.clockify_api.add_tag(task_type_name)
if "id" not in response:
self.log.warning(
"Task \"{}\" can't be created. Response: {}".format(
@@ -121,4 +125,4 @@ class SyncClocifyLocal(BaseAction):
def register(session, **kw):
- SyncClocifyLocal(session).register()
+ SyncClockifyLocal(session).register()
diff --git a/openpype/modules/clockify/launcher_actions/ClockifyStart.py b/openpype/modules/clockify/launcher_actions/ClockifyStart.py
index 7663aecc31..4a653c1b8d 100644
--- a/openpype/modules/clockify/launcher_actions/ClockifyStart.py
+++ b/openpype/modules/clockify/launcher_actions/ClockifyStart.py
@@ -6,9 +6,9 @@ from openpype_modules.clockify.clockify_api import ClockifyAPI
class ClockifyStart(LauncherAction):
name = "clockify_start_timer"
label = "Clockify - Start Timer"
- icon = "clockify_icon"
+ icon = "app_icons/clockify.png"
order = 500
- clockapi = ClockifyAPI()
+ clockify_api = ClockifyAPI()
def is_compatible(self, session):
"""Return whether the action is compatible with the session"""
@@ -17,23 +17,39 @@ class ClockifyStart(LauncherAction):
return False
def process(self, session, **kwargs):
+ self.clockify_api.set_api()
+ user_id = self.clockify_api.user_id
+ workspace_id = self.clockify_api.workspace_id
project_name = session["AVALON_PROJECT"]
asset_name = session["AVALON_ASSET"]
task_name = session["AVALON_TASK"]
-
description = asset_name
- asset_doc = get_asset_by_name(
- project_name, asset_name, fields=["data.parents"]
- )
- if asset_doc is not None:
- desc_items = asset_doc.get("data", {}).get("parents", [])
- desc_items.append(asset_name)
- desc_items.append(task_name)
- description = "/".join(desc_items)
- project_id = self.clockapi.get_project_id(project_name)
- tag_ids = []
- tag_ids.append(self.clockapi.get_tag_id(task_name))
- self.clockapi.start_time_entry(
- description, project_id, tag_ids=tag_ids
+ # fetch asset docs
+ asset_doc = get_asset_by_name(project_name, asset_name)
+
+ # get task type to fill the timer tag
+ task_info = asset_doc["data"]["tasks"][task_name]
+ task_type = task_info["type"]
+
+ # check if the task has hierarchy and fill the
+ parents_data = asset_doc["data"]
+ if parents_data is not None:
+ description_items = parents_data.get("parents", [])
+ description_items.append(asset_name)
+ description_items.append(task_name)
+ description = "/".join(description_items)
+
+ project_id = self.clockify_api.get_project_id(
+ project_name, workspace_id
+ )
+ tag_ids = []
+ tag_name = task_type
+ tag_ids.append(self.clockify_api.get_tag_id(tag_name, workspace_id))
+ self.clockify_api.start_time_entry(
+ description,
+ project_id,
+ tag_ids=tag_ids,
+ workspace_id=workspace_id,
+ user_id=user_id,
)
diff --git a/openpype/modules/clockify/launcher_actions/ClockifySync.py b/openpype/modules/clockify/launcher_actions/ClockifySync.py
index c346a1b4f6..cbd2519a04 100644
--- a/openpype/modules/clockify/launcher_actions/ClockifySync.py
+++ b/openpype/modules/clockify/launcher_actions/ClockifySync.py
@@ -3,20 +3,39 @@ from openpype_modules.clockify.clockify_api import ClockifyAPI
from openpype.pipeline import LauncherAction
-class ClockifySync(LauncherAction):
+class ClockifyPermissionsCheckFailed(Exception):
+ """Timer start failed due to user permissions check.
+ Message should be self explanatory as traceback won't be shown.
+ """
+ pass
+
+
+class ClockifySync(LauncherAction):
name = "sync_to_clockify"
label = "Sync to Clockify"
- icon = "clockify_white_icon"
+ icon = "app_icons/clockify-white.png"
order = 500
- clockapi = ClockifyAPI()
- have_permissions = clockapi.validate_workspace_perm()
+ clockify_api = ClockifyAPI()
def is_compatible(self, session):
- """Return whether the action is compatible with the session"""
- return self.have_permissions
+ """Check if there's some projects to sync"""
+ try:
+ next(get_projects())
+ return True
+ except StopIteration:
+ return False
def process(self, session, **kwargs):
+ self.clockify_api.set_api()
+ workspace_id = self.clockify_api.workspace_id
+ user_id = self.clockify_api.user_id
+ if not self.clockify_api.validate_workspace_permissions(
+ workspace_id, user_id
+ ):
+ raise ClockifyPermissionsCheckFailed(
+ "Current CLockify user is missing permissions for this action!"
+ )
project_name = session.get("AVALON_PROJECT") or ""
projects_to_sync = []
@@ -30,24 +49,28 @@ class ClockifySync(LauncherAction):
task_types = project["config"]["tasks"].keys()
projects_info[project["name"]] = task_types
- clockify_projects = self.clockapi.get_projects()
+ clockify_projects = self.clockify_api.get_projects(workspace_id)
for project_name, task_types in projects_info.items():
if project_name in clockify_projects:
continue
- response = self.clockapi.add_project(project_name)
+ response = self.clockify_api.add_project(
+ project_name, workspace_id
+ )
if "id" not in response:
- self.log.error("Project {} can't be created".format(
- project_name
- ))
+ self.log.error(
+ "Project {} can't be created".format(project_name)
+ )
continue
- clockify_workspace_tags = self.clockapi.get_tags()
+ clockify_workspace_tags = self.clockify_api.get_tags(workspace_id)
for task_type in task_types:
if task_type not in clockify_workspace_tags:
- response = self.clockapi.add_tag(task_type)
+ response = self.clockify_api.add_tag(
+ task_type, workspace_id
+ )
if "id" not in response:
- self.log.error('Task {} can\'t be created'.format(
- task_type
- ))
+ self.log.error(
+ "Task {} can't be created".format(task_type)
+ )
continue
diff --git a/openpype/modules/clockify/widgets.py b/openpype/modules/clockify/widgets.py
index 122b6212c0..8c28f38b6e 100644
--- a/openpype/modules/clockify/widgets.py
+++ b/openpype/modules/clockify/widgets.py
@@ -77,15 +77,15 @@ class MessageWidget(QtWidgets.QWidget):
class ClockifySettings(QtWidgets.QWidget):
- SIZE_W = 300
+ SIZE_W = 500
SIZE_H = 130
loginSignal = QtCore.Signal(object, object, object)
- def __init__(self, clockapi, optional=True):
+ def __init__(self, clockify_api, optional=True):
super(ClockifySettings, self).__init__()
- self.clockapi = clockapi
+ self.clockify_api = clockify_api
self.optional = optional
self.validated = False
@@ -162,17 +162,17 @@ class ClockifySettings(QtWidgets.QWidget):
def click_ok(self):
api_key = self.input_api_key.text().strip()
if self.optional is True and api_key == '':
- self.clockapi.save_api_key(None)
- self.clockapi.set_api(api_key)
+ self.clockify_api.save_api_key(None)
+ self.clockify_api.set_api(api_key)
self.validated = False
self._close_widget()
return
- validation = self.clockapi.validate_api_key(api_key)
+ validation = self.clockify_api.validate_api_key(api_key)
if validation:
- self.clockapi.save_api_key(api_key)
- self.clockapi.set_api(api_key)
+ self.clockify_api.save_api_key(api_key)
+ self.clockify_api.set_api(api_key)
self.validated = True
self._close_widget()
else:
diff --git a/openpype/modules/deadline/plugins/publish/collect_pools.py b/openpype/modules/deadline/plugins/publish/collect_pools.py
index 48130848d5..e221eb00ea 100644
--- a/openpype/modules/deadline/plugins/publish/collect_pools.py
+++ b/openpype/modules/deadline/plugins/publish/collect_pools.py
@@ -3,21 +3,60 @@
"""
import pyblish.api
+from openpype.lib import TextDef
+from openpype.pipeline.publish import OpenPypePyblishPluginMixin
-class CollectDeadlinePools(pyblish.api.InstancePlugin):
+class CollectDeadlinePools(pyblish.api.InstancePlugin,
+ OpenPypePyblishPluginMixin):
"""Collect pools from instance if present, from Setting otherwise."""
order = pyblish.api.CollectorOrder + 0.420
label = "Collect Deadline Pools"
- families = ["rendering", "render.farm", "renderFarm", "renderlayer"]
+ families = ["rendering",
+ "render.farm",
+ "renderFarm",
+ "renderlayer",
+ "maxrender"]
primary_pool = None
secondary_pool = None
+ @classmethod
+ def apply_settings(cls, project_settings, system_settings):
+ # deadline.publish.CollectDeadlinePools
+ settings = project_settings["deadline"]["publish"]["CollectDeadlinePools"] # noqa
+ cls.primary_pool = settings.get("primary_pool", None)
+ cls.secondary_pool = settings.get("secondary_pool", None)
+
def process(self, instance):
+
+ attr_values = self.get_attr_values_from_data(instance.data)
if not instance.data.get("primaryPool"):
- instance.data["primaryPool"] = self.primary_pool or "none"
+ instance.data["primaryPool"] = (
+ attr_values.get("primaryPool") or self.primary_pool or "none"
+ )
if not instance.data.get("secondaryPool"):
- instance.data["secondaryPool"] = self.secondary_pool or "none"
+ instance.data["secondaryPool"] = (
+ attr_values.get("secondaryPool") or self.secondary_pool or "none" # noqa
+ )
+
+ @classmethod
+ def get_attribute_defs(cls):
+ # TODO: Preferably this would be an enum for the user
+ # but the Deadline server URL can be dynamic and
+ # can be set per render instance. Since get_attribute_defs
+ # can't be dynamic unfortunately EnumDef isn't possible (yet?)
+ # pool_names = self.deadline_module.get_deadline_pools(deadline_url,
+ # self.log)
+ # secondary_pool_names = ["-"] + pool_names
+
+ return [
+ TextDef("primaryPool",
+ label="Primary Pool",
+ default=cls.primary_pool),
+ TextDef("secondaryPool",
+ label="Secondary Pool",
+ default=cls.secondary_pool)
+ ]
diff --git a/openpype/modules/deadline/plugins/publish/submit_celaction_deadline.py b/openpype/modules/deadline/plugins/publish/submit_celaction_deadline.py
index 038ee4fc03..bcf0850768 100644
--- a/openpype/modules/deadline/plugins/publish/submit_celaction_deadline.py
+++ b/openpype/modules/deadline/plugins/publish/submit_celaction_deadline.py
@@ -106,7 +106,7 @@ class CelactionSubmitDeadline(pyblish.api.InstancePlugin):
# define chunk and priority
chunk_size = instance.context.data.get("chunk")
- if chunk_size == 0:
+ if not chunk_size:
chunk_size = self.deadline_chunk_size
# search for %02d pattern in name, and padding number
diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py
index 417a03de74..c728b6b9c7 100644
--- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py
+++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py
@@ -3,7 +3,15 @@ import getpass
import copy
import attr
-from openpype.pipeline import legacy_io
+from openpype.lib import (
+ TextDef,
+ BoolDef,
+ NumberDef,
+)
+from openpype.pipeline import (
+ legacy_io,
+ OpenPypePyblishPluginMixin
+)
from openpype.settings import get_project_settings
from openpype.hosts.max.api.lib import (
get_current_renderer,
@@ -22,7 +30,8 @@ class MaxPluginInfo(object):
IgnoreInputs = attr.ib(default=True)
-class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
+class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline,
+ OpenPypePyblishPluginMixin):
label = "Submit Render to Deadline"
hosts = ["max"]
@@ -31,14 +40,22 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
use_published = True
priority = 50
- tile_priority = 50
chunk_size = 1
jobInfo = {}
pluginInfo = {}
group = None
- deadline_pool = None
- deadline_pool_secondary = None
- framePerTask = 1
+
+ @classmethod
+ def apply_settings(cls, project_settings, system_settings):
+ settings = project_settings["deadline"]["publish"]["MaxSubmitDeadline"] # noqa
+
+ # Take some defaults from settings
+ cls.use_published = settings.get("use_published",
+ cls.use_published)
+ cls.priority = settings.get("priority",
+ cls.priority)
+ cls.chuck_size = settings.get("chunk_size", cls.chunk_size)
+ cls.group = settings.get("group", cls.group)
def get_job_info(self):
job_info = DeadlineJobInfo(Plugin="3dsmax")
@@ -49,11 +66,11 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
instance = self._instance
context = instance.context
-
# Always use the original work file name for the Job name even when
# rendering is done from the published Work File. The original work
# file name is clearer because it can also have subversion strings,
# etc. which are stripped for the published file.
+
src_filepath = context.data["currentFile"]
src_filename = os.path.basename(src_filepath)
@@ -71,13 +88,13 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
job_info.Pool = instance.data.get("primaryPool")
job_info.SecondaryPool = instance.data.get("secondaryPool")
- job_info.ChunkSize = instance.data.get("chunkSize", 1)
- job_info.Comment = context.data.get("comment")
- job_info.Priority = instance.data.get("priority", self.priority)
- job_info.FramesPerTask = instance.data.get("framesPerTask", 1)
- if self.group:
- job_info.Group = self.group
+ attr_values = self.get_attr_values_from_data(instance.data)
+
+ job_info.ChunkSize = attr_values.get("chunkSize", 1)
+ job_info.Comment = context.data.get("comment")
+ job_info.Priority = attr_values.get("priority", self.priority)
+ job_info.Group = attr_values.get("group", self.group)
# Add options from RenderGlobals
render_globals = instance.data.get("renderGlobals", {})
@@ -216,3 +233,32 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
plugin_info.update(plugin_data)
return job_info, plugin_info
+
+ @classmethod
+ def get_attribute_defs(cls):
+ defs = super(MaxSubmitDeadline, cls).get_attribute_defs()
+ defs.extend([
+ BoolDef("use_published",
+ default=cls.use_published,
+ label="Use Published Scene"),
+
+ NumberDef("priority",
+ minimum=1,
+ maximum=250,
+ decimals=0,
+ default=cls.priority,
+ label="Priority"),
+
+ NumberDef("chunkSize",
+ minimum=1,
+ maximum=50,
+ decimals=0,
+ default=cls.chunk_size,
+ label="Frame Per Task"),
+
+ TextDef("group",
+ default=cls.group,
+ label="Group Name"),
+ ])
+
+ return defs
diff --git a/openpype/modules/deadline/plugins/publish/submit_maya_deadline.py b/openpype/modules/deadline/plugins/publish/submit_maya_deadline.py
index 15025e47f2..062732c059 100644
--- a/openpype/modules/deadline/plugins/publish/submit_maya_deadline.py
+++ b/openpype/modules/deadline/plugins/publish/submit_maya_deadline.py
@@ -422,6 +422,7 @@ class MayaSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
assembly_job_info.Priority = instance.data.get(
"tile_priority", self.tile_priority
)
+ assembly_job_info.TileJob = False
pool = instance.context.data["project_settings"]["deadline"]
pool = pool["publish"]["ProcessSubmittedJobOnFarm"]["deadline_pool"]
@@ -450,15 +451,14 @@ class MayaSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
frame_assembly_job_info.ExtraInfo[0] = file_hash
frame_assembly_job_info.ExtraInfo[1] = file
frame_assembly_job_info.JobDependencies = tile_job_id
+ frame_assembly_job_info.Frames = frame
# write assembly job config files
- now = datetime.now()
-
config_file = os.path.join(
output_dir,
"{}_config_{}.txt".format(
os.path.splitext(file)[0],
- now.strftime("%Y_%m_%d_%H_%M_%S")
+ datetime.now().strftime("%Y_%m_%d_%H_%M_%S")
)
)
try:
@@ -469,6 +469,8 @@ class MayaSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
self.log.warning("Path is unreachable: "
"`{}`".format(output_dir))
+ assembly_plugin_info["ConfigFile"] = config_file
+
with open(config_file, "w") as cf:
print("TileCount={}".format(tiles_count), file=cf)
print("ImageFileName={}".format(file), file=cf)
@@ -477,25 +479,30 @@ class MayaSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
print("ImageHeight={}".format(
instance.data.get("resolutionHeight")), file=cf)
+ with open(config_file, "a") as cf:
+ # Need to reverse the order of the y tiles, because image
+ # coordinates are calculated from bottom left corner.
tiles = _format_tiles(
file, 0,
instance.data.get("tilesX"),
instance.data.get("tilesY"),
instance.data.get("resolutionWidth"),
instance.data.get("resolutionHeight"),
- payload_plugin_info["OutputFilePrefix"]
+ payload_plugin_info["OutputFilePrefix"],
+ reversed_y=True
)[1]
for k, v in sorted(tiles.items()):
print("{}={}".format(k, v), file=cf)
- payload = self.assemble_payload(
- job_info=frame_assembly_job_info,
- plugin_info=assembly_plugin_info.copy(),
- # todo: aux file transfers don't work with deadline webservice
- # add config file as job auxFile
- # aux_files=[config_file]
+ assembly_payloads.append(
+ self.assemble_payload(
+ job_info=frame_assembly_job_info,
+ plugin_info=assembly_plugin_info.copy(),
+ # This would fail if the client machine and webserice are
+ # using different storage paths.
+ aux_files=[config_file]
+ )
)
- assembly_payloads.append(payload)
# Submit assembly jobs
assembly_job_ids = []
@@ -505,6 +512,7 @@ class MayaSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
"submitting assembly job {} of {}".format(i + 1,
num_assemblies)
)
+ self.log.info(payload)
assembly_job_id = self.submit(payload)
assembly_job_ids.append(assembly_job_id)
@@ -764,8 +772,15 @@ class MayaSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline):
def _format_tiles(
- filename, index, tiles_x, tiles_y,
- width, height, prefix):
+ filename,
+ index,
+ tiles_x,
+ tiles_y,
+ width,
+ height,
+ prefix,
+ reversed_y=False
+):
"""Generate tile entries for Deadline tile job.
Returns two dictionaries - one that can be directly used in Deadline
@@ -802,6 +817,7 @@ def _format_tiles(
width (int): Width resolution of final image.
height (int): Height resolution of final image.
prefix (str): Image prefix.
+ reversed_y (bool): Reverses the order of the y tiles.
Returns:
(dict, dict): Tuple of two dictionaries - first can be used to
@@ -824,12 +840,16 @@ def _format_tiles(
cfg["TilesCropped"] = "False"
tile = 0
+ range_y = range(1, tiles_y + 1)
+ reversed_y_range = list(reversed(range_y))
for tile_x in range(1, tiles_x + 1):
- for tile_y in reversed(range(1, tiles_y + 1)):
+ for i, tile_y in enumerate(range_y):
+ tile_y_index = tile_y
+ if reversed_y:
+ tile_y_index = reversed_y_range[i]
+
tile_prefix = "_tile_{}x{}_{}x{}_".format(
- tile_x, tile_y,
- tiles_x,
- tiles_y
+ tile_x, tile_y_index, tiles_x, tiles_y
)
new_filename = "{}/{}{}".format(
@@ -844,11 +864,14 @@ def _format_tiles(
right = (tile_x * w_space) - 1
# Job info
- out["JobInfo"]["OutputFilename{}Tile{}".format(index, tile)] = new_filename # noqa: E501
+ key = "OutputFilename{}".format(index)
+ out["JobInfo"][key] = new_filename
# Plugin Info
- out["PluginInfo"]["RegionPrefix{}".format(str(tile))] = \
- "/{}".format(tile_prefix).join(prefix.rsplit("/", 1))
+ key = "RegionPrefix{}".format(str(tile))
+ out["PluginInfo"][key] = "/{}".format(
+ tile_prefix
+ ).join(prefix.rsplit("/", 1))
out["PluginInfo"]["RegionTop{}".format(tile)] = top
out["PluginInfo"]["RegionBottom{}".format(tile)] = bottom
out["PluginInfo"]["RegionLeft{}".format(tile)] = left
diff --git a/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py
index aff34c7e4a..cc069cf51a 100644
--- a/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py
+++ b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py
@@ -32,7 +32,7 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin,
label = "Submit Nuke to Deadline"
order = pyblish.api.IntegratorOrder + 0.1
hosts = ["nuke"]
- families = ["render", "prerender.farm"]
+ families = ["render", "prerender"]
optional = True
targets = ["local"]
@@ -80,6 +80,10 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin,
]
def process(self, instance):
+ if not instance.data.get("farm"):
+ self.log.info("Skipping local instance.")
+ return
+
instance.data["attributeValues"] = self.get_attr_values_from_data(
instance.data)
@@ -168,10 +172,10 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin,
resp.json()["_id"])
# redefinition of families
- if "render.farm" in families:
+ if "render" in instance.data["family"]:
instance.data['family'] = 'write'
families.insert(0, "render2d")
- elif "prerender.farm" in families:
+ elif "prerender" in instance.data["family"]:
instance.data['family'] = 'write'
families.insert(0, "prerender")
instance.data["families"] = families
diff --git a/openpype/modules/deadline/plugins/publish/submit_publish_job.py b/openpype/modules/deadline/plugins/publish/submit_publish_job.py
index 53c09ad22f..0d0698c21f 100644
--- a/openpype/modules/deadline/plugins/publish/submit_publish_job.py
+++ b/openpype/modules/deadline/plugins/publish/submit_publish_job.py
@@ -756,6 +756,10 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin):
instance (pyblish.api.Instance): Instance data.
"""
+ if not instance.data.get("farm"):
+ self.log.info("Skipping local instance.")
+ return
+
data = instance.data.copy()
context = instance.context
self.context = context
diff --git a/openpype/modules/deadline/plugins/publish/validate_deadline_pools.py b/openpype/modules/deadline/plugins/publish/validate_deadline_pools.py
index 78eed17c98..7c8ab62d4d 100644
--- a/openpype/modules/deadline/plugins/publish/validate_deadline_pools.py
+++ b/openpype/modules/deadline/plugins/publish/validate_deadline_pools.py
@@ -17,10 +17,18 @@ class ValidateDeadlinePools(OptionalPyblishPluginMixin,
label = "Validate Deadline Pools"
order = pyblish.api.ValidatorOrder
- families = ["rendering", "render.farm", "renderFarm", "renderlayer"]
+ families = ["rendering",
+ "render.farm",
+ "renderFarm",
+ "renderlayer",
+ "maxrender"]
optional = True
def process(self, instance):
+ if not instance.data.get("farm"):
+ self.log.info("Skipping local instance.")
+ return
+
# get default deadline webservice url from deadline module
deadline_url = instance.context.data["defaultDeadline"]
self.log.info("deadline_url::{}".format(deadline_url))
diff --git a/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py b/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py
index f34f71d213..ff4be677e7 100644
--- a/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py
+++ b/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py
@@ -68,8 +68,15 @@ class ValidateExpectedFiles(pyblish.api.InstancePlugin):
# files to be in the folder that we might not want to use.
missing = expected_files - existing_files
if missing:
- raise RuntimeError("Missing expected files: {}".format(
- sorted(missing)))
+ raise RuntimeError(
+ "Missing expected files: {}\n"
+ "Expected files: {}\n"
+ "Existing files: {}".format(
+ sorted(missing),
+ sorted(expected_files),
+ sorted(existing_files)
+ )
+ )
def _get_frame_list(self, original_job_id):
"""Returns list of frame ranges from all render job.
diff --git a/openpype/modules/deadline/repository/custom/plugins/GlobalJobPreLoad.py b/openpype/modules/deadline/repository/custom/plugins/GlobalJobPreLoad.py
index 20a58c9131..15226bb773 100644
--- a/openpype/modules/deadline/repository/custom/plugins/GlobalJobPreLoad.py
+++ b/openpype/modules/deadline/repository/custom/plugins/GlobalJobPreLoad.py
@@ -362,11 +362,11 @@ def inject_openpype_environment(deadlinePlugin):
args_str = subprocess.list2cmdline(args)
print(">>> Executing: {} {}".format(exe, args_str))
- process = ProcessUtils.SpawnProcess(
- exe, args_str, os.path.dirname(exe)
+ process_exitcode = deadlinePlugin.RunProcess(
+ exe, args_str, os.path.dirname(exe), -1
)
- ProcessUtils.WaitForExit(process, -1)
- if process.ExitCode != 0:
+
+ if process_exitcode != 0:
raise RuntimeError(
"Failed to run OpenPype process to extract environments."
)
diff --git a/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py b/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py
index 861f16518c..b51daffbc8 100644
--- a/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py
+++ b/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py
@@ -16,6 +16,10 @@ from Deadline.Scripting import (
FileUtils, RepositoryUtils, SystemUtils)
+version_major = 1
+version_minor = 0
+version_patch = 0
+version_string = "{}.{}.{}".format(version_major, version_minor, version_patch)
STRING_TAGS = {
"format"
}
@@ -264,6 +268,7 @@ class OpenPypeTileAssembler(DeadlinePlugin):
def initialize_process(self):
"""Initialization."""
+ self.LogInfo("Plugin version: {}".format(version_string))
self.SingleFramesOnly = True
self.StdoutHandling = True
self.renderer = self.GetPluginInfoEntryWithDefault(
@@ -320,12 +325,7 @@ class OpenPypeTileAssembler(DeadlinePlugin):
output_file = data["ImageFileName"]
output_file = RepositoryUtils.CheckPathMapping(output_file)
output_file = self.process_path(output_file)
- """
- _, ext = os.path.splitext(output_file)
- if "exr" not in ext:
- self.FailRender(
- "[{}] Only EXR format is supported for now.".format(ext))
- """
+
tile_info = []
for tile in range(int(data["TileCount"])):
tile_info.append({
@@ -336,11 +336,6 @@ class OpenPypeTileAssembler(DeadlinePlugin):
"width": int(data["Tile{}Width".format(tile)])
})
- # FFMpeg doesn't support tile coordinates at the moment.
- # arguments = self.tile_completer_ffmpeg_args(
- # int(data["ImageWidth"]), int(data["ImageHeight"]),
- # tile_info, output_file)
-
arguments = self.tile_oiio_args(
int(data["ImageWidth"]), int(data["ImageHeight"]),
tile_info, output_file)
@@ -362,20 +357,20 @@ class OpenPypeTileAssembler(DeadlinePlugin):
def pre_render_tasks(self):
"""Load config file and do remapping."""
self.LogInfo("OpenPype Tile Assembler starting...")
- scene_filename = self.GetDataFilename()
+ config_file = self.GetPluginInfoEntry("ConfigFile")
temp_scene_directory = self.CreateTempDirectory(
"thread" + str(self.GetThreadNumber()))
- temp_scene_filename = Path.GetFileName(scene_filename)
+ temp_scene_filename = Path.GetFileName(config_file)
self.config_file = Path.Combine(
temp_scene_directory, temp_scene_filename)
if SystemUtils.IsRunningOnWindows():
RepositoryUtils.CheckPathMappingInFileAndReplaceSeparator(
- scene_filename, self.config_file, "/", "\\")
+ config_file, self.config_file, "/", "\\")
else:
RepositoryUtils.CheckPathMappingInFileAndReplaceSeparator(
- scene_filename, self.config_file, "\\", "/")
+ config_file, self.config_file, "\\", "/")
os.chmod(self.config_file, os.stat(self.config_file).st_mode)
def post_render_tasks(self):
@@ -459,75 +454,3 @@ class OpenPypeTileAssembler(DeadlinePlugin):
args.append(output_path)
return args
-
- def tile_completer_ffmpeg_args(
- self, output_width, output_height, tiles_info, output_path):
- """Generate ffmpeg arguments for tile assembly.
-
- Expected inputs are tiled images.
-
- Args:
- output_width (int): Width of output image.
- output_height (int): Height of output image.
- tiles_info (list): List of tile items, each item must be
- dictionary with `filepath`, `pos_x` and `pos_y` keys
- representing path to file and x, y coordinates on output
- image where top-left point of tile item should start.
- output_path (str): Path to file where should be output stored.
-
- Returns:
- (list): ffmpeg arguments.
-
- """
- previous_name = "base"
- ffmpeg_args = []
- filter_complex_strs = []
-
- filter_complex_strs.append("nullsrc=size={}x{}[{}]".format(
- output_width, output_height, previous_name
- ))
-
- new_tiles_info = {}
- for idx, tile_info in enumerate(tiles_info):
- # Add input and store input index
- filepath = tile_info["filepath"]
- ffmpeg_args.append("-i \"{}\"".format(filepath.replace("\\", "/")))
-
- # Prepare initial filter complex arguments
- index_name = "input{}".format(idx)
- filter_complex_strs.append(
- "[{}]setpts=PTS-STARTPTS[{}]".format(idx, index_name)
- )
- tile_info["index"] = idx
- new_tiles_info[index_name] = tile_info
-
- # Set frames to 1
- ffmpeg_args.append("-frames 1")
-
- # Concatenation filter complex arguments
- global_index = 1
- total_index = len(new_tiles_info)
- for index_name, tile_info in new_tiles_info.items():
- item_str = (
- "[{previous_name}][{index_name}]overlay={pos_x}:{pos_y}"
- ).format(
- previous_name=previous_name,
- index_name=index_name,
- pos_x=tile_info["pos_x"],
- pos_y=tile_info["pos_y"]
- )
- new_previous = "tmp{}".format(global_index)
- if global_index != total_index:
- item_str += "[{}]".format(new_previous)
- filter_complex_strs.append(item_str)
- previous_name = new_previous
- global_index += 1
-
- joined_parts = ";".join(filter_complex_strs)
- filter_complex_str = "-filter_complex \"{}\"".format(joined_parts)
-
- ffmpeg_args.append(filter_complex_str)
- ffmpeg_args.append("-y")
- ffmpeg_args.append("\"{}\"".format(output_path))
-
- return ffmpeg_args
diff --git a/openpype/modules/example_addons/example_addon/addon.py b/openpype/modules/example_addons/example_addon/addon.py
index ead647b41d..be1d3ff920 100644
--- a/openpype/modules/example_addons/example_addon/addon.py
+++ b/openpype/modules/example_addons/example_addon/addon.py
@@ -44,7 +44,7 @@ class AddonSettingsDef(JsonFilesSettingsDef):
class ExampleAddon(OpenPypeAddOn, IPluginPaths, ITrayAction):
- """This Addon has defined it's settings and interface.
+ """This Addon has defined its settings and interface.
This example has system settings with an enabled option. And use
few other interfaces:
diff --git a/openpype/modules/ftrack/event_handlers_server/action_push_frame_values_to_task.py b/openpype/modules/ftrack/event_handlers_server/action_push_frame_values_to_task.py
index 1209375f82..a698195c59 100644
--- a/openpype/modules/ftrack/event_handlers_server/action_push_frame_values_to_task.py
+++ b/openpype/modules/ftrack/event_handlers_server/action_push_frame_values_to_task.py
@@ -9,7 +9,7 @@ from openpype_modules.ftrack.lib import (
class PushHierValuesToNonHier(ServerAction):
- """Action push hierarchical custom attribute values to non hierarchical.
+ """Action push hierarchical custom attribute values to non-hierarchical.
Hierarchical value is also pushed to their task entities.
@@ -119,17 +119,109 @@ class PushHierValuesToNonHier(ServerAction):
self.join_query_keys(object_ids)
)).all()
- output = {}
+ attrs_by_obj_id = collections.defaultdict(list)
hiearchical = []
for attr in attrs:
if attr["is_hierarchical"]:
hiearchical.append(attr)
continue
obj_id = attr["object_type_id"]
- if obj_id not in output:
- output[obj_id] = []
- output[obj_id].append(attr)
- return output, hiearchical
+ attrs_by_obj_id[obj_id].append(attr)
+ return attrs_by_obj_id, hiearchical
+
+ def query_attr_value(
+ self,
+ session,
+ hier_attrs,
+ attrs_by_obj_id,
+ dst_object_type_ids,
+ task_entity_ids,
+ non_task_entity_ids,
+ parent_id_by_entity_id
+ ):
+ all_non_task_ids_with_parents = set()
+ for entity_id in non_task_entity_ids:
+ all_non_task_ids_with_parents.add(entity_id)
+ _entity_id = entity_id
+ while True:
+ parent_id = parent_id_by_entity_id.get(_entity_id)
+ if (
+ parent_id is None
+ or parent_id in all_non_task_ids_with_parents
+ ):
+ break
+ all_non_task_ids_with_parents.add(parent_id)
+ _entity_id = parent_id
+
+ all_entity_ids = (
+ set(all_non_task_ids_with_parents)
+ | set(task_entity_ids)
+ )
+ attr_ids = {attr["id"] for attr in hier_attrs}
+ for obj_id in dst_object_type_ids:
+ attrs = attrs_by_obj_id.get(obj_id)
+ if attrs is not None:
+ for attr in attrs:
+ attr_ids.add(attr["id"])
+
+ real_values_by_entity_id = {
+ entity_id: {}
+ for entity_id in all_entity_ids
+ }
+
+ attr_values = query_custom_attributes(
+ session, attr_ids, all_entity_ids, True
+ )
+ for item in attr_values:
+ entity_id = item["entity_id"]
+ attr_id = item["configuration_id"]
+ real_values_by_entity_id[entity_id][attr_id] = item["value"]
+
+ # Fill hierarchical values
+ hier_attrs_key_by_id = {
+ hier_attr["id"]: hier_attr
+ for hier_attr in hier_attrs
+ }
+ hier_values_per_entity_id = {}
+ for entity_id in all_non_task_ids_with_parents:
+ real_values = real_values_by_entity_id[entity_id]
+ hier_values_per_entity_id[entity_id] = {}
+ for attr_id, attr in hier_attrs_key_by_id.items():
+ key = attr["key"]
+ hier_values_per_entity_id[entity_id][key] = (
+ real_values.get(attr_id)
+ )
+
+ output = {}
+ for entity_id in non_task_entity_ids:
+ output[entity_id] = {}
+ for attr in hier_attrs_key_by_id.values():
+ key = attr["key"]
+ value = hier_values_per_entity_id[entity_id][key]
+ tried_ids = set()
+ if value is None:
+ tried_ids.add(entity_id)
+ _entity_id = entity_id
+ while value is None:
+ parent_id = parent_id_by_entity_id.get(_entity_id)
+ if not parent_id:
+ break
+ value = hier_values_per_entity_id[parent_id][key]
+ if value is not None:
+ break
+ _entity_id = parent_id
+ tried_ids.add(parent_id)
+
+ if value is None:
+ value = attr["default"]
+
+ if value is not None:
+ for ent_id in tried_ids:
+ hier_values_per_entity_id[ent_id][key] = value
+
+ output[entity_id][key] = value
+
+ return real_values_by_entity_id, output
def propagate_values(self, session, event, selected_entities):
ftrack_settings = self.get_ftrack_settings(
@@ -156,29 +248,24 @@ class PushHierValuesToNonHier(ServerAction):
}
task_object_type = object_types_by_low_name["task"]
- destination_object_types = [task_object_type]
+ dst_object_type_ids = {task_object_type["id"]}
for ent_type in interest_entity_types:
obj_type = object_types_by_low_name.get(ent_type)
- if obj_type and obj_type not in destination_object_types:
- destination_object_types.append(obj_type)
-
- destination_object_type_ids = set(
- obj_type["id"]
- for obj_type in destination_object_types
- )
+ if obj_type:
+ dst_object_type_ids.add(obj_type["id"])
interest_attributes = action_settings["interest_attributes"]
# Find custom attributes definitions
attrs_by_obj_id, hier_attrs = self.attrs_configurations(
- session, destination_object_type_ids, interest_attributes
+ session, dst_object_type_ids, interest_attributes
)
# Filter destination object types if they have any object specific
# custom attribute
- for obj_id in tuple(destination_object_type_ids):
+ for obj_id in tuple(dst_object_type_ids):
if obj_id not in attrs_by_obj_id:
- destination_object_type_ids.remove(obj_id)
+ dst_object_type_ids.remove(obj_id)
- if not destination_object_type_ids:
+ if not dst_object_type_ids:
# TODO report that there are not matching custom attributes
return {
"success": True,
@@ -192,14 +279,14 @@ class PushHierValuesToNonHier(ServerAction):
session,
selected_ids,
project_entity,
- destination_object_type_ids
+ dst_object_type_ids
)
self.log.debug("Preparing whole project hierarchy by ids.")
entities_by_obj_id = {
obj_id: []
- for obj_id in destination_object_type_ids
+ for obj_id in dst_object_type_ids
}
self.log.debug("Filtering Task entities.")
@@ -223,10 +310,16 @@ class PushHierValuesToNonHier(ServerAction):
"message": "Nothing to do in your selection."
}
- self.log.debug("Getting Hierarchical custom attribute values parents.")
- hier_values_by_entity_id = self.get_hier_values(
+ self.log.debug("Getting Custom attribute values.")
+ (
+ real_values_by_entity_id,
+ hier_values_by_entity_id
+ ) = self.query_attr_value(
session,
hier_attrs,
+ attrs_by_obj_id,
+ dst_object_type_ids,
+ task_entity_ids,
non_task_entity_ids,
parent_id_by_entity_id
)
@@ -237,7 +330,8 @@ class PushHierValuesToNonHier(ServerAction):
hier_attrs,
task_entity_ids,
hier_values_by_entity_id,
- parent_id_by_entity_id
+ parent_id_by_entity_id,
+ real_values_by_entity_id
)
self.log.debug("Setting values to entities themselves.")
@@ -245,7 +339,8 @@ class PushHierValuesToNonHier(ServerAction):
session,
entities_by_obj_id,
attrs_by_obj_id,
- hier_values_by_entity_id
+ hier_values_by_entity_id,
+ real_values_by_entity_id
)
return True
@@ -322,112 +417,64 @@ class PushHierValuesToNonHier(ServerAction):
return parent_id_by_entity_id, filtered_entities
- def get_hier_values(
- self,
- session,
- hier_attrs,
- focus_entity_ids,
- parent_id_by_entity_id
- ):
- all_ids_with_parents = set()
- for entity_id in focus_entity_ids:
- all_ids_with_parents.add(entity_id)
- _entity_id = entity_id
- while True:
- parent_id = parent_id_by_entity_id.get(_entity_id)
- if (
- not parent_id
- or parent_id in all_ids_with_parents
- ):
- break
- all_ids_with_parents.add(parent_id)
- _entity_id = parent_id
-
- hier_attr_ids = tuple(hier_attr["id"] for hier_attr in hier_attrs)
- hier_attrs_key_by_id = {
- hier_attr["id"]: hier_attr["key"]
- for hier_attr in hier_attrs
- }
-
- values_per_entity_id = {}
- for entity_id in all_ids_with_parents:
- values_per_entity_id[entity_id] = {}
- for key in hier_attrs_key_by_id.values():
- values_per_entity_id[entity_id][key] = None
-
- values = query_custom_attributes(
- session, hier_attr_ids, all_ids_with_parents, True
- )
- for item in values:
- entity_id = item["entity_id"]
- key = hier_attrs_key_by_id[item["configuration_id"]]
-
- values_per_entity_id[entity_id][key] = item["value"]
-
- output = {}
- for entity_id in focus_entity_ids:
- output[entity_id] = {}
- for key in hier_attrs_key_by_id.values():
- value = values_per_entity_id[entity_id][key]
- tried_ids = set()
- if value is None:
- tried_ids.add(entity_id)
- _entity_id = entity_id
- while value is None:
- parent_id = parent_id_by_entity_id.get(_entity_id)
- if not parent_id:
- break
- value = values_per_entity_id[parent_id][key]
- if value is not None:
- break
- _entity_id = parent_id
- tried_ids.add(parent_id)
-
- if value is not None:
- for ent_id in tried_ids:
- values_per_entity_id[ent_id][key] = value
-
- output[entity_id][key] = value
- return output
-
def set_task_attr_values(
self,
session,
hier_attrs,
task_entity_ids,
hier_values_by_entity_id,
- parent_id_by_entity_id
+ parent_id_by_entity_id,
+ real_values_by_entity_id
):
hier_attr_id_by_key = {
attr["key"]: attr["id"]
for attr in hier_attrs
}
+ filtered_task_ids = set()
for task_id in task_entity_ids:
- parent_id = parent_id_by_entity_id.get(task_id) or {}
+ parent_id = parent_id_by_entity_id.get(task_id)
parent_values = hier_values_by_entity_id.get(parent_id)
- if not parent_values:
- continue
+ if parent_values:
+ filtered_task_ids.add(task_id)
+ if not filtered_task_ids:
+ return
+
+ for task_id in filtered_task_ids:
+ parent_id = parent_id_by_entity_id[task_id]
+ parent_values = hier_values_by_entity_id[parent_id]
hier_values_by_entity_id[task_id] = {}
+ real_task_attr_values = real_values_by_entity_id[task_id]
for key, value in parent_values.items():
hier_values_by_entity_id[task_id][key] = value
+ if value is None:
+ continue
+
configuration_id = hier_attr_id_by_key[key]
_entity_key = collections.OrderedDict([
("configuration_id", configuration_id),
("entity_id", task_id)
])
-
- session.recorded_operations.push(
- ftrack_api.operation.UpdateEntityOperation(
- "ContextCustomAttributeValue",
+ op = None
+ if configuration_id not in real_task_attr_values:
+ op = ftrack_api.operation.CreateEntityOperation(
+ "CustomAttributeValue",
+ _entity_key,
+ {"value": value}
+ )
+ elif real_task_attr_values[configuration_id] != value:
+ op = ftrack_api.operation.UpdateEntityOperation(
+ "CustomAttributeValue",
_entity_key,
"value",
- ftrack_api.symbol.NOT_SET,
+ real_task_attr_values[configuration_id],
value
)
- )
- if len(session.recorded_operations) > 100:
- session.commit()
+
+ if op is not None:
+ session.recorded_operations.push(op)
+ if len(session.recorded_operations) > 100:
+ session.commit()
session.commit()
@@ -436,39 +483,68 @@ class PushHierValuesToNonHier(ServerAction):
session,
entities_by_obj_id,
attrs_by_obj_id,
- hier_values_by_entity_id
+ hier_values_by_entity_id,
+ real_values_by_entity_id
):
+ """Push values from hierarchical custom attributes to non-hierarchical.
+
+ Args:
+ session (ftrack_api.Sessison): Session which queried entities,
+ values and which is used for change propagation.
+ entities_by_obj_id (dict[str, list[str]]): TypedContext
+ ftrack entity ids where the attributes are propagated by their
+ object ids.
+ attrs_by_obj_id (dict[str, ftrack_api.Entity]): Objects of
+ 'CustomAttributeConfiguration' by their ids.
+ hier_values_by_entity_id (doc[str, dict[str, Any]]): Attribute
+ values by entity id and by their keys.
+ real_values_by_entity_id (doc[str, dict[str, Any]]): Real attribute
+ values of entities.
+ """
+
for object_id, entity_ids in entities_by_obj_id.items():
attrs = attrs_by_obj_id.get(object_id)
if not attrs or not entity_ids:
continue
- for attr in attrs:
- for entity_id in entity_ids:
- value = (
- hier_values_by_entity_id
- .get(entity_id, {})
- .get(attr["key"])
- )
+ for entity_id in entity_ids:
+ real_values = real_values_by_entity_id.get(entity_id)
+ hier_values = hier_values_by_entity_id.get(entity_id)
+ if hier_values is None:
+ continue
+
+ for attr in attrs:
+ attr_id = attr["id"]
+ attr_key = attr["key"]
+ value = hier_values.get(attr_key)
if value is None:
continue
_entity_key = collections.OrderedDict([
- ("configuration_id", attr["id"]),
+ ("configuration_id", attr_id),
("entity_id", entity_id)
])
- session.recorded_operations.push(
- ftrack_api.operation.UpdateEntityOperation(
- "ContextCustomAttributeValue",
+ op = None
+ if attr_id not in real_values:
+ op = ftrack_api.operation.CreateEntityOperation(
+ "CustomAttributeValue",
+ _entity_key,
+ {"value": value}
+ )
+ elif real_values[attr_id] != value:
+ op = ftrack_api.operation.UpdateEntityOperation(
+ "CustomAttributeValue",
_entity_key,
"value",
- ftrack_api.symbol.NOT_SET,
+ real_values[attr_id],
value
)
- )
- if len(session.recorded_operations) > 100:
- session.commit()
+
+ if op is not None:
+ session.recorded_operations.push(op)
+ if len(session.recorded_operations) > 100:
+ session.commit()
session.commit()
diff --git a/openpype/modules/ftrack/event_handlers_server/event_push_frame_values_to_task.py b/openpype/modules/ftrack/event_handlers_server/event_push_frame_values_to_task.py
index dc76920a57..0f10145c06 100644
--- a/openpype/modules/ftrack/event_handlers_server/event_push_frame_values_to_task.py
+++ b/openpype/modules/ftrack/event_handlers_server/event_push_frame_values_to_task.py
@@ -1,6 +1,6 @@
import collections
-import datetime
import copy
+from typing import Any
import ftrack_api
from openpype_modules.ftrack.lib import (
@@ -9,13 +9,30 @@ from openpype_modules.ftrack.lib import (
)
-class PushFrameValuesToTaskEvent(BaseEvent):
+class PushHierValuesToNonHierEvent(BaseEvent):
+ """Push value changes between hierarchical and non-hierarchical attributes.
+
+ Changes of non-hierarchical attributes are pushed to hierarchical and back.
+ The attributes must have same definition of custom attribute.
+
+ Handler does not handle changes of hierarchical parents. So if entity does
+ not have explicitly set value of hierarchical attribute and any parent
+ would change it the change would not be propagated.
+
+ The handler also push the value to task entity on task creation
+ and movement. To push values between hierarchical & non-hierarchical
+ add 'Task' to entity types in settings.
+
+ Todos:
+ Task attribute values push on create/move should be possible to
+ enabled by settings.
+ """
+
# Ignore event handler by default
cust_attrs_query = (
"select id, key, object_type_id, is_hierarchical, default"
" from CustomAttributeConfiguration"
- " where key in ({}) and"
- " (object_type_id in ({}) or is_hierarchical is true)"
+ " where key in ({})"
)
_cached_task_object_id = None
@@ -26,35 +43,35 @@ class PushFrameValuesToTaskEvent(BaseEvent):
settings_key = "sync_hier_entity_attributes"
- def session_user_id(self, session):
- if self._cached_user_id is None:
- user = session.query(
- "User where username is \"{}\"".format(session.api_user)
- ).one()
- self._cached_user_id = user["id"]
- return self._cached_user_id
+ def filter_entities_info(
+ self, event: ftrack_api.event.base.Event
+ ) -> dict[str, list[dict[str, Any]]]:
+ """Basic entities filter info we care about.
- def launch(self, session, event):
- filtered_entities_info = self.filter_entities_info(event)
- if not filtered_entities_info:
- return
+ This filtering is first of many filters. This does not query anything
+ from ftrack nor use settings.
- for project_id, entities_info in filtered_entities_info.items():
- self.process_by_project(session, event, project_id, entities_info)
+ Args:
+ event (ftrack_api.event.base.Event): Ftrack event with update
+ information.
+
+ Returns:
+ dict[str, list[dict[str, Any]]]: Filtered entity changes by
+ project id.
+ """
- def filter_entities_info(self, event):
# Filter if event contain relevant data
entities_info = event["data"].get("entities")
if not entities_info:
return
- entities_info_by_project_id = {}
+ entities_info_by_project_id = collections.defaultdict(list)
for entity_info in entities_info:
- # Care only about tasks
- if entity_info.get("entityType") != "task":
+ # Ignore removed entities
+ if entity_info.get("action") == "remove":
continue
- # Care only about changes of status
+ # Care only about information with changes of entities
changes = entity_info.get("changes")
if not changes:
continue
@@ -69,367 +86,287 @@ class PushFrameValuesToTaskEvent(BaseEvent):
if project_id is None:
continue
- # Skip `Task` entity type if parent didn't change
- if entity_info["entity_type"].lower() == "task":
- if (
- "parent_id" not in changes
- or changes["parent_id"]["new"] is None
- ):
- continue
-
- if project_id not in entities_info_by_project_id:
- entities_info_by_project_id[project_id] = []
entities_info_by_project_id[project_id].append(entity_info)
return entities_info_by_project_id
- def process_by_project(self, session, event, project_id, entities_info):
- project_name = self.get_project_name_from_event(
+ def _get_attrs_configurations(self, session, interest_attributes):
+ """Get custom attribute configurations by name.
+
+ Args:
+ session (ftrack_api.Session): Ftrack sesson.
+ interest_attributes (list[str]): Names of custom attributes
+ that should be synchronized.
+
+ Returns:
+ tuple[dict[str, list], list]: Attributes by object id and
+ hierarchical attributes.
+ """
+
+ attrs = session.query(self.cust_attrs_query.format(
+ self.join_query_keys(interest_attributes)
+ )).all()
+
+ attrs_by_obj_id = collections.defaultdict(list)
+ hier_attrs = []
+ for attr in attrs:
+ if attr["is_hierarchical"]:
+ hier_attrs.append(attr)
+ continue
+ obj_id = attr["object_type_id"]
+ attrs_by_obj_id[obj_id].append(attr)
+ return attrs_by_obj_id, hier_attrs
+
+ def _get_handler_project_settings(
+ self,
+ session: ftrack_api.Session,
+ event: ftrack_api.event.base.Event,
+ project_id: str
+ ) -> tuple[set[str], set[str]]:
+ """Get handler settings based on the project.
+
+ Args:
+ session (ftrack_api.Session): Ftrack session.
+ event (ftrack_api.event.base.Event): Ftrack event which triggered
+ the changes.
+ project_id (str): Project id where the current changes are handled.
+
+ Returns:
+ tuple[set[str], set[str]]: Attribute names we care about and
+ entity types we care about.
+ """
+
+ project_name: str = self.get_project_name_from_event(
session, event, project_id
)
# Load settings
- project_settings = self.get_project_settings_from_event(
- event, project_name
+ project_settings: dict[str, Any] = (
+ self.get_project_settings_from_event(event, project_name)
)
# Load status mapping from presets
- event_settings = (
+ event_settings: dict[str, Any] = (
project_settings
["ftrack"]
["events"]
- ["sync_hier_entity_attributes"]
+ [self.settings_key]
)
# Skip if event is not enabled
if not event_settings["enabled"]:
self.log.debug("Project \"{}\" has disabled {}".format(
project_name, self.__class__.__name__
))
- return
+ return set(), set()
- interest_attributes = event_settings["interest_attributes"]
+ interest_attributes: list[str] = event_settings["interest_attributes"]
if not interest_attributes:
self.log.info((
"Project \"{}\" does not have filled 'interest_attributes',"
" skipping."
))
- return
- interest_entity_types = event_settings["interest_entity_types"]
+
+ interest_entity_types: list[str] = (
+ event_settings["interest_entity_types"])
if not interest_entity_types:
self.log.info((
"Project \"{}\" does not have filled 'interest_entity_types',"
" skipping."
))
- return
- interest_attributes = set(interest_attributes)
- interest_entity_types = set(interest_entity_types)
+ # Unify possible issues from settings ('Asset Build' -> 'assetbuild')
+ interest_entity_types: set[str] = {
+ entity_type.replace(" ", "").lower()
+ for entity_type in interest_entity_types
+ }
+ return set(interest_attributes), interest_entity_types
- # Separate value changes and task parent changes
- _entities_info = []
- added_entities = []
- added_entity_ids = set()
- task_parent_changes = []
+ def _entities_filter_by_settings(
+ self,
+ entities_info: list[dict[str, Any]],
+ interest_attributes: set[str],
+ interest_entity_types: set[str]
+ ):
+ new_entities_info = []
for entity_info in entities_info:
- if entity_info["entity_type"].lower() == "task":
- task_parent_changes.append(entity_info)
- elif entity_info.get("action") == "add":
- added_entities.append(entity_info)
- added_entity_ids.add(entity_info["entityId"])
- else:
- _entities_info.append(entity_info)
- entities_info = _entities_info
+ entity_type_low = entity_info["entity_type"].lower()
- # Filter entities info with changes
- interesting_data, changed_keys_by_object_id = self.filter_changes(
- session, event, entities_info, interest_attributes
- )
- self.interesting_data_for_added(
- session,
- added_entities,
- interest_attributes,
- interesting_data,
- changed_keys_by_object_id
- )
- if not interesting_data and not task_parent_changes:
- return
+ changes = entity_info["changes"]
+ # SPECIAL CASE: Capture changes of task created/moved under
+ # interested entity type
+ if (
+ entity_type_low == "task"
+ and "parent_id" in changes
+ ):
+ # Direct parent is always second item in 'parents' and 'Task'
+ # must have at least one parent
+ parent_info = entity_info["parents"][1]
+ parent_entity_type = (
+ parent_info["entity_type"]
+ .replace(" ", "")
+ .lower()
+ )
+ if parent_entity_type in interest_entity_types:
+ new_entities_info.append(entity_info)
+ continue
- # Prepare object types
- object_types = session.query("select id, name from ObjectType").all()
- object_types_by_name = {}
- for object_type in object_types:
- name_low = object_type["name"].lower()
- object_types_by_name[name_low] = object_type
+ # Skip if entity type is not enabled for attr value sync
+ if entity_type_low not in interest_entity_types:
+ continue
- # NOTE it would be nice to check if `interesting_data` do not contain
- # value changs of tasks that were created or moved
- # - it is a complex way how to find out
- if interesting_data:
- self.process_attribute_changes(
- session,
- object_types_by_name,
- interesting_data,
- changed_keys_by_object_id,
- interest_entity_types,
- interest_attributes,
- added_entity_ids
- )
+ valid_attr_change = entity_info.get("action") == "add"
+ for attr_key in interest_attributes:
+ if valid_attr_change:
+ break
- if task_parent_changes:
- self.process_task_parent_change(
- session, object_types_by_name, task_parent_changes,
- interest_entity_types, interest_attributes
- )
+ if attr_key not in changes:
+ continue
- def process_task_parent_change(
+ if changes[attr_key]["new"] is not None:
+ valid_attr_change = True
+
+ if not valid_attr_change:
+ continue
+
+ new_entities_info.append(entity_info)
+
+ return new_entities_info
+
+ def propagate_attribute_changes(
self,
session,
- object_types_by_name,
- task_parent_changes,
- interest_entity_types,
- interest_attributes
+ interest_attributes,
+ entities_info,
+ attrs_by_obj_id,
+ hier_attrs,
+ real_values_by_entity_id,
+ hier_values_by_entity_id,
):
- """Push custom attribute values if task parent has changed.
+ hier_attr_ids_by_key = {
+ attr["key"]: attr["id"]
+ for attr in hier_attrs
+ }
+ filtered_interest_attributes = {
+ attr_name
+ for attr_name in interest_attributes
+ if attr_name in hier_attr_ids_by_key
+ }
+ attrs_keys_by_obj_id = {}
+ for obj_id, attrs in attrs_by_obj_id.items():
+ attrs_keys_by_obj_id[obj_id] = {
+ attr["key"]: attr["id"]
+ for attr in attrs
+ }
- Parent is changed if task is created or if is moved under different
- entity. We don't care about all task changes only about those that
- have it's parent in interest types (from settings).
+ op_changes = []
+ for entity_info in entities_info:
+ entity_id = entity_info["entityId"]
+ obj_id = entity_info["objectTypeId"]
+ # Skip attributes sync if does not have object specific custom
+ # attribute
+ if obj_id not in attrs_keys_by_obj_id:
+ continue
+ attr_keys = attrs_keys_by_obj_id[obj_id]
+ real_values = real_values_by_entity_id[entity_id]
+ hier_values = hier_values_by_entity_id[entity_id]
- Tasks hierarchical value should be unset or set based on parents
- real hierarchical value and non hierarchical custom attribute value
- should be set to hierarchical value.
- """
-
- # Store task ids which were created or moved under parent with entity
- # type defined in settings (interest_entity_types).
- task_ids = set()
- # Store parent ids of matching task ids
- matching_parent_ids = set()
- # Store all entity ids of all entities to be able query hierarchical
- # values.
- whole_hierarchy_ids = set()
- # Store parent id of each entity id
- parent_id_by_entity_id = {}
- for entity_info in task_parent_changes:
- # Ignore entities with less parents than 2
- # NOTE entity itself is also part of "parents" value
- parents = entity_info.get("parents") or []
- if len(parents) < 2:
+ changes = copy.deepcopy(entity_info["changes"])
+ obj_id_attr_keys = {
+ attr_key
+ for attr_key in filtered_interest_attributes
+ if attr_key in attr_keys
+ }
+ if not obj_id_attr_keys:
continue
- parent_info = parents[1]
- # Check if parent has entity type we care about.
- if parent_info["entity_type"] not in interest_entity_types:
- continue
+ value_by_key = {}
+ is_new_entity = entity_info.get("action") == "add"
+ for attr_key in obj_id_attr_keys:
+ if (
+ attr_key in changes
+ and changes[attr_key]["new"] is not None
+ ):
+ value_by_key[attr_key] = changes[attr_key]["new"]
- task_ids.add(entity_info["entityId"])
- matching_parent_ids.add(parent_info["entityId"])
-
- # Store whole hierarchi of task entity
- prev_id = None
- for item in parents:
- item_id = item["entityId"]
- whole_hierarchy_ids.add(item_id)
-
- if prev_id is None:
- prev_id = item_id
+ if not is_new_entity:
continue
- parent_id_by_entity_id[prev_id] = item_id
- if item["entityType"] == "show":
- break
- prev_id = item_id
+ hier_attr_id = hier_attr_ids_by_key[attr_key]
+ attr_id = attr_keys[attr_key]
+ if hier_attr_id in real_values or attr_id in real_values:
+ continue
- # Just skip if nothing is interesting for our settings
- if not matching_parent_ids:
- return
+ value_by_key[attr_key] = hier_values[hier_attr_id]
- # Query object type ids of parent ids for custom attribute
- # definitions query
- entities = session.query(
- "select object_type_id from TypedContext where id in ({})".format(
- self.join_query_keys(matching_parent_ids)
- )
- )
+ for key, new_value in value_by_key.items():
+ if new_value is None:
+ continue
- # Prepare task object id
- task_object_id = object_types_by_name["task"]["id"]
+ hier_id = hier_attr_ids_by_key[key]
+ std_id = attr_keys[key]
+ real_hier_value = real_values.get(hier_id)
+ real_std_value = real_values.get(std_id)
+ hier_value = hier_values[hier_id]
+ # Get right type of value for conversion
+ # - values in event are strings
+ type_value = real_hier_value
+ if type_value is None:
+ type_value = real_std_value
+ if type_value is None:
+ type_value = hier_value
+ # Skip if current values are not set
+ if type_value is None:
+ continue
- # All object ids for which we're querying custom attribute definitions
- object_type_ids = set()
- object_type_ids.add(task_object_id)
- for entity in entities:
- object_type_ids.add(entity["object_type_id"])
+ try:
+ new_value = type(type_value)(new_value)
+ except Exception:
+ self.log.warning((
+ "Couldn't convert from {} to {}."
+ " Skipping update values."
+ ).format(type(new_value), type(type_value)))
+ continue
- attrs_by_obj_id, hier_attrs = self.attrs_configurations(
- session, object_type_ids, interest_attributes
- )
+ real_std_value_is_same = new_value == real_std_value
+ real_hier_value_is_same = new_value == real_hier_value
+ # New value does not match anything in current entity values
+ if (
+ not is_new_entity
+ and not real_std_value_is_same
+ and not real_hier_value_is_same
+ ):
+ continue
- # Skip if all task attributes are not available
- task_attrs = attrs_by_obj_id.get(task_object_id)
- if not task_attrs:
- return
+ if not real_std_value_is_same:
+ op_changes.append((
+ std_id,
+ entity_id,
+ new_value,
+ real_values.get(std_id),
+ std_id in real_values
+ ))
- # Skip attributes that is not in both hierarchical and nonhierarchical
- # TODO be able to push values if hierarchical is available
- for key in interest_attributes:
- if key not in hier_attrs:
- task_attrs.pop(key, None)
+ if not real_hier_value_is_same:
+ op_changes.append((
+ hier_id,
+ entity_id,
+ new_value,
+ real_values.get(hier_id),
+ hier_id in real_values
+ ))
- elif key not in task_attrs:
- hier_attrs.pop(key)
+ for change in op_changes:
+ (
+ attr_id,
+ entity_id,
+ new_value,
+ old_value,
+ do_update
+ ) = change
- # Skip if nothing remained
- if not task_attrs:
- return
-
- # Do some preparations for custom attribute values query
- attr_key_by_id = {}
- nonhier_id_by_key = {}
- hier_attr_ids = []
- for key, attr_id in hier_attrs.items():
- attr_key_by_id[attr_id] = key
- hier_attr_ids.append(attr_id)
-
- conf_ids = list(hier_attr_ids)
- task_conf_ids = []
- for key, attr_id in task_attrs.items():
- attr_key_by_id[attr_id] = key
- nonhier_id_by_key[key] = attr_id
- conf_ids.append(attr_id)
- task_conf_ids.append(attr_id)
-
- # Query custom attribute values
- # - result does not contain values for all entities only result of
- # query callback to ftrack server
- result = query_custom_attributes(
- session, list(hier_attr_ids), whole_hierarchy_ids, True
- )
- result.extend(
- query_custom_attributes(
- session, task_conf_ids, whole_hierarchy_ids, False
- )
- )
-
- # Prepare variables where result will be stored
- # - hierachical values should not contain attribute with value by
- # default
- hier_values_by_entity_id = {
- entity_id: {}
- for entity_id in whole_hierarchy_ids
- }
- # - real values of custom attributes
- values_by_entity_id = {
- entity_id: {
- attr_id: None
- for attr_id in conf_ids
- }
- for entity_id in whole_hierarchy_ids
- }
- for item in result:
- attr_id = item["configuration_id"]
- entity_id = item["entity_id"]
- value = item["value"]
-
- values_by_entity_id[entity_id][attr_id] = value
-
- if attr_id in hier_attr_ids and value is not None:
- hier_values_by_entity_id[entity_id][attr_id] = value
-
- # Prepare values for all task entities
- # - going through all parents and storing first value value
- # - store None to those that are already known that do not have set
- # value at all
- for task_id in tuple(task_ids):
- for attr_id in hier_attr_ids:
- entity_ids = []
- value = None
- entity_id = task_id
- while value is None:
- entity_value = hier_values_by_entity_id[entity_id]
- if attr_id in entity_value:
- value = entity_value[attr_id]
- if value is None:
- break
-
- if value is None:
- entity_ids.append(entity_id)
-
- entity_id = parent_id_by_entity_id.get(entity_id)
- if entity_id is None:
- break
-
- for entity_id in entity_ids:
- hier_values_by_entity_id[entity_id][attr_id] = value
-
- # Prepare changes to commit
- changes = []
- for task_id in tuple(task_ids):
- parent_id = parent_id_by_entity_id[task_id]
- for attr_id in hier_attr_ids:
- attr_key = attr_key_by_id[attr_id]
- nonhier_id = nonhier_id_by_key[attr_key]
-
- # Real value of hierarchical attribute on parent
- # - If is none then should be unset
- real_parent_value = values_by_entity_id[parent_id][attr_id]
- # Current hierarchical value of a task
- # - Will be compared to real parent value
- hier_value = hier_values_by_entity_id[task_id][attr_id]
-
- # Parent value that can be inherited from it's parent entity
- parent_value = hier_values_by_entity_id[parent_id][attr_id]
- # Task value of nonhierarchical custom attribute
- nonhier_value = values_by_entity_id[task_id][nonhier_id]
-
- if real_parent_value != hier_value:
- changes.append({
- "new_value": real_parent_value,
- "attr_id": attr_id,
- "entity_id": task_id,
- "attr_key": attr_key
- })
-
- if parent_value != nonhier_value:
- changes.append({
- "new_value": parent_value,
- "attr_id": nonhier_id,
- "entity_id": task_id,
- "attr_key": attr_key
- })
-
- self._commit_changes(session, changes)
-
- def _commit_changes(self, session, changes):
- uncommited_changes = False
- for idx, item in enumerate(changes):
- new_value = item["new_value"]
- old_value = item["old_value"]
- attr_id = item["attr_id"]
- entity_id = item["entity_id"]
- attr_key = item["attr_key"]
-
- entity_key = collections.OrderedDict((
+ entity_key = collections.OrderedDict([
("configuration_id", attr_id),
("entity_id", entity_id)
- ))
- self._cached_changes.append({
- "attr_key": attr_key,
- "entity_id": entity_id,
- "value": new_value,
- "time": datetime.datetime.now()
- })
- old_value_is_set = (
- old_value is not ftrack_api.symbol.NOT_SET
- and old_value is not None
- )
- if new_value is None:
- if not old_value_is_set:
- continue
- op = ftrack_api.operation.DeleteEntityOperation(
- "CustomAttributeValue",
- entity_key
- )
-
- elif old_value_is_set:
+ ])
+ if do_update:
op = ftrack_api.operation.UpdateEntityOperation(
"CustomAttributeValue",
entity_key,
@@ -446,449 +383,116 @@ class PushFrameValuesToTaskEvent(BaseEvent):
)
session.recorded_operations.push(op)
- self.log.info((
- "Changing Custom Attribute \"{}\" to value"
- " \"{}\" on entity: {}"
- ).format(attr_key, new_value, entity_id))
-
- if (idx + 1) % 20 == 0:
- uncommited_changes = False
- try:
- session.commit()
- except Exception:
- session.rollback()
- self.log.warning(
- "Changing of values failed.", exc_info=True
- )
- else:
- uncommited_changes = True
- if uncommited_changes:
- try:
+ if len(session.recorded_operations) > 100:
session.commit()
- except Exception:
- session.rollback()
- self.log.warning("Changing of values failed.", exc_info=True)
+ session.commit()
- def process_attribute_changes(
+ def process_by_project(
self,
- session,
- object_types_by_name,
- interesting_data,
- changed_keys_by_object_id,
- interest_entity_types,
- interest_attributes,
- added_entity_ids
+ session: ftrack_api.Session,
+ event: ftrack_api.event.base.Event,
+ project_id: str,
+ entities_info: list[dict[str, Any]]
):
- # Prepare task object id
- task_object_id = object_types_by_name["task"]["id"]
+ """Proces changes in single project.
- # Collect object type ids based on settings
- interest_object_ids = []
- for entity_type in interest_entity_types:
- _entity_type = entity_type.lower()
- object_type = object_types_by_name.get(_entity_type)
- if not object_type:
- self.log.warning("Couldn't find object type \"{}\"".format(
- entity_type
- ))
+ Args:
+ session (ftrack_api.Session): Ftrack session.
+ event (ftrack_api.event.base.Event): Event which has all changes
+ information.
+ project_id (str): Project id related to changes.
+ entities_info (list[dict[str, Any]]): Changes of entities.
+ """
- interest_object_ids.append(object_type["id"])
-
- # Query entities by filtered data and object ids
- entities = self.get_entities(
- session, interesting_data, interest_object_ids
- )
- if not entities:
+ (
+ interest_attributes,
+ interest_entity_types
+ ) = self._get_handler_project_settings(session, event, project_id)
+ if not interest_attributes or not interest_entity_types:
return
- # Pop not found entities from interesting data
- entity_ids = set(
- entity["id"]
- for entity in entities
+ entities_info: list[dict[str, Any]] = (
+ self._entities_filter_by_settings(
+ entities_info,
+ interest_attributes,
+ interest_entity_types
+ )
)
- for entity_id in tuple(interesting_data.keys()):
- if entity_id not in entity_ids:
- interesting_data.pop(entity_id)
-
- # Add task object type to list
- attr_obj_ids = list(interest_object_ids)
- attr_obj_ids.append(task_object_id)
-
- attrs_by_obj_id, hier_attrs = self.attrs_configurations(
- session, attr_obj_ids, interest_attributes
- )
-
- task_attrs = attrs_by_obj_id.get(task_object_id)
-
- changed_keys = set()
- # Skip keys that are not both in hierachical and type specific
- for object_id, keys in changed_keys_by_object_id.items():
- changed_keys |= set(keys)
- object_id_attrs = attrs_by_obj_id.get(object_id)
- for key in keys:
- if key not in hier_attrs:
- attrs_by_obj_id[object_id].pop(key)
- continue
-
- if (
- (not object_id_attrs or key not in object_id_attrs)
- and (not task_attrs or key not in task_attrs)
- ):
- hier_attrs.pop(key)
-
- # Clean up empty values
- for key, value in tuple(attrs_by_obj_id.items()):
- if not value:
- attrs_by_obj_id.pop(key)
-
- if not attrs_by_obj_id:
- self.log.warning((
- "There is not created Custom Attributes {} "
- " for entity types: {}"
- ).format(
- self.join_query_keys(interest_attributes),
- self.join_query_keys(interest_entity_types)
- ))
+ if not entities_info:
return
- # Prepare task entities
- task_entities = []
- # If task entity does not contain changed attribute then skip
- if task_attrs:
- task_entities = self.get_task_entities(session, interesting_data)
-
- task_entity_ids = set()
- parent_id_by_task_id = {}
- for task_entity in task_entities:
- task_id = task_entity["id"]
- task_entity_ids.add(task_id)
- parent_id_by_task_id[task_id] = task_entity["parent_id"]
-
- self.finalize_attribute_changes(
- session,
- interesting_data,
- changed_keys,
- attrs_by_obj_id,
- hier_attrs,
- task_entity_ids,
- parent_id_by_task_id,
- added_entity_ids
- )
-
- def finalize_attribute_changes(
- self,
- session,
- interesting_data,
- changed_keys,
- attrs_by_obj_id,
- hier_attrs,
- task_entity_ids,
- parent_id_by_task_id,
- added_entity_ids
- ):
- attr_id_to_key = {}
- for attr_confs in attrs_by_obj_id.values():
- for key in changed_keys:
- custom_attr_id = attr_confs.get(key)
- if custom_attr_id:
- attr_id_to_key[custom_attr_id] = key
-
- for key in changed_keys:
- custom_attr_id = hier_attrs.get(key)
- if custom_attr_id:
- attr_id_to_key[custom_attr_id] = key
-
- entity_ids = (
- set(interesting_data.keys()) | task_entity_ids
- )
- attr_ids = set(attr_id_to_key.keys())
-
- current_values_by_id = self.get_current_values(
- session,
- attr_ids,
- entity_ids,
- task_entity_ids,
- hier_attrs
- )
-
- changes = []
- for entity_id, current_values in current_values_by_id.items():
- parent_id = parent_id_by_task_id.get(entity_id)
- if not parent_id:
- parent_id = entity_id
- values = interesting_data[parent_id]
-
- added_entity = entity_id in added_entity_ids
- for attr_id, old_value in current_values.items():
- if added_entity and attr_id in hier_attrs:
- continue
-
- attr_key = attr_id_to_key.get(attr_id)
- if not attr_key:
- continue
-
- # Convert new value from string
- new_value = values.get(attr_key)
- new_value_is_valid = (
- old_value is not ftrack_api.symbol.NOT_SET
- and new_value is not None
- )
- if added_entity and not new_value_is_valid:
- continue
-
- if new_value is not None and new_value_is_valid:
- try:
- new_value = type(old_value)(new_value)
- except Exception:
- self.log.warning((
- "Couldn't convert from {} to {}."
- " Skipping update values."
- ).format(type(new_value), type(old_value)))
- if new_value == old_value:
- continue
-
- changes.append({
- "new_value": new_value,
- "attr_id": attr_id,
- "old_value": old_value,
- "entity_id": entity_id,
- "attr_key": attr_key
- })
- self._commit_changes(session, changes)
-
- def filter_changes(
- self, session, event, entities_info, interest_attributes
- ):
- session_user_id = self.session_user_id(session)
- user_data = event["data"].get("user")
- changed_by_session = False
- if user_data and user_data.get("userid") == session_user_id:
- changed_by_session = True
-
- current_time = datetime.datetime.now()
-
- interesting_data = {}
- changed_keys_by_object_id = {}
-
- for entity_info in entities_info:
- # Care only about changes if specific keys
- entity_changes = {}
- changes = entity_info["changes"]
- for key in interest_attributes:
- if key in changes:
- entity_changes[key] = changes[key]["new"]
-
- entity_id = entity_info["entityId"]
- if changed_by_session:
- for key, new_value in tuple(entity_changes.items()):
- for cached in tuple(self._cached_changes):
- if (
- cached["entity_id"] != entity_id
- or cached["attr_key"] != key
- ):
- continue
-
- cached_value = cached["value"]
- try:
- new_value = type(cached_value)(new_value)
- except Exception:
- pass
-
- if cached_value == new_value:
- self._cached_changes.remove(cached)
- entity_changes.pop(key)
- break
-
- delta = (current_time - cached["time"]).seconds
- if delta > self._max_delta:
- self._cached_changes.remove(cached)
-
- if not entity_changes:
- continue
-
- entity_id = entity_info["entityId"]
- object_id = entity_info["objectTypeId"]
- interesting_data[entity_id] = entity_changes
- if object_id not in changed_keys_by_object_id:
- changed_keys_by_object_id[object_id] = set()
- changed_keys_by_object_id[object_id] |= set(entity_changes.keys())
-
- return interesting_data, changed_keys_by_object_id
-
- def interesting_data_for_added(
- self,
- session,
- added_entities,
- interest_attributes,
- interesting_data,
- changed_keys_by_object_id
- ):
- if not added_entities or not interest_attributes:
- return
-
- object_type_ids = set()
- entity_ids = set()
- all_entity_ids = set()
- object_id_by_entity_id = {}
- project_id = None
- entity_ids_by_parent_id = collections.defaultdict(set)
- for entity_info in added_entities:
- object_id = entity_info["objectTypeId"]
- entity_id = entity_info["entityId"]
- object_type_ids.add(object_id)
- entity_ids.add(entity_id)
- object_id_by_entity_id[entity_id] = object_id
-
- for item in entity_info["parents"]:
- entity_id = item["entityId"]
- all_entity_ids.add(entity_id)
- parent_id = item["parentId"]
- if not parent_id:
- project_id = entity_id
- else:
- entity_ids_by_parent_id[parent_id].add(entity_id)
-
- hier_attrs = self.get_hierarchical_configurations(
+ attrs_by_obj_id, hier_attrs = self._get_attrs_configurations(
session, interest_attributes
)
- if not hier_attrs:
+ # Skip if attributes are not available
+ # - there is nothing to sync
+ if not attrs_by_obj_id or not hier_attrs:
return
- hier_attrs_key_by_id = {
- attr_conf["id"]: attr_conf["key"]
- for attr_conf in hier_attrs
- }
- default_values_by_key = {
- attr_conf["key"]: attr_conf["default"]
- for attr_conf in hier_attrs
- }
+ entity_ids_by_parent_id = collections.defaultdict(set)
+ all_entity_ids = set()
+ for entity_info in entities_info:
+ entity_id = None
+ for item in entity_info["parents"]:
+ item_id = item["entityId"]
+ all_entity_ids.add(item_id)
+ if entity_id is not None:
+ entity_ids_by_parent_id[item_id].add(entity_id)
+ entity_id = item_id
- values = query_custom_attributes(
- session, list(hier_attrs_key_by_id.keys()), all_entity_ids, True
+ attr_ids = {attr["id"] for attr in hier_attrs}
+ for attrs in attrs_by_obj_id.values():
+ attr_ids |= {attr["id"] for attr in attrs}
+
+ # Query real custom attribute values
+ # - we have to know what are the real values, if are set and to what
+ # value
+ value_items = query_custom_attributes(
+ session, attr_ids, all_entity_ids, True
)
- values_per_entity_id = {}
- for entity_id in all_entity_ids:
- values_per_entity_id[entity_id] = {}
- for attr_name in interest_attributes:
- values_per_entity_id[entity_id][attr_name] = None
-
- for item in values:
- entity_id = item["entity_id"]
- key = hier_attrs_key_by_id[item["configuration_id"]]
- values_per_entity_id[entity_id][key] = item["value"]
-
- fill_queue = collections.deque()
- fill_queue.append((project_id, default_values_by_key))
- while fill_queue:
- item = fill_queue.popleft()
- entity_id, values_by_key = item
- entity_values = values_per_entity_id[entity_id]
- new_values_by_key = copy.deepcopy(values_by_key)
- for key, value in values_by_key.items():
- current_value = entity_values[key]
- if current_value is None:
- entity_values[key] = value
- else:
- new_values_by_key[key] = current_value
-
- for child_id in entity_ids_by_parent_id[entity_id]:
- fill_queue.append((child_id, new_values_by_key))
-
- for entity_id in entity_ids:
- entity_changes = {}
- for key, value in values_per_entity_id[entity_id].items():
- if value is not None:
- entity_changes[key] = value
-
- if not entity_changes:
- continue
-
- interesting_data[entity_id] = entity_changes
- object_id = object_id_by_entity_id[entity_id]
- if object_id not in changed_keys_by_object_id:
- changed_keys_by_object_id[object_id] = set()
- changed_keys_by_object_id[object_id] |= set(entity_changes.keys())
-
- def get_current_values(
- self,
- session,
- attr_ids,
- entity_ids,
- task_entity_ids,
- hier_attrs
- ):
- current_values_by_id = {}
- if not attr_ids or not entity_ids:
- return current_values_by_id
-
- for entity_id in entity_ids:
- current_values_by_id[entity_id] = {}
- for attr_id in attr_ids:
- current_values_by_id[entity_id][attr_id] = (
- ftrack_api.symbol.NOT_SET
- )
-
- values = query_custom_attributes(
- session, attr_ids, entity_ids, True
- )
-
- for item in values:
+ real_values_by_entity_id = collections.defaultdict(dict)
+ for item in value_items:
entity_id = item["entity_id"]
attr_id = item["configuration_id"]
- if entity_id in task_entity_ids and attr_id in hier_attrs:
- continue
+ real_values_by_entity_id[entity_id][attr_id] = item["value"]
- if entity_id not in current_values_by_id:
- current_values_by_id[entity_id] = {}
- current_values_by_id[entity_id][attr_id] = item["value"]
- return current_values_by_id
+ hier_values_by_entity_id = {}
+ default_values = {
+ attr["id"]: attr["default"]
+ for attr in hier_attrs
+ }
+ hier_queue = collections.deque()
+ hier_queue.append((default_values, [project_id]))
+ while hier_queue:
+ parent_values, entity_ids = hier_queue.popleft()
+ for entity_id in entity_ids:
+ entity_values = copy.deepcopy(parent_values)
+ real_values = real_values_by_entity_id[entity_id]
+ for attr_id, value in real_values.items():
+ entity_values[attr_id] = value
+ hier_values_by_entity_id[entity_id] = entity_values
+ hier_queue.append(
+ (entity_values, entity_ids_by_parent_id[entity_id])
+ )
- def get_entities(self, session, interesting_data, interest_object_ids):
- return session.query((
- "select id from TypedContext"
- " where id in ({}) and object_type_id in ({})"
- ).format(
- self.join_query_keys(interesting_data.keys()),
- self.join_query_keys(interest_object_ids)
- )).all()
-
- def get_task_entities(self, session, interesting_data):
- return session.query(
- "select id, parent_id from Task where parent_id in ({})".format(
- self.join_query_keys(interesting_data.keys())
- )
- ).all()
-
- def attrs_configurations(self, session, object_ids, interest_attributes):
- attrs = session.query(self.cust_attrs_query.format(
- self.join_query_keys(interest_attributes),
- self.join_query_keys(object_ids)
- )).all()
-
- output = {}
- hiearchical = {}
- for attr in attrs:
- if attr["is_hierarchical"]:
- hiearchical[attr["key"]] = attr["id"]
- continue
- obj_id = attr["object_type_id"]
- if obj_id not in output:
- output[obj_id] = {}
- output[obj_id][attr["key"]] = attr["id"]
- return output, hiearchical
-
- def get_hierarchical_configurations(self, session, interest_attributes):
- hier_attr_query = (
- "select id, key, object_type_id, is_hierarchical, default"
- " from CustomAttributeConfiguration"
- " where key in ({}) and is_hierarchical is true"
+ self.propagate_attribute_changes(
+ session,
+ interest_attributes,
+ entities_info,
+ attrs_by_obj_id,
+ hier_attrs,
+ real_values_by_entity_id,
+ hier_values_by_entity_id,
)
- if not interest_attributes:
- return []
- return list(session.query(hier_attr_query.format(
- self.join_query_keys(interest_attributes),
- )).all())
+
+ def launch(self, session, event):
+ filtered_entities_info = self.filter_entities_info(event)
+ if not filtered_entities_info:
+ return
+
+ for project_id, entities_info in filtered_entities_info.items():
+ self.process_by_project(session, event, project_id, entities_info)
def register(session):
- PushFrameValuesToTaskEvent(session).register()
+ PushHierValuesToNonHierEvent(session).register()
diff --git a/openpype/modules/ftrack/event_handlers_user/action_applications.py b/openpype/modules/ftrack/event_handlers_user/action_applications.py
index 102f04c956..30399b463d 100644
--- a/openpype/modules/ftrack/event_handlers_user/action_applications.py
+++ b/openpype/modules/ftrack/event_handlers_user/action_applications.py
@@ -124,6 +124,11 @@ class AppplicationsAction(BaseAction):
if not avalon_project_apps:
return False
+ settings = self.get_project_settings_from_event(
+ event, avalon_project_doc["name"])
+
+ only_available = settings["applications"]["only_available"]
+
items = []
for app_name in avalon_project_apps:
app = self.application_manager.applications.get(app_name)
@@ -133,6 +138,10 @@ class AppplicationsAction(BaseAction):
if app.group.name in CUSTOM_LAUNCH_APP_GROUPS:
continue
+ # Skip applications without valid executables
+ if only_available and not app.find_executable():
+ continue
+
app_icon = app.icon
if app_icon and self.icon_url:
try:
diff --git a/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py b/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py
index 576a7d36c4..97815f490f 100644
--- a/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py
+++ b/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py
@@ -7,23 +7,22 @@ Provides:
"""
import pyblish.api
-from openpype.pipeline import legacy_io
from openpype.lib import filter_profiles
class CollectFtrackFamily(pyblish.api.InstancePlugin):
+ """Adds explicitly 'ftrack' to families to upload instance to FTrack.
+
+ Uses selection by combination of hosts/families/tasks names via
+ profiles resolution.
+
+ Triggered everywhere, checks instance against configured.
+
+ Checks advanced filtering which works on 'families' not on main
+ 'family', as some variants dynamically resolves addition of ftrack
+ based on 'families' (editorial drives it by presence of 'review')
"""
- Adds explicitly 'ftrack' to families to upload instance to FTrack.
- Uses selection by combination of hosts/families/tasks names via
- profiles resolution.
-
- Triggered everywhere, checks instance against configured.
-
- Checks advanced filtering which works on 'families' not on main
- 'family', as some variants dynamically resolves addition of ftrack
- based on 'families' (editorial drives it by presence of 'review')
- """
label = "Collect Ftrack Family"
order = pyblish.api.CollectorOrder + 0.4990
@@ -34,68 +33,64 @@ class CollectFtrackFamily(pyblish.api.InstancePlugin):
self.log.warning("No profiles present for adding Ftrack family")
return
- add_ftrack_family = False
- task_name = instance.data.get("task",
- legacy_io.Session["AVALON_TASK"])
- host_name = legacy_io.Session["AVALON_APP"]
+ host_name = instance.context.data["hostName"]
family = instance.data["family"]
+ task_name = instance.data.get("task")
filtering_criteria = {
"hosts": host_name,
"families": family,
"tasks": task_name
}
- profile = filter_profiles(self.profiles, filtering_criteria,
- logger=self.log)
+ profile = filter_profiles(
+ self.profiles,
+ filtering_criteria,
+ logger=self.log
+ )
+
+ add_ftrack_family = False
+ families = instance.data.setdefault("families", [])
if profile:
- families = instance.data.get("families")
add_ftrack_family = profile["add_ftrack_family"]
-
additional_filters = profile.get("advanced_filtering")
if additional_filters:
- self.log.info("'{}' families used for additional filtering".
- format(families))
+ families_set = set(families) | {family}
+ self.log.info(
+ "'{}' families used for additional filtering".format(
+ families_set))
add_ftrack_family = self._get_add_ftrack_f_from_addit_filters(
additional_filters,
- families,
+ families_set,
add_ftrack_family
)
- if add_ftrack_family:
- self.log.debug("Adding ftrack family for '{}'".
- format(instance.data.get("family")))
+ result_str = "Not adding"
+ if add_ftrack_family:
+ result_str = "Adding"
+ if "ftrack" not in families:
+ families.append("ftrack")
- if families:
- if "ftrack" not in families:
- instance.data["families"].append("ftrack")
- else:
- instance.data["families"] = ["ftrack"]
-
- result_str = "Adding"
- if not add_ftrack_family:
- result_str = "Not adding"
self.log.info("{} 'ftrack' family for instance with '{}'".format(
result_str, family
))
- def _get_add_ftrack_f_from_addit_filters(self,
- additional_filters,
- families,
- add_ftrack_family):
- """
- Compares additional filters - working on instance's families.
+ def _get_add_ftrack_f_from_addit_filters(
+ self, additional_filters, families, add_ftrack_family
+ ):
+ """Compares additional filters - working on instance's families.
- Triggered for more detailed filtering when main family matches,
- but content of 'families' actually matter.
- (For example 'review' in 'families' should result in adding to
- Ftrack)
+ Triggered for more detailed filtering when main family matches,
+ but content of 'families' actually matter.
+ (For example 'review' in 'families' should result in adding to
+ Ftrack)
- Args:
- additional_filters (dict) - from Setting
- families (list) - subfamilies
- add_ftrack_family (bool) - add ftrack to families if True
+ Args:
+ additional_filters (dict) - from Setting
+ families (set[str]) - subfamilies
+ add_ftrack_family (bool) - add ftrack to families if True
"""
+
override_filter = None
override_filter_value = -1
for additional_filter in additional_filters:
diff --git a/openpype/modules/kitsu/plugins/publish/collect_kitsu_entities.py b/openpype/modules/kitsu/plugins/publish/collect_kitsu_entities.py
index a0bd2b305b..4ea8135620 100644
--- a/openpype/modules/kitsu/plugins/publish/collect_kitsu_entities.py
+++ b/openpype/modules/kitsu/plugins/publish/collect_kitsu_entities.py
@@ -29,7 +29,7 @@ class CollectKitsuEntities(pyblish.api.ContextPlugin):
if not zou_asset_data:
raise ValueError("Zou asset data not found in OpenPype!")
- task_name = instance.data.get("task")
+ task_name = instance.data.get("task", context.data.get("task"))
if not task_name:
continue
diff --git a/openpype/modules/kitsu/plugins/publish/integrate_kitsu_note.py b/openpype/modules/kitsu/plugins/publish/integrate_kitsu_note.py
index 6702cbe7aa..f8e56377bb 100644
--- a/openpype/modules/kitsu/plugins/publish/integrate_kitsu_note.py
+++ b/openpype/modules/kitsu/plugins/publish/integrate_kitsu_note.py
@@ -1,6 +1,7 @@
# -*- coding: utf-8 -*-
import gazu
import pyblish.api
+import re
class IntegrateKitsuNote(pyblish.api.ContextPlugin):
@@ -9,27 +10,98 @@ class IntegrateKitsuNote(pyblish.api.ContextPlugin):
order = pyblish.api.IntegratorOrder
label = "Kitsu Note and Status"
families = ["render", "kitsu"]
+
+ # status settings
set_status_note = False
note_status_shortname = "wfa"
+ status_change_conditions = {
+ "status_conditions": [],
+ "family_requirements": [],
+ }
+
+ # comment settings
+ custom_comment_template = {
+ "enabled": False,
+ "comment_template": "{comment}",
+ }
+
+ def format_publish_comment(self, instance):
+ """Format the instance's publish comment
+
+ Formats `instance.data` against the custom template.
+ """
+
+ def replace_missing_key(match):
+ """If key is not found in kwargs, set None instead"""
+ key = match.group(1)
+ if key not in instance.data:
+ self.log.warning(
+ "Key '{}' was not found in instance.data "
+ "and will be rendered as an empty string "
+ "in the comment".format(key)
+ )
+ return ""
+ else:
+ return str(instance.data[key])
+
+ template = self.custom_comment_template["comment_template"]
+ pattern = r"\{([^}]*)\}"
+ return re.sub(pattern, replace_missing_key, template)
def process(self, context):
- # Get comment text body
- publish_comment = context.data.get("comment")
- if not publish_comment:
- self.log.info("Comment is not set.")
-
- self.log.debug("Comment is `{}`".format(publish_comment))
-
for instance in context:
+ # Check if instance is a review by checking its family
+ # Allow a match to primary family or any of families
+ families = set([instance.data["family"]] +
+ instance.data.get("families", []))
+ if "review" not in families:
+ continue
+
kitsu_task = instance.data.get("kitsu_task")
- if kitsu_task is None:
+ if not kitsu_task:
continue
# Get note status, by default uses the task status for the note
# if it is not specified in the configuration
- note_status = kitsu_task["task_status"]["id"]
+ shortname = kitsu_task["task_status"]["short_name"].upper()
+ note_status = kitsu_task["task_status_id"]
- if self.set_status_note:
+ # Check if any status condition is not met
+ allow_status_change = True
+ for status_cond in self.status_change_conditions[
+ "status_conditions"
+ ]:
+ condition = status_cond["condition"] == "equal"
+ match = status_cond["short_name"].upper() == shortname
+ if match and not condition or condition and not match:
+ allow_status_change = False
+ break
+
+ if allow_status_change:
+ # Get families
+ families = {
+ instance.data.get("family")
+ for instance in context
+ if instance.data.get("publish")
+ }
+
+ # Check if any family requirement is met
+ for family_requirement in self.status_change_conditions[
+ "family_requirements"
+ ]:
+ condition = family_requirement["condition"] == "equal"
+
+ for family in families:
+ match = family_requirement["family"].lower() == family
+ if match and not condition or condition and not match:
+ allow_status_change = False
+ break
+
+ if allow_status_change:
+ break
+
+ # Set note status
+ if self.set_status_note and allow_status_change:
kitsu_status = gazu.task.get_task_status_by_short_name(
self.note_status_shortname
)
@@ -42,11 +114,22 @@ class IntegrateKitsuNote(pyblish.api.ContextPlugin):
"changed!".format(self.note_status_shortname)
)
+ # Get comment text body
+ publish_comment = instance.data.get("comment")
+ if self.custom_comment_template["enabled"]:
+ publish_comment = self.format_publish_comment(instance)
+
+ if not publish_comment:
+ self.log.info("Comment is not set.")
+ else:
+ self.log.debug("Comment is `{}`".format(publish_comment))
+
# Add comment to kitsu task
- task_id = kitsu_task["id"]
- self.log.debug("Add new note in taks id {}".format(task_id))
+ self.log.debug(
+ "Add new note in tasks id {}".format(kitsu_task["id"])
+ )
kitsu_comment = gazu.task.add_comment(
- task_id, note_status, comment=publish_comment
+ kitsu_task, note_status, comment=publish_comment
)
instance.data["kitsu_comment"] = kitsu_comment
diff --git a/openpype/modules/kitsu/plugins/publish/integrate_kitsu_review.py b/openpype/modules/kitsu/plugins/publish/integrate_kitsu_review.py
index 12482b5657..e05ff05f50 100644
--- a/openpype/modules/kitsu/plugins/publish/integrate_kitsu_review.py
+++ b/openpype/modules/kitsu/plugins/publish/integrate_kitsu_review.py
@@ -12,17 +12,17 @@ class IntegrateKitsuReview(pyblish.api.InstancePlugin):
optional = True
def process(self, instance):
- task = instance.data["kitsu_task"]["id"]
- comment = instance.data["kitsu_comment"]["id"]
# Check comment has been created
- if not comment:
+ comment_id = instance.data.get("kitsu_comment", {}).get("id")
+ if not comment_id:
self.log.debug(
"Comment not created, review not pushed to preview."
)
return
# Add review representations as preview of comment
+ task_id = instance.data["kitsu_task"]["id"]
for representation in instance.data.get("representations", []):
# Skip if not tagged as review
if "kitsureview" not in representation.get("tags", []):
@@ -31,6 +31,6 @@ class IntegrateKitsuReview(pyblish.api.InstancePlugin):
self.log.debug("Found review at: {}".format(review_path))
gazu.task.add_preview(
- task, comment, review_path, normalize_movie=True
+ task_id, comment_id, review_path, normalize_movie=True
)
self.log.info("Review upload on comment")
diff --git a/openpype/modules/kitsu/utils/update_op_with_zou.py b/openpype/modules/kitsu/utils/update_op_with_zou.py
index 4fa8cf9fdd..1f38648dfa 100644
--- a/openpype/modules/kitsu/utils/update_op_with_zou.py
+++ b/openpype/modules/kitsu/utils/update_op_with_zou.py
@@ -129,7 +129,7 @@ def update_op_assets(
frame_out = frame_in + frames_duration - 1
else:
frame_out = project_doc["data"].get("frameEnd", frame_in)
- item_data["frameEnd"] = frame_out
+ item_data["frameEnd"] = int(frame_out)
# Fps, fallback to project's value or default value (25.0)
try:
fps = float(item_data.get("fps"))
@@ -147,33 +147,37 @@ def update_op_assets(
item_data["resolutionWidth"] = int(match_res.group(1))
item_data["resolutionHeight"] = int(match_res.group(2))
else:
- item_data["resolutionWidth"] = project_doc["data"].get(
- "resolutionWidth"
+ item_data["resolutionWidth"] = int(
+ project_doc["data"].get("resolutionWidth")
)
- item_data["resolutionHeight"] = project_doc["data"].get(
- "resolutionHeight"
+ item_data["resolutionHeight"] = int(
+ project_doc["data"].get("resolutionHeight")
)
# Properties that doesn't fully exist in Kitsu.
# Guessing those property names below:
# Pixel Aspect Ratio
- item_data["pixelAspect"] = item_data.get(
- "pixel_aspect", project_doc["data"].get("pixelAspect")
+ item_data["pixelAspect"] = float(
+ item_data.get(
+ "pixel_aspect", project_doc["data"].get("pixelAspect")
+ )
)
# Handle Start
- item_data["handleStart"] = item_data.get(
- "handle_start", project_doc["data"].get("handleStart")
+ item_data["handleStart"] = int(
+ item_data.get(
+ "handle_start", project_doc["data"].get("handleStart")
+ )
)
# Handle End
- item_data["handleEnd"] = item_data.get(
- "handle_end", project_doc["data"].get("handleEnd")
+ item_data["handleEnd"] = int(
+ item_data.get("handle_end", project_doc["data"].get("handleEnd"))
)
# Clip In
- item_data["clipIn"] = item_data.get(
- "clip_in", project_doc["data"].get("clipIn")
+ item_data["clipIn"] = int(
+ item_data.get("clip_in", project_doc["data"].get("clipIn"))
)
# Clip Out
- item_data["clipOut"] = item_data.get(
- "clip_out", project_doc["data"].get("clipOut")
+ item_data["clipOut"] = int(
+ item_data.get("clip_out", project_doc["data"].get("clipOut"))
)
# Tasks
diff --git a/openpype/modules/sync_server/sync_server_module.py b/openpype/modules/sync_server/sync_server_module.py
index 28863c091a..5a4fa07e98 100644
--- a/openpype/modules/sync_server/sync_server_module.py
+++ b/openpype/modules/sync_server/sync_server_module.py
@@ -1472,13 +1472,15 @@ class SyncServerModule(OpenPypeModule, ITrayModule):
return sync_settings
- def get_all_site_configs(self, project_name=None):
+ def get_all_site_configs(self, project_name=None,
+ local_editable_only=False):
"""
Returns (dict) with all sites configured system wide.
Args:
project_name (str)(optional): if present, check if not disabled
-
+ local_editable_only (bool)(opt): if True return only Local
+ Setting configurable (for LS UI)
Returns:
(dict): {'studio': {'provider':'local_drive'...},
'MY_LOCAL': {'provider':....}}
@@ -1499,9 +1501,21 @@ class SyncServerModule(OpenPypeModule, ITrayModule):
if site_settings:
detail.update(site_settings)
system_sites[site] = detail
-
system_sites.update(self._get_default_site_configs(sync_enabled,
project_name))
+ if local_editable_only:
+ local_schema = SyncServerModule.get_local_settings_schema()
+ editable_keys = {}
+ for provider_code, editables in local_schema.items():
+ editable_keys[provider_code] = ["enabled", "provider"]
+ for editable_item in editables:
+ editable_keys[provider_code].append(editable_item["key"])
+
+ for _, site in system_sites.items():
+ provider = site["provider"]
+ for site_config_key in list(site.keys()):
+ if site_config_key not in editable_keys[provider]:
+ site.pop(site_config_key, None)
return system_sites
diff --git a/openpype/modules/timers_manager/timers_manager.py b/openpype/modules/timers_manager/timers_manager.py
index 0ba68285a4..43286f7da4 100644
--- a/openpype/modules/timers_manager/timers_manager.py
+++ b/openpype/modules/timers_manager/timers_manager.py
@@ -141,7 +141,9 @@ class TimersManager(
signal_handler = SignalHandler(self)
idle_manager = IdleManager()
widget_user_idle = WidgetUserIdle(self)
- widget_user_idle.set_countdown_start(self.time_show_message)
+ widget_user_idle.set_countdown_start(
+ self.time_stop_timer - self.time_show_message
+ )
idle_manager.signal_reset_timer.connect(
widget_user_idle.reset_countdown
diff --git a/openpype/pipeline/create/context.py b/openpype/pipeline/create/context.py
index acc2bb054f..22cab28e4b 100644
--- a/openpype/pipeline/create/context.py
+++ b/openpype/pipeline/create/context.py
@@ -22,7 +22,7 @@ from openpype.lib.attribute_definitions import (
deserialize_attr_defs,
get_default_values,
)
-from openpype.host import IPublishHost
+from openpype.host import IPublishHost, IWorkfileHost
from openpype.pipeline import legacy_io
from openpype.pipeline.plugin_discover import DiscoverResult
@@ -1374,6 +1374,7 @@ class CreateContext:
self._current_project_name = None
self._current_asset_name = None
self._current_task_name = None
+ self._current_workfile_path = None
self._host_is_valid = host_is_valid
# Currently unused variable
@@ -1503,14 +1504,62 @@ class CreateContext:
return os.environ["AVALON_APP"]
def get_current_project_name(self):
+ """Project name which was used as current context on context reset.
+
+ Returns:
+ Union[str, None]: Project name.
+ """
+
return self._current_project_name
def get_current_asset_name(self):
+ """Asset name which was used as current context on context reset.
+
+ Returns:
+ Union[str, None]: Asset name.
+ """
+
return self._current_asset_name
def get_current_task_name(self):
+ """Task name which was used as current context on context reset.
+
+ Returns:
+ Union[str, None]: Task name.
+ """
+
return self._current_task_name
+ def get_current_workfile_path(self):
+ """Workfile path which was opened on context reset.
+
+ Returns:
+ Union[str, None]: Workfile path.
+ """
+
+ return self._current_workfile_path
+
+ @property
+ def context_has_changed(self):
+ """Host context has changed.
+
+ As context is used project, asset, task name and workfile path if
+ host does support workfiles.
+
+ Returns:
+ bool: Context changed.
+ """
+
+ project_name, asset_name, task_name, workfile_path = (
+ self._get_current_host_context()
+ )
+ return (
+ self._current_project_name != project_name
+ or self._current_asset_name != asset_name
+ or self._current_task_name != task_name
+ or self._current_workfile_path != workfile_path
+ )
+
project_name = property(get_current_project_name)
@property
@@ -1575,6 +1624,28 @@ class CreateContext:
self._collection_shared_data = None
self.refresh_thumbnails()
+ def _get_current_host_context(self):
+ project_name = asset_name = task_name = workfile_path = None
+ if hasattr(self.host, "get_current_context"):
+ host_context = self.host.get_current_context()
+ if host_context:
+ project_name = host_context.get("project_name")
+ asset_name = host_context.get("asset_name")
+ task_name = host_context.get("task_name")
+
+ if isinstance(self.host, IWorkfileHost):
+ workfile_path = self.host.get_current_workfile()
+
+ # --- TODO remove these conditions ---
+ if not project_name:
+ project_name = legacy_io.Session.get("AVALON_PROJECT")
+ if not asset_name:
+ asset_name = legacy_io.Session.get("AVALON_ASSET")
+ if not task_name:
+ task_name = legacy_io.Session.get("AVALON_TASK")
+ # ---
+ return project_name, asset_name, task_name, workfile_path
+
def reset_current_context(self):
"""Refresh current context.
@@ -1593,24 +1664,14 @@ class CreateContext:
are stored. We should store the workfile (if is available) too.
"""
- project_name = asset_name = task_name = None
- if hasattr(self.host, "get_current_context"):
- host_context = self.host.get_current_context()
- if host_context:
- project_name = host_context.get("project_name")
- asset_name = host_context.get("asset_name")
- task_name = host_context.get("task_name")
-
- if not project_name:
- project_name = legacy_io.Session.get("AVALON_PROJECT")
- if not asset_name:
- asset_name = legacy_io.Session.get("AVALON_ASSET")
- if not task_name:
- task_name = legacy_io.Session.get("AVALON_TASK")
+ project_name, asset_name, task_name, workfile_path = (
+ self._get_current_host_context()
+ )
self._current_project_name = project_name
self._current_asset_name = asset_name
self._current_task_name = task_name
+ self._current_workfile_path = workfile_path
def reset_plugins(self, discover_publish_plugins=True):
"""Reload plugins.
diff --git a/openpype/pipeline/publish/contants.py b/openpype/pipeline/publish/contants.py
index 169eca2e5c..c5296afe9a 100644
--- a/openpype/pipeline/publish/contants.py
+++ b/openpype/pipeline/publish/contants.py
@@ -1,2 +1,3 @@
DEFAULT_PUBLISH_TEMPLATE = "publish"
DEFAULT_HERO_PUBLISH_TEMPLATE = "hero"
+TRANSIENT_DIR_TEMPLATE = "transient"
diff --git a/openpype/pipeline/publish/lib.py b/openpype/pipeline/publish/lib.py
index 1ec641bac4..81913bcdd5 100644
--- a/openpype/pipeline/publish/lib.py
+++ b/openpype/pipeline/publish/lib.py
@@ -20,13 +20,15 @@ from openpype.settings import (
get_system_settings,
)
from openpype.pipeline import (
- tempdir
+ tempdir,
+ Anatomy
)
from openpype.pipeline.plugin_discover import DiscoverResult
from .contants import (
DEFAULT_PUBLISH_TEMPLATE,
DEFAULT_HERO_PUBLISH_TEMPLATE,
+ TRANSIENT_DIR_TEMPLATE
)
@@ -690,3 +692,79 @@ def get_publish_repre_path(instance, repre, only_published=False):
if os.path.exists(src_path):
return src_path
return None
+
+
+def get_custom_staging_dir_info(project_name, host_name, family, task_name,
+ task_type, subset_name,
+ project_settings=None,
+ anatomy=None, log=None):
+ """Checks profiles if context should use special custom dir as staging.
+
+ Args:
+ project_name (str)
+ host_name (str)
+ family (str)
+ task_name (str)
+ task_type (str)
+ subset_name (str)
+ project_settings(Dict[str, Any]): Prepared project settings.
+ anatomy (Dict[str, Any])
+ log (Logger) (optional)
+
+ Returns:
+ (tuple)
+ Raises:
+ ValueError - if misconfigured template should be used
+ """
+ settings = project_settings or get_project_settings(project_name)
+ custom_staging_dir_profiles = (settings["global"]
+ ["tools"]
+ ["publish"]
+ ["custom_staging_dir_profiles"])
+ if not custom_staging_dir_profiles:
+ return None, None
+
+ if not log:
+ log = Logger.get_logger("get_custom_staging_dir_info")
+
+ filtering_criteria = {
+ "hosts": host_name,
+ "families": family,
+ "task_names": task_name,
+ "task_types": task_type,
+ "subsets": subset_name
+ }
+ profile = filter_profiles(custom_staging_dir_profiles,
+ filtering_criteria,
+ logger=log)
+
+ if not profile or not profile["active"]:
+ return None, None
+
+ if not anatomy:
+ anatomy = Anatomy(project_name)
+
+ template_name = profile["template_name"] or TRANSIENT_DIR_TEMPLATE
+ _validate_transient_template(project_name, template_name, anatomy)
+
+ custom_staging_dir = anatomy.templates[template_name]["folder"]
+ is_persistent = profile["custom_staging_dir_persistent"]
+
+ return custom_staging_dir, is_persistent
+
+
+def _validate_transient_template(project_name, template_name, anatomy):
+ """Check that transient template is correctly configured.
+
+ Raises:
+ ValueError - if misconfigured template
+ """
+ if template_name not in anatomy.templates:
+ raise ValueError(("Anatomy of project \"{}\" does not have set"
+ " \"{}\" template key!"
+ ).format(project_name, template_name))
+
+ if "folder" not in anatomy.templates[template_name]:
+ raise ValueError(("There is not set \"folder\" template in \"{}\" anatomy" # noqa
+ " for project \"{}\"."
+ ).format(template_name, project_name))
diff --git a/openpype/plugins/publish/cleanup.py b/openpype/plugins/publish/cleanup.py
index ef312e391f..b90c88890d 100644
--- a/openpype/plugins/publish/cleanup.py
+++ b/openpype/plugins/publish/cleanup.py
@@ -93,6 +93,10 @@ class CleanUp(pyblish.api.InstancePlugin):
self.log.info("No staging directory found: %s" % staging_dir)
return
+ if instance.data.get("stagingDir_persistent"):
+ self.log.info("Staging dir: %s should be persistent" % staging_dir)
+ return
+
self.log.info("Removing staging directory {}".format(staging_dir))
shutil.rmtree(staging_dir)
diff --git a/openpype/plugins/publish/cleanup_farm.py b/openpype/plugins/publish/cleanup_farm.py
index b87d4698a2..8052f13734 100644
--- a/openpype/plugins/publish/cleanup_farm.py
+++ b/openpype/plugins/publish/cleanup_farm.py
@@ -37,7 +37,7 @@ class CleanUpFarm(pyblish.api.ContextPlugin):
dirpaths_to_remove = set()
for instance in context:
staging_dir = instance.data.get("stagingDir")
- if staging_dir:
+ if staging_dir and not instance.data.get("stagingDir_persistent"):
dirpaths_to_remove.add(os.path.normpath(staging_dir))
if "representations" in instance.data:
diff --git a/openpype/plugins/publish/collect_comment.py b/openpype/plugins/publish/collect_comment.py
index 5be04731ac..9f41e37f22 100644
--- a/openpype/plugins/publish/collect_comment.py
+++ b/openpype/plugins/publish/collect_comment.py
@@ -29,7 +29,7 @@ from openpype.pipeline.publish import OpenPypePyblishPluginMixin
class CollectInstanceCommentDef(
- pyblish.api.ContextPlugin,
+ pyblish.api.InstancePlugin,
OpenPypePyblishPluginMixin
):
label = "Comment per instance"
diff --git a/openpype/plugins/publish/collect_custom_staging_dir.py b/openpype/plugins/publish/collect_custom_staging_dir.py
new file mode 100644
index 0000000000..72ab0fe34d
--- /dev/null
+++ b/openpype/plugins/publish/collect_custom_staging_dir.py
@@ -0,0 +1,67 @@
+"""
+Requires:
+ anatomy
+
+
+Provides:
+ instance.data -> stagingDir (folder path)
+ -> stagingDir_persistent (bool)
+"""
+import copy
+import os.path
+
+import pyblish.api
+
+from openpype.pipeline.publish.lib import get_custom_staging_dir_info
+
+
+class CollectCustomStagingDir(pyblish.api.InstancePlugin):
+ """Looks through profiles if stagingDir should be persistent and in special
+ location.
+
+ Transient staging dir could be useful in specific use cases where is
+ desirable to have temporary renders in specific, persistent folders, could
+ be on disks optimized for speed for example.
+
+ It is studio responsibility to clean up obsolete folders with data.
+
+ Location of the folder is configured in `project_anatomy/templates/others`.
+ ('transient' key is expected, with 'folder' key)
+
+ Which family/task type/subset is applicable is configured in:
+ `project_settings/global/tools/publish/custom_staging_dir_profiles`
+
+ """
+ label = "Collect Custom Staging Directory"
+ order = pyblish.api.CollectorOrder + 0.4990
+
+ template_key = "transient"
+
+ def process(self, instance):
+ family = instance.data["family"]
+ subset_name = instance.data["subset"]
+ host_name = instance.context.data["hostName"]
+ project_name = instance.context.data["projectName"]
+
+ anatomy = instance.context.data["anatomy"]
+ anatomy_data = copy.deepcopy(instance.data["anatomyData"])
+ task = anatomy_data.get("task", {})
+
+ transient_tml, is_persistent = get_custom_staging_dir_info(
+ project_name, host_name, family, task.get("name"),
+ task.get("type"), subset_name, anatomy=anatomy, log=self.log)
+ result_str = "Not adding"
+ if transient_tml:
+ anatomy_data["root"] = anatomy.roots
+ scene_name = instance.context.data.get("currentFile")
+ if scene_name:
+ anatomy_data["scene_name"] = os.path.basename(scene_name)
+ transient_dir = transient_tml.format(**anatomy_data)
+ instance.data["stagingDir"] = transient_dir
+
+ instance.data["stagingDir_persistent"] = is_persistent
+ result_str = "Adding '{}' as".format(transient_dir)
+
+ self.log.info("{} custom staging dir for instance with '{}'".format(
+ result_str, family
+ ))
diff --git a/openpype/plugins/publish/extract_burnin.py b/openpype/plugins/publish/extract_burnin.py
index 621c63a87e..816393f6f9 100644
--- a/openpype/plugins/publish/extract_burnin.py
+++ b/openpype/plugins/publish/extract_burnin.py
@@ -16,9 +16,7 @@ from openpype.lib import (
get_transcode_temp_directory,
convert_input_paths_for_ffmpeg,
- should_convert_for_ffmpeg,
-
- CREATE_NO_WINDOW
+ should_convert_for_ffmpeg
)
from openpype.lib.profiles_filtering import filter_profiles
@@ -255,6 +253,9 @@ class ExtractBurnin(publish.Extractor):
# Add context data burnin_data.
burnin_data["custom"] = custom_data
+ # Add data members.
+ burnin_data.update(instance.data.get("burninDataMembers", {}))
+
# Add source camera name to burnin data
camera_name = repre.get("camera_name")
if camera_name:
@@ -339,8 +340,6 @@ class ExtractBurnin(publish.Extractor):
"logger": self.log,
"env": {}
}
- if platform.system().lower() == "windows":
- process_kwargs["creationflags"] = CREATE_NO_WINDOW
run_openpype_process(*args, **process_kwargs)
# Remove the temporary json
@@ -730,7 +729,6 @@ class ExtractBurnin(publish.Extractor):
return filtered_burnin_defs
families = self.families_from_instance(instance)
- low_families = [family.lower() for family in families]
for filename_suffix, orig_burnin_def in burnin_defs.items():
burnin_def = copy.deepcopy(orig_burnin_def)
@@ -741,7 +739,7 @@ class ExtractBurnin(publish.Extractor):
families_filters = def_filter["families"]
if not self.families_filter_validation(
- low_families, families_filters
+ families, families_filters
):
self.log.debug((
"Skipped burnin definition \"{}\". Family"
@@ -778,31 +776,19 @@ class ExtractBurnin(publish.Extractor):
return filtered_burnin_defs
def families_filter_validation(self, families, output_families_filter):
- """Determine if entered families intersect with families filters.
+ """Determines if entered families intersect with families filters.
All family values are lowered to avoid unexpected results.
"""
- if not output_families_filter:
+
+ families_filter_lower = set(family.lower() for family in
+ output_families_filter
+ # Exclude empty filter values
+ if family)
+ if not families_filter_lower:
return True
-
- for family_filter in output_families_filter:
- if not family_filter:
- continue
-
- if not isinstance(family_filter, (list, tuple)):
- if family_filter.lower() not in families:
- continue
- return True
-
- valid = True
- for family in family_filter:
- if family.lower() not in families:
- valid = False
- break
-
- if valid:
- return True
- return False
+ return any(family.lower() in families_filter_lower
+ for family in families)
def families_from_instance(self, instance):
"""Return all families of entered instance."""
diff --git a/openpype/plugins/publish/integrate.py b/openpype/plugins/publish/integrate.py
index b117006871..760b1a6b37 100644
--- a/openpype/plugins/publish/integrate.py
+++ b/openpype/plugins/publish/integrate.py
@@ -24,7 +24,10 @@ from openpype.client import (
get_version_by_name,
)
from openpype.lib import source_hash
-from openpype.lib.file_transaction import FileTransaction
+from openpype.lib.file_transaction import (
+ FileTransaction,
+ DuplicateDestinationError
+)
from openpype.pipeline.publish import (
KnownPublishError,
get_publish_template_name,
@@ -80,10 +83,12 @@ class IntegrateAsset(pyblish.api.InstancePlugin):
order = pyblish.api.IntegratorOrder
families = ["workfile",
"pointcache",
+ "pointcloud",
"proxyAbc",
"camera",
"animation",
"model",
+ "maxScene",
"mayaAscii",
"mayaScene",
"setdress",
@@ -168,9 +173,18 @@ class IntegrateAsset(pyblish.api.InstancePlugin):
).format(instance.data["family"]))
return
- file_transactions = FileTransaction(log=self.log)
+ file_transactions = FileTransaction(log=self.log,
+ # Enforce unique transfers
+ allow_queue_replacements=False)
try:
self.register(instance, file_transactions, filtered_repres)
+ except DuplicateDestinationError as exc:
+ # Raise DuplicateDestinationError as KnownPublishError
+ # and rollback the transactions
+ file_transactions.rollback()
+ six.reraise(KnownPublishError,
+ KnownPublishError(exc),
+ sys.exc_info()[2])
except Exception:
# clean destination
# todo: preferably we'd also rollback *any* changes to the database
diff --git a/openpype/plugins/publish/integrate_legacy.py b/openpype/plugins/publish/integrate_legacy.py
index b93abab1d8..1d0177f151 100644
--- a/openpype/plugins/publish/integrate_legacy.py
+++ b/openpype/plugins/publish/integrate_legacy.py
@@ -76,10 +76,12 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
order = pyblish.api.IntegratorOrder + 0.00001
families = ["workfile",
"pointcache",
+ "pointcloud",
"proxyAbc",
"camera",
"animation",
"model",
+ "maxScene",
"mayaAscii",
"mayaScene",
"setdress",
diff --git a/openpype/plugins/publish/preintegrate_thumbnail_representation.py b/openpype/plugins/publish/preintegrate_thumbnail_representation.py
index b88ccee9dc..1c95b82c97 100644
--- a/openpype/plugins/publish/preintegrate_thumbnail_representation.py
+++ b/openpype/plugins/publish/preintegrate_thumbnail_representation.py
@@ -60,6 +60,8 @@ class PreIntegrateThumbnails(pyblish.api.InstancePlugin):
if not found_profile:
return
+ thumbnail_repre.setdefault("tags", [])
+
if not found_profile["integrate_thumbnail"]:
if "delete" not in thumbnail_repre["tags"]:
thumbnail_repre["tags"].append("delete")
diff --git a/openpype/pype_commands.py b/openpype/pype_commands.py
index 932fdc9be4..dc5b3d63c3 100644
--- a/openpype/pype_commands.py
+++ b/openpype/pype_commands.py
@@ -270,7 +270,7 @@ class PypeCommands:
pass
def run_tests(self, folder, mark, pyargs,
- test_data_folder, persist, app_variant, timeout):
+ test_data_folder, persist, app_variant, timeout, setup_only):
"""
Runs tests from 'folder'
@@ -311,6 +311,9 @@ class PypeCommands:
if timeout:
args.extend(["--timeout", timeout])
+ if setup_only:
+ args.extend(["--setup_only", setup_only])
+
print("run_tests args: {}".format(args))
import pytest
pytest.main(args)
diff --git a/openpype/scripts/otio_burnin.py b/openpype/scripts/otio_burnin.py
index cb4646c099..d0a4266941 100644
--- a/openpype/scripts/otio_burnin.py
+++ b/openpype/scripts/otio_burnin.py
@@ -4,8 +4,10 @@ import re
import subprocess
import platform
import json
-import opentimelineio_contrib.adapters.ffmpeg_burnins as ffmpeg_burnins
+import tempfile
+from string import Formatter
+import opentimelineio_contrib.adapters.ffmpeg_burnins as ffmpeg_burnins
from openpype.lib import (
get_ffmpeg_tool_path,
get_ffmpeg_codec_args,
@@ -23,7 +25,7 @@ FFMPEG = (
).format(ffmpeg_path)
DRAWTEXT = (
- "drawtext=fontfile='%(font)s':text=\\'%(text)s\\':"
+ "drawtext@'%(label)s'=fontfile='%(font)s':text=\\'%(text)s\\':"
"x=%(x)s:y=%(y)s:fontcolor=%(color)s@%(opacity).1f:fontsize=%(size)d"
)
TIMECODE = (
@@ -39,6 +41,45 @@ TIMECODE_KEY = "{timecode}"
SOURCE_TIMECODE_KEY = "{source_timecode}"
+def convert_list_to_command(list_to_convert, fps, label=""):
+ """Convert a list of values to a drawtext command file for ffmpeg `sendcmd`
+
+ The list of values is expected to have a value per frame. If the video
+ file ends up being longer than the amount of samples per frame than the
+ last value will be held.
+
+ Args:
+ list_to_convert (list): List of values per frame.
+ fps (float or int): The expected frame per seconds of the output file.
+ label (str): Label for the drawtext, if specific drawtext filter is
+ required
+
+ Returns:
+ str: Filepath to the temporary drawtext command file.
+
+ """
+
+ with tempfile.NamedTemporaryFile(mode="w", delete=False) as f:
+ for i, value in enumerate(list_to_convert):
+ seconds = i / fps
+
+ # Escape special character
+ value = str(value).replace(":", "\\:")
+
+ filter = "drawtext"
+ if label:
+ filter += "@" + label
+
+ line = (
+ "{start} {filter} reinit text='{value}';"
+ "\n".format(start=seconds, filter=filter, value=value)
+ )
+
+ f.write(line)
+ f.flush()
+ return f.name
+
+
def _get_ffprobe_data(source):
"""Reimplemented from otio burnins to be able use full path to ffprobe
:param str source: source media file
@@ -144,7 +185,13 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
self.options_init.update(options_init)
def add_text(
- self, text, align, frame_start=None, frame_end=None, options=None
+ self,
+ text,
+ align,
+ frame_start=None,
+ frame_end=None,
+ options=None,
+ cmd=""
):
"""
Adding static text to a filter.
@@ -165,7 +212,13 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
if frame_end is not None:
options["frame_end"] = frame_end
- self._add_burnin(text, align, options, DRAWTEXT)
+ draw_text = DRAWTEXT
+ if cmd:
+ draw_text = "{}, {}".format(cmd, DRAWTEXT)
+
+ options["label"] = align
+
+ self._add_burnin(text, align, options, draw_text)
def add_timecode(
self, align, frame_start=None, frame_end=None, frame_start_tc=None,
@@ -345,12 +398,6 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
"stderr": subprocess.PIPE,
"shell": True,
}
- if platform.system().lower() == "windows":
- kwargs["creationflags"] = (
- subprocess.CREATE_NEW_PROCESS_GROUP
- | getattr(subprocess, "DETACHED_PROCESS", 0)
- | getattr(subprocess, "CREATE_NO_WINDOW", 0)
- )
proc = subprocess.Popen(command, **kwargs)
_stdout, _stderr = proc.communicate()
@@ -414,11 +461,13 @@ def burnins_from_data(
True by default.
Presets must be set separately. Should be dict with 2 keys:
- - "options" - sets look of burnins - colors, opacity,...(more info: ModifiedBurnins doc)
+ - "options" - sets look of burnins - colors, opacity,...
+ (more info: ModifiedBurnins doc)
- *OPTIONAL* default values are used when not included
- "burnins" - contains dictionary with burnins settings
- *OPTIONAL* burnins won't be added (easier is not to use this)
- - each key of "burnins" represents Alignment, there are 6 possibilities:
+ - each key of "burnins" represents Alignment,
+ there are 6 possibilities:
TOP_LEFT TOP_CENTERED TOP_RIGHT
BOTTOM_LEFT BOTTOM_CENTERED BOTTOM_RIGHT
- value must be string with text you want to burn-in
@@ -497,13 +546,14 @@ def burnins_from_data(
if source_timecode is not None:
data[SOURCE_TIMECODE_KEY[1:-1]] = SOURCE_TIMECODE_KEY
+ clean_up_paths = []
for align_text, value in burnin_values.items():
if not value:
continue
- if isinstance(value, (dict, list, tuple)):
+ if isinstance(value, dict):
raise TypeError((
- "Expected string or number type."
+ "Expected string, number or list type."
" Got: {} - \"{}\""
" (Make sure you have new burnin presets)."
).format(str(type(value)), str(value)))
@@ -539,8 +589,48 @@ def burnins_from_data(
print("Source does not have set timecode value.")
value = value.replace(SOURCE_TIMECODE_KEY, MISSING_KEY_VALUE)
- key_pattern = re.compile(r"(\{.*?[^{0]*\})")
+ # Convert lists.
+ cmd = ""
+ text = None
+ keys = [i[1] for i in Formatter().parse(value) if i[1] is not None]
+ list_to_convert = []
+ # Warn about nested dictionary support for lists. Ei. we dont support
+ # it.
+ if "[" in "".join(keys):
+ print(
+ "We dont support converting nested dictionaries to lists,"
+ " so skipping {}".format(value)
+ )
+ else:
+ for key in keys:
+ data_value = data[key]
+
+ # Multiple lists are not supported.
+ if isinstance(data_value, list) and list_to_convert:
+ raise ValueError(
+ "Found multiple lists to convert, which is not "
+ "supported: {}".format(value)
+ )
+
+ if isinstance(data_value, list):
+ print("Found list to convert: {}".format(data_value))
+ for v in data_value:
+ data[key] = v
+ list_to_convert.append(value.format(**data))
+
+ if list_to_convert:
+ value = list_to_convert[0]
+ path = convert_list_to_command(
+ list_to_convert, data["fps"], label=align
+ )
+ cmd = "sendcmd=f='{}'".format(path)
+ cmd = cmd.replace("\\", "/")
+ cmd = cmd.replace(":", "\\:")
+ clean_up_paths.append(path)
+
+ # Failsafe for missing keys.
+ key_pattern = re.compile(r"(\{.*?[^{0]*\})")
missing_keys = []
for group in key_pattern.findall(value):
try:
@@ -574,7 +664,8 @@ def burnins_from_data(
continue
text = value.format(**data)
- burnin.add_text(text, align, frame_start, frame_end)
+
+ burnin.add_text(text, align, frame_start, frame_end, cmd=cmd)
ffmpeg_args = []
if codec_data:
@@ -605,6 +696,8 @@ def burnins_from_data(
burnin.render(
output_path, args=ffmpeg_args_str, overwrite=overwrite, **data
)
+ for path in clean_up_paths:
+ os.remove(path)
if __name__ == "__main__":
diff --git a/openpype/settings/defaults/project_anatomy/templates.json b/openpype/settings/defaults/project_anatomy/templates.json
index 02c0e35377..e5e535bf19 100644
--- a/openpype/settings/defaults/project_anatomy/templates.json
+++ b/openpype/settings/defaults/project_anatomy/templates.json
@@ -58,12 +58,16 @@
"file": "{originalBasename}.{ext}",
"path": "{@folder}/{@file}"
},
+ "transient": {
+ "folder": "{root[work]}/{project[name]}/{hierarchy}/{asset}/work/{family}/{subset}"
+ },
"__dynamic_keys_labels__": {
"maya2unreal": "Maya to Unreal",
"simpleUnrealTextureHero": "Simple Unreal Texture - Hero",
"simpleUnrealTexture": "Simple Unreal Texture",
"online": "online",
- "source": "source"
+ "source": "source",
+ "transient": "transient"
}
}
}
diff --git a/openpype/settings/defaults/project_settings/applications.json b/openpype/settings/defaults/project_settings/applications.json
new file mode 100644
index 0000000000..62f3cdfe1b
--- /dev/null
+++ b/openpype/settings/defaults/project_settings/applications.json
@@ -0,0 +1,3 @@
+{
+ "only_available": false
+}
diff --git a/openpype/settings/defaults/project_settings/blender.json b/openpype/settings/defaults/project_settings/blender.json
index fe05f94590..20eec0c09d 100644
--- a/openpype/settings/defaults/project_settings/blender.json
+++ b/openpype/settings/defaults/project_settings/blender.json
@@ -80,6 +80,94 @@
"enabled": true,
"optional": true,
"active": false
+ },
+ "ExtractThumbnail": {
+ "enabled": true,
+ "optional": true,
+ "active": true,
+ "presets": {
+ "model": {
+ "image_settings": {
+ "file_format": "JPEG",
+ "color_mode": "RGB",
+ "quality": 100
+ },
+ "display_options": {
+ "shading": {
+ "light": "STUDIO",
+ "studio_light": "Default",
+ "type": "SOLID",
+ "color_type": "OBJECT",
+ "show_xray": false,
+ "show_shadows": false,
+ "show_cavity": true
+ },
+ "overlay": {
+ "show_overlays": false
+ }
+ }
+ },
+ "rig": {
+ "image_settings": {
+ "file_format": "JPEG",
+ "color_mode": "RGB",
+ "quality": 100
+ },
+ "display_options": {
+ "shading": {
+ "light": "STUDIO",
+ "studio_light": "Default",
+ "type": "SOLID",
+ "color_type": "OBJECT",
+ "show_xray": true,
+ "show_shadows": false,
+ "show_cavity": false
+ },
+ "overlay": {
+ "show_overlays": true,
+ "show_ortho_grid": false,
+ "show_floor": false,
+ "show_axis_x": false,
+ "show_axis_y": false,
+ "show_axis_z": false,
+ "show_text": false,
+ "show_stats": false,
+ "show_cursor": false,
+ "show_annotation": false,
+ "show_extras": false,
+ "show_relationship_lines": false,
+ "show_outline_selected": false,
+ "show_motion_paths": false,
+ "show_object_origins": false,
+ "show_bones": true
+ }
+ }
+ }
+ }
+ },
+ "ExtractPlayblast": {
+ "enabled": true,
+ "optional": true,
+ "active": true,
+ "presets": {
+ "default": {
+ "image_settings": {
+ "file_format": "PNG",
+ "color_mode": "RGB",
+ "color_depth": "8",
+ "compression": 15
+ },
+ "display_options": {
+ "shading": {
+ "type": "MATERIAL",
+ "render_pass": "COMBINED"
+ },
+ "overlay": {
+ "show_overlays": false
+ }
+ }
+ }
+ }
}
}
}
diff --git a/openpype/settings/defaults/project_settings/celaction.json b/openpype/settings/defaults/project_settings/celaction.json
index bdba6d7322..822604fd2f 100644
--- a/openpype/settings/defaults/project_settings/celaction.json
+++ b/openpype/settings/defaults/project_settings/celaction.json
@@ -9,6 +9,13 @@
"rules": {}
}
},
+ "workfile": {
+ "submission_overrides": [
+ "render_chunk",
+ "frame_range",
+ "resolution"
+ ]
+ },
"publish": {
"CollectRenderPath": {
"output_extension": "png",
diff --git a/openpype/settings/defaults/project_settings/deadline.json b/openpype/settings/defaults/project_settings/deadline.json
index 6b6f2d465b..fdd70f1a44 100644
--- a/openpype/settings/defaults/project_settings/deadline.json
+++ b/openpype/settings/defaults/project_settings/deadline.json
@@ -23,7 +23,7 @@
"enabled": true,
"optional": false,
"active": true,
- "tile_assembler_plugin": "OpenPypeTileAssembler",
+ "tile_assembler_plugin": "DraftTileAssembler",
"use_published": true,
"import_reference": false,
"asset_dependencies": true,
@@ -43,10 +43,7 @@
"use_published": true,
"priority": 50,
"chunk_size": 10,
- "group": "none",
- "deadline_pool": "",
- "deadline_pool_secondary": "",
- "framePerTask": 1
+ "group": "none"
},
"NukeSubmitDeadline": {
"enabled": true,
diff --git a/openpype/settings/defaults/project_settings/fusion.json b/openpype/settings/defaults/project_settings/fusion.json
index 954606820a..f974eebaca 100644
--- a/openpype/settings/defaults/project_settings/fusion.json
+++ b/openpype/settings/defaults/project_settings/fusion.json
@@ -16,5 +16,10 @@
"linux": []
}
}
+ },
+ "copy_fusion_settings": {
+ "copy_path": "~/.openpype/hosts/fusion/profiles",
+ "copy_status": false,
+ "force_sync": false
}
}
diff --git a/openpype/settings/defaults/project_settings/global.json b/openpype/settings/defaults/project_settings/global.json
index aad17d54da..30e56300d1 100644
--- a/openpype/settings/defaults/project_settings/global.json
+++ b/openpype/settings/defaults/project_settings/global.json
@@ -249,6 +249,29 @@
}
}
}
+ },
+ {
+ "families": [],
+ "hosts": [
+ "maya"
+ ],
+ "task_types": [],
+ "task_names": [],
+ "subsets": [],
+ "burnins": {
+ "maya_burnin": {
+ "TOP_LEFT": "{yy}-{mm}-{dd}",
+ "TOP_CENTERED": "{focalLength:.2f} mm",
+ "TOP_RIGHT": "{anatomy[version]}",
+ "BOTTOM_LEFT": "{username}",
+ "BOTTOM_CENTERED": "{asset}",
+ "BOTTOM_RIGHT": "{frame_start}-{current_frame}-{frame_end}",
+ "filter": {
+ "families": [],
+ "tags": []
+ }
+ }
+ }
}
]
},
@@ -591,7 +614,8 @@
"task_names": [],
"template_name": "simpleUnrealTextureHero"
}
- ]
+ ],
+ "custom_staging_dir_profiles": []
}
},
"project_folder_structure": "{\"__project_root__\": {\"prod\": {}, \"resources\": {\"footage\": {\"plates\": {}, \"offline\": {}}, \"audio\": {}, \"art_dept\": {}}, \"editorial\": {}, \"assets\": {\"characters\": {}, \"locations\": {}}, \"shots\": {}}}",
diff --git a/openpype/settings/defaults/project_settings/kitsu.json b/openpype/settings/defaults/project_settings/kitsu.json
index 95b3da04ae..59a36d8b97 100644
--- a/openpype/settings/defaults/project_settings/kitsu.json
+++ b/openpype/settings/defaults/project_settings/kitsu.json
@@ -7,7 +7,15 @@
"publish": {
"IntegrateKitsuNote": {
"set_status_note": false,
- "note_status_shortname": "wfa"
+ "note_status_shortname": "wfa",
+ "status_change_conditions": {
+ "status_conditions": [],
+ "family_requirements": []
+ },
+ "custom_comment_template": {
+ "enabled": false,
+ "comment_template": "{comment}\n\n| | |\n|--|--|\n| version| `{version}` |\n| family | `{family}` |\n| name | `{name}` |"
+ }
}
}
}
diff --git a/openpype/settings/defaults/project_settings/max.json b/openpype/settings/defaults/project_settings/max.json
index 667b42411d..d59cdf8c4a 100644
--- a/openpype/settings/defaults/project_settings/max.json
+++ b/openpype/settings/defaults/project_settings/max.json
@@ -4,5 +4,20 @@
"aov_separator": "underscore",
"image_format": "exr",
"multipass": true
+ },
+ "PointCloud":{
+ "attribute":{
+ "Age": "age",
+ "Radius": "radius",
+ "Position": "position",
+ "Rotation": "rotation",
+ "Scale": "scale",
+ "Velocity": "velocity",
+ "Color": "color",
+ "TextureCoordinate": "texcoord",
+ "MaterialID": "matid",
+ "custFloats": "custFloats",
+ "custVecs": "custVecs"
+ }
}
}
diff --git a/openpype/settings/defaults/project_settings/maya.json b/openpype/settings/defaults/project_settings/maya.json
index dca0b95293..e914eb29f9 100644
--- a/openpype/settings/defaults/project_settings/maya.json
+++ b/openpype/settings/defaults/project_settings/maya.json
@@ -147,6 +147,7 @@
"enabled": true,
"write_color_sets": false,
"write_face_sets": false,
+ "include_parent_hierarchy": false,
"include_user_defined_attributes": false,
"defaults": [
"Main"
@@ -330,6 +331,11 @@
"optional": true,
"active": true
},
+ "ValidateMayaColorSpace": {
+ "enabled": true,
+ "optional": true,
+ "active": true
+ },
"ValidateAttributes": {
"enabled": false,
"attributes": {}
@@ -784,7 +790,7 @@
"ExtractPlayblast": {
"capture_preset": {
"Codec": {
- "compression": "jpg",
+ "compression": "png",
"format": "image",
"quality": 95
},
@@ -811,7 +817,8 @@
},
"Generic": {
"isolate_view": true,
- "off_screen": true
+ "off_screen": true,
+ "pan_zoom": false
},
"Renderer": {
"rendererName": "vp2Renderer"
diff --git a/openpype/settings/defaults/project_settings/tvpaint.json b/openpype/settings/defaults/project_settings/tvpaint.json
index 9173a8c3d5..1671748e97 100644
--- a/openpype/settings/defaults/project_settings/tvpaint.json
+++ b/openpype/settings/defaults/project_settings/tvpaint.json
@@ -42,6 +42,7 @@
"default_variants": []
},
"auto_detect_render": {
+ "enabled": false,
"allow_group_rename": true,
"group_name_template": "L{group_index}",
"group_idx_offset": 10,
diff --git a/openpype/settings/defaults/system_settings/applications.json b/openpype/settings/defaults/system_settings/applications.json
index 5fd9b926fb..eb3a88ce66 100644
--- a/openpype/settings/defaults/system_settings/applications.json
+++ b/openpype/settings/defaults/system_settings/applications.json
@@ -133,7 +133,7 @@
"linux": []
},
"arguments": {
- "windows": [],
+ "windows": ["-U MAXScript {OPENPYPE_ROOT}\\openpype\\hosts\\max\\startup\\startup.ms"],
"darwin": [],
"linux": []
},
diff --git a/openpype/settings/entities/schemas/README.md b/openpype/settings/entities/schemas/README.md
index b4c878fe0f..cff614a4bb 100644
--- a/openpype/settings/entities/schemas/README.md
+++ b/openpype/settings/entities/schemas/README.md
@@ -350,7 +350,7 @@ How output of the schema could look like on save:
- number input, can be used for both integer and float
- key `"decimal"` defines how many decimal places will be used, 0 is for integer input (Default: `0`)
- key `"minimum"` as minimum allowed number to enter (Default: `-99999`)
- - key `"maxium"` as maximum allowed number to enter (Default: `99999`)
+ - key `"maximum"` as maximum allowed number to enter (Default: `99999`)
- key `"steps"` will change single step value of UI inputs (using arrows and wheel scroll)
- for UI it is possible to show slider to enable this option set `show_slider` to `true`
```
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_main.json b/openpype/settings/entities/schemas/projects_schema/schema_main.json
index ebe59c7942..8c1d8ccbdd 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_main.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_main.json
@@ -82,6 +82,10 @@
"type": "schema",
"name": "schema_project_slack"
},
+ {
+ "type": "schema",
+ "name": "schema_project_applications"
+ },
{
"type": "schema",
"name": "schema_project_max"
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_applications.json b/openpype/settings/entities/schemas/projects_schema/schema_project_applications.json
new file mode 100644
index 0000000000..030ed3ee8a
--- /dev/null
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_applications.json
@@ -0,0 +1,14 @@
+{
+ "type": "dict",
+ "key": "applications",
+ "label": "Applications",
+ "collapsible": true,
+ "is_file": true,
+ "children": [
+ {
+ "type": "boolean",
+ "key": "only_available",
+ "label": "Show only available applications"
+ }
+ ]
+}
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_celaction.json b/openpype/settings/entities/schemas/projects_schema/schema_project_celaction.json
index 2320d9ae26..c5ca3eb9f5 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_celaction.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_celaction.json
@@ -22,6 +22,31 @@
]
},
+ {
+ "type": "dict",
+ "collapsible": true,
+ "key": "workfile",
+ "label": "Workfile",
+ "children": [
+ {
+ "key": "submission_overrides",
+ "label": "Submission workfile overrides",
+ "type": "enum",
+ "multiselection": true,
+ "enum_items": [
+ {
+ "render_chunk": "Pass chunk size"
+ },
+ {
+ "frame_range": "Pass frame range"
+ },
+ {
+ "resolution": "Pass resolution"
+ }
+ ]
+ }
+ ]
+ },
{
"type": "dict",
"collapsible": true,
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json b/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json
index bb5a65e1b7..d8b5e4dc1f 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json
@@ -121,7 +121,7 @@
"DraftTileAssembler": "Draft Tile Assembler"
},
{
- "OpenPypeTileAssembler": "Open Image IO"
+ "OpenPypeTileAssembler": "OpenPype Tile Assembler"
}
]
},
@@ -239,27 +239,12 @@
{
"type": "number",
"key": "chunk_size",
- "label": "Chunk Size"
+ "label": "Frame per Task"
},
{
"type": "text",
"key": "group",
"label": "Group Name"
- },
- {
- "type": "text",
- "key": "deadline_pool",
- "label": "Deadline pool"
- },
- {
- "type": "text",
- "key": "deadline_pool_secondary",
- "label": "Deadline pool (secondary)"
- },
- {
- "type": "number",
- "key": "framePerTask",
- "label": "Frame Per Task"
}
]
},
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json b/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json
index 8c62d75815..464cf2c06d 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json
@@ -45,6 +45,29 @@
]
}
]
+ },
+ {
+ "type": "dict",
+ "key": "copy_fusion_settings",
+ "collapsible": true,
+ "label": "Local Fusion profile settings",
+ "children": [
+ {
+ "key": "copy_path",
+ "type": "path",
+ "label": "Local Fusion profile directory"
+ },
+ {
+ "type": "boolean",
+ "key": "copy_status",
+ "label": "Copy profile on first launch"
+ },
+ {
+ "key":"force_sync",
+ "type": "boolean",
+ "label": "Resync profile on each launch"
+ }
+ ]
}
]
}
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_kitsu.json b/openpype/settings/entities/schemas/projects_schema/schema_project_kitsu.json
index fb47670e74..8aeed00542 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_kitsu.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_kitsu.json
@@ -46,12 +46,94 @@
{
"type": "boolean",
"key": "set_status_note",
- "label": "Set status on note"
+ "label": "Set status with note"
},
{
"type": "text",
"key": "note_status_shortname",
"label": "Note shortname"
+ },
+ {
+ "type": "dict",
+ "collapsible": true,
+ "key": "status_change_conditions",
+ "label": "Status change conditions",
+ "children": [
+ {
+ "type": "list",
+ "key": "status_conditions",
+ "label": "Status conditions",
+ "object_type": {
+ "type": "dict",
+ "key": "condition_dict",
+ "children": [
+ {
+ "type": "enum",
+ "key": "condition",
+ "label": "Condition",
+ "enum_items": [
+ {"equal": "Equal"},
+ {"not_equal": "Not equal"}
+ ]
+ },
+ {
+ "type": "text",
+ "key": "short_name",
+ "label": "Short name"
+ }
+ ]
+ }
+ },
+ {
+ "type": "list",
+ "key": "family_requirements",
+ "label": "Family requirements",
+ "object_type": {
+ "type": "dict",
+ "key": "requirement_dict",
+ "children": [
+ {
+ "type": "enum",
+ "key": "condition",
+ "label": "Condition",
+ "enum_items": [
+ {"equal": "Equal"},
+ {"not_equal": "Not equal"}
+ ]
+ },
+ {
+ "type": "text",
+ "key": "family",
+ "label": "Family"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "type": "dict",
+ "collapsible": true,
+ "checkbox_key": "enabled",
+ "key": "custom_comment_template",
+ "label": "Custom Comment Template",
+ "children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
+ {
+ "type": "label",
+ "label": "Kitsu supports markdown and here you can create a custom comment template. You can use data from your publishing instance's data."
+ },
+ {
+ "key": "comment_template",
+ "type": "text",
+ "multiline": true,
+ "label": "Custom comment"
+ }
+ ]
}
]
}
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_max.json b/openpype/settings/entities/schemas/projects_schema/schema_project_max.json
index 8a283c1acc..4fba9aff0a 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_max.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_max.json
@@ -51,6 +51,28 @@
"label": "multipass"
}
]
+ },
+ {
+ "type": "dict",
+ "collapsible": true,
+ "key": "PointCloud",
+ "label": "Point Cloud",
+ "children": [
+ {
+ "type": "label",
+ "label": "Define the channel attribute names before exporting as PRT"
+ },
+ {
+ "type": "dict-modifiable",
+ "collapsible": true,
+ "key": "attribute",
+ "label": "Channel Attribute",
+ "use_label_wrap": true,
+ "object_type": {
+ "type": "text"
+ }
+ }
+ ]
}
]
-}
\ No newline at end of file
+}
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_tvpaint.json b/openpype/settings/entities/schemas/projects_schema/schema_project_tvpaint.json
index 708b688ba5..1094595851 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_tvpaint.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_tvpaint.json
@@ -202,7 +202,13 @@
"key": "auto_detect_render",
"label": "Auto-Detect Create Render",
"is_group": true,
+ "checkbox_key": "enabled",
"children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
{
"type": "label",
"label": "The creator tries to auto-detect Render Layers and Render Passes in scene. For Render Layers is used group name as a variant and for Render Passes is used TVPaint layer name.
Group names can be renamed by their used order in scene. The renaming template where can be used {group_index} formatting key which is filled by \"used position index of group\". - Template: L{group_index} - Group offset: 10 - Group padding: 3 Would create group names \"L010\", \"L020\", ..."
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_blender_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_blender_publish.json
index 53949f65cb..1037519f57 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_blender_publish.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_blender_publish.json
@@ -112,6 +112,66 @@
"label": "Extract Layout as JSON"
}
]
+ },
+ {
+ "type": "dict",
+ "collapsible": true,
+ "key": "ExtractThumbnail",
+ "label": "ExtractThumbnail",
+ "checkbox_key": "enabled",
+ "is_group": true,
+ "children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
+ {
+ "type": "boolean",
+ "key": "optional",
+ "label": "Optional"
+ },
+ {
+ "type": "boolean",
+ "key": "active",
+ "label": "Active"
+ },
+ {
+ "type": "raw-json",
+ "key": "presets",
+ "label": "Presets"
+ }
+ ]
+ },
+ {
+ "type": "dict",
+ "collapsible": true,
+ "key": "ExtractPlayblast",
+ "label": "ExtractPlayblast",
+ "checkbox_key": "enabled",
+ "is_group": true,
+ "children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
+ {
+ "type": "boolean",
+ "key": "optional",
+ "label": "Optional"
+ },
+ {
+ "type": "boolean",
+ "key": "active",
+ "label": "Active"
+ },
+ {
+ "type": "raw-json",
+ "key": "presets",
+ "label": "Presets"
+ }
+ ]
}
]
-}
+}
\ No newline at end of file
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_tools.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_tools.json
index 962008d476..85ec482e73 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_tools.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_tools.json
@@ -408,6 +408,71 @@
}
]
}
+ },
+ {
+ "type": "list",
+ "key": "custom_staging_dir_profiles",
+ "label": "Custom Staging Dir Profiles",
+ "use_label_wrap": true,
+ "docstring": "Profiles to specify special location and persistence for staging dir. Could be used in Creators and Publish phase!",
+ "object_type": {
+ "type": "dict",
+ "children": [
+ {
+ "type": "boolean",
+ "key": "active",
+ "label": "Is active",
+ "default": true
+ },
+ {
+ "type": "separator"
+ },
+ {
+ "key": "hosts",
+ "label": "Host names",
+ "type": "hosts-enum",
+ "multiselection": true
+ },
+ {
+ "key": "task_types",
+ "label": "Task types",
+ "type": "task-types-enum"
+ },
+ {
+ "key": "task_names",
+ "label": "Task names",
+ "type": "list",
+ "object_type": "text"
+ },
+ {
+ "key": "families",
+ "label": "Families",
+ "type": "list",
+ "object_type": "text"
+ },
+ {
+ "key": "subsets",
+ "label": "Subset names",
+ "type": "list",
+ "object_type": "text"
+ },
+ {
+ "type": "separator"
+ },
+ {
+ "key": "custom_staging_dir_persistent",
+ "label": "Custom Staging Folder Persistent",
+ "type": "boolean",
+ "default": false
+ },
+ {
+ "key": "template_name",
+ "label": "Template Name",
+ "type": "text",
+ "placeholder": "transient"
+ }
+ ]
+ }
}
]
}
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_capture.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_capture.json
index 1f0e4eeffb..416e530db2 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_capture.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_capture.json
@@ -19,12 +19,12 @@
{
"type": "text",
"key": "compression",
- "label": "Compression type"
+ "label": "Encoding"
},
{
"type": "text",
"key": "format",
- "label": "Data format"
+ "label": "Format"
},
{
"type": "number",
@@ -91,6 +91,11 @@
"type": "boolean",
"key": "off_screen",
"label": " Off Screen"
+ },
+ {
+ "type": "boolean",
+ "key": "pan_zoom",
+ "label": " 2D Pan/Zoom"
}
]
},
@@ -156,7 +161,7 @@
{
"type": "boolean",
"key": "override_viewport_options",
- "label": "override_viewport_options"
+ "label": "Override Viewport Options"
},
{
"type": "enum",
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_create.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_create.json
index 1598f90643..d6e6c97b8c 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_create.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_create.json
@@ -132,6 +132,11 @@
"key": "write_face_sets",
"label": "Write Face Sets"
},
+ {
+ "type": "boolean",
+ "key": "include_parent_hierarchy",
+ "label": "Include Parent Hierarchy"
+ },
{
"type": "boolean",
"key": "include_user_defined_attributes",
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_publish.json
index 994e2d0032..5a66f8a513 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_publish.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_publish.json
@@ -144,6 +144,10 @@
{
"key": "ValidateShadingEngine",
"label": "Validate Look Shading Engine Naming"
+ },
+ {
+ "key": "ValidateMayaColorSpace",
+ "label": "ValidateMayaColorSpace"
}
]
},
@@ -365,7 +369,8 @@
"label": "Arnold Render Attributes",
"use_label_wrap": true,
"object_type": {
- "type": "text"
+ "type": "list",
+ "object_type": "text"
}
},
{
@@ -375,7 +380,8 @@
"label": "Vray Render Attributes",
"use_label_wrap": true,
"object_type": {
- "type": "text"
+ "type": "list",
+ "object_type": "text"
}
},
{
@@ -385,7 +391,8 @@
"label": "Redshift Render Attributes",
"use_label_wrap": true,
"object_type": {
- "type": "text"
+ "type": "list",
+ "object_type": "text"
}
},
{
@@ -395,7 +402,8 @@
"label": "Renderman Render Attributes",
"use_label_wrap": true,
"object_type": {
- "type": "text"
+ "type": "list",
+ "object_type": "text"
}
}
]
diff --git a/openpype/tools/launcher/models.py b/openpype/tools/launcher/models.py
index 6c763544a9..3aa6c5d8cb 100644
--- a/openpype/tools/launcher/models.py
+++ b/openpype/tools/launcher/models.py
@@ -19,6 +19,7 @@ from openpype.lib.applications import (
CUSTOM_LAUNCH_APP_GROUPS,
ApplicationManager
)
+from openpype.settings import get_project_settings
from openpype.pipeline import discover_launcher_actions
from openpype.tools.utils.lib import (
DynamicQThread,
@@ -94,6 +95,8 @@ class ActionModel(QtGui.QStandardItemModel):
if not project_doc:
return actions
+ project_settings = get_project_settings(project_name)
+ only_available = project_settings["applications"]["only_available"]
self.application_manager.refresh()
for app_def in project_doc["config"]["apps"]:
app_name = app_def["name"]
@@ -104,6 +107,9 @@ class ActionModel(QtGui.QStandardItemModel):
if app.group.name in CUSTOM_LAUNCH_APP_GROUPS:
continue
+ if only_available and not app.find_executable():
+ continue
+
# Get from app definition, if not there from app in project
action = type(
"app_{}".format(app_name),
diff --git a/openpype/tools/loader/widgets.py b/openpype/tools/loader/widgets.py
index 98ac9c871f..b3aa381d14 100644
--- a/openpype/tools/loader/widgets.py
+++ b/openpype/tools/loader/widgets.py
@@ -295,10 +295,10 @@ class SubsetWidget(QtWidgets.QWidget):
self.model.set_grouping(state)
def _subset_changed(self, text):
- if hasattr(self.proxy, "setFilterRegularExpression"):
- self.proxy.setFilterRegularExpression(text)
- else:
+ if hasattr(self.proxy, "setFilterRegExp"):
self.proxy.setFilterRegExp(text)
+ else:
+ self.proxy.setFilterRegularExpression(text)
self.view.expandAll()
def set_loading_state(self, loading, empty):
diff --git a/openpype/tools/project_manager/project_manager/view.py b/openpype/tools/project_manager/project_manager/view.py
index b35491c5b2..2cf11b702d 100644
--- a/openpype/tools/project_manager/project_manager/view.py
+++ b/openpype/tools/project_manager/project_manager/view.py
@@ -72,8 +72,8 @@ class HierarchyView(QtWidgets.QTreeView):
column_delegate_defs = {
"name": NameDef(),
"type": TypeDef(),
- "frameStart": NumberDef(1),
- "frameEnd": NumberDef(1),
+ "frameStart": NumberDef(0),
+ "frameEnd": NumberDef(0),
"fps": NumberDef(1, decimals=3, step=1),
"resolutionWidth": NumberDef(0),
"resolutionHeight": NumberDef(0),
diff --git a/openpype/tools/publisher/constants.py b/openpype/tools/publisher/constants.py
index b2bfd7dd5c..5d23886aa8 100644
--- a/openpype/tools/publisher/constants.py
+++ b/openpype/tools/publisher/constants.py
@@ -1,4 +1,4 @@
-from qtpy import QtCore
+from qtpy import QtCore, QtGui
# ID of context item in instance view
CONTEXT_ID = "context"
@@ -26,6 +26,9 @@ GROUP_ROLE = QtCore.Qt.UserRole + 7
CONVERTER_IDENTIFIER_ROLE = QtCore.Qt.UserRole + 8
CREATOR_SORT_ROLE = QtCore.Qt.UserRole + 9
+ResetKeySequence = QtGui.QKeySequence(
+ QtCore.Qt.ControlModifier | QtCore.Qt.Key_R
+)
__all__ = (
"CONTEXT_ID",
diff --git a/openpype/tools/publisher/control.py b/openpype/tools/publisher/control.py
index 49e7eeb4f7..b62ae7ecc1 100644
--- a/openpype/tools/publisher/control.py
+++ b/openpype/tools/publisher/control.py
@@ -6,7 +6,7 @@ import collections
import uuid
import tempfile
import shutil
-from abc import ABCMeta, abstractmethod, abstractproperty
+from abc import ABCMeta, abstractmethod
import six
import pyblish.api
@@ -964,7 +964,8 @@ class AbstractPublisherController(object):
access objects directly but by using wrappers that can be serialized.
"""
- @abstractproperty
+ @property
+ @abstractmethod
def log(self):
"""Controller's logger object.
@@ -974,13 +975,15 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def event_system(self):
"""Inner event system for publisher controller."""
pass
- @abstractproperty
+ @property
+ @abstractmethod
def project_name(self):
"""Current context project name.
@@ -990,7 +993,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def current_asset_name(self):
"""Current context asset name.
@@ -1000,7 +1004,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def current_task_name(self):
"""Current context task name.
@@ -1010,7 +1015,21 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
+ def host_context_has_changed(self):
+ """Host context changed after last reset.
+
+ 'CreateContext' has this option available using 'context_has_changed'.
+
+ Returns:
+ bool: Context has changed.
+ """
+
+ pass
+
+ @property
+ @abstractmethod
def host_is_valid(self):
"""Host is valid for creation part.
@@ -1023,7 +1042,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def instances(self):
"""Collected/created instances.
@@ -1134,7 +1154,13 @@ class AbstractPublisherController(object):
@abstractmethod
def save_changes(self):
- """Save changes in create context."""
+ """Save changes in create context.
+
+ Save can crash because of unexpected errors.
+
+ Returns:
+ bool: Save was successful.
+ """
pass
@@ -1145,7 +1171,19 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
+ def publish_has_started(self):
+ """Has publishing finished.
+
+ Returns:
+ bool: If publishing finished and all plugins were iterated.
+ """
+
+ pass
+
+ @property
+ @abstractmethod
def publish_has_finished(self):
"""Has publishing finished.
@@ -1155,7 +1193,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def publish_is_running(self):
"""Publishing is running right now.
@@ -1165,7 +1204,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def publish_has_validated(self):
"""Publish validation passed.
@@ -1175,7 +1215,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def publish_has_crashed(self):
"""Publishing crashed for any reason.
@@ -1185,7 +1226,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def publish_has_validation_errors(self):
"""During validation happened at least one validation error.
@@ -1195,7 +1237,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def publish_max_progress(self):
"""Get maximum possible progress number.
@@ -1205,7 +1248,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def publish_progress(self):
"""Current progress number.
@@ -1215,7 +1259,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def publish_error_msg(self):
"""Current error message which cause fail of publishing.
@@ -1267,7 +1312,8 @@ class AbstractPublisherController(object):
pass
- @abstractproperty
+ @property
+ @abstractmethod
def convertor_items(self):
pass
@@ -1356,6 +1402,7 @@ class BasePublisherController(AbstractPublisherController):
self._publish_has_validation_errors = False
self._publish_has_crashed = False
# All publish plugins are processed
+ self._publish_has_started = False
self._publish_has_finished = False
self._publish_max_progress = 0
self._publish_progress = 0
@@ -1386,7 +1433,8 @@ class BasePublisherController(AbstractPublisherController):
"show.card.message" - Show card message request (UI related).
"instances.refresh.finished" - Instances are refreshed.
"plugins.refresh.finished" - Plugins refreshed.
- "publish.reset.finished" - Publish context reset finished.
+ "publish.reset.finished" - Reset finished.
+ "controller.reset.started" - Controller reset started.
"controller.reset.finished" - Controller reset finished.
"publish.process.started" - Publishing started. Can be started from
paused state.
@@ -1425,7 +1473,16 @@ class BasePublisherController(AbstractPublisherController):
def _set_host_is_valid(self, value):
if self._host_is_valid != value:
self._host_is_valid = value
- self._emit_event("publish.host_is_valid.changed", {"value": value})
+ self._emit_event(
+ "publish.host_is_valid.changed", {"value": value}
+ )
+
+ def _get_publish_has_started(self):
+ return self._publish_has_started
+
+ def _set_publish_has_started(self, value):
+ if value != self._publish_has_started:
+ self._publish_has_started = value
def _get_publish_has_finished(self):
return self._publish_has_finished
@@ -1449,7 +1506,9 @@ class BasePublisherController(AbstractPublisherController):
def _set_publish_has_validated(self, value):
if self._publish_has_validated != value:
self._publish_has_validated = value
- self._emit_event("publish.has_validated.changed", {"value": value})
+ self._emit_event(
+ "publish.has_validated.changed", {"value": value}
+ )
def _get_publish_has_crashed(self):
return self._publish_has_crashed
@@ -1497,6 +1556,9 @@ class BasePublisherController(AbstractPublisherController):
host_is_valid = property(
_get_host_is_valid, _set_host_is_valid
)
+ publish_has_started = property(
+ _get_publish_has_started, _set_publish_has_started
+ )
publish_has_finished = property(
_get_publish_has_finished, _set_publish_has_finished
)
@@ -1526,6 +1588,7 @@ class BasePublisherController(AbstractPublisherController):
"""Reset most of attributes that can be reset."""
self.publish_is_running = False
+ self.publish_has_started = False
self.publish_has_validated = False
self.publish_has_crashed = False
self.publish_has_validation_errors = False
@@ -1645,10 +1708,7 @@ class PublisherController(BasePublisherController):
str: Project name.
"""
- if not hasattr(self._host, "get_current_context"):
- return legacy_io.active_project()
-
- return self._host.get_current_context()["project_name"]
+ return self._create_context.get_current_project_name()
@property
def current_asset_name(self):
@@ -1658,10 +1718,7 @@ class PublisherController(BasePublisherController):
Union[str, None]: Asset name or None if asset is not set.
"""
- if not hasattr(self._host, "get_current_context"):
- return legacy_io.Session["AVALON_ASSET"]
-
- return self._host.get_current_context()["asset_name"]
+ return self._create_context.get_current_asset_name()
@property
def current_task_name(self):
@@ -1671,10 +1728,11 @@ class PublisherController(BasePublisherController):
Union[str, None]: Task name or None if task is not set.
"""
- if not hasattr(self._host, "get_current_context"):
- return legacy_io.Session["AVALON_TASK"]
+ return self._create_context.get_current_task_name()
- return self._host.get_current_context()["task_name"]
+ @property
+ def host_context_has_changed(self):
+ return self._create_context.context_has_changed
@property
def instances(self):
@@ -1751,6 +1809,8 @@ class PublisherController(BasePublisherController):
"""Reset everything related to creation and publishing."""
self.stop_publish()
+ self._emit_event("controller.reset.started")
+
self.host_is_valid = self._create_context.host_is_valid
self._create_context.reset_preparation()
@@ -1992,7 +2052,15 @@ class PublisherController(BasePublisherController):
)
def trigger_convertor_items(self, convertor_identifiers):
- self.save_changes()
+ """Trigger legacy item convertors.
+
+ This functionality requires to save and reset CreateContext. The reset
+ is needed so Creators can collect converted items.
+
+ Args:
+ convertor_identifiers (list[str]): Identifiers of convertor
+ plugins.
+ """
success = True
try:
@@ -2039,13 +2107,33 @@ class PublisherController(BasePublisherController):
self._on_create_instance_change()
return success
- def save_changes(self):
- """Save changes happened during creation."""
+ def save_changes(self, show_message=True):
+ """Save changes happened during creation.
+
+ Trigger save of changes using host api. This functionality does not
+ validate anything. It is required to do checks before this method is
+ called to be able to give user actionable response e.g. check of
+ context using 'host_context_has_changed'.
+
+ Args:
+ show_message (bool): Show message that changes were
+ saved successfully.
+
+ Returns:
+ bool: Save of changes was successful.
+ """
+
if not self._create_context.host_is_valid:
- return
+ # TODO remove
+ # Fake success save when host is not valid for CreateContext
+ # this is for testing as experimental feature
+ return True
try:
self._create_context.save_changes()
+ if show_message:
+ self.emit_card_message("Saved changes..")
+ return True
except CreatorsOperationFailed as exc:
self._emit_event(
@@ -2056,16 +2144,17 @@ class PublisherController(BasePublisherController):
}
)
+ return False
+
def remove_instances(self, instance_ids):
"""Remove instances based on instance ids.
Args:
instance_ids (List[str]): List of instance ids to remove.
"""
- # QUESTION Expect that instances are really removed? In that case save
- # reset is not required and save changes too.
- self.save_changes()
+ # QUESTION Expect that instances are really removed? In that case reset
+ # is not required.
self._remove_instances_from_context(instance_ids)
self._on_create_instance_change()
@@ -2136,12 +2225,22 @@ class PublisherController(BasePublisherController):
self._publish_comment_is_set = True
def publish(self):
- """Run publishing."""
+ """Run publishing.
+
+ Make sure all changes are saved before method is called (Call
+ 'save_changes' and check output).
+ """
+
self._publish_up_validation = False
self._start_publish()
def validate(self):
- """Run publishing and stop after Validation."""
+ """Run publishing and stop after Validation.
+
+ Make sure all changes are saved before method is called (Call
+ 'save_changes' and check output).
+ """
+
if self.publish_has_validated:
return
self._publish_up_validation = True
@@ -2152,10 +2251,8 @@ class PublisherController(BasePublisherController):
if self.publish_is_running:
return
- # Make sure changes are saved
- self.save_changes()
-
self.publish_is_running = True
+ self.publish_has_started = True
self._emit_event("publish.process.started")
diff --git a/openpype/tools/publisher/widgets/__init__.py b/openpype/tools/publisher/widgets/__init__.py
index 042985b007..f18e6cc61e 100644
--- a/openpype/tools/publisher/widgets/__init__.py
+++ b/openpype/tools/publisher/widgets/__init__.py
@@ -4,8 +4,9 @@ from .icons import (
get_icon
)
from .widgets import (
- StopBtn,
+ SaveBtn,
ResetBtn,
+ StopBtn,
ValidateBtn,
PublishBtn,
CreateNextPageOverlay,
@@ -25,8 +26,9 @@ __all__ = (
"get_pixmap",
"get_icon",
- "StopBtn",
+ "SaveBtn",
"ResetBtn",
+ "StopBtn",
"ValidateBtn",
"PublishBtn",
"CreateNextPageOverlay",
diff --git a/openpype/tools/publisher/widgets/card_view_widgets.py b/openpype/tools/publisher/widgets/card_view_widgets.py
index 3fd5243ce9..0734e1bc27 100644
--- a/openpype/tools/publisher/widgets/card_view_widgets.py
+++ b/openpype/tools/publisher/widgets/card_view_widgets.py
@@ -164,6 +164,11 @@ class BaseGroupWidget(QtWidgets.QWidget):
def _on_widget_selection(self, instance_id, group_id, selection_type):
self.selected.emit(instance_id, group_id, selection_type)
+ def set_active_toggle_enabled(self, enabled):
+ for widget in self._widgets_by_id.values():
+ if isinstance(widget, InstanceCardWidget):
+ widget.set_active_toggle_enabled(enabled)
+
class ConvertorItemsGroupWidget(BaseGroupWidget):
def update_items(self, items_by_id):
@@ -437,6 +442,9 @@ class InstanceCardWidget(CardWidget):
self.update_instance_values()
+ def set_active_toggle_enabled(self, enabled):
+ self._active_checkbox.setEnabled(enabled)
+
def set_active(self, new_value):
"""Set instance as active."""
checkbox_value = self._active_checkbox.isChecked()
@@ -551,6 +559,7 @@ class InstanceCardView(AbstractInstanceView):
self._context_widget = None
self._convertor_items_group = None
+ self._active_toggle_enabled = True
self._widgets_by_group = {}
self._ordered_groups = []
@@ -667,6 +676,9 @@ class InstanceCardView(AbstractInstanceView):
group_widget.update_instances(
instances_by_group[group_name]
)
+ group_widget.set_active_toggle_enabled(
+ self._active_toggle_enabled
+ )
self._update_ordered_group_names()
@@ -1091,3 +1103,10 @@ class InstanceCardView(AbstractInstanceView):
self._explicitly_selected_groups = selected_groups
self._explicitly_selected_instance_ids = selected_instances
+
+ def set_active_toggle_enabled(self, enabled):
+ if self._active_toggle_enabled is enabled:
+ return
+ self._active_toggle_enabled = enabled
+ for group_widget in self._widgets_by_group.values():
+ group_widget.set_active_toggle_enabled(enabled)
diff --git a/openpype/tools/publisher/widgets/images/save.png b/openpype/tools/publisher/widgets/images/save.png
new file mode 100644
index 0000000000..0db48d74ae
Binary files /dev/null and b/openpype/tools/publisher/widgets/images/save.png differ
diff --git a/openpype/tools/publisher/widgets/list_view_widgets.py b/openpype/tools/publisher/widgets/list_view_widgets.py
index 172563d15c..227ae7bda9 100644
--- a/openpype/tools/publisher/widgets/list_view_widgets.py
+++ b/openpype/tools/publisher/widgets/list_view_widgets.py
@@ -198,6 +198,9 @@ class InstanceListItemWidget(QtWidgets.QWidget):
self.instance["active"] = new_value
self.active_changed.emit(self.instance.id, new_value)
+ def set_active_toggle_enabled(self, enabled):
+ self._active_checkbox.setEnabled(enabled)
+
class ListContextWidget(QtWidgets.QFrame):
"""Context (or global attributes) widget."""
@@ -302,6 +305,9 @@ class InstanceListGroupWidget(QtWidgets.QFrame):
else:
self.expand_btn.setArrowType(QtCore.Qt.RightArrow)
+ def set_active_toggle_enabled(self, enabled):
+ self.toggle_checkbox.setEnabled(enabled)
+
class InstanceTreeView(QtWidgets.QTreeView):
"""View showing instances and their groups."""
@@ -461,6 +467,8 @@ class InstanceListView(AbstractInstanceView):
self._instance_model = instance_model
self._proxy_model = proxy_model
+ self._active_toggle_enabled = True
+
def _on_expand(self, index):
self._update_widget_expand_state(index, True)
@@ -667,6 +675,9 @@ class InstanceListView(AbstractInstanceView):
widget = InstanceListItemWidget(
instance, self._instance_view
)
+ widget.set_active_toggle_enabled(
+ self._active_toggle_enabled
+ )
widget.active_changed.connect(self._on_active_changed)
self._instance_view.setIndexWidget(proxy_index, widget)
self._widgets_by_id[instance.id] = widget
@@ -802,6 +813,9 @@ class InstanceListView(AbstractInstanceView):
proxy_index = self._proxy_model.mapFromSource(index)
group_name = group_item.data(GROUP_ROLE)
widget = InstanceListGroupWidget(group_name, self._instance_view)
+ widget.set_active_toggle_enabled(
+ self._active_toggle_enabled
+ )
widget.expand_changed.connect(self._on_group_expand_request)
widget.toggle_requested.connect(self._on_group_toggle_request)
self._group_widgets[group_name] = widget
@@ -1051,3 +1065,16 @@ class InstanceListView(AbstractInstanceView):
QtCore.QItemSelectionModel.Select
| QtCore.QItemSelectionModel.Rows
)
+
+ def set_active_toggle_enabled(self, enabled):
+ if self._active_toggle_enabled is enabled:
+ return
+
+ self._active_toggle_enabled = enabled
+ for widget in self._widgets_by_id.values():
+ if isinstance(widget, InstanceListItemWidget):
+ widget.set_active_toggle_enabled(enabled)
+
+ for widget in self._group_widgets.values():
+ if isinstance(widget, InstanceListGroupWidget):
+ widget.set_active_toggle_enabled(enabled)
diff --git a/openpype/tools/publisher/widgets/overview_widget.py b/openpype/tools/publisher/widgets/overview_widget.py
index 8706daeda6..25fff73134 100644
--- a/openpype/tools/publisher/widgets/overview_widget.py
+++ b/openpype/tools/publisher/widgets/overview_widget.py
@@ -17,6 +17,7 @@ class OverviewWidget(QtWidgets.QFrame):
active_changed = QtCore.Signal()
instance_context_changed = QtCore.Signal()
create_requested = QtCore.Signal()
+ convert_requested = QtCore.Signal()
anim_end_value = 200
anim_duration = 200
@@ -132,6 +133,9 @@ class OverviewWidget(QtWidgets.QFrame):
controller.event_system.add_callback(
"publish.process.started", self._on_publish_start
)
+ controller.event_system.add_callback(
+ "controller.reset.started", self._on_controller_reset_start
+ )
controller.event_system.add_callback(
"publish.reset.finished", self._on_publish_reset
)
@@ -336,13 +340,31 @@ class OverviewWidget(QtWidgets.QFrame):
self.instance_context_changed.emit()
def _on_convert_requested(self):
- _, _, convertor_identifiers = self.get_selected_items()
- self._controller.trigger_convertor_items(convertor_identifiers)
+ self.convert_requested.emit()
def get_selected_items(self):
+ """Selected items in current view widget.
+
+ Returns:
+ tuple[list[str], bool, list[str]]: Selected items. List of
+ instance ids, context is selected, list of selected legacy
+ convertor plugins.
+ """
+
view = self._subset_views_layout.currentWidget()
return view.get_selected_items()
+ def get_selected_legacy_convertors(self):
+ """Selected legacy convertor identifiers.
+
+ Returns:
+ list[str]: Selected legacy convertor identifiers.
+ Example: ['io.openpype.creators.houdini.legacy']
+ """
+
+ _, _, convertor_identifiers = self.get_selected_items()
+ return convertor_identifiers
+
def _change_view_type(self):
idx = self._subset_views_layout.currentIndex()
new_idx = (idx + 1) % self._subset_views_layout.count()
@@ -391,9 +413,19 @@ class OverviewWidget(QtWidgets.QFrame):
self._create_btn.setEnabled(False)
self._subset_attributes_wrap.setEnabled(False)
+ for idx in range(self._subset_views_layout.count()):
+ widget = self._subset_views_layout.widget(idx)
+ widget.set_active_toggle_enabled(False)
+
+ def _on_controller_reset_start(self):
+ """Controller reset started."""
+
+ for idx in range(self._subset_views_layout.count()):
+ widget = self._subset_views_layout.widget(idx)
+ widget.set_active_toggle_enabled(True)
def _on_publish_reset(self):
- """Context in controller has been refreshed."""
+ """Context in controller has been reseted."""
self._create_btn.setEnabled(True)
self._subset_attributes_wrap.setEnabled(True)
diff --git a/openpype/tools/publisher/widgets/widgets.py b/openpype/tools/publisher/widgets/widgets.py
index 86475460aa..d2ce1fbcb2 100644
--- a/openpype/tools/publisher/widgets/widgets.py
+++ b/openpype/tools/publisher/widgets/widgets.py
@@ -34,7 +34,8 @@ from .icons import (
)
from ..constants import (
- VARIANT_TOOLTIP
+ VARIANT_TOOLTIP,
+ ResetKeySequence,
)
@@ -198,12 +199,26 @@ class CreateBtn(PublishIconBtn):
self.setLayoutDirection(QtCore.Qt.RightToLeft)
+class SaveBtn(PublishIconBtn):
+ """Save context and instances information."""
+ def __init__(self, parent=None):
+ icon_path = get_icon_path("save")
+ super(SaveBtn, self).__init__(icon_path, parent)
+ self.setToolTip(
+ "Save changes ({})".format(
+ QtGui.QKeySequence(QtGui.QKeySequence.Save).toString()
+ )
+ )
+
+
class ResetBtn(PublishIconBtn):
"""Publish reset button."""
def __init__(self, parent=None):
icon_path = get_icon_path("refresh")
super(ResetBtn, self).__init__(icon_path, parent)
- self.setToolTip("Refresh publishing")
+ self.setToolTip(
+ "Reset & discard changes ({})".format(ResetKeySequence.toString())
+ )
class StopBtn(PublishIconBtn):
@@ -348,6 +363,19 @@ class AbstractInstanceView(QtWidgets.QWidget):
"{} Method 'set_selected_items' is not implemented."
).format(self.__class__.__name__))
+ def set_active_toggle_enabled(self, enabled):
+ """Instances are disabled for changing enabled state.
+
+ Active state should stay the same until is "unset".
+
+ Args:
+ enabled (bool): Instance state can be changed.
+ """
+
+ raise NotImplementedError((
+ "{} Method 'set_active_toggle_enabled' is not implemented."
+ ).format(self.__class__.__name__))
+
class ClickableLineEdit(QtWidgets.QLineEdit):
"""QLineEdit capturing left mouse click.
@@ -1533,7 +1561,7 @@ class SubsetAttributesWidget(QtWidgets.QWidget):
│ attributes │ Thumbnail │ TOP
│ │ │
├─────────────┬───┴─────────────┤
- │ Family │ Publish │
+ │ Creator │ Publish │
│ attributes │ plugin │ BOTTOM
│ │ attributes │
└───────────────────────────────┘
diff --git a/openpype/tools/publisher/window.py b/openpype/tools/publisher/window.py
index 74977d65d8..8826e0f849 100644
--- a/openpype/tools/publisher/window.py
+++ b/openpype/tools/publisher/window.py
@@ -13,6 +13,7 @@ from openpype.tools.utils import (
PixmapLabel,
)
+from .constants import ResetKeySequence
from .publish_report_viewer import PublishReportViewerWidget
from .control_qt import QtPublisherController
from .widgets import (
@@ -22,8 +23,9 @@ from .widgets import (
PublisherTabsWidget,
- StopBtn,
+ SaveBtn,
ResetBtn,
+ StopBtn,
ValidateBtn,
PublishBtn,
@@ -121,6 +123,7 @@ class PublisherWindow(QtWidgets.QDialog):
"Attach a comment to your publish"
)
+ save_btn = SaveBtn(footer_widget)
reset_btn = ResetBtn(footer_widget)
stop_btn = StopBtn(footer_widget)
validate_btn = ValidateBtn(footer_widget)
@@ -129,6 +132,7 @@ class PublisherWindow(QtWidgets.QDialog):
footer_bottom_layout = QtWidgets.QHBoxLayout(footer_bottom_widget)
footer_bottom_layout.setContentsMargins(0, 0, 0, 0)
footer_bottom_layout.addStretch(1)
+ footer_bottom_layout.addWidget(save_btn, 0)
footer_bottom_layout.addWidget(reset_btn, 0)
footer_bottom_layout.addWidget(stop_btn, 0)
footer_bottom_layout.addWidget(validate_btn, 0)
@@ -250,7 +254,11 @@ class PublisherWindow(QtWidgets.QDialog):
overview_widget.create_requested.connect(
self._on_create_request
)
+ overview_widget.convert_requested.connect(
+ self._on_convert_requested
+ )
+ save_btn.clicked.connect(self._on_save_clicked)
reset_btn.clicked.connect(self._on_reset_clicked)
stop_btn.clicked.connect(self._on_stop_clicked)
validate_btn.clicked.connect(self._on_validate_clicked)
@@ -330,8 +338,9 @@ class PublisherWindow(QtWidgets.QDialog):
self._comment_input = comment_input
self._footer_spacer = footer_spacer
- self._stop_btn = stop_btn
+ self._save_btn = save_btn
self._reset_btn = reset_btn
+ self._stop_btn = stop_btn
self._validate_btn = validate_btn
self._publish_btn = publish_btn
@@ -388,7 +397,9 @@ class PublisherWindow(QtWidgets.QDialog):
def closeEvent(self, event):
self._window_is_visible = False
self._uninstall_app_event_listener()
- self.save_changes()
+ # TODO capture changes and ask user if wants to save changes on close
+ if not self._controller.host_context_has_changed:
+ self._save_changes(False)
self._reset_on_show = True
self._controller.clear_thumbnail_temp_dir_path()
super(PublisherWindow, self).closeEvent(event)
@@ -421,6 +432,21 @@ class PublisherWindow(QtWidgets.QDialog):
if event.key() == QtCore.Qt.Key_Escape:
event.accept()
return
+
+ if event.matches(QtGui.QKeySequence.Save):
+ if not self._controller.publish_has_started:
+ self._save_changes(True)
+ event.accept()
+ return
+
+ if ResetKeySequence.matches(
+ QtGui.QKeySequence(event.key() | event.modifiers())
+ ):
+ if not self.controller.publish_is_running:
+ self.reset()
+ event.accept()
+ return
+
super(PublisherWindow, self).keyPressEvent(event)
def _on_overlay_message(self, event):
@@ -455,8 +481,65 @@ class PublisherWindow(QtWidgets.QDialog):
self._reset_on_show = False
self.reset()
- def save_changes(self):
- self._controller.save_changes()
+ def _checks_before_save(self, explicit_save):
+ """Save of changes may trigger some issues.
+
+ Check if context did change and ask user if he is really sure the
+ save should happen. A dialog can be shown during this method.
+
+ Args:
+ explicit_save (bool): Method was called when user explicitly asked
+ for save. Value affects shown message.
+
+ Returns:
+ bool: Save can happen.
+ """
+
+ if not self._controller.host_context_has_changed:
+ return True
+
+ title = "Host context changed"
+ if explicit_save:
+ message = (
+ "Context has changed since Publisher window was refreshed last"
+ " time.\n\nAre you sure you want to save changes?"
+ )
+ else:
+ message = (
+ "Your action requires save of changes but context has changed"
+ " since Publisher window was refreshed last time.\n\nAre you"
+ " sure you want to continue and save changes?"
+ )
+
+ result = QtWidgets.QMessageBox.question(
+ self,
+ title,
+ message,
+ QtWidgets.QMessageBox.Save | QtWidgets.QMessageBox.Cancel
+ )
+ return result == QtWidgets.QMessageBox.Save
+
+ def _save_changes(self, explicit_save):
+ """Save changes of Creation part.
+
+ All possible triggers of save changes were moved to main window (here),
+ so it can handle possible issues with save at one place. Do checks,
+ so user don't accidentally save changes to different file or using
+ different context.
+ Moving responsibility to this place gives option to show the dialog and
+ wait for user's response without breaking action he wanted to do.
+
+ Args:
+ explicit_save (bool): Method was called when user explicitly asked
+ for save. Value affects shown message.
+
+ Returns:
+ bool: Save happened successfully.
+ """
+
+ if not self._checks_before_save(explicit_save):
+ return False
+ return self._controller.save_changes()
def reset(self):
self._controller.reset()
@@ -491,15 +574,18 @@ class PublisherWindow(QtWidgets.QDialog):
self._help_dialog.show()
window = self.window()
- desktop = QtWidgets.QApplication.desktop()
- screen_idx = desktop.screenNumber(window)
- screen = desktop.screen(screen_idx)
- screen_rect = screen.geometry()
+ if hasattr(QtWidgets.QApplication, "desktop"):
+ desktop = QtWidgets.QApplication.desktop()
+ screen_idx = desktop.screenNumber(window)
+ screen_geo = desktop.screenGeometry(screen_idx)
+ else:
+ screen = window.screen()
+ screen_geo = screen.geometry()
window_geo = window.geometry()
dialog_x = window_geo.x() + window_geo.width()
dialog_right = (dialog_x + self._help_dialog.width()) - 1
- diff = dialog_right - screen_rect.right()
+ diff = dialog_right - screen_geo.right()
if diff > 0:
dialog_x -= diff
@@ -549,6 +635,14 @@ class PublisherWindow(QtWidgets.QDialog):
def _on_create_request(self):
self._go_to_create_tab()
+ def _on_convert_requested(self):
+ if not self._save_changes(False):
+ return
+ convertor_identifiers = (
+ self._overview_widget.get_selected_legacy_convertors()
+ )
+ self._controller.trigger_convertor_items(convertor_identifiers)
+
def _set_current_tab(self, identifier):
self._tabs_widget.set_current_tab(identifier)
@@ -599,8 +693,10 @@ class PublisherWindow(QtWidgets.QDialog):
self._publish_frame.setVisible(visible)
self._update_publish_frame_rect()
+ def _on_save_clicked(self):
+ self._save_changes(True)
+
def _on_reset_clicked(self):
- self.save_changes()
self.reset()
def _on_stop_clicked(self):
@@ -610,14 +706,17 @@ class PublisherWindow(QtWidgets.QDialog):
self._controller.set_comment(self._comment_input.text())
def _on_validate_clicked(self):
- self._set_publish_comment()
- self._controller.validate()
+ if self._save_changes(False):
+ self._set_publish_comment()
+ self._controller.validate()
def _on_publish_clicked(self):
- self._set_publish_comment()
- self._controller.publish()
+ if self._save_changes(False):
+ self._set_publish_comment()
+ self._controller.publish()
def _set_footer_enabled(self, enabled):
+ self._save_btn.setEnabled(True)
self._reset_btn.setEnabled(True)
if enabled:
self._stop_btn.setEnabled(False)
diff --git a/openpype/tools/sceneinventory/model.py b/openpype/tools/sceneinventory/model.py
index 3398743aec..63d2945145 100644
--- a/openpype/tools/sceneinventory/model.py
+++ b/openpype/tools/sceneinventory/model.py
@@ -327,7 +327,7 @@ class InventoryModel(TreeModel):
project_name, repre_id
)
if not representation:
- not_found["representation"].append(group_items)
+ not_found["representation"].extend(group_items)
not_found_ids.append(repre_id)
continue
@@ -335,7 +335,7 @@ class InventoryModel(TreeModel):
project_name, representation["parent"]
)
if not version:
- not_found["version"].append(group_items)
+ not_found["version"].extend(group_items)
not_found_ids.append(repre_id)
continue
@@ -348,13 +348,13 @@ class InventoryModel(TreeModel):
subset = get_subset_by_id(project_name, version["parent"])
if not subset:
- not_found["subset"].append(group_items)
+ not_found["subset"].extend(group_items)
not_found_ids.append(repre_id)
continue
asset = get_asset_by_id(project_name, subset["parent"])
if not asset:
- not_found["asset"].append(group_items)
+ not_found["asset"].extend(group_items)
not_found_ids.append(repre_id)
continue
@@ -380,11 +380,11 @@ class InventoryModel(TreeModel):
self.add_child(group_node, parent=parent)
- for _group_items in group_items:
+ for item in group_items:
item_node = Item()
- item_node["Name"] = ", ".join(
- [item["objectName"] for item in _group_items]
- )
+ item_node.update(item)
+ item_node["Name"] = item.get("objectName", "NO NAME")
+ item_node["isNotFound"] = True
self.add_child(item_node, parent=group_node)
for repre_id, group_dict in sorted(grouped.items()):
@@ -482,10 +482,10 @@ class FilterProxyModel(QtCore.QSortFilterProxyModel):
return True
# Filter by regex
- if hasattr(self, "filterRegularExpression"):
- regex = self.filterRegularExpression()
- else:
+ if hasattr(self, "filterRegExp"):
regex = self.filterRegExp()
+ else:
+ regex = self.filterRegularExpression()
pattern = regex.pattern()
if pattern:
pattern = re.escape(pattern)
diff --git a/openpype/tools/sceneinventory/view.py b/openpype/tools/sceneinventory/view.py
index a04171e429..3279be6094 100644
--- a/openpype/tools/sceneinventory/view.py
+++ b/openpype/tools/sceneinventory/view.py
@@ -80,9 +80,16 @@ class SceneInventoryView(QtWidgets.QTreeView):
self.setStyleSheet("QTreeView {}")
def _build_item_menu_for_selection(self, items, menu):
+
+ # Exclude items that are "NOT FOUND" since setting versions, updating
+ # and removal won't work for those items.
+ items = [item for item in items if not item.get("isNotFound")]
+
if not items:
return
+ # An item might not have a representation, for example when an item
+ # is listed as "NOT FOUND"
repre_ids = {
item["representation"]
for item in items
diff --git a/openpype/tools/sceneinventory/window.py b/openpype/tools/sceneinventory/window.py
index 8a6e43f796..89424fd746 100644
--- a/openpype/tools/sceneinventory/window.py
+++ b/openpype/tools/sceneinventory/window.py
@@ -160,10 +160,10 @@ class SceneInventoryWindow(QtWidgets.QDialog):
self._model.set_hierarchy_view(enabled)
def _on_text_filter_change(self, text_filter):
- if hasattr(self._proxy, "setFilterRegularExpression"):
- self._proxy.setFilterRegularExpression(text_filter)
- else:
+ if hasattr(self._proxy, "setFilterRegExp"):
self._proxy.setFilterRegExp(text_filter)
+ else:
+ self._proxy.setFilterRegularExpression(text_filter)
def _on_outdated_state_change(self):
self._proxy.set_filter_outdated(
diff --git a/openpype/tools/settings/local_settings/projects_widget.py b/openpype/tools/settings/local_settings/projects_widget.py
index bdf291524c..4a4148d7cd 100644
--- a/openpype/tools/settings/local_settings/projects_widget.py
+++ b/openpype/tools/settings/local_settings/projects_widget.py
@@ -272,7 +272,7 @@ class SitesWidget(QtWidgets.QWidget):
)
site_configs = sync_server_module.get_all_site_configs(
- self._project_name)
+ self._project_name, local_editable_only=True)
roots_entity = (
self.project_settings[PROJECT_ANATOMY_KEY][LOCAL_ROOTS_KEY]
diff --git a/openpype/tools/settings/settings/search_dialog.py b/openpype/tools/settings/settings/search_dialog.py
index 33a4d16e98..59750c02e1 100644
--- a/openpype/tools/settings/settings/search_dialog.py
+++ b/openpype/tools/settings/settings/search_dialog.py
@@ -27,10 +27,10 @@ class RecursiveSortFilterProxyModel(QtCore.QSortFilterProxyModel):
if not parent.isValid():
return False
- if hasattr(self, "filterRegularExpression"):
- regex = self.filterRegularExpression()
- else:
+ if hasattr(self, "filterRegExp"):
regex = self.filterRegExp()
+ else:
+ regex = self.filterRegularExpression()
pattern = regex.pattern()
if pattern and regex.isValid():
@@ -111,10 +111,10 @@ class SearchEntitiesDialog(QtWidgets.QDialog):
def _on_filter_timer(self):
text = self._filter_edit.text()
- if hasattr(self._proxy, "setFilterRegularExpression"):
- self._proxy.setFilterRegularExpression(text)
- else:
+ if hasattr(self._proxy, "setFilterRegExp"):
self._proxy.setFilterRegExp(text)
+ else:
+ self._proxy.setFilterRegularExpression(text)
# WARNING This expanding and resizing is relatively slow.
self._view.expandAll()
diff --git a/openpype/tools/standalonepublish/widgets/model_filter_proxy_recursive_sort.py b/openpype/tools/standalonepublish/widgets/model_filter_proxy_recursive_sort.py
index 5c72e2049b..602faaa489 100644
--- a/openpype/tools/standalonepublish/widgets/model_filter_proxy_recursive_sort.py
+++ b/openpype/tools/standalonepublish/widgets/model_filter_proxy_recursive_sort.py
@@ -5,10 +5,10 @@ from qtpy import QtCore
class RecursiveSortFilterProxyModel(QtCore.QSortFilterProxyModel):
"""Filters to the regex if any of the children matches allow parent"""
def filterAcceptsRow(self, row, parent):
- if hasattr(self, "filterRegularExpression"):
- regex = self.filterRegularExpression()
- else:
+ if hasattr(self, "filterRegExp"):
regex = self.filterRegExp()
+ else:
+ regex = self.filterRegularExpression()
pattern = regex.pattern()
if pattern:
model = self.sourceModel()
diff --git a/openpype/tools/traypublisher/window.py b/openpype/tools/traypublisher/window.py
index 3007fa66a5..3ac1b4c4ad 100644
--- a/openpype/tools/traypublisher/window.py
+++ b/openpype/tools/traypublisher/window.py
@@ -247,7 +247,7 @@ class TrayPublishWindow(PublisherWindow):
def _on_project_select(self, project_name):
# TODO register project specific plugin paths
- self._controller.save_changes()
+ self._controller.save_changes(False)
self._controller.reset_project_data_cache()
self.reset()
diff --git a/openpype/tools/utils/delegates.py b/openpype/tools/utils/delegates.py
index d76284afb1..fa69113ef1 100644
--- a/openpype/tools/utils/delegates.py
+++ b/openpype/tools/utils/delegates.py
@@ -30,9 +30,11 @@ class VersionDelegate(QtWidgets.QStyledItemDelegate):
def displayText(self, value, locale):
if isinstance(value, HeroVersionType):
return lib.format_version(value, True)
- assert isinstance(value, numbers.Integral), (
- "Version is not integer. \"{}\" {}".format(value, str(type(value)))
- )
+ if not isinstance(value, numbers.Integral):
+ # For cases where no version is resolved like NOT FOUND cases
+ # where a representation might not exist in current database
+ return
+
return lib.format_version(value)
def paint(self, painter, option, index):
diff --git a/openpype/tools/utils/host_tools.py b/openpype/tools/utils/host_tools.py
index e8593a8ae2..ac242d24d2 100644
--- a/openpype/tools/utils/host_tools.py
+++ b/openpype/tools/utils/host_tools.py
@@ -38,7 +38,6 @@ class HostToolsHelper:
self._subset_manager_tool = None
self._scene_inventory_tool = None
self._library_loader_tool = None
- self._look_assigner_tool = None
self._experimental_tools_dialog = None
@property
@@ -219,27 +218,6 @@ class HostToolsHelper:
raise ImportError("No Pyblish GUI found")
- def get_look_assigner_tool(self, parent):
- """Create, cache and return look assigner tool window."""
- if self._look_assigner_tool is None:
- from openpype.tools.mayalookassigner import MayaLookAssignerWindow
-
- mayalookassigner_window = MayaLookAssignerWindow(parent)
- self._look_assigner_tool = mayalookassigner_window
- return self._look_assigner_tool
-
- def show_look_assigner(self, parent=None):
- """Look manager is Maya specific tool for look management."""
-
- with qt_app_context():
- look_assigner_tool = self.get_look_assigner_tool(parent)
- look_assigner_tool.show()
-
- # Pull window to the front.
- look_assigner_tool.raise_()
- look_assigner_tool.activateWindow()
- look_assigner_tool.showNormal()
-
def get_experimental_tools_dialog(self, parent=None):
"""Dialog of experimental tools.
@@ -315,9 +293,6 @@ class HostToolsHelper:
elif tool_name == "sceneinventory":
return self.get_scene_inventory_tool(parent, *args, **kwargs)
- elif tool_name == "lookassigner":
- return self.get_look_assigner_tool(parent, *args, **kwargs)
-
elif tool_name == "publish":
self.log.info("Can't return publish tool window.")
@@ -356,9 +331,6 @@ class HostToolsHelper:
elif tool_name == "sceneinventory":
self.show_scene_inventory(parent, *args, **kwargs)
- elif tool_name == "lookassigner":
- self.show_look_assigner(parent, *args, **kwargs)
-
elif tool_name == "publish":
self.show_publish(parent, *args, **kwargs)
@@ -436,10 +408,6 @@ def show_scene_inventory(parent=None):
_SingletonPoint.show_tool_by_name("sceneinventory", parent)
-def show_look_assigner(parent=None):
- _SingletonPoint.show_tool_by_name("lookassigner", parent)
-
-
def show_publish(parent=None):
_SingletonPoint.show_tool_by_name("publish", parent)
diff --git a/openpype/tools/utils/lib.py b/openpype/tools/utils/lib.py
index 8d38f03b8d..950c782727 100644
--- a/openpype/tools/utils/lib.py
+++ b/openpype/tools/utils/lib.py
@@ -862,11 +862,11 @@ class WrappedCallbackItem:
return self._result
def execute(self):
- """Execute callback and store it's result.
+ """Execute callback and store its result.
Method must be called from main thread. Item is marked as `done`
when callback execution finished. Store output of callback of exception
- information when callback raise one.
+ information when callback raises one.
"""
if self.done:
self.log.warning("- item is already processed")
diff --git a/openpype/tools/utils/models.py b/openpype/tools/utils/models.py
index 270e00b2ef..94645af110 100644
--- a/openpype/tools/utils/models.py
+++ b/openpype/tools/utils/models.py
@@ -202,11 +202,20 @@ class RecursiveSortFilterProxyModel(QtCore.QSortFilterProxyModel):
Use case: Filtering by string - parent won't be filtered if does not match
the filter string but first checks if any children does.
"""
+
+ def __init__(self, *args, **kwargs):
+ super(RecursiveSortFilterProxyModel, self).__init__(*args, **kwargs)
+ recursive_enabled = False
+ if hasattr(self, "setRecursiveFilteringEnabled"):
+ self.setRecursiveFilteringEnabled(True)
+ recursive_enabled = True
+ self._recursive_enabled = recursive_enabled
+
def filterAcceptsRow(self, row, parent_index):
- if hasattr(self, "filterRegularExpression"):
- regex = self.filterRegularExpression()
- else:
+ if hasattr(self, "filterRegExp"):
regex = self.filterRegExp()
+ else:
+ regex = self.filterRegularExpression()
pattern = regex.pattern()
if pattern:
@@ -219,8 +228,9 @@ class RecursiveSortFilterProxyModel(QtCore.QSortFilterProxyModel):
# Check current index itself
value = model.data(source_index, self.filterRole())
- if re.search(pattern, value, re.IGNORECASE):
- return True
+ matched = bool(re.search(pattern, value, re.IGNORECASE))
+ if matched or self._recursive_enabled:
+ return matched
rows = model.rowCount(source_index)
for idx in range(rows):
diff --git a/openpype/version.py b/openpype/version.py
index e8124f1466..4d6ee5590e 100644
--- a/openpype/version.py
+++ b/openpype/version.py
@@ -1,3 +1,3 @@
# -*- coding: utf-8 -*-
"""Package declaring Pype version."""
-__version__ = "3.15.2-nightly.6"
+__version__ = "3.15.4-nightly.1"
diff --git a/openpype/widgets/splash_screen.py b/openpype/widgets/splash_screen.py
index fffe143ea5..7c1ff72ecd 100644
--- a/openpype/widgets/splash_screen.py
+++ b/openpype/widgets/splash_screen.py
@@ -49,9 +49,7 @@ class SplashScreen(QtWidgets.QDialog):
self.init_ui()
def was_proc_successful(self) -> bool:
- if self.thread_return_code == 0:
- return True
- return False
+ return self.thread_return_code == 0
def start_thread(self, q_thread: QtCore.QThread):
"""Saves the reference to this thread and starts it.
@@ -80,8 +78,14 @@ class SplashScreen(QtWidgets.QDialog):
"""
self.thread_return_code = 0
self.q_thread.quit()
+
+ if not self.q_thread.wait(5000):
+ raise RuntimeError("Failed to quit the QThread! "
+ "The deadline has been reached! The thread "
+ "has not finished it's execution!.")
self.close()
+
@QtCore.Slot()
def toggle_log(self):
if self.is_log_visible:
@@ -256,3 +260,4 @@ class SplashScreen(QtWidgets.QDialog):
self.close_btn.show()
self.thread_return_code = return_code
self.q_thread.exit(return_code)
+ self.q_thread.wait()
diff --git a/pyproject.toml b/pyproject.toml
index 2fc4f6fe39..42ce5aa32c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "OpenPype"
-version = "3.15.1" # OpenPype
+version = "3.15.3" # OpenPype
description = "Open VFX and Animation pipeline with support."
authors = ["OpenPype Team "]
license = "MIT License"
diff --git a/tests/conftest.py b/tests/conftest.py
index 7b58b0314d..4f7c17244b 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -24,6 +24,11 @@ def pytest_addoption(parser):
help="Overwrite default timeout"
)
+ parser.addoption(
+ "--setup_only", action="store", default=None,
+ help="True - only setup test, do not run any tests"
+ )
+
@pytest.fixture(scope="module")
def test_data_folder(request):
@@ -45,6 +50,11 @@ def timeout(request):
return request.config.getoption("--timeout")
+@pytest.fixture(scope="module")
+def setup_only(request):
+ return request.config.getoption("--setup_only")
+
+
@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
# execute all other hooks to obtain the report object
diff --git a/tests/integration/hosts/nuke/test_deadline_publish_in_nuke.py b/tests/integration/hosts/nuke/test_deadline_publish_in_nuke.py
index cd9cbb94f8..a4026f195b 100644
--- a/tests/integration/hosts/nuke/test_deadline_publish_in_nuke.py
+++ b/tests/integration/hosts/nuke/test_deadline_publish_in_nuke.py
@@ -71,12 +71,30 @@ class TestDeadlinePublishInNuke(NukeDeadlinePublishTestClass):
failures.append(
DBAssert.count_of_types(dbcon, "representation", 4))
+ additional_args = {"context.subset": "workfileTest_task",
+ "context.ext": "nk"}
+ failures.append(
+ DBAssert.count_of_types(dbcon, "representation", 1,
+ additional_args=additional_args))
+
additional_args = {"context.subset": "renderTest_taskMain",
"context.ext": "exr"}
failures.append(
DBAssert.count_of_types(dbcon, "representation", 1,
additional_args=additional_args))
+ additional_args = {"context.subset": "renderTest_taskMain",
+ "name": "thumbnail"}
+ failures.append(
+ DBAssert.count_of_types(dbcon, "representation", 1,
+ additional_args=additional_args))
+
+ additional_args = {"context.subset": "renderTest_taskMain",
+ "name": "h264_mov"}
+ failures.append(
+ DBAssert.count_of_types(dbcon, "representation", 1,
+ additional_args=additional_args))
+
assert not any(failures)
diff --git a/tests/integration/hosts/nuke/test_publish_in_nuke.py b/tests/integration/hosts/nuke/test_publish_in_nuke.py
index f84f13fa20..bfd84e4fd5 100644
--- a/tests/integration/hosts/nuke/test_publish_in_nuke.py
+++ b/tests/integration/hosts/nuke/test_publish_in_nuke.py
@@ -15,7 +15,7 @@ class TestPublishInNuke(NukeLocalPublishTestClass):
!!!
It expects modified path in WriteNode,
use '[python {nuke.script_directory()}]' instead of regular root
- dir (eg. instead of `c:/projects/test_project/test_asset/test_task`).
+ dir (eg. instead of `c:/projects`).
Access file path by selecting WriteNode group, CTRL+Enter, update file
input
!!!
@@ -70,12 +70,30 @@ class TestPublishInNuke(NukeLocalPublishTestClass):
failures.append(
DBAssert.count_of_types(dbcon, "representation", 4))
+ additional_args = {"context.subset": "workfileTest_task",
+ "context.ext": "nk"}
+ failures.append(
+ DBAssert.count_of_types(dbcon, "representation", 1,
+ additional_args=additional_args))
+
additional_args = {"context.subset": "renderTest_taskMain",
"context.ext": "exr"}
failures.append(
DBAssert.count_of_types(dbcon, "representation", 1,
additional_args=additional_args))
+ additional_args = {"context.subset": "renderTest_taskMain",
+ "name": "thumbnail"}
+ failures.append(
+ DBAssert.count_of_types(dbcon, "representation", 1,
+ additional_args=additional_args))
+
+ additional_args = {"context.subset": "renderTest_taskMain",
+ "name": "h264_mov"}
+ failures.append(
+ DBAssert.count_of_types(dbcon, "representation", 1,
+ additional_args=additional_args))
+
assert not any(failures)
diff --git a/tests/lib/testing_classes.py b/tests/lib/testing_classes.py
index 2bafa16971..300024dc98 100644
--- a/tests/lib/testing_classes.py
+++ b/tests/lib/testing_classes.py
@@ -243,6 +243,8 @@ class PublishTest(ModuleUnitTest):
PERSIST = True # True - keep test_db, test_openpype, outputted test files
TEST_DATA_FOLDER = None # use specific folder of unzipped test file
+ SETUP_ONLY = False
+
@pytest.fixture(scope="module")
def app_name(self, app_variant):
"""Returns calculated value for ApplicationManager. Eg.(nuke/12-2)"""
@@ -286,8 +288,13 @@ class PublishTest(ModuleUnitTest):
@pytest.fixture(scope="module")
def launched_app(self, dbcon, download_test_data, last_workfile_path,
- startup_scripts, app_args, app_name, output_folder_url):
+ startup_scripts, app_args, app_name, output_folder_url,
+ setup_only):
"""Launch host app"""
+ if setup_only or self.SETUP_ONLY:
+ print("Creating only setup for test, not launching app")
+ yield
+ return
# set schema - for integrate_new
from openpype import PACKAGE_DIR
# Path to OpenPype's schema
@@ -316,8 +323,12 @@ class PublishTest(ModuleUnitTest):
@pytest.fixture(scope="module")
def publish_finished(self, dbcon, launched_app, download_test_data,
- timeout):
+ timeout, setup_only):
"""Dummy fixture waiting for publish to finish"""
+ if setup_only or self.SETUP_ONLY:
+ print("Creating only setup for test, not launching app")
+ yield False
+ return
import time
time_start = time.time()
timeout = timeout or self.TIMEOUT
@@ -334,11 +345,16 @@ class PublishTest(ModuleUnitTest):
def test_folder_structure_same(self, dbcon, publish_finished,
download_test_data, output_folder_url,
- skip_compare_folders):
+ skip_compare_folders,
+ setup_only):
"""Check if expected and published subfolders contain same files.
Compares only presence, not size nor content!
"""
+ if setup_only or self.SETUP_ONLY:
+ print("Creating only setup for test, not launching app")
+ return
+
published_dir_base = output_folder_url
expected_dir_base = os.path.join(download_test_data,
"expected")
diff --git a/tests/unit/openpype/pipeline/publish/test_publish_plugins.py b/tests/unit/openpype/pipeline/publish/test_publish_plugins.py
index 5c2d7b367f..88e0095e34 100644
--- a/tests/unit/openpype/pipeline/publish/test_publish_plugins.py
+++ b/tests/unit/openpype/pipeline/publish/test_publish_plugins.py
@@ -135,7 +135,7 @@ class TestPipelinePublishPlugins(TestPipeline):
}
# load plugin function for testing
- plugin = publish_plugins.ExtractorColormanaged()
+ plugin = publish_plugins.ColormanagedPyblishPluginMixin()
plugin.log = log
config_data, file_rules = plugin.get_colorspace_settings(context)
@@ -175,14 +175,14 @@ class TestPipelinePublishPlugins(TestPipeline):
}
# load plugin function for testing
- plugin = publish_plugins.ExtractorColormanaged()
+ plugin = publish_plugins.ColormanagedPyblishPluginMixin()
plugin.log = log
plugin.set_representation_colorspace(
representation_nuke, context,
colorspace_settings=(config_data_nuke, file_rules_nuke)
)
# load plugin function for testing
- plugin = publish_plugins.ExtractorColormanaged()
+ plugin = publish_plugins.ColormanagedPyblishPluginMixin()
plugin.log = log
plugin.set_representation_colorspace(
representation_hiero, context,
diff --git a/website/docs/admin_environment.md b/website/docs/admin_environment.md
index 1eb755b90b..29b70a6c47 100644
--- a/website/docs/admin_environment.md
+++ b/website/docs/admin_environment.md
@@ -27,4 +27,4 @@ import TabItem from '@theme/TabItem';
- for more details on how to use it go [here](admin_use#check-for-mongodb-database-connection)
## OPENPYPE_USERNAME
-- if set it overides system created username
+- if set it overrides system created username
diff --git a/website/docs/admin_hosts_maya.md b/website/docs/admin_hosts_maya.md
index 0e77f29fc2..68b402c5e0 100644
--- a/website/docs/admin_hosts_maya.md
+++ b/website/docs/admin_hosts_maya.md
@@ -6,13 +6,13 @@ sidebar_label: Maya
## Publish Plugins
-### Render Settings Validator
+### Render Settings Validator
`ValidateRenderSettings`
Render Settings Validator is here to make sure artists will submit renders
-we correct settings. Some of these settings are needed by OpenPype but some
-can be defined by TD using [OpenPype Settings UI](admin_settings.md).
+with the correct settings. Some of these settings are needed by OpenPype but some
+can be defined by the admin using [OpenPype Settings UI](admin_settings.md).
OpenPype enforced settings include:
@@ -36,10 +36,9 @@ For **Renderman**:
For **Arnold**:
- there shouldn't be `` token when merge AOVs option is turned on
-
Additional check can be added via Settings - **Project Settings > Maya > Publish plugin > ValidateRenderSettings**.
You can add as many options as you want for every supported renderer. In first field put node type and attribute
-and in the second required value.
+and in the second required value. You can create multiple values for an attribute, but when repairing it'll be the first value in the list that get selected.
@@ -51,7 +50,11 @@ just one instance of this node type but if that is not so, validator will go thr
instances and check the value there. Node type for **VRay** settings is `VRaySettingsNode`, for **Renderman**
it is `rmanGlobals`, for **Redshift** it is `RedshiftOptions`.
-### Model Name Validator
+:::info getting attribute values
+If you do not know what an attributes value is supposed to be, for example for dropdown menu (enum), try changing the attribute and look in the script editor where it should log what the attribute was set to.
+:::
+
+### Model Name Validator
`ValidateRenderSettings`
@@ -95,7 +98,7 @@ You can set various aspects of scene submission to farm with per-project setting
- **Optional** will mark sumission plugin optional
- **Active** will enable/disable plugin
- - **Tile Assembler Plugin** will set what should be used to assemble tiles on Deadline. Either **Open Image IO** will be used
+ - **Tile Assembler Plugin** will set what should be used to assemble tiles on Deadline. Either **Open Image IO** will be used
or Deadlines **Draft Tile Assembler**.
- **Use Published scene** enable to render from published scene instead of scene in work area. Rendering from published files is much safer.
- **Use Asset dependencies** will mark job pending on farm until asset dependencies are fulfilled - for example Deadline will wait for scene file to be synced to cloud, etc.
@@ -107,6 +110,41 @@ or Deadlines **Draft Tile Assembler**.
This is useful to fix some specific renderer glitches and advanced hacking of Maya Scene files. `Patch name` is label for patch for easier orientation.
`Patch regex` is regex used to find line in file, after `Patch line` string is inserted. Note that you need to add line ending.
+### Extract Playblast Settings (review)
+These settings provide granular control over how the playblasts or reviews are produced in Maya.
+
+Some of these settings are also available on the instance itself, in which case these settings will become the default value when creating the review instance.
+
+
+
+- **Compression type** which file encoding to use.
+- **Data format** what format is the file encoding.
+- **Quality** lets you control the compression value for the output. Results can vary depending on the compression you selected. Quality values can range from 0 to 100, with a default value of 95.
+- **Background Color** the viewports background color.
+- **Background Bottom** the viewports background bottom color.
+- **Background Top** the viewports background top color.
+- **Override display options** override the viewports display options to use what is set in the settings.
+- **Isolate view** isolates the view to what is in the review instance. If only a camera is present in the review instance, all nodes are displayed in view.
+- **Off Screen** records the playblast hidden from the user.
+- **2D Pan/Zoom** enables the 2D Pan/Zoom functionality of the camera.
+- **Renderer name** which renderer to use for playblasting.
+- **Width** width of the output resolution. If this value is `0`, the asset's width is used.
+- **Height** height of the output resolution. If this value is `0`, the asset's height is used.
+
+#### Viewport Options
+
+Most settings to override in the viewport are self explanatory and can be found in Maya.
+
+
+
+- **Override Viewport Options** enable to use the settings below for the viewport when publishing the review.
+
+#### Camera Options
+
+These options are set on the camera shape when publishing the review. They correspond to attributes on the Maya camera shape node.
+
+
+
## Custom Menu
You can add your custom tools menu into Maya by extending definitions in **Maya -> Scripts Menu Definition**.
@@ -142,7 +180,7 @@ Fill in the necessary fields (the optional fields are regex filters)
- - Builder type: Wether the the placeholder should load current asset representations or linked assets representations
+ - Builder type: Whether the the placeholder should load current asset representations or linked assets representations
- Representation: Representation that will be loaded (ex: ma, abc, png, etc...)
@@ -169,5 +207,3 @@ Fill in the necessary fields (the optional fields are regex filters)
- Build your workfile
-
-
diff --git a/website/docs/admin_settings.md b/website/docs/admin_settings.md
index 8626ef16ba..1128cc00c6 100644
--- a/website/docs/admin_settings.md
+++ b/website/docs/admin_settings.md
@@ -7,12 +7,15 @@ sidebar_label: Working with settings
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-OpenPype stores all of it's settings and configuration in the mongo database. To make the configuration as easy as possible we provide a robust GUI where you can access and change everything that is configurable
+OpenPype stores all of its settings and configuration in the mongo database. To make the configuration as easy as possible we provide a robust GUI where you can access and change everything that is configurable
**Settings** GUI can be started from the tray menu *Admin -> Studio Settings*.
-Please keep in mind that these settings are set-up for the full studio and not per-individual. If you're looking for individual artist settings, you can head to
-[Local Settings](admin_settings_local.md) section in the artist documentation.
+:::important Studio Settings versus Local Settings
+Please keep in mind that these settings are set up for the full studio and not per-individual. If you're looking for individual artist settings, you can head to
+[Local Settings](admin_settings_local.md) section in the documentation.
+:::
+
## Categories
@@ -76,7 +79,7 @@ You can also reset any settings to OpenPype default by doing `right click` and `
Many settings are useful to be adjusted on a per-project basis. To identify project
overrides, they are marked with **orange edge** and **orange labels** in the settings GUI.
-The process of settting project overrides is similar to setting the Studio defaults. The key difference is to select a particular project you want to be configure. Those projects can be found on the left hand side of the Project Settings tab.
+The process of setting project overrides is similar to setting the Studio defaults. The key difference is to select a particular project you want to be configure. Those projects can be found on the left hand side of the Project Settings tab.
In the image below you can see all three overrides at the same time.
1. Deadline has **no changes to the OpenPype defaults** at all — **grey** colour of left bar.
diff --git a/website/docs/admin_use.md b/website/docs/admin_use.md
index c92ac3a77a..c1d1de0e8c 100644
--- a/website/docs/admin_use.md
+++ b/website/docs/admin_use.md
@@ -68,7 +68,7 @@ Add `--headless` to run OpenPype without graphical UI (useful on server or on au
`--verbose` `` - change log verbose level of OpenPype loggers.
-Level value can be integer in range `0-50` or one of enum strings `"notset" (0)`, `"debug" (10)`, `"info" (20)`, `"warning" (30)`, `"error" (40)`, `"ciritcal" (50)`. Value is stored to `OPENPYPE_LOG_LEVEL` environment variable for next processes.
+Level value can be integer in range `0-50` or one of enum strings `"notset" (0)`, `"debug" (10)`, `"info" (20)`, `"warning" (30)`, `"error" (40)`, `"critical" (50)`. Value is stored to `OPENPYPE_LOG_LEVEL` environment variable for next processes.
```shell
openpype_console --verbose debug
diff --git a/website/docs/artist_hosts_3dsmax.md b/website/docs/artist_hosts_3dsmax.md
index 71ba8785dc..12c1f40181 100644
--- a/website/docs/artist_hosts_3dsmax.md
+++ b/website/docs/artist_hosts_3dsmax.md
@@ -47,7 +47,7 @@ This is the core functional area for you as a user. Most of your actions will ta
:::note OpenPype Menu
-User should use this menu exclusively for **Opening/Saving** when dealing with work files not standard ```File Menu``` even though user still being able perform file operations via this menu but prefferably just performing quick saves during work session not saving actual workfile versions.
+User should use this menu exclusively for **Opening/Saving** when dealing with work files not standard ```File Menu``` even though user still being able perform file operations via this menu but preferably just performing quick saves during work session not saving actual workfile versions.
:::
## Working With Scene Files
@@ -73,7 +73,7 @@ OpenPype correctly names it and add version to the workfile. This basically happ
etc.
-Basically meaning user is free of guessing what is the correct naming and other neccessities to keep everthing in order and managed.
+Basically meaning user is free of guessing what is the correct naming and other necessities to keep everything in order and managed.
> Note: user still has also other options for naming like ```Subversion```, ```Artist's Note``` but we won't dive into those now.
diff --git a/website/docs/artist_hosts_aftereffects.md b/website/docs/artist_hosts_aftereffects.md
index a9c9ca49fa..939ef4034c 100644
--- a/website/docs/artist_hosts_aftereffects.md
+++ b/website/docs/artist_hosts_aftereffects.md
@@ -34,7 +34,7 @@ a correct name. You should use it instead of standard file saving dialog.
In AfterEffects you'll find the tools in the `OpenPype` extension:
-
+
You can show the extension panel by going to `Window` > `Extensions` > `OpenPype`.
@@ -104,7 +104,7 @@ There are currently 2 options of `render` item:
When you want to load existing published work, you can use the `Loader` tool. You can reach it in the extension's panel.
-
+
The supported families for loading into AfterEffects are:
@@ -128,7 +128,7 @@ Now that we have some content loaded, you can manage which version is loaded. Th
Loaded images have to stay as smart layers in order to be updated. If you rasterize the layer, you can no longer update it to a different version using OpenPype tools.
:::
-
+
You can switch to a previous version of the image or update to the latest.
diff --git a/website/docs/artist_hosts_harmony.md b/website/docs/artist_hosts_harmony.md
index aa9355e221..eaa6edc42a 100644
--- a/website/docs/artist_hosts_harmony.md
+++ b/website/docs/artist_hosts_harmony.md
@@ -44,7 +44,7 @@ Because the saving to the network location happens in the background, be careful
`OpenPype > Create`
-
+
These are the families supported in Harmony:
diff --git a/website/docs/artist_hosts_hiero.md b/website/docs/artist_hosts_hiero.md
index 136ed6ea9c..977c7a7baf 100644
--- a/website/docs/artist_hosts_hiero.md
+++ b/website/docs/artist_hosts_hiero.md
@@ -231,14 +231,14 @@ All published instances that will replace the place holder must contain unique i
-The informations about these objects are given by the user by filling the extra attributes of the Place Holder
+The information about these objects are given by the user by filling the extra attributes of the Place Holder
### Update Place Holder
-This tool alows the user to change the information provided in the extra attributes of the selected Place Holder.
+This tool allows the user to change the information provided in the extra attributes of the selected Place Holder.
@@ -250,7 +250,7 @@ This tool imports the template used and replaces the existed PlaceHolders with t
#### Result
-- Replace `PLACEHOLDER` node in the template with the published instance corresponding to the informations provided in extra attributes of the Place Holder
+- Replace `PLACEHOLDER` node in the template with the published instance corresponding to the information provided in extra attributes of the Place Holder
diff --git a/website/docs/artist_hosts_maya.md b/website/docs/artist_hosts_maya.md
index 07495fbc96..0a551f0213 100644
--- a/website/docs/artist_hosts_maya.md
+++ b/website/docs/artist_hosts_maya.md
@@ -230,8 +230,8 @@ Maya settings concerning framerate, resolution and frame range are handled by
OpenPype. If set correctly in Ftrack, Maya will validate you have correct fps on
scene save and publishing offering way to fix it for you.
-For resolution and frame range, use **OpenPype → Reset Frame Range** and
-**OpenPype → Reset Resolution**
+For resolution and frame range, use **OpenPype → Set Frame Range** and
+**OpenPype → Set Resolution**
## Creating rigs with OpenPype
@@ -386,7 +386,7 @@ Lets start with empty scene. First I'll pull in my favorite Buddha model.
there just click on **Reference (abc)**.
Next, I want to be sure that I have same frame range as is set on shot I am working
-on. To do this just **OpenPype → Reset Frame Range**. This should set Maya timeline to same
+on. To do this just **OpenPype → Set Frame Range**. This should set Maya timeline to same
values as they are set on shot in *Ftrack* for example.
I have my time set, so lets create some animation. We'll turn Buddha model around for
@@ -500,7 +500,7 @@ and for vray:
maya//
```
-Doing **OpenPype → Reset Resolution** will set correct resolution on camera.
+Doing **OpenPype → Set Resolution** will set correct resolution on camera.
Scene is now ready for submission and should publish without errors.
@@ -516,6 +516,22 @@ In the scene from where you want to publish your model create *Render subset*. P
model subset (Maya set node) under corresponding `LAYER_` set under *Render instance*. During publish, it will submit this render to farm and
after it is rendered, it will be attached to your model subset.
+### Tile Rendering
+:::note Deadline
+This feature is only supported when using Deadline. See [here](module_deadline#openpypetileassembler-plugin) for setup.
+:::
+On the render instance objectset you'll find:
+
+* `Tile Rendering` - for enabling tile rendering.
+* `Tile X` - number of tiles in the X axis.
+* `Tile Y` - number of tiles in the Y axis.
+
+When submittig to Deadline, you'll get:
+
+- for each frame a tile rendering job, to render each from Maya.
+- for each frame a tile assembly job, to assemble the rendered tiles.
+- job to publish the assembled frames.
+
## Render Setups
### Publishing Render Setups
diff --git a/website/docs/artist_hosts_maya_arnold.md b/website/docs/artist_hosts_maya_arnold.md
index b3c02a0894..da16ba66c0 100644
--- a/website/docs/artist_hosts_maya_arnold.md
+++ b/website/docs/artist_hosts_maya_arnold.md
@@ -6,7 +6,7 @@ sidebar_label: Arnold
## Arnold Scene Source (.ass)
Arnold Scene Source can be published as a single file or a sequence of files, determined by the frame range.
-When creating the instance, two objectsets are created; `content` and `proxy`. Meshes in the `proxy` objectset will be the viewport representation when loading as `standin`. Proxy representations are stored as `resources` of the subset.
+When creating the instance, two objectsets are created; `content` and `proxy`. Meshes in the `proxy` objectset will be the viewport representation when loading as `standin`.
### Arnold Scene Source Proxy Workflow
In order to utilize operators and proxies, the content and proxy nodes need to share the same names (including the shape names). This is done by parenting the content and proxy nodes into separate groups. For example:
diff --git a/website/docs/artist_hosts_maya_yeti.md b/website/docs/artist_hosts_maya_yeti.md
index f5a6a4d2c9..aa783cc8b6 100644
--- a/website/docs/artist_hosts_maya_yeti.md
+++ b/website/docs/artist_hosts_maya_yeti.md
@@ -9,7 +9,9 @@ sidebar_label: Yeti
OpenPype can work with [Yeti](https://peregrinelabs.com/yeti/) in two data modes.
It can handle Yeti caches and Yeti rigs.
-### Creating and publishing Yeti caches
+## Yeti Caches
+
+### Creating and publishing
Let start by creating simple Yeti setup, just one object and Yeti node. Open new
empty scene in Maya and create sphere. Then select sphere and go **Yeti → Create Yeti Node on Mesh**
@@ -44,7 +46,15 @@ You can now publish Yeti cache as any other types. **OpenPype → Publish**. It
create sequence of `.fur` files and `.fursettings` metadata file with Yeti node
setting.
-### Loading Yeti caches
+:::note Collect Yeti Cache failure
+If you encounter **Collect Yeti Cache** failure during collecting phase, and the error is like
+```fix
+No object matches name: pgYetiMaya1Shape.cbId
+```
+then it is probably caused by scene not being saved before publishing.
+:::
+
+### Loading
You can load Yeti cache by **OpenPype → Load ...**. Select your cache, right+click on
it and select **Load Yeti cache**. This will create Yeti node in scene and set its
@@ -52,26 +62,39 @@ cache path to point to your published cache files. Note that this Yeti node will
be named with same name as the one you've used to publish cache. Also notice that
when you open graph on this Yeti node, all nodes are as they were in publishing node.
-### Creating and publishing Yeti Rig
+## Yeti Rigs
-Yeti Rigs are working in similar way as caches, but are more complex and they deal with
-other data used by Yeti, like geometry and textures.
+### Creating and publishing
-Let's start by [loading](artist_hosts_maya.md#loading-model) into new scene some model.
-I've loaded my Buddha model.
+Yeti Rigs are designed to connect to published models or animation rig. The workflow gives the Yeti Rig full control on that geometry to do additional things on top of whatever input comes in, e.g. deleting faces, pushing faces in/out, subdividing, etc.
-Create select model mesh, create Yeti node - **Yeti → Create Yeti Node on Mesh** and
-setup similar Yeti graph as in cache example above.
+Let's start with a [model](artist_hosts_maya.md#loading-model) or [rig](artist_hosts_maya.md#loading-rigs) loaded into the scene. Here we are using a simple rig.
-Then select this Yeti node (mine is called with default name `pgYetiMaya1`) and
-create *Yeti Rig instance* - **OpenPype → Create...** and select **Yeti Cache**.
+
+
+We'll need to prepare the scene a bit. We want some Yeti hair on the ball geometry, so duplicating the geometry, adding the Yeti hair and grouping it together.
+
+
+
+:::note yeti nodes and types
+You can use any number of Yeti nodes and types, but they have to have unique names.
+:::
+
+Now we need to connect the Yeti Rig with the animation rig. Yeti Rigs work by publishing the attribute connections from its input nodes and reconnect them later in the pipeline. This means we can only use attribute connections to from outside of the Yeti Rig hierarchy. Internal to the Yeti Rig hierarchy, we can use any complexity of node connections. We'll connnect the Yeti Rig geometry to the animation rig, with the transform and mesh attributes.
+
+
+
+Now we are ready for publishing. Select the Yeti Rig group (`rig_GRP`) and
+create *Yeti Rig instance* - **OpenPype → Create...** and select **Yeti Rig**.
Leave `Use selection` checked.
-Last step is to add our model geometry to rig instance, so middle+drag its
-geometry to `input_SET` under `yetiRigDefault` set representing rig instance.
+Last step is to add our geometry to the rig instance, so middle+drag its
+geometry to `input_SET` under the `yetiRigMain` set representing rig instance.
Note that its name can differ and is based on your subset name.
-
+
+
+You can have any number of nodes in the Yeti Rig, but only nodes with incoming attribute connections from outside of the Yeti Rig hierarchy is needed in the `input_SET`.
Save your scene and ready for publishing our new simple Yeti Rig!
@@ -81,28 +104,14 @@ the beginning of your timeline. It will also collect all textures used in Yeti
node, copy them to publish folder `resource` directory and set *Image search path*
of published node to this location.
-:::note Collect Yeti Cache failure
-If you encounter **Collect Yeti Cache** failure during collecting phase, and the error is like
-```fix
-No object matches name: pgYetiMaya1Shape.cbId
-```
-then it is probably caused by scene not being saved before publishing.
-:::
+### Loading
-### Loading Yeti Rig
-
-You can load published Yeti Rigs as any other thing in OpenPype - **OpenPype → Load ...**,
+You can load published Yeti Rigs in OpenPype with **OpenPype → Load ...**,
select you Yeti rig and right+click on it. In context menu you should see
-**Load Yeti Cache** and **Load Yeti Rig** items (among others). First one will
-load that one frame cache. The other one will load whole rig.
+**Load Yeti Rig** item (among others).
-Notice that although we put only geometry into `input_SET`, whole hierarchy was
-pulled inside also. This allows you to store complex scene element along Yeti
-node.
+To connect the Yeti Rig with published animation, we'll load in the animation and use the Inventory to establish the connections.
-:::tip auto-connecting rig mesh to existing one
-If you select some objects before loading rig it will try to find shapes
-under selected hierarchies and match them with shapes loaded with rig (published
-under `input_SET`). This mechanism uses *cbId* attribute on those shapes.
-If match is found shapes are connected using their `outMesh` and `outMesh`. Thus you can easily connect existing animation to loaded rig.
-:::
+
+
+The Yeti Rig should now be following the animation. :tada:
diff --git a/website/docs/artist_hosts_photoshop.md b/website/docs/artist_hosts_photoshop.md
index 88bfb1484d..12203a5c6e 100644
--- a/website/docs/artist_hosts_photoshop.md
+++ b/website/docs/artist_hosts_photoshop.md
@@ -75,7 +75,7 @@ enabled instances, you could see more information after clicking on `Details` ta
-In this dialog you could see publishable instances in left colummn, triggered plugins in the middle and logs in the right column.
+In this dialog you could see publishable instances in left column, triggered plugins in the middle and logs in the right column.
In left column you could see that `review` instance was created automatically. This instance flattens all publishable instances or
all visible layers if no publishable instances were created into single image which could serve as a single reviewable element (for example in Ftrack).
diff --git a/website/docs/artist_tools_sync_queu.md b/website/docs/artist_tools_sync_queu.md
index 770c2f77ad..7dac8638f9 100644
--- a/website/docs/artist_tools_sync_queu.md
+++ b/website/docs/artist_tools_sync_queu.md
@@ -2,7 +2,7 @@
id: artist_tools_sync_queue
title: Sync Queue
sidebar_label: Sync Queue
-description: Track sites syncronization progress.
+description: Track sites synchronization progress.
---
# Sync Queue
diff --git a/website/docs/assets/harmony_creator.PNG b/website/docs/assets/harmony_creator.png
similarity index 100%
rename from website/docs/assets/harmony_creator.PNG
rename to website/docs/assets/harmony_creator.png
diff --git a/website/docs/assets/integrate_kitsu_note_settings.png b/website/docs/assets/integrate_kitsu_note_settings.png
new file mode 100644
index 0000000000..9c59f0bf5c
Binary files /dev/null and b/website/docs/assets/integrate_kitsu_note_settings.png differ
diff --git a/website/docs/assets/maya-admin_extract_playblast_settings.png b/website/docs/assets/maya-admin_extract_playblast_settings.png
new file mode 100644
index 0000000000..9312e30321
Binary files /dev/null and b/website/docs/assets/maya-admin_extract_playblast_settings.png differ
diff --git a/website/docs/assets/maya-admin_extract_playblast_settings_camera_options.png b/website/docs/assets/maya-admin_extract_playblast_settings_camera_options.png
new file mode 100644
index 0000000000..1a5561328e
Binary files /dev/null and b/website/docs/assets/maya-admin_extract_playblast_settings_camera_options.png differ
diff --git a/website/docs/assets/maya-admin_extract_playblast_settings_viewport_options.png b/website/docs/assets/maya-admin_extract_playblast_settings_viewport_options.png
new file mode 100644
index 0000000000..5b801775d3
Binary files /dev/null and b/website/docs/assets/maya-admin_extract_playblast_settings_viewport_options.png differ
diff --git a/website/docs/assets/maya-admin_render_settings_validator.png b/website/docs/assets/maya-admin_render_settings_validator.png
index 8687b538b1..8ee11f16f6 100644
Binary files a/website/docs/assets/maya-admin_render_settings_validator.png and b/website/docs/assets/maya-admin_render_settings_validator.png differ
diff --git a/website/docs/assets/maya-yeti_hair_setup.png b/website/docs/assets/maya-yeti_hair_setup.png
new file mode 100644
index 0000000000..8cd7f5f97a
Binary files /dev/null and b/website/docs/assets/maya-yeti_hair_setup.png differ
diff --git a/website/docs/assets/maya-yeti_load_connections.png b/website/docs/assets/maya-yeti_load_connections.png
new file mode 100644
index 0000000000..4e96fdc0b3
Binary files /dev/null and b/website/docs/assets/maya-yeti_load_connections.png differ
diff --git a/website/docs/assets/maya-yeti_publish_setup.png b/website/docs/assets/maya-yeti_publish_setup.png
new file mode 100644
index 0000000000..f376f47cc1
Binary files /dev/null and b/website/docs/assets/maya-yeti_publish_setup.png differ
diff --git a/website/docs/assets/maya-yeti_rig.jpg b/website/docs/assets/maya-yeti_rig.jpg
deleted file mode 100644
index 07b13db409..0000000000
Binary files a/website/docs/assets/maya-yeti_rig.jpg and /dev/null differ
diff --git a/website/docs/assets/maya-yeti_rig_setup.png b/website/docs/assets/maya-yeti_rig_setup.png
new file mode 100644
index 0000000000..876ecba0a2
Binary files /dev/null and b/website/docs/assets/maya-yeti_rig_setup.png differ
diff --git a/website/docs/assets/maya-yeti_simple_rig.png b/website/docs/assets/maya-yeti_simple_rig.png
new file mode 100644
index 0000000000..31a60ac40b
Binary files /dev/null and b/website/docs/assets/maya-yeti_simple_rig.png differ
diff --git a/website/docs/dev_colorspace.md b/website/docs/dev_colorspace.md
index fe9a0ec1e3..c4b8e74d73 100644
--- a/website/docs/dev_colorspace.md
+++ b/website/docs/dev_colorspace.md
@@ -24,8 +24,8 @@ It's up to the Loaders to read these values and apply the correct expected color
### Keys
- **colorspace** - string value used in other publish plugins and loaders
- **config** - storing two versions of path.
- - **path** - is formated and with baked platform root. It is used for posible need to find out where we were sourcing color config during publishing.
- - **template** - unformated tempate resolved from settings. It is used for other plugins targeted to remote publish which could be processed at different platform.
+ - **path** - is formatted and with baked platform root. It is used for possible need to find out where we were sourcing color config during publishing.
+ - **template** - unformatted template resolved from settings. It is used for other plugins targeted to remote publish which could be processed at different platform.
### Example
{
@@ -63,7 +63,7 @@ It's up to the Loaders to read these values and apply the correct expected color
- set the `OCIO` environment variable before launching the host via a prelaunch hook
- or (if the host allows) to set the workfile OCIO config path using the host's API
-3. Each Extractor exporting pixel data (e.g. image or video) has to use parent class `openpype.pipeline.publish.publish_plugins.ExtractorColormanaged` and use `self.set_representation_colorspace` on the representations to be integrated.
+3. Each Extractor exporting pixel data (e.g. image or video) has to inherit from the mixin class `openpype.pipeline.publish.publish_plugins.ColormanagedPyblishPluginMixin` and use `self.set_representation_colorspace` on the representations to be integrated.
The **set_representation_colorspace** method adds `colorspaceData` to the representation. If the `colorspace` passed is not `None` then it is added directly to the representation with resolved config path otherwise a color space is assumed using the configured file rules. If no file rule matches the `colorspaceData` is **not** added to the representation.
diff --git a/website/docs/dev_host_implementation.md b/website/docs/dev_host_implementation.md
index 3702483ad1..e62043723f 100644
--- a/website/docs/dev_host_implementation.md
+++ b/website/docs/dev_host_implementation.md
@@ -45,10 +45,10 @@ openpype/hosts/{host name}
```
### Launch Hooks
-Launch hooks are not directly connected to host implementation, but they can be used to modify launch of process which may be crutial for the implementation. Launch hook are plugins called when DCC is launched. They are processed in sequence before and after launch. Pre launch hooks can change how process of DCC is launched, e.g. change subprocess flags, modify environments or modify launch arguments. If prelaunch hook crashes the application is not launched at all. Postlaunch hooks are triggered after launch of subprocess. They can be used to change statuses in your project tracker, start timer, etc. Crashed postlaunch hooks have no effect on rest of postlaunch hooks or launched process. They can be filtered by platform, host and application and order is defined by integer value. Hooks inside host are automatically loaded (one reason why folder name should match host name) or can be defined from modules. Hooks execution share same launch context where can be stored data used across multiple hooks (please be very specific in stored keys e.g. 'project' vs. 'project_name'). For more detailed information look into `openpype/lib/applications.py`.
+Launch hooks are not directly connected to host implementation, but they can be used to modify launch of process which may be crucial for the implementation. Launch hook are plugins called when DCC is launched. They are processed in sequence before and after launch. Pre launch hooks can change how process of DCC is launched, e.g. change subprocess flags, modify environments or modify launch arguments. If prelaunch hook crashes the application is not launched at all. Postlaunch hooks are triggered after launch of subprocess. They can be used to change statuses in your project tracker, start timer, etc. Crashed postlaunch hooks have no effect on rest of postlaunch hooks or launched process. They can be filtered by platform, host and application and order is defined by integer value. Hooks inside host are automatically loaded (one reason why folder name should match host name) or can be defined from modules. Hooks execution share same launch context where can be stored data used across multiple hooks (please be very specific in stored keys e.g. 'project' vs. 'project_name'). For more detailed information look into `openpype/lib/applications.py`.
### Public interface
-Public face is at this moment related to launching of the DCC. At this moment there there is only option to modify environment variables before launch by implementing function `add_implementation_envs` (must be available in `openpype/hosts/{host name}/__init__.py`). The function is called after pre launch hooks, as last step before subprocess launch, to be able set environment variables crutial for proper integration. It is also good place for functions that are used in prelaunch hooks and in-DCC integration. Future plans are to be able get workfiles extensions from here. Right now workfiles extensions are hardcoded in `openpype/pipeline/constants.py` under `HOST_WORKFILE_EXTENSIONS`, we would like to handle hosts as addons similar to OpenPype modules, and more improvements which are now hardcoded.
+Public face is at this moment related to launching of the DCC. At this moment there there is only option to modify environment variables before launch by implementing function `add_implementation_envs` (must be available in `openpype/hosts/{host name}/__init__.py`). The function is called after pre launch hooks, as last step before subprocess launch, to be able set environment variables crucial for proper integration. It is also good place for functions that are used in prelaunch hooks and in-DCC integration. Future plans are to be able get workfiles extensions from here. Right now workfiles extensions are hardcoded in `openpype/pipeline/constants.py` under `HOST_WORKFILE_EXTENSIONS`, we would like to handle hosts as addons similar to OpenPype modules, and more improvements which are now hardcoded.
### Integration
We've prepared base class `HostBase` in `openpype/host/host.py` to define minimum requirements and provide some default method implementations. The minimum requirement for a host is `name` attribute, this host would not be able to do much but is valid. To extend functionality we've prepared interfaces that helps to identify what is host capable of and if is possible to use certain tools with it. For those cases we defined interfaces for each workflow. `IWorkfileHost` interface add requirement to implement workfiles related methods which makes host usable in combination with Workfiles tool. `ILoadHost` interface add requirements to be able load, update, switch or remove referenced representations which should add support to use Loader and Scene Inventory tools. `INewPublisher` interface is required to be able use host with new OpenPype publish workflow. This is what must or can be implemented to allow certain functionality. `HostBase` will have more responsibility which will be taken from global variables in future. This process won't happen at once, but will be slow to keep backwards compatibility for some time.
diff --git a/website/docs/dev_publishing.md b/website/docs/dev_publishing.md
index 135f6cd985..2c57537223 100644
--- a/website/docs/dev_publishing.md
+++ b/website/docs/dev_publishing.md
@@ -415,7 +415,7 @@ class CreateRender(Creator):
# - 'asset' - asset name
# - 'task' - task name
# - 'variant' - variant
- # - 'family' - instnace family
+ # - 'family' - instance family
# Check if should use selection or not
if pre_create_data.get("use_selection"):
diff --git a/website/docs/dev_settings.md b/website/docs/dev_settings.md
index 94590345e8..1010169a5f 100644
--- a/website/docs/dev_settings.md
+++ b/website/docs/dev_settings.md
@@ -355,7 +355,7 @@ These inputs wraps another inputs into {key: value} relation
{
"type": "text",
"key": "command",
- "label": "Comand"
+ "label": "Command"
}
]
},
@@ -420,7 +420,7 @@ How output of the schema could look like on save:
- number input, can be used for both integer and float
- key `"decimal"` defines how many decimal places will be used, 0 is for integer input (Default: `0`)
- key `"minimum"` as minimum allowed number to enter (Default: `-99999`)
- - key `"maxium"` as maximum allowed number to enter (Default: `99999`)
+ - key `"maximum"` as maximum allowed number to enter (Default: `99999`)
- key `"steps"` will change single step value of UI inputs (using arrows and wheel scroll)
- for UI it is possible to show slider to enable this option set `show_slider` to `true`
```javascript
@@ -602,7 +602,7 @@ How output of the schema could look like on save:
- there are 2 possible ways how to set the type:
1.) dictionary with item modifiers (`number` input has `minimum`, `maximum` and `decimals`) in that case item type must be set as value of `"type"` (example below)
2.) item type name as string without modifiers (e.g. [text](#text))
- 3.) enhancement of 1.) there is also support of `template` type but be carefull about endless loop of templates
+ 3.) enhancement of 1.) there is also support of `template` type but be careful about endless loop of templates
- goal of using `template` is to easily change same item definitions in multiple lists
1.) with item modifiers
diff --git a/website/docs/dev_testing.md b/website/docs/dev_testing.md
index 7136ceb479..434c1ca9ff 100644
--- a/website/docs/dev_testing.md
+++ b/website/docs/dev_testing.md
@@ -57,7 +57,7 @@ Content:
Contains end to end testing in a DCC. Currently it is setup to start DCC application with prepared worfkile, run publish process and compare results in DB and file system automatically.
This approach is implemented as it should work in any DCC application and should cover most common use cases. Not all hosts allow "real headless" publishing, but all hosts should allow to trigger
-publish process programatically when UI of host is actually running.
+publish process programmatically when UI of host is actually running.
There will be eventually also possibility to build workfile and publish it programmatically, this would work only in DCCs that support it (Maya, Nuke).
diff --git a/website/docs/manager_ftrack.md b/website/docs/manager_ftrack.md
index b5ca167838..836d84405e 100644
--- a/website/docs/manager_ftrack.md
+++ b/website/docs/manager_ftrack.md
@@ -4,7 +4,7 @@ title: Ftrack
sidebar_label: Project Manager
---
-Ftrack is currently the main project management option for OpenPype. This documentation assumes that you are familiar with Ftrack and it's basic principles. If you're new to Ftrack, we recommend having a thorough look at [Ftrack Official Documentation](https://help.ftrack.com/en/).
+Ftrack is currently the main project management option for OpenPype. This documentation assumes that you are familiar with Ftrack and its basic principles. If you're new to Ftrack, we recommend having a thorough look at [Ftrack Official Documentation](https://help.ftrack.com/en/).
## Project management
Setting project attributes is the key to properly working pipeline.
diff --git a/website/docs/module_deadline.md b/website/docs/module_deadline.md
index ab1016788d..94b6a381c2 100644
--- a/website/docs/module_deadline.md
+++ b/website/docs/module_deadline.md
@@ -45,6 +45,10 @@ executable. It is recommended to use the `openpype_console` executable as it pro
+### OpenPypeTileAssembler Plugin
+To setup tile rendering copy the `OpenPypeTileAssembler` plugin to the repository;
+`[OpenPype]\openpype\modules\deadline\repository\custom\plugins\OpenPypeTileAssembler` > `[DeadlineRepository]\custom\plugins\OpenPypeTileAssembler`
+
### Pools
The main pools can be configured at `project_settings/deadline/publish/CollectDeadlinePools/primary_pool`, which is applied to the rendering jobs.
diff --git a/website/docs/module_ftrack.md b/website/docs/module_ftrack.md
index 6d5529b512..9111e4658c 100644
--- a/website/docs/module_ftrack.md
+++ b/website/docs/module_ftrack.md
@@ -8,7 +8,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-Ftrack is currently the main project management option for OpenPype. This documentation assumes that you are familiar with Ftrack and it's basic principles. If you're new to Ftrack, we recommend having a thorough look at [Ftrack Official Documentation](http://ftrack.rtd.ftrack.com/en/stable/).
+Ftrack is currently the main project management option for OpenPype. This documentation assumes that you are familiar with Ftrack and its basic principles. If you're new to Ftrack, we recommend having a thorough look at [Ftrack Official Documentation](http://ftrack.rtd.ftrack.com/en/stable/).
## Prepare Ftrack for OpenPype
diff --git a/website/docs/module_kitsu.md b/website/docs/module_kitsu.md
index 7738ee1ce2..05cff87fcc 100644
--- a/website/docs/module_kitsu.md
+++ b/website/docs/module_kitsu.md
@@ -7,7 +7,7 @@ sidebar_label: Kitsu
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-Kitsu is a great open source production tracker and can be used for project management instead of Ftrack. This documentation assumes that you are familiar with Kitsu and it's basic principles. If you're new to Kitsu, we recommend having a thorough look at [Kitsu Official Documentation](https://kitsu.cg-wire.com/).
+Kitsu is a great open source production tracker and can be used for project management instead of Ftrack. This documentation assumes that you are familiar with Kitsu and its basic principles. If you're new to Kitsu, we recommend having a thorough look at [Kitsu Official Documentation](https://kitsu.cg-wire.com/).
## Prepare Kitsu for OpenPype
@@ -38,7 +38,20 @@ This functionality cannot deal with all cases and is not error proof, some inter
openpype_console module kitsu push-to-zou -l me@domain.ext -p my_password
```
+## Integrate Kitsu Note
+Task status can be automatically set during publish thanks to `Integrate Kitsu Note`. This feature can be configured in:
+
+`Admin -> Studio Settings -> Project Settings -> Kitsu -> Integrate Kitsu Note`.
+
+There are four settings available:
+- `Set status on note` -> Turns on and off this integrator.
+- `Note shortname` -> Which status shortname should be set automatically (Case sensitive).
+- `Status change conditions - Status conditions` -> Conditions that need to be met for kitsu status to be changed. You can add as many conditions as you like. There are two fields to each conditions: `Condition` (Whether current status should be equal or not equal to the condition status) and `Short name` (Kitsu Shortname of the condition status).
+- `Status change conditions - Family requirements` -> With this option you can add requirements to which families must be pushed or not in order to have the task status set by this integrator. There are two fields for each requirements: `Condition` (Same as the above) and `Family` (name of the family concerned by this requirement). For instance, adding one item set to `Not equal` and `workfile`, would mean the task status would change if a subset from another family than workfile is published (workfile can still be included), but not if you publish the workfile subset only.
+
+
+
## Q&A
### Is it safe to rename an entity from Kitsu?
Absolutely! Entities are linked by their unique IDs between the two databases.
-But renaming from the OP's Project Manager won't apply the change to Kitsu, it'll be overriden during the next synchronization.
+But renaming from the OP's Project Manager won't apply the change to Kitsu, it'll be overridden during the next synchronization.
diff --git a/website/docs/module_site_sync.md b/website/docs/module_site_sync.md
index 2e9cf01102..3e5794579c 100644
--- a/website/docs/module_site_sync.md
+++ b/website/docs/module_site_sync.md
@@ -89,7 +89,7 @@ all share the same provider).
Handles files stored on disk storage.
-Local drive provider is the most basic one that is used for accessing all standard hard disk storage scenarios. It will work with any storage that can be mounted on your system in a standard way. This could correspond to a physical external hard drive, network mounted storage, internal drive or even VPN connected network drive. It doesn't care about how te drive is mounted, but you must be able to point to it with a simple directory path.
+Local drive provider is the most basic one that is used for accessing all standard hard disk storage scenarios. It will work with any storage that can be mounted on your system in a standard way. This could correspond to a physical external hard drive, network mounted storage, internal drive or even VPN connected network drive. It doesn't care about how the drive is mounted, but you must be able to point to it with a simple directory path.
Default sites `local` and `studio` both use local drive provider.
diff --git a/website/docs/project_settings/assets/global_tools_custom_staging_dir.png b/website/docs/project_settings/assets/global_tools_custom_staging_dir.png
new file mode 100644
index 0000000000..f7e8660a88
Binary files /dev/null and b/website/docs/project_settings/assets/global_tools_custom_staging_dir.png differ
diff --git a/website/docs/project_settings/settings_project_global.md b/website/docs/project_settings/settings_project_global.md
index b320b5502f..821585ae21 100644
--- a/website/docs/project_settings/settings_project_global.md
+++ b/website/docs/project_settings/settings_project_global.md
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
Project settings can have project specific values. Each new project is using studio values defined in **default** project but these values can be modified or overridden per project.
:::warning Default studio values
-Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orage colour). Any changes in default project may affect all existing projects.
+Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orange colour). Any changes in default project may affect all existing projects.
:::
## Color Management (ImageIO)
@@ -39,14 +39,14 @@ Procedure of resolving path (from above example) will look first into path 1st a
### Using File rules
File rules are inspired by [OCIO v2 configuration]((https://opencolorio.readthedocs.io/en/latest/guides/authoring/rules.html)). Each rule has a unique name which can be overridden by host-specific _File rules_ (example: `project_settings/nuke/imageio/file_rules/rules`).
-The _input pattern_ matching uses REGEX expression syntax (try [regexr.com](https://regexr.com/)). Matching rules procedure's intention is to be used during publishing or loading of representation. Since the publishing procedure is run before integrator formate publish template path, make sure the pattern is working or any work render path.
+The _input pattern_ matching uses REGEX expression syntax (try [regexr.com](https://regexr.com/)). Matching rules procedure's intention is to be used during publishing or loading of representation. Since the publishing procedure is run before integrator format publish template path, make sure the pattern is working or any work render path.
:::warning Colorspace name input
The **colorspace name** value is a raw string input and no validation is run after saving project settings. We recommend to open the specified `config.ocio` file and copy pasting the exact colorspace names.
:::
### Extract OIIO Transcode
-OIIOTools transcoder plugin with configurable output presets. Any incoming representation with `colorspaceData` is convertable to single or multiple representations with different target colorspaces or display and viewer names found in linked **config.ocio** file.
+OIIOTools transcoder plugin with configurable output presets. Any incoming representation with `colorspaceData` is convertible to single or multiple representations with different target colorspaces or display and viewer names found in linked **config.ocio** file.
`oiiotool` is used for transcoding, eg. `oiiotool` must be present in `vendor/bin/oiio` or environment variable `OPENPYPE_OIIO_PATHS` must be provided for custom oiio installation.
@@ -82,8 +82,8 @@ All context filters are lists which may contain strings or Regular expressions (
- **`tasks`** - Currently processed task. `["modeling", "animation"]`
:::important Filtering
-Filters are optional. In case when multiple profiles match current context, profile with higher number of matched filters has higher priority that profile without filters.
-(Eg. order of when filter is added doesn't matter, only the precision of matching does.)
+Filters are optional. In case when multiple profiles match current context, profile with higher number of matched filters has higher priority than profile without filters.
+(The order the profiles in settings doesn't matter, only the precision of matching does.)
:::
## Publish plugins
@@ -94,7 +94,7 @@ Publish plugins used across all integrations.
### Extract Review
Plugin responsible for automatic FFmpeg conversion to variety of formats.
-Extract review is using [profile filtering](#profile-filters) to be able render different outputs for different situations.
+Extract review uses [profile filtering](#profile-filters) to render different outputs for different situations.
Applicable context filters:
**`hosts`** - Host from which publishing was triggered. `["maya", "nuke"]`
@@ -104,7 +104,7 @@ Applicable context filters:
**Output Definitions**
-Profile may generate multiple outputs from a single input. Each output must define unique name and output extension (use the extension without a dot e.g. **mp4**). All other settings of output definition are optional.
+A profile may generate multiple outputs from a single input. Each output must define unique name and output extension (use the extension without a dot e.g. **mp4**). All other settings of output definition are optional.
- **`Tags`**
@@ -118,7 +118,7 @@ Profile may generate multiple outputs from a single input. Each output must defi
- **Output arguments** other FFmpeg output arguments like codec definition.
- **`Output width`** and **`Output height`**
- - it is possible to rescale output to specified resolution and keep aspect ratio.
+ - It is possible to rescale output to specified resolution and keep aspect ratio.
- If value is set to 0, source resolution will be used.
- **`Overscan crop`**
@@ -230,10 +230,10 @@ Applicable context filters:
## Tools
Settings for OpenPype tools.
-## Creator
+### Creator
Settings related to [Creator tool](artist_tools_creator).
-### Subset name profiles
+#### Subset name profiles
Subset name helps to identify published content. More specific name helps with organization and avoid mixing of published content. Subset name is defined using one of templates defined in **Subset name profiles settings**. The template is filled with context information at the time of creation.
@@ -263,10 +263,31 @@ Template may look like `"{family}{Task}{Variant}"`.
Some creators may have other keys as their context may require more information or more specific values. Make sure you've read documentation of host you're using.
-## Workfiles
+### Publish
+
+#### Custom Staging Directory Profiles
+With this feature, users can specify a custom data folder path based on presets, which can be used during the creation and publishing stages.
+
+
+
+Staging directories are used as a destination for intermediate files (as renders) before they are renamed and copied to proper location during the integration phase. They could be created completely dynamically in the temp folder or for some DCCs in the `work` area.
+Example could be Nuke where artist might want to temporarily render pictures into `work` area to check them before they get published with the choice of "Use existing frames" on the write node.
+
+One of the key advantages of this feature is that it allows users to choose the folder for writing such intermediate files to take advantage of faster storage for rendering, which can help improve workflow efficiency. Additionally, this feature allows users to keep their intermediate extracted data persistent, and use their own infrastructure for regular cleaning.
+
+In some cases, these DCCs (Nuke, Houdini, Maya) automatically add a rendering path during the creation stage, which is then used in publishing. Creators and extractors of such DCCs need to use these profiles to fill paths in DCC's nodes to use this functionality.
+
+The custom staging folder uses a path template configured in `project_anatomy/templates/others` with `transient` being a default example path that could be used. The template requires a 'folder' key for it to be usable as custom staging folder.
+
+##### Known issues
+- Any DCC that uses prefilled paths and store them inside of workfile nodes needs to implement resolving these paths with a configured profiles.
+- If studio uses Site Sync remote artists need to have access to configured custom staging folder!
+- Each node on the rendering farm must have access to configured custom staging folder!
+
+### Workfiles
All settings related to Workfile tool.
-### Open last workfile at launch
+#### Open last workfile at launch
This feature allows you to define a rule for each task/host or toggle the feature globally to all tasks as they are visible in the picture.
diff --git a/website/docs/project_settings/settings_project_nuke.md b/website/docs/project_settings/settings_project_nuke.md
index b3ee5f77a6..c9c3d12df9 100644
--- a/website/docs/project_settings/settings_project_nuke.md
+++ b/website/docs/project_settings/settings_project_nuke.md
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
Project settings can have project specific values. Each new project is using studio values defined in **default** project but these values can be modified or overridden per project.
:::warning Default studio values
-Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orage colour). Any changes in default project may affect all existing projects.
+Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orange colour). Any changes in default project may affect all existing projects.
:::
## Workfile Builder
diff --git a/website/docs/project_settings/settings_project_standalone.md b/website/docs/project_settings/settings_project_standalone.md
index 778aba2942..1383bd488e 100644
--- a/website/docs/project_settings/settings_project_standalone.md
+++ b/website/docs/project_settings/settings_project_standalone.md
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
Project settings can have project specific values. Each new project is using studio values defined in **default** project but these values can be modified or overridden per project.
:::warning Default studio values
-Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orage colour). Any changes in default project may affect all existing projects.
+Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orange colour). Any changes in default project may affect all existing projects.
:::
## Creator Plugins
diff --git a/website/docs/pype2/admin_ftrack.md b/website/docs/pype2/admin_ftrack.md
index a81147bece..4ebe1a7add 100644
--- a/website/docs/pype2/admin_ftrack.md
+++ b/website/docs/pype2/admin_ftrack.md
@@ -8,7 +8,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-Ftrack is currently the main project management option for Pype. This documentation assumes that you are familiar with Ftrack and it's basic principles. If you're new to Ftrack, we recommend having a thorough look at [Ftrack Official Documentation](http://ftrack.rtd.ftrack.com/en/stable/).
+Ftrack is currently the main project management option for Pype. This documentation assumes that you are familiar with Ftrack and its basic principles. If you're new to Ftrack, we recommend having a thorough look at [Ftrack Official Documentation](http://ftrack.rtd.ftrack.com/en/stable/).
## Prepare Ftrack for Pype
diff --git a/website/docs/pype2/admin_presets_plugins.md b/website/docs/pype2/admin_presets_plugins.md
index fcdc09439b..44c2a28dec 100644
--- a/website/docs/pype2/admin_presets_plugins.md
+++ b/website/docs/pype2/admin_presets_plugins.md
@@ -36,7 +36,7 @@ All context filters are lists which may contain strings or Regular expressions (
- **families** - Main family of processed instance. `["plate", "model"]`
:::important Filtering
-Filters are optional and may not be set. In case when multiple profiles match current context, profile with filters has higher priority that profile without filters.
+Filters are optional and may not be set. In case when multiple profiles match current context, profile with filters has higher priority than profile without filters.
:::
#### Profile outputs
@@ -293,6 +293,7 @@ If source representation has suffix **"h264"** and burnin suffix is **"client"**
- It is allowed to use [Anatomy templates](admin_config#anatomy) themselves in burnins if they can be filled with available data.
- Additional keys in burnins:
+
| Burnin key | Description |
| --- | --- |
| frame_start | First frame number. |
@@ -303,6 +304,7 @@ If source representation has suffix **"h264"** and burnin suffix is **"client"**
| resolution_height | Resolution height. |
| fps | Fps of an output. |
| timecode | Timecode by frame start and fps. |
+ | focalLength | **Only available in Maya**