diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index 258458e2d4..d9b4d8089c 100644 --- a/.github/workflows/prerelease.yml +++ b/.github/workflows/prerelease.yml @@ -43,7 +43,7 @@ jobs: uses: heinrichreimer/github-changelog-generator-action@v2.2 with: token: ${{ secrets.ADMIN_TOKEN }} - addSections: '{"documentation":{"prefix":"### 📖 Documentation","labels":["type: documentation"]},"tests":{"prefix":"### ✅ Testing","labels":["tests"]},"feature":{"prefix":"**🆕 New features**", "labels":["type: feature"]},"breaking":{"prefix":"**💥 Breaking**", "labels":["breaking"]},"enhancements":{"prefix":"**🚀 Enhancements**", "labels":["type: enhancement"]},"bugs":{"prefix":"**🐛 Bug fixes**", "labels":["type: bug"]},"deprecated":{"prefix":"**⚠️ Deprecations**", "labels":["depreciated"]}}' + addSections: '{"documentation":{"prefix":"### 📖 Documentation","labels":["type: documentation"]},"tests":{"prefix":"### ✅ Testing","labels":["tests"]},"feature":{"prefix":"**🆕 New features**", "labels":["type: feature"]},"breaking":{"prefix":"**💥 Breaking**", "labels":["breaking"]},"enhancements":{"prefix":"**🚀 Enhancements**", "labels":["type: enhancement"]},"bugs":{"prefix":"**🐛 Bug fixes**", "labels":["type: bug"]},"deprecated":{"prefix":"**⚠️ Deprecations**", "labels":["depreciated"]}, "refactor":{"prefix":"**🔀 Refactored code**", "labels":["refactor"]}}' issues: false issuesWoLabels: false sinceTag: "3.0.0" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3f85525c26..917e6c884c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -39,7 +39,7 @@ jobs: uses: heinrichreimer/github-changelog-generator-action@v2.2 with: token: ${{ secrets.ADMIN_TOKEN }} - addSections: '{"tests":{"prefix":"### ✅ Testing","labels":["tests"]},"feature":{"prefix":"**🆕 New features**", "labels":["type: feature"]},"breaking":{"prefix":"**💥 Breaking**", "labels":["breaking"]},"enhancements":{"prefix":"**🚀 Enhancements**", "labels":["type: enhancement"]},"bugs":{"prefix":"**🐛 Bug fixes**", "labels":["type: bug"]},"deprecated":{"prefix":"**⚠️ Deprecations**", "labels":["depreciated"]},"documentation":{"prefix":"### 📖 Documentation","labels":["type: documentation"]}}' + addSections: '{"documentation":{"prefix":"### 📖 Documentation","labels":["type: documentation"]},"tests":{"prefix":"### ✅ Testing","labels":["tests"]},"feature":{"prefix":"**🆕 New features**", "labels":["type: feature"]},"breaking":{"prefix":"**💥 Breaking**", "labels":["breaking"]},"enhancements":{"prefix":"**🚀 Enhancements**", "labels":["type: enhancement"]},"bugs":{"prefix":"**🐛 Bug fixes**", "labels":["type: bug"]},"deprecated":{"prefix":"**⚠️ Deprecations**", "labels":["depreciated"]}, "refactor":{"prefix":"**🔀 Refactored code**", "labels":["refactor"]}}' issues: false issuesWoLabels: false sinceTag: "3.0.0" @@ -81,7 +81,7 @@ jobs: uses: heinrichreimer/github-changelog-generator-action@v2.2 with: token: ${{ secrets.ADMIN_TOKEN }} - addSections: '{"documentation":{"prefix":"### 📖 Documentation","labels":["type: documentation"]},"tests":{"prefix":"### ✅ Testing","labels":["tests"]},"feature":{"prefix":"**🆕 New features**", "labels":["type: feature"]},"breaking":{"prefix":"**💥 Breaking**", "labels":["breaking"]},"enhancements":{"prefix":"**🚀 Enhancements**", "labels":["type: enhancement"]},"bugs":{"prefix":"**🐛 Bug fixes**", "labels":["type: bug"]},"deprecated":{"prefix":"**⚠️ Deprecations**", "labels":["depreciated"]}}' + addSections: '{"documentation":{"prefix":"### 📖 Documentation","labels":["type: documentation"]},"tests":{"prefix":"### ✅ Testing","labels":["tests"]},"feature":{"prefix":"**🆕 New features**", "labels":["type: feature"]},"breaking":{"prefix":"**💥 Breaking**", "labels":["breaking"]},"enhancements":{"prefix":"**🚀 Enhancements**", "labels":["type: enhancement"]},"bugs":{"prefix":"**🐛 Bug fixes**", "labels":["type: bug"]},"deprecated":{"prefix":"**⚠️ Deprecations**", "labels":["depreciated"]}, "refactor":{"prefix":"**🔀 Refactored code**", "labels":["refactor"]}}' issues: false issuesWoLabels: false sinceTag: ${{ steps.version.outputs.last_release }} diff --git a/.gitmodules b/.gitmodules index e1b0917e9d..9920ceaad6 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,12 +1,3 @@ [submodule "repos/avalon-core"] path = repos/avalon-core - url = https://github.com/pypeclub/avalon-core.git -[submodule "repos/avalon-unreal-integration"] - path = repos/avalon-unreal-integration - url = https://github.com/pypeclub/avalon-unreal-integration.git -[submodule "openpype/modules/default_modules/ftrack/python2_vendor/arrow"] - path = openpype/modules/default_modules/ftrack/python2_vendor/arrow - url = https://github.com/arrow-py/arrow.git -[submodule "openpype/modules/default_modules/ftrack/python2_vendor/ftrack-python-api"] - path = openpype/modules/default_modules/ftrack/python2_vendor/ftrack-python-api - url = https://bitbucket.org/ftrack/ftrack-python-api.git \ No newline at end of file + url = https://github.com/pypeclub/avalon-core.git \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 3babdceafb..7790894b7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,121 +1,89 @@ # Changelog -## [3.9.0-nightly.3](https://github.com/pypeclub/OpenPype/tree/HEAD) +## [3.9.1-nightly.1](https://github.com/pypeclub/OpenPype/tree/HEAD) -[Full Changelog](https://github.com/pypeclub/OpenPype/compare/3.8.2...HEAD) - -**Deprecated:** - -- Loader: Remove default family states for hosts from code [\#2706](https://github.com/pypeclub/OpenPype/pull/2706) - -### 📖 Documentation - -- Update docusaurus to latest version [\#2760](https://github.com/pypeclub/OpenPype/pull/2760) -- documentation: add example to `repack-version` command [\#2669](https://github.com/pypeclub/OpenPype/pull/2669) - -**🆕 New features** - -- Flame: loading clips to reels [\#2622](https://github.com/pypeclub/OpenPype/pull/2622) - -**🚀 Enhancements** - -- Pyblish Pype: Remove redundant new line in installed fonts printing [\#2758](https://github.com/pypeclub/OpenPype/pull/2758) -- Flame: adding validator source clip [\#2746](https://github.com/pypeclub/OpenPype/pull/2746) -- Work Files: Preserve subversion comment of current filename by default [\#2734](https://github.com/pypeclub/OpenPype/pull/2734) -- Ftrack: Disable ftrack module by default [\#2732](https://github.com/pypeclub/OpenPype/pull/2732) -- Project Manager: Disable add task, add asset and save button when not in a project [\#2727](https://github.com/pypeclub/OpenPype/pull/2727) -- dropbox handle big file [\#2718](https://github.com/pypeclub/OpenPype/pull/2718) -- Fusion Move PR: Minor tweaks to Fusion integration [\#2716](https://github.com/pypeclub/OpenPype/pull/2716) -- Nuke: prerender with review knob [\#2691](https://github.com/pypeclub/OpenPype/pull/2691) -- Maya configurable unit validator [\#2680](https://github.com/pypeclub/OpenPype/pull/2680) -- General: Add settings for CleanUpFarm and disable the plugin by default [\#2679](https://github.com/pypeclub/OpenPype/pull/2679) -- Project Manager: Only allow scroll wheel edits when spinbox is active [\#2678](https://github.com/pypeclub/OpenPype/pull/2678) -- Ftrack: Sync description to assets [\#2670](https://github.com/pypeclub/OpenPype/pull/2670) -- General: FFmpeg conversion also check attribute string length [\#2635](https://github.com/pypeclub/OpenPype/pull/2635) -- Global: adding studio name/code to anatomy template formatting data [\#2630](https://github.com/pypeclub/OpenPype/pull/2630) -- Houdini: Load Arnold .ass procedurals into Houdini [\#2606](https://github.com/pypeclub/OpenPype/pull/2606) -- Deadline: Simplify GlobalJobPreLoad logic [\#2605](https://github.com/pypeclub/OpenPype/pull/2605) -- Houdini: Implement Arnold .ass standin extraction from Houdini \(also support .ass.gz\) [\#2603](https://github.com/pypeclub/OpenPype/pull/2603) +[Full Changelog](https://github.com/pypeclub/OpenPype/compare/3.9.0...HEAD) **🐛 Bug fixes** -- Loader UI: Fix right click in representation widget [\#2757](https://github.com/pypeclub/OpenPype/pull/2757) -- Aftereffects 2022 and Deadline [\#2748](https://github.com/pypeclub/OpenPype/pull/2748) -- Flame: bunch of bugs [\#2745](https://github.com/pypeclub/OpenPype/pull/2745) -- Maya: Save current scene on workfile publish [\#2744](https://github.com/pypeclub/OpenPype/pull/2744) -- Version Up: Preserve parts of filename after version number \(like subversion\) on version\_up [\#2741](https://github.com/pypeclub/OpenPype/pull/2741) -- Loader UI: Multiple asset selection and underline colors fixed [\#2731](https://github.com/pypeclub/OpenPype/pull/2731) -- General: Fix loading of unused chars in xml format [\#2729](https://github.com/pypeclub/OpenPype/pull/2729) -- TVPaint: Set objectName with members [\#2725](https://github.com/pypeclub/OpenPype/pull/2725) -- General: Don't use 'objectName' from loaded references [\#2715](https://github.com/pypeclub/OpenPype/pull/2715) -- Settings: Studio Project anatomy is queried using right keys [\#2711](https://github.com/pypeclub/OpenPype/pull/2711) -- Local Settings: Additional applications don't break UI [\#2710](https://github.com/pypeclub/OpenPype/pull/2710) -- Houdini: Fix refactor of Houdini host move for CreateArnoldAss [\#2704](https://github.com/pypeclub/OpenPype/pull/2704) -- LookAssigner: Fix imports after moving code to OpenPype repository [\#2701](https://github.com/pypeclub/OpenPype/pull/2701) -- Multiple hosts: unify menu style across hosts [\#2693](https://github.com/pypeclub/OpenPype/pull/2693) -- Maya Redshift fixes [\#2692](https://github.com/pypeclub/OpenPype/pull/2692) -- Maya: fix fps validation popup [\#2685](https://github.com/pypeclub/OpenPype/pull/2685) -- Houdini Explicitly collect correct frame name even in case of single frame render when `frameStart` is provided [\#2676](https://github.com/pypeclub/OpenPype/pull/2676) -- hiero: fix effect collector name and order [\#2673](https://github.com/pypeclub/OpenPype/pull/2673) -- Maya: Fix menu callbacks [\#2671](https://github.com/pypeclub/OpenPype/pull/2671) -- Launcher: Fix access to 'data' attribute on actions [\#2659](https://github.com/pypeclub/OpenPype/pull/2659) -- Houdini: fix usd family in loader and integrators [\#2631](https://github.com/pypeclub/OpenPype/pull/2631) +- Harmony - fixed creator issue [\#2891](https://github.com/pypeclub/OpenPype/pull/2891) +- General: Remove forgotten use of avalon Creator [\#2885](https://github.com/pypeclub/OpenPype/pull/2885) +- General: Avoid circular import [\#2884](https://github.com/pypeclub/OpenPype/pull/2884) +- Fixes for attaching loaded containers \(\#2837\) [\#2874](https://github.com/pypeclub/OpenPype/pull/2874) -**Merged pull requests:** +**🔀 Refactored code** -- Harmony: Rendering in Deadline didn't work in other machines than submitter [\#2754](https://github.com/pypeclub/OpenPype/pull/2754) -- Maya: set Deadline job/batch name to original source workfile name instead of published workfile [\#2733](https://github.com/pypeclub/OpenPype/pull/2733) -- Fusion: Moved implementation into OpenPype [\#2713](https://github.com/pypeclub/OpenPype/pull/2713) -- TVPaint: Plugin build without dependencies [\#2705](https://github.com/pypeclub/OpenPype/pull/2705) -- Webpublisher: Photoshop create a beauty png [\#2689](https://github.com/pypeclub/OpenPype/pull/2689) -- Ftrack: Hierarchical attributes are queried properly [\#2682](https://github.com/pypeclub/OpenPype/pull/2682) -- Maya: Add Validate Frame Range settings [\#2661](https://github.com/pypeclub/OpenPype/pull/2661) -- Harmony: move to Openpype [\#2657](https://github.com/pypeclub/OpenPype/pull/2657) -- General: Show applications without integration in project [\#2656](https://github.com/pypeclub/OpenPype/pull/2656) -- Maya: cleanup duplicate rendersetup code [\#2642](https://github.com/pypeclub/OpenPype/pull/2642) +- General: Reduce style usage to OpenPype repository [\#2889](https://github.com/pypeclub/OpenPype/pull/2889) + +## [3.9.0](https://github.com/pypeclub/OpenPype/tree/3.9.0) (2022-03-14) + +[Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.9.0-nightly.9...3.9.0) + +**Deprecated:** + +- AssetCreator: Remove the tool [\#2845](https://github.com/pypeclub/OpenPype/pull/2845) + +**🚀 Enhancements** + +- General: Subset name filtering in ExtractReview outpus [\#2872](https://github.com/pypeclub/OpenPype/pull/2872) +- NewPublisher: Descriptions and Icons in creator dialog [\#2867](https://github.com/pypeclub/OpenPype/pull/2867) +- NewPublisher: Changing task on publishing instance [\#2863](https://github.com/pypeclub/OpenPype/pull/2863) +- TrayPublisher: Choose project widget is more clear [\#2859](https://github.com/pypeclub/OpenPype/pull/2859) +- New: Validation exceptions [\#2841](https://github.com/pypeclub/OpenPype/pull/2841) +- Maya: add loaded containers to published instance [\#2837](https://github.com/pypeclub/OpenPype/pull/2837) +- Ftrack: Can sync fps as string [\#2836](https://github.com/pypeclub/OpenPype/pull/2836) +- General: Custom function for find executable [\#2822](https://github.com/pypeclub/OpenPype/pull/2822) +- General: Color dialog UI fixes [\#2817](https://github.com/pypeclub/OpenPype/pull/2817) +- global: letter box calculated on output as last process [\#2812](https://github.com/pypeclub/OpenPype/pull/2812) +- Nuke: adding Reformat to baking mov plugin [\#2811](https://github.com/pypeclub/OpenPype/pull/2811) +- Manager: Update all to latest button [\#2805](https://github.com/pypeclub/OpenPype/pull/2805) + +**🐛 Bug fixes** + +- General: Missing time function [\#2877](https://github.com/pypeclub/OpenPype/pull/2877) +- Deadline: Fix plugin name for tile assemble [\#2868](https://github.com/pypeclub/OpenPype/pull/2868) +- Nuke: gizmo precollect fix [\#2866](https://github.com/pypeclub/OpenPype/pull/2866) +- General: Fix hardlink for windows [\#2864](https://github.com/pypeclub/OpenPype/pull/2864) +- General: ffmpeg was crashing on slate merge [\#2860](https://github.com/pypeclub/OpenPype/pull/2860) +- WebPublisher: Video file was published with one too many frame [\#2858](https://github.com/pypeclub/OpenPype/pull/2858) +- New Publisher: Error dialog got right styles [\#2857](https://github.com/pypeclub/OpenPype/pull/2857) +- General: Fix getattr clalback on dynamic modules [\#2855](https://github.com/pypeclub/OpenPype/pull/2855) +- Nuke: slate resolution to input video resolution [\#2853](https://github.com/pypeclub/OpenPype/pull/2853) +- WebPublisher: Fix username stored in DB [\#2852](https://github.com/pypeclub/OpenPype/pull/2852) +- WebPublisher: Fix wrong number of frames for video file [\#2851](https://github.com/pypeclub/OpenPype/pull/2851) +- Nuke: Fix family test in validate\_write\_legacy to work with stillImage [\#2847](https://github.com/pypeclub/OpenPype/pull/2847) +- Nuke: fix multiple baking profile farm publishing [\#2842](https://github.com/pypeclub/OpenPype/pull/2842) +- Blender: Fixed parameters for FBX export of the camera [\#2840](https://github.com/pypeclub/OpenPype/pull/2840) +- Maya: Stop creation of reviews for Cryptomattes [\#2832](https://github.com/pypeclub/OpenPype/pull/2832) +- Deadline: Remove recreated event [\#2828](https://github.com/pypeclub/OpenPype/pull/2828) +- Deadline: Added missing events folder [\#2827](https://github.com/pypeclub/OpenPype/pull/2827) +- Settings: Missing document with OP versions may break start of OpenPype [\#2825](https://github.com/pypeclub/OpenPype/pull/2825) +- Deadline: more detailed temp file name for environment json [\#2824](https://github.com/pypeclub/OpenPype/pull/2824) +- General: Host name was formed from obsolete code [\#2821](https://github.com/pypeclub/OpenPype/pull/2821) +- Settings UI: Fix "Apply from" action [\#2820](https://github.com/pypeclub/OpenPype/pull/2820) +- Ftrack: Job killer with missing user [\#2819](https://github.com/pypeclub/OpenPype/pull/2819) +- Nuke: Use AVALON\_APP to get value for "app" key [\#2818](https://github.com/pypeclub/OpenPype/pull/2818) +- StandalonePublisher: use dynamic groups in subset names [\#2816](https://github.com/pypeclub/OpenPype/pull/2816) + +**🔀 Refactored code** + +- Refactor: move webserver tool to openpype [\#2876](https://github.com/pypeclub/OpenPype/pull/2876) +- General: Move create logic from avalon to OpenPype [\#2854](https://github.com/pypeclub/OpenPype/pull/2854) +- General: Add vendors from avalon [\#2848](https://github.com/pypeclub/OpenPype/pull/2848) +- General: Basic event system [\#2846](https://github.com/pypeclub/OpenPype/pull/2846) +- General: Move change context functions [\#2839](https://github.com/pypeclub/OpenPype/pull/2839) +- Tools: Don't use avalon tools code [\#2829](https://github.com/pypeclub/OpenPype/pull/2829) +- Move Unreal Implementation to OpenPype [\#2823](https://github.com/pypeclub/OpenPype/pull/2823) +- General: Extract template formatting from anatomy [\#2766](https://github.com/pypeclub/OpenPype/pull/2766) ## [3.8.2](https://github.com/pypeclub/OpenPype/tree/3.8.2) (2022-02-07) [Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.8.2-nightly.3...3.8.2) -### 📖 Documentation - -- Cosmetics: Fix common typos in openpype/website [\#2617](https://github.com/pypeclub/OpenPype/pull/2617) - -**🚀 Enhancements** - -- General: Project backup tools [\#2629](https://github.com/pypeclub/OpenPype/pull/2629) -- nuke: adding clear button to write nodes [\#2627](https://github.com/pypeclub/OpenPype/pull/2627) -- Ftrack: Family to Asset type mapping is in settings [\#2602](https://github.com/pypeclub/OpenPype/pull/2602) - -**🐛 Bug fixes** - -- Fix pulling of cx\_freeze 6.10 [\#2628](https://github.com/pypeclub/OpenPype/pull/2628) - -**Merged pull requests:** - -- Docker: enhance dockerfiles with metadata, fix pyenv initialization [\#2647](https://github.com/pypeclub/OpenPype/pull/2647) -- WebPublisher: fix instance duplicates [\#2641](https://github.com/pypeclub/OpenPype/pull/2641) -- Fix - safer pulling of task name for webpublishing from PS [\#2613](https://github.com/pypeclub/OpenPype/pull/2613) - ## [3.8.1](https://github.com/pypeclub/OpenPype/tree/3.8.1) (2022-02-01) [Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.8.1-nightly.3...3.8.1) -**🚀 Enhancements** - -- Webpublisher: Thumbnail extractor [\#2600](https://github.com/pypeclub/OpenPype/pull/2600) - -**🐛 Bug fixes** - -- Release/3.8.0 [\#2619](https://github.com/pypeclub/OpenPype/pull/2619) -- hotfix: OIIO tool path - add extension on windows [\#2618](https://github.com/pypeclub/OpenPype/pull/2618) -- Settings: Enum does not store empty string if has single item to select [\#2615](https://github.com/pypeclub/OpenPype/pull/2615) - -**Merged pull requests:** - -- Bump pillow from 8.4.0 to 9.0.0 [\#2595](https://github.com/pypeclub/OpenPype/pull/2595) - ## [3.8.0](https://github.com/pypeclub/OpenPype/tree/3.8.0) (2022-01-24) [Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.8.0-nightly.7...3.8.0) diff --git a/openpype/__init__.py b/openpype/__init__.py index 11b563ebfe..99629a4257 100644 --- a/openpype/__init__.py +++ b/openpype/__init__.py @@ -10,7 +10,8 @@ from .lib import ( Anatomy, filter_pyblish_plugins, set_plugin_attributes_from_settings, - change_timer_to_current_context + change_timer_to_current_context, + register_event_callback, ) pyblish = avalon = _original_discover = None @@ -58,10 +59,15 @@ def patched_discover(superclass): """ # run original discover and get plugins plugins = _original_discover(superclass) + filtered_plugins = [ + plugin + for plugin in plugins + if issubclass(plugin, superclass) + ] - set_plugin_attributes_from_settings(plugins, superclass) + set_plugin_attributes_from_settings(filtered_plugins, superclass) - return plugins + return filtered_plugins @import_wrapper @@ -69,6 +75,10 @@ def install(): """Install Pype to Avalon.""" from pyblish.lib import MessageHandler from openpype.modules import load_modules + from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + ) from avalon import pipeline # Make sure modules are loaded @@ -84,7 +94,7 @@ def install(): log.info("Registering global plug-ins..") pyblish.register_plugin_path(PUBLISH_PATH) pyblish.register_discovery_filter(filter_pyblish_plugins) - avalon.register_plugin_path(avalon.Loader, LOAD_PATH) + register_loader_plugin_path(LOAD_PATH) project_name = os.environ.get("AVALON_PROJECT") @@ -112,8 +122,8 @@ def install(): continue pyblish.register_plugin_path(path) - avalon.register_plugin_path(avalon.Loader, path) - avalon.register_plugin_path(avalon.Creator, path) + register_loader_plugin_path(path) + avalon.register_plugin_path(LegacyCreator, path) avalon.register_plugin_path(avalon.InventoryAction, path) # apply monkey patched discover to original one @@ -122,20 +132,22 @@ def install(): avalon.discover = patched_discover pipeline.discover = patched_discover - avalon.on("taskChanged", _on_task_change) + register_event_callback("taskChanged", _on_task_change) -def _on_task_change(*args): +def _on_task_change(): change_timer_to_current_context() @import_wrapper def uninstall(): """Uninstall Pype from Avalon.""" + from openpype.pipeline import deregister_loader_plugin_path + log.info("Deregistering global plug-ins..") pyblish.deregister_plugin_path(PUBLISH_PATH) pyblish.deregister_discovery_filter(filter_pyblish_plugins) - avalon.deregister_plugin_path(avalon.Loader, LOAD_PATH) + deregister_loader_plugin_path(LOAD_PATH) log.info("Global plug-ins unregistred") # restore original discover diff --git a/openpype/api.py b/openpype/api.py index 51854492ab..b692b36065 100644 --- a/openpype/api.py +++ b/openpype/api.py @@ -45,9 +45,6 @@ from .lib.avalon_context import ( from . import resources from .plugin import ( - PypeCreatorMixin, - Creator, - Extractor, ValidatePipelineOrder, @@ -89,9 +86,6 @@ __all__ = [ # Resources "resources", - # Pype creator mixin - "PypeCreatorMixin", - "Creator", # plugin classes "Extractor", # ordering diff --git a/openpype/cli.py b/openpype/cli.py index 0597c387d0..155e07dea3 100644 --- a/openpype/cli.py +++ b/openpype/cli.py @@ -42,6 +42,12 @@ def standalonepublisher(): PypeCommands().launch_standalone_publisher() +@main.command() +def traypublisher(): + """Show new OpenPype Standalone publisher UI.""" + PypeCommands().launch_traypublisher() + + @main.command() @click.option("-d", "--debug", is_flag=True, help=("Run pype tray in debug mode")) @@ -371,10 +377,15 @@ def run(script): "--app_variant", help="Provide specific app variant for test, empty for latest", default=None) -def runtests(folder, mark, pyargs, test_data_folder, persist, app_variant): +@click.option("-t", + "--timeout", + help="Provide specific timeout value for test case", + default=None) +def runtests(folder, mark, pyargs, test_data_folder, persist, app_variant, + timeout): """Run all automatic tests after proper initialization via start.py""" PypeCommands().run_tests(folder, mark, pyargs, test_data_folder, - persist, app_variant) + persist, app_variant, timeout) @main.command() diff --git a/openpype/hooks/pre_add_last_workfile_arg.py b/openpype/hooks/pre_add_last_workfile_arg.py index eb9e6a6b1c..3609620917 100644 --- a/openpype/hooks/pre_add_last_workfile_arg.py +++ b/openpype/hooks/pre_add_last_workfile_arg.py @@ -17,12 +17,13 @@ class AddLastWorkfileToLaunchArgs(PreLaunchHook): "nuke", "nukex", "hiero", + "houdini", "nukestudio", "fusion", "blender", "photoshop", "tvpaint", - "afftereffects" + "aftereffects" ] def execute(self): diff --git a/openpype/hooks/pre_copy_template_workfile.py b/openpype/hooks/pre_copy_template_workfile.py index 5c56d721e8..dffac22ee2 100644 --- a/openpype/hooks/pre_copy_template_workfile.py +++ b/openpype/hooks/pre_copy_template_workfile.py @@ -19,7 +19,7 @@ class CopyTemplateWorkfile(PreLaunchHook): # Before `AddLastWorkfileToLaunchArgs` order = 0 - app_groups = ["blender", "photoshop", "tvpaint", "afftereffects"] + app_groups = ["blender", "photoshop", "tvpaint", "aftereffects"] def execute(self): """Check if can copy template for context and do it if possible. @@ -44,7 +44,7 @@ class CopyTemplateWorkfile(PreLaunchHook): return if os.path.exists(last_workfile): - self.log.debug("Last workfile exits. Skipping {} process.".format( + self.log.debug("Last workfile exists. Skipping {} process.".format( self.__class__.__name__ )) return @@ -120,7 +120,7 @@ class CopyTemplateWorkfile(PreLaunchHook): f"Creating workfile from template: \"{template_path}\"" ) - # Copy template workfile to new destinantion + # Copy template workfile to new destination shutil.copy2( os.path.normpath(template_path), os.path.normpath(last_workfile) diff --git a/openpype/hooks/pre_global_host_data.py b/openpype/hooks/pre_global_host_data.py index bae967e25f..4c85a511ed 100644 --- a/openpype/hooks/pre_global_host_data.py +++ b/openpype/hooks/pre_global_host_data.py @@ -2,7 +2,7 @@ from openpype.api import Anatomy from openpype.lib import ( PreLaunchHook, EnvironmentPrepData, - prepare_host_environments, + prepare_app_environments, prepare_context_environments ) @@ -14,14 +14,6 @@ class GlobalHostDataHook(PreLaunchHook): def execute(self): """Prepare global objects to `data` that will be used for sure.""" - if not self.application.is_host: - self.log.info( - "Skipped hook {}. Application is not marked as host.".format( - self.__class__.__name__ - ) - ) - return - self.prepare_global_data() if not self.data.get("asset_doc"): @@ -49,7 +41,7 @@ class GlobalHostDataHook(PreLaunchHook): "log": self.log }) - prepare_host_environments(temp_data, self.launch_context.env_group) + prepare_app_environments(temp_data, self.launch_context.env_group) prepare_context_environments(temp_data) temp_data.pop("log") diff --git a/openpype/hosts/aftereffects/api/launch_logic.py b/openpype/hosts/aftereffects/api/launch_logic.py index 97f14c9332..c549268978 100644 --- a/openpype/hosts/aftereffects/api/launch_logic.py +++ b/openpype/hosts/aftereffects/api/launch_logic.py @@ -15,7 +15,7 @@ from Qt import QtCore from openpype.tools.utils import host_tools from avalon import api -from avalon.tools.webserver.app import WebServerTool +from openpype.tools.adobe_webserver.app import WebServerTool from .ws_stub import AfterEffectsServerStub diff --git a/openpype/hosts/aftereffects/api/pipeline.py b/openpype/hosts/aftereffects/api/pipeline.py index 94f1e3d105..681f1c51a7 100644 --- a/openpype/hosts/aftereffects/api/pipeline.py +++ b/openpype/hosts/aftereffects/api/pipeline.py @@ -9,7 +9,13 @@ from avalon import io, pipeline from openpype import lib from openpype.api import Logger +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) import openpype.hosts.aftereffects +from openpype.lib import register_event_callback from .launch_logic import get_stub @@ -65,21 +71,21 @@ def install(): pyblish.api.register_host("aftereffects") pyblish.api.register_plugin_path(PUBLISH_PATH) - avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH) log.info(PUBLISH_PATH) pyblish.api.register_callback( "instanceToggled", on_pyblish_instance_toggled ) - avalon.api.on("application.launched", application_launch) + register_event_callback("application.launched", application_launch) def uninstall(): pyblish.api.deregister_plugin_path(PUBLISH_PATH) - avalon.api.deregister_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.deregister_plugin_path(avalon.api.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.api.deregister_plugin_path(LegacyCreator, CREATE_PATH) def on_pyblish_instance_toggled(instance, old_value, new_value): diff --git a/openpype/hosts/aftereffects/api/plugin.py b/openpype/hosts/aftereffects/api/plugin.py index fbe07663dd..29705cc5be 100644 --- a/openpype/hosts/aftereffects/api/plugin.py +++ b/openpype/hosts/aftereffects/api/plugin.py @@ -1,9 +1,8 @@ -import avalon.api +from openpype.pipeline import LoaderPlugin from .launch_logic import get_stub -class AfterEffectsLoader(avalon.api.Loader): +class AfterEffectsLoader(LoaderPlugin): @staticmethod def get_stub(): return get_stub() - diff --git a/openpype/hosts/aftereffects/api/ws_stub.py b/openpype/hosts/aftereffects/api/ws_stub.py index 5a0600e92e..b0893310c1 100644 --- a/openpype/hosts/aftereffects/api/ws_stub.py +++ b/openpype/hosts/aftereffects/api/ws_stub.py @@ -8,7 +8,7 @@ import logging import attr from wsrpc_aiohttp import WebSocketAsync -from avalon.tools.webserver.app import WebServerTool +from openpype.tools.adobe_webserver.app import WebServerTool @attr.s diff --git a/openpype/hosts/aftereffects/plugins/create/create_render.py b/openpype/hosts/aftereffects/plugins/create/create_render.py index 8dfc85cdc8..41efb4b0ba 100644 --- a/openpype/hosts/aftereffects/plugins/create/create_render.py +++ b/openpype/hosts/aftereffects/plugins/create/create_render.py @@ -1,13 +1,12 @@ -from avalon.api import CreatorError - -import openpype.api +from openpype.pipeline import create +from openpype.pipeline import CreatorError from openpype.hosts.aftereffects.api import ( get_stub, list_instances ) -class CreateRender(openpype.api.Creator): +class CreateRender(create.LegacyCreator): """Render folder for publish. Creates subsets in format 'familyTaskSubsetname', diff --git a/openpype/hosts/aftereffects/plugins/load/load_background.py b/openpype/hosts/aftereffects/plugins/load/load_background.py index 1a2d6fc432..be43cae44e 100644 --- a/openpype/hosts/aftereffects/plugins/load/load_background.py +++ b/openpype/hosts/aftereffects/plugins/load/load_background.py @@ -1,11 +1,10 @@ import re -import avalon.api - from openpype.lib import ( get_background_layers, get_unique_layer_name ) +from openpype.pipeline import get_representation_path from openpype.hosts.aftereffects.api import ( AfterEffectsLoader, containerise @@ -78,7 +77,7 @@ class BackgroundLoader(AfterEffectsLoader): else: # switching version - keep same name comp_name = container["namespace"] - path = avalon.api.get_representation_path(representation) + path = get_representation_path(representation) layers = get_background_layers(path) comp = stub.reload_background(container["members"][1], diff --git a/openpype/hosts/aftereffects/plugins/load/load_file.py b/openpype/hosts/aftereffects/plugins/load/load_file.py index 9dbbf7aae1..9eb9e80a2c 100644 --- a/openpype/hosts/aftereffects/plugins/load/load_file.py +++ b/openpype/hosts/aftereffects/plugins/load/load_file.py @@ -1,8 +1,8 @@ import re -import avalon.api from openpype import lib +from openpype.pipeline import get_representation_path from openpype.hosts.aftereffects.api import ( AfterEffectsLoader, containerise @@ -92,7 +92,7 @@ class FileLoader(AfterEffectsLoader): "{}_{}".format(context["asset"], context["subset"])) else: # switching version - keep same name layer_name = container["namespace"] - path = avalon.api.get_representation_path(representation) + path = get_representation_path(representation) # with aftereffects.maintained_selection(): # TODO stub.replace_item(layer.id, path, stub.LOADED_ICON + layer_name) stub.imprint( diff --git a/openpype/hosts/aftereffects/plugins/publish/help/validate_instance_asset.xml b/openpype/hosts/aftereffects/plugins/publish/help/validate_instance_asset.xml new file mode 100644 index 0000000000..13f03a9b9a --- /dev/null +++ b/openpype/hosts/aftereffects/plugins/publish/help/validate_instance_asset.xml @@ -0,0 +1,21 @@ + + + +Subset context + +## Invalid subset context + +Context of the given subset doesn't match your current scene. + +### How to repair? + +You can fix this with "repair" button on the right. + + +### __Detailed Info__ (optional) + +This might happen if you are reuse old workfile and open it in different context. +(Eg. you created subset "renderCompositingDefault" from asset "Robot' in "your_project_Robot_compositing.aep", now you opened this workfile in a context "Sloth" but existing subset for "Robot" asset stayed in the workfile.) + + + \ No newline at end of file diff --git a/openpype/hosts/aftereffects/plugins/publish/help/validate_scene_settings.xml b/openpype/hosts/aftereffects/plugins/publish/help/validate_scene_settings.xml new file mode 100644 index 0000000000..36fa90456e --- /dev/null +++ b/openpype/hosts/aftereffects/plugins/publish/help/validate_scene_settings.xml @@ -0,0 +1,35 @@ + + + +Scene setting + +## Invalid scene setting found + +One of the settings in a scene doesn't match to asset settings in database. + +{invalid_setting_str} + +### How to repair? + +Change values for {invalid_keys_str} in the scene OR change them in the asset database if they are wrong there. + + +### __Detailed Info__ (optional) + +This error is shown when for example resolution in the scene doesn't match to resolution set on the asset in the database. +Either value in the database or in the scene is wrong. + + + +Scene file doesn't exist + +## Scene file doesn't exist + +Collected scene {scene_url} doesn't exist. + +### How to repair? + +Re-save file, start publish from the beginning again. + + + \ No newline at end of file diff --git a/openpype/hosts/aftereffects/plugins/publish/validate_instance_asset.py b/openpype/hosts/aftereffects/plugins/publish/validate_instance_asset.py index 71c1750457..37cecfbcc4 100644 --- a/openpype/hosts/aftereffects/plugins/publish/validate_instance_asset.py +++ b/openpype/hosts/aftereffects/plugins/publish/validate_instance_asset.py @@ -1,6 +1,7 @@ from avalon import api import pyblish.api import openpype.api +from openpype.pipeline import PublishXmlValidationError from openpype.hosts.aftereffects.api import get_stub @@ -53,9 +54,8 @@ class ValidateInstanceAsset(pyblish.api.InstancePlugin): current_asset = api.Session["AVALON_ASSET"] msg = ( f"Instance asset {instance_asset} is not the same " - f"as current context {current_asset}. PLEASE DO:\n" - f"Repair with 'A' action to use '{current_asset}'.\n" - f"If that's not correct value, close workfile and " - f"reopen via Workfiles!" + f"as current context {current_asset}." ) - assert instance_asset == current_asset, msg + + if instance_asset != current_asset: + raise PublishXmlValidationError(self, msg) diff --git a/openpype/hosts/aftereffects/plugins/publish/validate_scene_settings.py b/openpype/hosts/aftereffects/plugins/publish/validate_scene_settings.py index 5ae391e230..273ccd295e 100644 --- a/openpype/hosts/aftereffects/plugins/publish/validate_scene_settings.py +++ b/openpype/hosts/aftereffects/plugins/publish/validate_scene_settings.py @@ -5,6 +5,7 @@ import re import pyblish.api +from openpype.pipeline import PublishXmlValidationError from openpype.hosts.aftereffects.api import get_asset_settings @@ -99,12 +100,14 @@ class ValidateSceneSettings(pyblish.api.InstancePlugin): self.log.info("current_settings:: {}".format(current_settings)) invalid_settings = [] + invalid_keys = set() for key, value in expected_settings.items(): if value != current_settings[key]: invalid_settings.append( "{} expected: {} found: {}".format(key, value, current_settings[key]) ) + invalid_keys.add(key) if ((expected_settings.get("handleStart") or expected_settings.get("handleEnd")) @@ -116,7 +119,27 @@ class ValidateSceneSettings(pyblish.api.InstancePlugin): msg = "Found invalid settings:\n{}".format( "\n".join(invalid_settings) ) - assert not invalid_settings, msg - assert os.path.exists(instance.data.get("source")), ( - "Scene file not found (saved under wrong name)" - ) + + if invalid_settings: + invalid_keys_str = ",".join(invalid_keys) + break_str = "
" + invalid_setting_str = "Found invalid settings:
{}".\ + format(break_str.join(invalid_settings)) + + formatting_data = { + "invalid_setting_str": invalid_setting_str, + "invalid_keys_str": invalid_keys_str + } + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) + + if not os.path.exists(instance.data.get("source")): + scene_url = instance.data.get("source") + msg = "Scene file {} not found (saved under wrong name)".format( + scene_url + ) + formatting_data = { + "scene_url": scene_url + } + raise PublishXmlValidationError(self, msg, key="file_not_found", + formatting_data=formatting_data) diff --git a/openpype/hosts/blender/api/pipeline.py b/openpype/hosts/blender/api/pipeline.py index 0e5104fea9..07a7509dd7 100644 --- a/openpype/hosts/blender/api/pipeline.py +++ b/openpype/hosts/blender/api/pipeline.py @@ -14,7 +14,16 @@ import avalon.api from avalon import io, schema from avalon.pipeline import AVALON_CONTAINER_ID +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) from openpype.api import Logger +from openpype.lib import ( + register_event_callback, + emit_event +) import openpype.hosts.blender HOST_DIR = os.path.dirname(os.path.abspath(openpype.hosts.blender.__file__)) @@ -45,13 +54,14 @@ def install(): pyblish.api.register_host("blender") pyblish.api.register_plugin_path(str(PUBLISH_PATH)) - avalon.api.register_plugin_path(avalon.api.Loader, str(LOAD_PATH)) - avalon.api.register_plugin_path(avalon.api.Creator, str(CREATE_PATH)) + register_loader_plugin_path(str(LOAD_PATH)) + avalon.api.register_plugin_path(LegacyCreator, str(CREATE_PATH)) lib.append_user_scripts() - avalon.api.on("new", on_new) - avalon.api.on("open", on_open) + register_event_callback("new", on_new) + register_event_callback("open", on_open) + _register_callbacks() _register_events() @@ -66,8 +76,8 @@ def uninstall(): pyblish.api.deregister_host("blender") pyblish.api.deregister_plugin_path(str(PUBLISH_PATH)) - avalon.api.deregister_plugin_path(avalon.api.Loader, str(LOAD_PATH)) - avalon.api.deregister_plugin_path(avalon.api.Creator, str(CREATE_PATH)) + deregister_loader_plugin_path(str(LOAD_PATH)) + avalon.api.deregister_plugin_path(LegacyCreator, str(CREATE_PATH)) if not IS_HEADLESS: ops.unregister() @@ -113,22 +123,22 @@ def set_start_end_frames(): scene.render.resolution_y = resolution_y -def on_new(arg1, arg2): +def on_new(): set_start_end_frames() -def on_open(arg1, arg2): +def on_open(): set_start_end_frames() @bpy.app.handlers.persistent def _on_save_pre(*args): - avalon.api.emit("before_save", args) + emit_event("before.save") @bpy.app.handlers.persistent def _on_save_post(*args): - avalon.api.emit("save", args) + emit_event("save") @bpy.app.handlers.persistent @@ -136,9 +146,9 @@ def _on_load_post(*args): # Detect new file or opening an existing file if bpy.data.filepath: # Likely this was an open operation since it has a filepath - avalon.api.emit("open", args) + emit_event("open") else: - avalon.api.emit("new", args) + emit_event("new") ops.OpenFileCacher.post_load() @@ -169,7 +179,7 @@ def _register_callbacks(): log.info("Installed event handler _on_load_post...") -def _on_task_changed(*args): +def _on_task_changed(): """Callback for when the task in the context is changed.""" # TODO (jasper): Blender has no concept of projects or workspace. @@ -186,7 +196,7 @@ def _on_task_changed(*args): def _register_events(): """Install callbacks for specific events.""" - avalon.api.on("taskChanged", _on_task_changed) + register_event_callback("taskChanged", _on_task_changed) log.info("Installed event callback for 'taskChanged'...") @@ -202,13 +212,10 @@ def reload_pipeline(*args): avalon.api.uninstall() for module in ( - "avalon.io", - "avalon.lib", - "avalon.pipeline", - "avalon.tools.creator.app", - "avalon.tools.manager.app", - "avalon.api", - "avalon.tools", + "avalon.io", + "avalon.lib", + "avalon.pipeline", + "avalon.api", ): module = importlib.import_module(module) importlib.reload(module) diff --git a/openpype/hosts/blender/api/plugin.py b/openpype/hosts/blender/api/plugin.py index 8c9ab9a27f..3207f543b7 100644 --- a/openpype/hosts/blender/api/plugin.py +++ b/openpype/hosts/blender/api/plugin.py @@ -5,8 +5,10 @@ from typing import Dict, List, Optional import bpy -import avalon.api -from openpype.api import PypeCreatorMixin +from openpype.pipeline import ( + LegacyCreator, + LoaderPlugin, +) from .pipeline import AVALON_CONTAINERS from .ops import ( MainThreadItem, @@ -129,7 +131,7 @@ def deselect_all(): bpy.context.view_layer.objects.active = active -class Creator(PypeCreatorMixin, avalon.api.Creator): +class Creator(LegacyCreator): """Base class for Creator plug-ins.""" defaults = ['Main'] @@ -145,13 +147,13 @@ class Creator(PypeCreatorMixin, avalon.api.Creator): return collection -class Loader(avalon.api.Loader): +class Loader(LoaderPlugin): """Base class for Loader plug-ins.""" hosts = ["blender"] -class AssetLoader(avalon.api.Loader): +class AssetLoader(LoaderPlugin): """A basic AssetLoader for Blender This will implement the basic logic for linking/appending assets diff --git a/openpype/hosts/blender/plugins/load/load_abc.py b/openpype/hosts/blender/plugins/load/load_abc.py index 07800521c9..3daaeceffe 100644 --- a/openpype/hosts/blender/plugins/load/load_abc.py +++ b/openpype/hosts/blender/plugins/load/load_abc.py @@ -6,7 +6,7 @@ from typing import Dict, List, Optional import bpy -from avalon import api +from openpype.pipeline import get_representation_path from openpype.hosts.blender.api.pipeline import ( AVALON_CONTAINERS, AVALON_PROPERTY, @@ -178,7 +178,7 @@ class CacheModelLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/load/load_action.py b/openpype/hosts/blender/plugins/load/load_action.py index a9d8522220..3c8fe988f0 100644 --- a/openpype/hosts/blender/plugins/load/load_action.py +++ b/openpype/hosts/blender/plugins/load/load_action.py @@ -5,9 +5,13 @@ from pathlib import Path from pprint import pformat from typing import Dict, List, Optional -from avalon import api, blender import bpy +from openpype.pipeline import get_representation_path import openpype.hosts.blender.api.plugin +from openpype.hosts.blender.api.pipeline import ( + containerise_existing, + AVALON_PROPERTY, +) logger = logging.getLogger("openpype").getChild("blender").getChild("load_action") @@ -49,7 +53,7 @@ class BlendActionLoader(openpype.hosts.blender.api.plugin.AssetLoader): container = bpy.data.collections.new(lib_container) container.name = container_name - blender.pipeline.containerise_existing( + containerise_existing( container, name, namespace, @@ -57,8 +61,7 @@ class BlendActionLoader(openpype.hosts.blender.api.plugin.AssetLoader): self.__class__.__name__, ) - container_metadata = container.get( - blender.pipeline.AVALON_PROPERTY) + container_metadata = container.get(AVALON_PROPERTY) container_metadata["libpath"] = libpath container_metadata["lib_container"] = lib_container @@ -90,16 +93,16 @@ class BlendActionLoader(openpype.hosts.blender.api.plugin.AssetLoader): anim_data.action.make_local() - if not obj.get(blender.pipeline.AVALON_PROPERTY): + if not obj.get(AVALON_PROPERTY): - obj[blender.pipeline.AVALON_PROPERTY] = dict() + obj[AVALON_PROPERTY] = dict() - avalon_info = obj[blender.pipeline.AVALON_PROPERTY] + avalon_info = obj[AVALON_PROPERTY] avalon_info.update({"container_name": container_name}) objects_list.append(obj) - animation_container.pop(blender.pipeline.AVALON_PROPERTY) + animation_container.pop(AVALON_PROPERTY) # Save the list of objects in the metadata container container_metadata["objects"] = objects_list @@ -128,7 +131,7 @@ class BlendActionLoader(openpype.hosts.blender.api.plugin.AssetLoader): container["objectName"] ) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() logger.info( @@ -153,8 +156,7 @@ class BlendActionLoader(openpype.hosts.blender.api.plugin.AssetLoader): f"Unsupported file: {libpath}" ) - collection_metadata = collection.get( - blender.pipeline.AVALON_PROPERTY) + collection_metadata = collection.get(AVALON_PROPERTY) collection_libpath = collection_metadata["libpath"] normalized_collection_libpath = ( @@ -225,16 +227,16 @@ class BlendActionLoader(openpype.hosts.blender.api.plugin.AssetLoader): strip.action = anim_data.action strip.action_frame_end = anim_data.action.frame_range[1] - if not obj.get(blender.pipeline.AVALON_PROPERTY): + if not obj.get(AVALON_PROPERTY): - obj[blender.pipeline.AVALON_PROPERTY] = dict() + obj[AVALON_PROPERTY] = dict() - avalon_info = obj[blender.pipeline.AVALON_PROPERTY] + avalon_info = obj[AVALON_PROPERTY] avalon_info.update({"container_name": collection.name}) objects_list.append(obj) - anim_container.pop(blender.pipeline.AVALON_PROPERTY) + anim_container.pop(AVALON_PROPERTY) # Save the list of objects in the metadata container collection_metadata["objects"] = objects_list @@ -266,8 +268,7 @@ class BlendActionLoader(openpype.hosts.blender.api.plugin.AssetLoader): "Nested collections are not supported." ) - collection_metadata = collection.get( - blender.pipeline.AVALON_PROPERTY) + collection_metadata = collection.get(AVALON_PROPERTY) objects = collection_metadata["objects"] lib_container = collection_metadata["lib_container"] diff --git a/openpype/hosts/blender/plugins/load/load_audio.py b/openpype/hosts/blender/plugins/load/load_audio.py index e065150c15..b95c5db270 100644 --- a/openpype/hosts/blender/plugins/load/load_audio.py +++ b/openpype/hosts/blender/plugins/load/load_audio.py @@ -6,7 +6,7 @@ from typing import Dict, List, Optional import bpy -from avalon import api +from openpype.pipeline import get_representation_path from openpype.hosts.blender.api import plugin from openpype.hosts.blender.api.pipeline import ( AVALON_CONTAINERS, @@ -102,7 +102,7 @@ class AudioLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) self.log.info( "Container: %s\nRepresentation: %s", diff --git a/openpype/hosts/blender/plugins/load/load_camera_blend.py b/openpype/hosts/blender/plugins/load/load_camera_blend.py index 61955f124d..6ed2e8a575 100644 --- a/openpype/hosts/blender/plugins/load/load_camera_blend.py +++ b/openpype/hosts/blender/plugins/load/load_camera_blend.py @@ -7,7 +7,7 @@ from typing import Dict, List, Optional import bpy -from avalon import api +from openpype.pipeline import get_representation_path from openpype.hosts.blender.api import plugin from openpype.hosts.blender.api.pipeline import ( AVALON_CONTAINERS, @@ -155,7 +155,7 @@ class BlendCameraLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/load/load_camera_fbx.py b/openpype/hosts/blender/plugins/load/load_camera_fbx.py index 175ddacf9f..626ed44f08 100644 --- a/openpype/hosts/blender/plugins/load/load_camera_fbx.py +++ b/openpype/hosts/blender/plugins/load/load_camera_fbx.py @@ -6,7 +6,7 @@ from typing import Dict, List, Optional import bpy -from avalon import api +from openpype.pipeline import get_representation_path from openpype.hosts.blender.api import plugin, lib from openpype.hosts.blender.api.pipeline import ( AVALON_CONTAINERS, @@ -143,7 +143,7 @@ class FbxCameraLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/load/load_fbx.py b/openpype/hosts/blender/plugins/load/load_fbx.py index c6e6af5592..2d249ef647 100644 --- a/openpype/hosts/blender/plugins/load/load_fbx.py +++ b/openpype/hosts/blender/plugins/load/load_fbx.py @@ -6,7 +6,7 @@ from typing import Dict, List, Optional import bpy -from avalon import api +from openpype.pipeline import get_representation_path from openpype.hosts.blender.api import plugin, lib from openpype.hosts.blender.api.pipeline import ( AVALON_CONTAINERS, @@ -187,7 +187,7 @@ class FbxModelLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/load/load_layout_blend.py b/openpype/hosts/blender/plugins/load/load_layout_blend.py index 8029c38b4a..d87df3c010 100644 --- a/openpype/hosts/blender/plugins/load/load_layout_blend.py +++ b/openpype/hosts/blender/plugins/load/load_layout_blend.py @@ -6,8 +6,11 @@ from typing import Dict, List, Optional import bpy -from avalon import api from openpype import lib +from openpype.pipeline import ( + legacy_create, + get_representation_path, +) from openpype.hosts.blender.api import plugin from openpype.hosts.blender.api.pipeline import ( AVALON_CONTAINERS, @@ -159,7 +162,7 @@ class BlendLayoutLoader(plugin.AssetLoader): raise ValueError("Creator plugin \"CreateAnimation\" was " "not found.") - api.create( + legacy_create( creator_plugin, name=local_obj.name.split(':')[-1] + "_animation", asset=asset, @@ -308,7 +311,7 @@ class BlendLayoutLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/load/load_layout_json.py b/openpype/hosts/blender/plugins/load/load_layout_json.py index 0a5bdeecaa..0693937fec 100644 --- a/openpype/hosts/blender/plugins/load/load_layout_json.py +++ b/openpype/hosts/blender/plugins/load/load_layout_json.py @@ -7,8 +7,13 @@ from typing import Dict, Optional import bpy -from avalon import api -from openpype import lib +from openpype.pipeline import ( + discover_loader_plugins, + remove_container, + load_container, + get_representation_path, + loaders_from_representation, +) from openpype.hosts.blender.api.pipeline import ( AVALON_INSTANCES, AVALON_CONTAINERS, @@ -34,7 +39,7 @@ class JsonLayoutLoader(plugin.AssetLoader): objects = list(asset_group.children) for obj in objects: - api.remove(obj.get(AVALON_PROPERTY)) + remove_container(obj.get(AVALON_PROPERTY)) def _remove_animation_instances(self, asset_group): instances = bpy.data.collections.get(AVALON_INSTANCES) @@ -67,13 +72,13 @@ class JsonLayoutLoader(plugin.AssetLoader): with open(libpath, "r") as fp: data = json.load(fp) - all_loaders = api.discover(api.Loader) + all_loaders = discover_loader_plugins() for element in data: reference = element.get('reference') family = element.get('family') - loaders = api.loaders_from_representation(all_loaders, reference) + loaders = loaders_from_representation(all_loaders, reference) loader = self._get_loader(loaders, family) if not loader: @@ -103,7 +108,7 @@ class JsonLayoutLoader(plugin.AssetLoader): # at this time it will not return anything. The assets will be # loaded in the next Blender cycle, so we use the options to # set the transform, parent and assign the action, if there is one. - api.load( + load_container( loader, reference, namespace=instance_name, @@ -118,7 +123,7 @@ class JsonLayoutLoader(plugin.AssetLoader): # raise ValueError("Creator plugin \"CreateCamera\" was " # "not found.") - # api.create( + # legacy_create( # creator_plugin, # name="camera", # # name=f"{unique_number}_{subset}_animation", @@ -189,7 +194,7 @@ class JsonLayoutLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/load/load_look.py b/openpype/hosts/blender/plugins/load/load_look.py index 066ec0101b..70d1b95f02 100644 --- a/openpype/hosts/blender/plugins/load/load_look.py +++ b/openpype/hosts/blender/plugins/load/load_look.py @@ -8,7 +8,7 @@ import os import json import bpy -from avalon import api +from openpype.pipeline import get_representation_path from openpype.hosts.blender.api import plugin from openpype.hosts.blender.api.pipeline import ( containerise_existing, @@ -140,7 +140,7 @@ class BlendLookLoader(plugin.AssetLoader): def update(self, container: Dict, representation: Dict): collection = bpy.data.collections.get(container["objectName"]) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/load/load_model.py b/openpype/hosts/blender/plugins/load/load_model.py index 04ece0b338..18d01dcb29 100644 --- a/openpype/hosts/blender/plugins/load/load_model.py +++ b/openpype/hosts/blender/plugins/load/load_model.py @@ -6,7 +6,7 @@ from typing import Dict, List, Optional import bpy -from avalon import api +from openpype.pipeline import get_representation_path from openpype.hosts.blender.api import plugin from openpype.hosts.blender.api.pipeline import ( AVALON_CONTAINERS, @@ -195,7 +195,7 @@ class BlendModelLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/load/load_rig.py b/openpype/hosts/blender/plugins/load/load_rig.py index eb6d273a51..cec088076c 100644 --- a/openpype/hosts/blender/plugins/load/load_rig.py +++ b/openpype/hosts/blender/plugins/load/load_rig.py @@ -6,10 +6,15 @@ from typing import Dict, List, Optional import bpy -from avalon import api -from avalon.blender import lib as avalon_lib from openpype import lib -from openpype.hosts.blender.api import plugin +from openpype.pipeline import ( + legacy_create, + get_representation_path, +) +from openpype.hosts.blender.api import ( + plugin, + get_selection, +) from openpype.hosts.blender.api.pipeline import ( AVALON_CONTAINERS, AVALON_PROPERTY, @@ -248,7 +253,7 @@ class BlendRigLoader(plugin.AssetLoader): animation_asset = options.get('animation_asset') - api.create( + legacy_create( creator_plugin, name=namespace + "_animation", # name=f"{unique_number}_{subset}_animation", @@ -262,7 +267,7 @@ class BlendRigLoader(plugin.AssetLoader): if anim_file: bpy.ops.import_scene.fbx(filepath=anim_file, anim_offset=0.0) - imported = avalon_lib.get_selection() + imported = get_selection() armature = [ o for o in asset_group.children if o.type == 'ARMATURE'][0] @@ -306,7 +311,7 @@ class BlendRigLoader(plugin.AssetLoader): """ object_name = container["objectName"] asset_group = bpy.data.objects.get(object_name) - libpath = Path(api.get_representation_path(representation)) + libpath = Path(get_representation_path(representation)) extension = libpath.suffix.lower() self.log.info( diff --git a/openpype/hosts/blender/plugins/publish/extract_camera.py b/openpype/hosts/blender/plugins/publish/extract_camera.py index 597dcecd21..b2c7611b58 100644 --- a/openpype/hosts/blender/plugins/publish/extract_camera.py +++ b/openpype/hosts/blender/plugins/publish/extract_camera.py @@ -50,6 +50,10 @@ class ExtractCamera(api.Extractor): filepath=filepath, use_active_collection=False, use_selection=True, + bake_anim_use_nla_strips=False, + bake_anim_use_all_actions=False, + add_leaf_bones=False, + armature_nodetype='ROOT', object_types={'CAMERA'}, bake_anim_simplify_factor=0.0 ) diff --git a/openpype/hosts/celaction/plugins/publish/submit_celaction_deadline.py b/openpype/hosts/celaction/plugins/publish/submit_celaction_deadline.py index fd958d11a3..ea109e9445 100644 --- a/openpype/hosts/celaction/plugins/publish/submit_celaction_deadline.py +++ b/openpype/hosts/celaction/plugins/publish/submit_celaction_deadline.py @@ -1,9 +1,9 @@ import os +import re import json import getpass -from avalon.vendor import requests -import re +import requests import pyblish.api diff --git a/openpype/hosts/flame/api/__init__.py b/openpype/hosts/flame/api/__init__.py index 56bbadd2fc..f210c27f87 100644 --- a/openpype/hosts/flame/api/__init__.py +++ b/openpype/hosts/flame/api/__init__.py @@ -68,7 +68,8 @@ from .workio import ( ) from .render_utils import ( export_clip, - get_preset_path_by_xml_name + get_preset_path_by_xml_name, + modify_preset_file ) __all__ = [ @@ -140,5 +141,6 @@ __all__ = [ # render utils "export_clip", - "get_preset_path_by_xml_name" + "get_preset_path_by_xml_name", + "modify_preset_file" ] diff --git a/openpype/hosts/flame/api/lib.py b/openpype/hosts/flame/api/lib.py index bbb7c38119..74d9e7607a 100644 --- a/openpype/hosts/flame/api/lib.py +++ b/openpype/hosts/flame/api/lib.py @@ -527,6 +527,7 @@ def get_segment_attributes(segment): # Add timeline segment to tree clip_data = { + "shot_name": segment.shot_name.get_value(), "segment_name": segment.name.get_value(), "segment_comment": segment.comment.get_value(), "tape_name": segment.tape_name, diff --git a/openpype/hosts/flame/api/pipeline.py b/openpype/hosts/flame/api/pipeline.py index af071439ef..930c6abe29 100644 --- a/openpype/hosts/flame/api/pipeline.py +++ b/openpype/hosts/flame/api/pipeline.py @@ -7,6 +7,11 @@ from avalon import api as avalon from avalon.pipeline import AVALON_CONTAINER_ID from pyblish import api as pyblish from openpype.api import Logger +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) from .lib import ( set_segment_data_marker, set_publish_attribute, @@ -32,8 +37,8 @@ def install(): pyblish.register_host("flame") pyblish.register_plugin_path(PUBLISH_PATH) - avalon.register_plugin_path(avalon.Loader, LOAD_PATH) - avalon.register_plugin_path(avalon.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.register_plugin_path(LegacyCreator, CREATE_PATH) avalon.register_plugin_path(avalon.InventoryAction, INVENTORY_PATH) log.info("OpenPype Flame plug-ins registred ...") @@ -47,8 +52,8 @@ def uninstall(): log.info("Deregistering Flame plug-ins..") pyblish.deregister_plugin_path(PUBLISH_PATH) - avalon.deregister_plugin_path(avalon.Loader, LOAD_PATH) - avalon.deregister_plugin_path(avalon.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.deregister_plugin_path(LegacyCreator, CREATE_PATH) avalon.deregister_plugin_path(avalon.InventoryAction, INVENTORY_PATH) # register callback for switching publishable diff --git a/openpype/hosts/flame/api/plugin.py b/openpype/hosts/flame/api/plugin.py index db1793cba8..4c9d3c5383 100644 --- a/openpype/hosts/flame/api/plugin.py +++ b/openpype/hosts/flame/api/plugin.py @@ -2,13 +2,16 @@ import os import re import shutil import sys -from avalon.vendor import qargparse from xml.etree import ElementTree as ET import six +import qargparse from Qt import QtWidgets, QtCore import openpype.api as openpype +from openpype.pipeline import ( + LegacyCreator, + LoaderPlugin, +) from openpype import style -import avalon.api as avalon from . import ( lib as flib, pipeline as fpipeline, @@ -299,7 +302,7 @@ class Spacer(QtWidgets.QWidget): self.setLayout(layout) -class Creator(openpype.Creator): +class Creator(LegacyCreator): """Creator class wrapper """ clip_color = constants.COLOR_MAP["purple"] @@ -361,6 +364,7 @@ class PublishableClip: vertical_sync_default = False driving_layer_default = "" index_from_segment_default = False + use_shot_name_default = False def __init__(self, segment, **kwargs): self.rename_index = kwargs["rename_index"] @@ -376,6 +380,7 @@ class PublishableClip: # segment (clip) main attributes self.cs_name = self.clip_data["segment_name"] self.cs_index = int(self.clip_data["segment"]) + self.shot_name = self.clip_data["shot_name"] # get track name and index self.track_index = int(self.clip_data["track"]) @@ -419,18 +424,21 @@ class PublishableClip: # deal with clip name new_name = self.marker_data.pop("newClipName") - if self.rename: + if self.rename and not self.use_shot_name: # rename segment self.current_segment.name = str(new_name) self.marker_data["asset"] = str(new_name) + elif self.use_shot_name: + self.marker_data["asset"] = self.shot_name + self.marker_data["hierarchyData"]["shot"] = self.shot_name else: self.marker_data["asset"] = self.cs_name self.marker_data["hierarchyData"]["shot"] = self.cs_name if self.marker_data["heroTrack"] and self.review_layer: - self.marker_data.update({"reviewTrack": self.review_layer}) + self.marker_data["reviewTrack"] = self.review_layer else: - self.marker_data.update({"reviewTrack": None}) + self.marker_data["reviewTrack"] = None # create pype tag on track_item and add data fpipeline.imprint(self.current_segment, self.marker_data) @@ -463,6 +471,8 @@ class PublishableClip: # ui_inputs data or default values if gui was not used self.rename = self.ui_inputs.get( "clipRename", {}).get("value") or self.rename_default + self.use_shot_name = self.ui_inputs.get( + "useShotName", {}).get("value") or self.use_shot_name_default self.clip_name = self.ui_inputs.get( "clipName", {}).get("value") or self.clip_name_default self.hierarchy = self.ui_inputs.get( @@ -652,7 +662,7 @@ class PublishableClip: # Publishing plugin functions # Loader plugin functions -class ClipLoader(avalon.Loader): +class ClipLoader(LoaderPlugin): """A basic clip loader for Flame This will implement the basic behavior for a loader to inherit from that diff --git a/openpype/hosts/flame/api/render_utils.py b/openpype/hosts/flame/api/render_utils.py index 1b086646cc..473fb2f985 100644 --- a/openpype/hosts/flame/api/render_utils.py +++ b/openpype/hosts/flame/api/render_utils.py @@ -1,4 +1,5 @@ import os +from xml.etree import ElementTree as ET def export_clip(export_path, clip, preset_path, **kwargs): @@ -123,3 +124,29 @@ def get_preset_path_by_xml_name(xml_preset_name): # if nothing found then return False return False + + +def modify_preset_file(xml_path, staging_dir, data): + """Modify xml preset with input data + + Args: + xml_path (str ): path for input xml preset + staging_dir (str): staging dir path + data (dict): data where key is xmlTag and value as string + + Returns: + str: _description_ + """ + # create temp path + dirname, basename = os.path.split(xml_path) + temp_path = os.path.join(staging_dir, basename) + + # change xml following data keys + with open(xml_path, "r") as datafile: + tree = ET.parse(datafile) + for key, value in data.items(): + for element in tree.findall(".//{}".format(key)): + element.text = str(value) + tree.write(temp_path) + + return temp_path diff --git a/openpype/hosts/flame/api/scripts/wiretap_com.py b/openpype/hosts/flame/api/scripts/wiretap_com.py index c864399608..ee906c2608 100644 --- a/openpype/hosts/flame/api/scripts/wiretap_com.py +++ b/openpype/hosts/flame/api/scripts/wiretap_com.py @@ -420,13 +420,20 @@ class WireTapCom(object): RuntimeError: Not able to set colorspace policy """ color_policy = color_policy or "Legacy" + + # check if the colour policy in custom dir + if not os.path.exists(color_policy): + color_policy = "/syncolor/policies/Autodesk/{}".format( + color_policy) + + # create arguments project_colorspace_cmd = [ os.path.join( self.wiretap_tools_dir, "wiretap_duplicate_node" ), "-s", - "/syncolor/policies/Autodesk/{}".format(color_policy), + color_policy, "-n", "/projects/{}/syncolor".format(project_name) ] diff --git a/openpype/hosts/flame/hooks/pre_flame_setup.py b/openpype/hosts/flame/hooks/pre_flame_setup.py index 0d63b0d926..ad2b0dc897 100644 --- a/openpype/hosts/flame/hooks/pre_flame_setup.py +++ b/openpype/hosts/flame/hooks/pre_flame_setup.py @@ -73,7 +73,7 @@ class FlamePrelaunch(PreLaunchHook): "FrameWidth": int(width), "FrameHeight": int(height), "AspectRatio": float((width / height) * _db_p_data["pixelAspect"]), - "FrameRate": "{} fps".format(fps), + "FrameRate": self._get_flame_fps(fps), "FrameDepth": str(imageio_flame["project"]["frameDepth"]), "FieldDominance": str(imageio_flame["project"]["fieldDominance"]) } @@ -101,6 +101,28 @@ class FlamePrelaunch(PreLaunchHook): self.launch_context.launch_args.extend(app_arguments) + def _get_flame_fps(self, fps_num): + fps_table = { + float(23.976): "23.976 fps", + int(25): "25 fps", + int(24): "24 fps", + float(29.97): "29.97 fps DF", + int(30): "30 fps", + int(50): "50 fps", + float(59.94): "59.94 fps DF", + int(60): "60 fps" + } + + match_key = min(fps_table.keys(), key=lambda x: abs(x - fps_num)) + + try: + return fps_table[match_key] + except KeyError as msg: + raise KeyError(( + "Missing FPS key in conversion table. " + "Following keys are available: {}".format(fps_table.keys()) + )) from msg + def _add_pythonpath(self): pythonpath = self.launch_context.env.get("PYTHONPATH") diff --git a/openpype/hosts/flame/plugins/create/create_shot_clip.py b/openpype/hosts/flame/plugins/create/create_shot_clip.py index f055c77a89..11c00dab42 100644 --- a/openpype/hosts/flame/plugins/create/create_shot_clip.py +++ b/openpype/hosts/flame/plugins/create/create_shot_clip.py @@ -87,41 +87,48 @@ class CreateShotClip(opfapi.Creator): "target": "tag", "toolTip": "Parents folder for shot root folder, Template filled with `Hierarchy Data` section", # noqa "order": 0}, + "useShotName": { + "value": True, + "type": "QCheckBox", + "label": "Use Shot Name", + "target": "ui", + "toolTip": "Use name form Shot name clip attribute", # noqa + "order": 1}, "clipRename": { "value": False, "type": "QCheckBox", "label": "Rename clips", "target": "ui", "toolTip": "Renaming selected clips on fly", # noqa - "order": 1}, + "order": 2}, "clipName": { "value": "{sequence}{shot}", "type": "QLineEdit", "label": "Clip Name Template", "target": "ui", "toolTip": "template for creating shot namespaused for renaming (use rename: on)", # noqa - "order": 2}, + "order": 3}, "segmentIndex": { "value": True, "type": "QCheckBox", "label": "Segment index", "target": "ui", "toolTip": "Take number from segment index", # noqa - "order": 3}, + "order": 4}, "countFrom": { "value": 10, "type": "QSpinBox", "label": "Count sequence from", "target": "ui", "toolTip": "Set when the sequence number stafrom", # noqa - "order": 4}, + "order": 5}, "countSteps": { "value": 10, "type": "QSpinBox", "label": "Stepping number", "target": "ui", "toolTip": "What number is adding every new step", # noqa - "order": 5}, + "order": 6}, } }, "hierarchyData": { diff --git a/openpype/hosts/flame/plugins/load/load_clip.py b/openpype/hosts/flame/plugins/load/load_clip.py index 8ba01d6937..8980f72cb8 100644 --- a/openpype/hosts/flame/plugins/load/load_clip.py +++ b/openpype/hosts/flame/plugins/load/load_clip.py @@ -172,7 +172,7 @@ class LoadClip(opfapi.ClipLoader): # version_name = version.get("name", None) # colorspace = version_data.get("colorspace", None) # object_name = "{}_{}".format(name, namespace) - # file = api.get_representation_path(representation).replace("\\", "/") + # file = get_representation_path(representation).replace("\\", "/") # clip = track_item.source() # # reconnect media to new path diff --git a/openpype/hosts/flame/plugins/publish/extract_subset_resources.py b/openpype/hosts/flame/plugins/publish/extract_subset_resources.py index db85bede85..3b1466925f 100644 --- a/openpype/hosts/flame/plugins/publish/extract_subset_resources.py +++ b/openpype/hosts/flame/plugins/publish/extract_subset_resources.py @@ -22,6 +22,7 @@ class ExtractSubsetResources(openpype.api.Extractor): "ext": "jpg", "xml_preset_file": "Jpeg (8-bit).xml", "xml_preset_dir": "", + "export_type": "File Sequence", "colorspace_out": "Output - sRGB", "representation_add_range": False, "representation_tags": ["thumbnail"] @@ -30,6 +31,7 @@ class ExtractSubsetResources(openpype.api.Extractor): "ext": "mov", "xml_preset_file": "Apple iPad (1920x1080).xml", "xml_preset_dir": "", + "export_type": "Movie", "colorspace_out": "Output - Rec.709", "representation_add_range": True, "representation_tags": [ @@ -54,21 +56,35 @@ class ExtractSubsetResources(openpype.api.Extractor): ): instance.data["representations"] = [] - frame_start = instance.data["frameStart"] - handle_start = instance.data["handleStart"] - frame_start_handle = frame_start - handle_start - source_first_frame = instance.data["sourceFirstFrame"] - source_start_handles = instance.data["sourceStartH"] - source_end_handles = instance.data["sourceEndH"] - source_duration_handles = ( - source_end_handles - source_start_handles) + 1 - + # flame objects + segment = instance.data["item"] + sequence_clip = instance.context.data["flameSequence"] clip_data = instance.data["flameSourceClip"] clip = clip_data["PyClip"] - in_mark = (source_start_handles - source_first_frame) + 1 - out_mark = in_mark + source_duration_handles + # segment's parent track name + s_track_name = segment.parent.name.get_value() + # get configured workfile frame start/end (handles excluded) + frame_start = instance.data["frameStart"] + # get media source first frame + source_first_frame = instance.data["sourceFirstFrame"] + + # get timeline in/out of segment + clip_in = instance.data["clipIn"] + clip_out = instance.data["clipOut"] + + # get handles value - take only the max from both + handle_start = instance.data["handleStart"] + handle_end = instance.data["handleStart"] + handles = max(handle_start, handle_end) + + # get media source range with handles + source_end_handles = instance.data["sourceEndH"] + source_start_handles = instance.data["sourceStartH"] + source_end_handles = instance.data["sourceEndH"] + + # create staging dir path staging_dir = self.staging_dir(instance) # add default preset type for thumbnail and reviewable video @@ -77,15 +93,52 @@ class ExtractSubsetResources(openpype.api.Extractor): export_presets = deepcopy(self.default_presets) export_presets.update(self.export_presets_mapping) - # with maintained duplication loop all presets - with opfapi.maintained_object_duplication(clip) as duplclip: - # loop all preset names and - for unique_name, preset_config in export_presets.items(): + # loop all preset names and + for unique_name, preset_config in export_presets.items(): + modify_xml_data = {} + + # get all presets attributes + preset_file = preset_config["xml_preset_file"] + preset_dir = preset_config["xml_preset_dir"] + export_type = preset_config["export_type"] + repre_tags = preset_config["representation_tags"] + color_out = preset_config["colorspace_out"] + + # get frame range with handles for representation range + frame_start_handle = frame_start - handle_start + source_duration_handles = ( + source_end_handles - source_start_handles) + 1 + + # define in/out marks + in_mark = (source_start_handles - source_first_frame) + 1 + out_mark = in_mark + source_duration_handles + + # by default export source clips + exporting_clip = clip + + if export_type == "Sequence Publish": + # change export clip to sequence + exporting_clip = sequence_clip + + # change in/out marks to timeline in/out + in_mark = clip_in + out_mark = clip_out + + # add xml tags modifications + modify_xml_data.update({ + "exportHandles": True, + "nbHandles": handles, + "startFrame": frame_start + }) + + # with maintained duplication loop all presets + with opfapi.maintained_object_duplication( + exporting_clip) as duplclip: kwargs = {} - preset_file = preset_config["xml_preset_file"] - preset_dir = preset_config["xml_preset_dir"] - repre_tags = preset_config["representation_tags"] - color_out = preset_config["colorspace_out"] + + if export_type == "Sequence Publish": + # only keep visible layer where instance segment is child + self.hide_other_tracks(duplclip, s_track_name) # validate xml preset file is filled if preset_file == "": @@ -108,10 +161,13 @@ class ExtractSubsetResources(openpype.api.Extractor): ) # create preset path - preset_path = str(os.path.join( + preset_orig_xml_path = str(os.path.join( preset_dir, preset_file )) + preset_path = opfapi.modify_preset_file( + preset_orig_xml_path, staging_dir, modify_xml_data) + # define kwargs based on preset type if "thumbnail" in unique_name: kwargs["thumb_frame_number"] = in_mark + ( @@ -122,6 +178,7 @@ class ExtractSubsetResources(openpype.api.Extractor): "out_mark": out_mark }) + # get and make export dir paths export_dir_path = str(os.path.join( staging_dir, unique_name )) @@ -132,6 +189,7 @@ class ExtractSubsetResources(openpype.api.Extractor): export_dir_path, duplclip, preset_path, **kwargs) extension = preset_config["ext"] + # create representation data representation_data = { "name": unique_name, @@ -159,7 +217,12 @@ class ExtractSubsetResources(openpype.api.Extractor): # add files to represetation but add # imagesequence as list if ( - "movie_file" in preset_path + # first check if path in files is not mov extension + [ + f for f in files + if os.path.splitext(f)[-1] == ".mov" + ] + # then try if thumbnail is not in unique name or unique_name == "thumbnail" ): representation_data["files"] = files.pop() @@ -246,3 +309,19 @@ class ExtractSubsetResources(openpype.api.Extractor): ) return new_stage_dir, new_files_list + + def hide_other_tracks(self, sequence_clip, track_name): + """Helper method used only if sequence clip is used + + Args: + sequence_clip (flame.Clip): sequence clip + track_name (str): track name + """ + # create otio tracks and clips + for ver in sequence_clip.versions: + for track in ver.tracks: + if len(track.segments) == 0 and track.hidden: + continue + + if track.name.get_value() != track_name: + track.hidden = True diff --git a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/export_preset/openpype_seg_thumbnails_jpg.xml b/openpype/hosts/flame/startup/openpype_babypublisher/export_preset/openpype_seg_thumbnails_jpg.xml similarity index 97% rename from openpype/hosts/flame/startup/openpype_flame_to_ftrack/export_preset/openpype_seg_thumbnails_jpg.xml rename to openpype/hosts/flame/startup/openpype_babypublisher/export_preset/openpype_seg_thumbnails_jpg.xml index fa43ceece7..44a7bd9770 100644 --- a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/export_preset/openpype_seg_thumbnails_jpg.xml +++ b/openpype/hosts/flame/startup/openpype_babypublisher/export_preset/openpype_seg_thumbnails_jpg.xml @@ -29,7 +29,7 @@ Jpeg 923688 - <segment name> + <shot name> 100 2 4 diff --git a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/export_preset/openpype_seg_video_h264.xml b/openpype/hosts/flame/startup/openpype_babypublisher/export_preset/openpype_seg_video_h264.xml similarity index 95% rename from openpype/hosts/flame/startup/openpype_flame_to_ftrack/export_preset/openpype_seg_video_h264.xml rename to openpype/hosts/flame/startup/openpype_babypublisher/export_preset/openpype_seg_video_h264.xml index 3ca185b8b4..1d2c5a28bb 100644 --- a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/export_preset/openpype_seg_video_h264.xml +++ b/openpype/hosts/flame/startup/openpype_babypublisher/export_preset/openpype_seg_video_h264.xml @@ -27,7 +27,7 @@ QuickTime - <segment name> + <shot name> 0 PCS_709 None @@ -43,7 +43,7 @@ 2021 /profiles/.33622016/HDTV_720p_8Mbits.cdxprof - <segment name>_<video codec> + <shot name>_<video codec> 50 2 4 diff --git a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/__init__.py b/openpype/hosts/flame/startup/openpype_babypublisher/modules/__init__.py similarity index 100% rename from openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/__init__.py rename to openpype/hosts/flame/startup/openpype_babypublisher/modules/__init__.py diff --git a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/app_utils.py b/openpype/hosts/flame/startup/openpype_babypublisher/modules/app_utils.py similarity index 98% rename from openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/app_utils.py rename to openpype/hosts/flame/startup/openpype_babypublisher/modules/app_utils.py index b255d8d3f5..e639c3f482 100644 --- a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/app_utils.py +++ b/openpype/hosts/flame/startup/openpype_babypublisher/modules/app_utils.py @@ -8,7 +8,7 @@ PLUGIN_DIR = os.path.dirname(os.path.dirname(__file__)) EXPORT_PRESETS_DIR = os.path.join(PLUGIN_DIR, "export_preset") CONFIG_DIR = os.path.join(os.path.expanduser( - "~/.openpype"), "openpype_flame_to_ftrack") + "~/.openpype"), "openpype_babypublisher") @contextmanager diff --git a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/ftrack_lib.py b/openpype/hosts/flame/startup/openpype_babypublisher/modules/ftrack_lib.py similarity index 96% rename from openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/ftrack_lib.py rename to openpype/hosts/flame/startup/openpype_babypublisher/modules/ftrack_lib.py index c2168016c6..0e84a5ef52 100644 --- a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/ftrack_lib.py +++ b/openpype/hosts/flame/startup/openpype_babypublisher/modules/ftrack_lib.py @@ -360,6 +360,8 @@ class FtrackComponentCreator: class FtrackEntityOperator: + existing_tasks = [] + def __init__(self, session, project_entity): self.session = session self.project_entity = project_entity @@ -392,10 +394,7 @@ class FtrackEntityOperator: query = '{} where name is "{}" and project_id is "{}"'.format( type, name, self.project_entity["id"]) - try: - entity = session.query(query).one() - except Exception: - entity = None + entity = session.query(query).first() # if entity doesnt exist then create one if not entity: @@ -430,10 +429,21 @@ class FtrackEntityOperator: return parents def create_task(self, task_type, task_types, parent): - existing_task = [ + _exising_tasks = [ child for child in parent['children'] if child.entity_type.lower() == 'task' - if child['name'].lower() in task_type.lower() + ] + + # add task into existing tasks if they are not already there + for _t in _exising_tasks: + if _t in self.existing_tasks: + continue + self.existing_tasks.append(_t) + + existing_task = [ + task for task in self.existing_tasks + if task['name'].lower() in task_type.lower() + if task['parent'] == parent ] if existing_task: @@ -445,4 +455,5 @@ class FtrackEntityOperator: }) task["type"] = task_types[task_type] + self.existing_tasks.append(task) return task diff --git a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/panel_app.py b/openpype/hosts/flame/startup/openpype_babypublisher/modules/panel_app.py similarity index 96% rename from openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/panel_app.py rename to openpype/hosts/flame/startup/openpype_babypublisher/modules/panel_app.py index 648f902872..1e8011efaa 100644 --- a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/panel_app.py +++ b/openpype/hosts/flame/startup/openpype_babypublisher/modules/panel_app.py @@ -1,4 +1,4 @@ -from PySide2 import QtWidgets, QtCore +from Qt import QtWidgets, QtCore import uiwidgets import app_utils @@ -33,11 +33,12 @@ class MainWindow(QtWidgets.QWidget): self.panel_class.clear_temp_data() self.panel_class.close() clear_inner_modules() + ftrack_lib.FtrackEntityOperator.existing_tasks = [] # now the panel can be closed event.accept() -class FlameToFtrackPanel(object): +class FlameBabyPublisherPanel(object): session = None temp_data_dir = None processed_components = [] @@ -78,7 +79,7 @@ class FlameToFtrackPanel(object): # creating ui self.window.setMinimumSize(1500, 600) - self.window.setWindowTitle('Sequence Shots to Ftrack') + self.window.setWindowTitle('OpenPype: Baby-publisher') self.window.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint) self.window.setAttribute(QtCore.Qt.WA_DeleteOnClose) self.window.setFocusPolicy(QtCore.Qt.StrongFocus) @@ -469,10 +470,14 @@ class FlameToFtrackPanel(object): for sequence in self.selection: frame_rate = float(str(sequence.frame_rate)[:-4]) for ver in sequence.versions: - for tracks in ver.tracks: - for segment in tracks.segments: + for track in ver.tracks: + if len(track.segments) == 0 and track.hidden: + continue + for segment in track.segments: print(segment.attributes) - if str(segment.name)[1:-1] == "": + if segment.name.get_value() == "": + continue + if segment.hidden.get_value() is True: continue # get clip frame duration record_duration = str(segment.record_duration)[1:-1] @@ -492,11 +497,11 @@ class FlameToFtrackPanel(object): # Add timeline segment to tree QtWidgets.QTreeWidgetItem(self.tree, [ - str(sequence.name)[1:-1], # seq - str(segment.name)[1:-1], # shot + sequence.name.get_value(), # seq name + segment.shot_name.get_value(), # shot name str(clip_duration), # clip duration shot_description, # shot description - str(segment.comment)[1:-1] # task description + segment.comment.get_value() # task description ]).setFlags( QtCore.Qt.ItemIsEditable | QtCore.Qt.ItemIsEnabled diff --git a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/uiwidgets.py b/openpype/hosts/flame/startup/openpype_babypublisher/modules/uiwidgets.py similarity index 99% rename from openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/uiwidgets.py rename to openpype/hosts/flame/startup/openpype_babypublisher/modules/uiwidgets.py index 0d4807a4ea..c6db875df0 100644 --- a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/modules/uiwidgets.py +++ b/openpype/hosts/flame/startup/openpype_babypublisher/modules/uiwidgets.py @@ -1,4 +1,4 @@ -from PySide2 import QtWidgets, QtCore +from Qt import QtWidgets, QtCore class FlameLabel(QtWidgets.QLabel): diff --git a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/openpype_flame_to_ftrack.py b/openpype/hosts/flame/startup/openpype_babypublisher/openpype_babypublisher.py similarity index 85% rename from openpype/hosts/flame/startup/openpype_flame_to_ftrack/openpype_flame_to_ftrack.py rename to openpype/hosts/flame/startup/openpype_babypublisher/openpype_babypublisher.py index 5a72706ba1..4675d163e3 100644 --- a/openpype/hosts/flame/startup/openpype_flame_to_ftrack/openpype_flame_to_ftrack.py +++ b/openpype/hosts/flame/startup/openpype_babypublisher/openpype_babypublisher.py @@ -16,10 +16,11 @@ def flame_panel_executor(selection): if "panel_app" in sys.modules.keys(): print("panel_app module is already loaded") del sys.modules["panel_app"] + import panel_app + reload(panel_app) # noqa print("panel_app module removed from sys.modules") - import panel_app - panel_app.FlameToFtrackPanel(selection) + panel_app.FlameBabyPublisherPanel(selection) def scope_sequence(selection): @@ -30,7 +31,7 @@ def scope_sequence(selection): def get_media_panel_custom_ui_actions(): return [ { - "name": "OpenPype: Ftrack", + "name": "OpenPype: Baby-publisher", "actions": [ { "name": "Create Shots", diff --git a/openpype/hosts/fusion/api/lib.py b/openpype/hosts/fusion/api/lib.py index 37a13e4a10..8f1ea26db0 100644 --- a/openpype/hosts/fusion/api/lib.py +++ b/openpype/hosts/fusion/api/lib.py @@ -5,8 +5,8 @@ import contextlib from Qt import QtGui -import avalon.api from avalon import io +from openpype.pipeline import switch_container from .pipeline import get_current_comp, comp_lock_and_undo_chunk from openpype.api import ( get_asset @@ -167,7 +167,7 @@ def switch_item(container, assert representation, ("Could not find representation in the database " "with the name '%s'" % representation_name) - avalon.api.switch(container, representation) + switch_container(container, representation) return representation diff --git a/openpype/hosts/fusion/api/pipeline.py b/openpype/hosts/fusion/api/pipeline.py index 0c1c5a4362..3e83f3a9da 100644 --- a/openpype/hosts/fusion/api/pipeline.py +++ b/openpype/hosts/fusion/api/pipeline.py @@ -11,6 +11,11 @@ import avalon.api from avalon.pipeline import AVALON_CONTAINER_ID from openpype.api import Logger +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) import openpype.hosts.fusion log = Logger().get_logger(__name__) @@ -62,8 +67,8 @@ def install(): pyblish.api.register_plugin_path(PUBLISH_PATH) log.info("Registering Fusion plug-ins..") - avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH) avalon.api.register_plugin_path(avalon.api.InventoryAction, INVENTORY_PATH) pyblish.api.register_callback( @@ -86,8 +91,8 @@ def uninstall(): pyblish.api.deregister_plugin_path(PUBLISH_PATH) log.info("Deregistering Fusion plug-ins..") - avalon.api.deregister_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.deregister_plugin_path(avalon.api.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.api.deregister_plugin_path(LegacyCreator, CREATE_PATH) avalon.api.deregister_plugin_path( avalon.api.InventoryAction, INVENTORY_PATH ) diff --git a/openpype/hosts/fusion/deploy/Scripts/Comp/OpenPype/switch_ui.py b/openpype/hosts/fusion/deploy/Scripts/Comp/OpenPype/switch_ui.py index fe324d9a41..d9eeae25ea 100644 --- a/openpype/hosts/fusion/deploy/Scripts/Comp/OpenPype/switch_ui.py +++ b/openpype/hosts/fusion/deploy/Scripts/Comp/OpenPype/switch_ui.py @@ -5,11 +5,12 @@ import logging from Qt import QtWidgets, QtCore import avalon.api -from avalon import io, pipeline -from avalon.vendor import qtawesome as qta +from avalon import io +import qtawesome as qta from openpype import style from openpype.hosts.fusion import api +from openpype.lib.avalon_context import get_workdir_from_session log = logging.getLogger("Fusion Switch Shot") @@ -123,7 +124,7 @@ class App(QtWidgets.QWidget): def _on_open_from_dir(self): - start_dir = self._get_context_directory() + start_dir = get_workdir_from_session() comp_file, _ = QtWidgets.QFileDialog.getOpenFileName( self, "Choose comp", start_dir) @@ -157,17 +158,6 @@ class App(QtWidgets.QWidget): import colorbleed.scripts.fusion_switch_shot as switch_shot switch_shot.switch(asset_name=asset, filepath=file_name, new=True) - def _get_context_directory(self): - - project = io.find_one({"type": "project", - "name": avalon.api.Session["AVALON_PROJECT"]}, - projection={"config": True}) - - template = project["config"]["template"]["work"] - dir = pipeline._format_work_template(template, avalon.api.Session) - - return dir - def collect_slap_comps(self, directory): items = glob.glob("{}/*.comp".format(directory)) return items diff --git a/openpype/hosts/fusion/plugins/create/create_exr_saver.py b/openpype/hosts/fusion/plugins/create/create_exr_saver.py index 04717f4746..ff8bdb21ef 100644 --- a/openpype/hosts/fusion/plugins/create/create_exr_saver.py +++ b/openpype/hosts/fusion/plugins/create/create_exr_saver.py @@ -1,13 +1,13 @@ import os -import openpype.api +from openpype.pipeline import create from openpype.hosts.fusion.api import ( get_current_comp, comp_lock_and_undo_chunk ) -class CreateOpenEXRSaver(openpype.api.Creator): +class CreateOpenEXRSaver(create.LegacyCreator): name = "openexrDefault" label = "Create OpenEXR Saver" diff --git a/openpype/hosts/fusion/plugins/load/actions.py b/openpype/hosts/fusion/plugins/load/actions.py index 6af99e4c56..bc59cec77f 100644 --- a/openpype/hosts/fusion/plugins/load/actions.py +++ b/openpype/hosts/fusion/plugins/load/actions.py @@ -2,10 +2,10 @@ """ -from avalon import api +from openpype.pipeline import load -class FusionSetFrameRangeLoader(api.Loader): +class FusionSetFrameRangeLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["animation", @@ -39,7 +39,7 @@ class FusionSetFrameRangeLoader(api.Loader): lib.update_frame_range(start, end) -class FusionSetFrameRangeWithHandlesLoader(api.Loader): +class FusionSetFrameRangeWithHandlesLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["animation", diff --git a/openpype/hosts/fusion/plugins/load/load_sequence.py b/openpype/hosts/fusion/plugins/load/load_sequence.py index ea118585bf..075820de35 100644 --- a/openpype/hosts/fusion/plugins/load/load_sequence.py +++ b/openpype/hosts/fusion/plugins/load/load_sequence.py @@ -1,8 +1,12 @@ import os import contextlib -from avalon import api, io +from avalon import io +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.fusion.api import ( imprint_container, get_current_comp, @@ -117,7 +121,7 @@ def loader_shift(loader, frame, relative=True): return int(shift) -class FusionLoadSequence(api.Loader): +class FusionLoadSequence(load.LoaderPlugin): """Load image sequence into Fusion""" families = ["imagesequence", "review", "render"] @@ -204,7 +208,7 @@ class FusionLoadSequence(api.Loader): assert tool.ID == "Loader", "Must be Loader" comp = tool.Comp() - root = os.path.dirname(api.get_representation_path(representation)) + root = os.path.dirname(get_representation_path(representation)) path = self._get_first_image(root) # Get start frame from version data diff --git a/openpype/hosts/fusion/scripts/fusion_switch_shot.py b/openpype/hosts/fusion/scripts/fusion_switch_shot.py index 9dd8a351e4..ca7efb9136 100644 --- a/openpype/hosts/fusion/scripts/fusion_switch_shot.py +++ b/openpype/hosts/fusion/scripts/fusion_switch_shot.py @@ -5,11 +5,12 @@ import logging # Pipeline imports import avalon.api -from avalon import io, pipeline +from avalon import io from openpype.lib import version_up from openpype.hosts.fusion import api from openpype.hosts.fusion.api import lib +from openpype.lib.avalon_context import get_workdir_from_session log = logging.getLogger("Update Slap Comp") @@ -44,16 +45,6 @@ def _format_version_folder(folder): return version_folder -def _get_work_folder(session): - """Convenience function to get the work folder path of the current asset""" - - # Get new filename, create path based on asset and work template - template_work = self._project["config"]["template"]["work"] - work_path = pipeline._format_work_template(template_work, session) - - return os.path.normpath(work_path) - - def _get_fusion_instance(): fusion = getattr(sys.modules["__main__"], "fusion", None) if fusion is None: @@ -72,7 +63,7 @@ def _format_filepath(session): asset = session["AVALON_ASSET"] # Save updated slap comp - work_path = _get_work_folder(session) + work_path = get_workdir_from_session(session) walk_to_dir = os.path.join(work_path, "scenes", "slapcomp") slapcomp_dir = os.path.abspath(walk_to_dir) @@ -112,7 +103,7 @@ def _update_savers(comp, session): None """ - new_work = _get_work_folder(session) + new_work = get_workdir_from_session(session) renders = os.path.join(new_work, "renders") version_folder = _format_version_folder(renders) renders_version = os.path.join(renders, version_folder) diff --git a/openpype/hosts/fusion/scripts/set_rendermode.py b/openpype/hosts/fusion/scripts/set_rendermode.py index 77a2d8e945..f0638e4fe3 100644 --- a/openpype/hosts/fusion/scripts/set_rendermode.py +++ b/openpype/hosts/fusion/scripts/set_rendermode.py @@ -1,5 +1,5 @@ from Qt import QtWidgets -from avalon.vendor import qtawesome +import qtawesome from openpype.hosts.fusion.api import get_current_comp diff --git a/openpype/hosts/harmony/api/README.md b/openpype/hosts/harmony/api/README.md index a8d182736a..e8d354e1e6 100644 --- a/openpype/hosts/harmony/api/README.md +++ b/openpype/hosts/harmony/api/README.md @@ -575,7 +575,7 @@ replace_files = """function %s_replace_files(args) """ % (signature, signature) -class ImageSequenceLoader(api.Loader): +class ImageSequenceLoader(load.LoaderPlugin): """Load images Stores the imported asset in a container named after the asset. """ diff --git a/openpype/hosts/harmony/api/TB_sceneOpened.js b/openpype/hosts/harmony/api/TB_sceneOpened.js index 5a3fe9ce82..6a403fa65e 100644 --- a/openpype/hosts/harmony/api/TB_sceneOpened.js +++ b/openpype/hosts/harmony/api/TB_sceneOpened.js @@ -272,8 +272,8 @@ function Client() { app.avalonClient.send( { - 'module': 'avalon.api', - 'method': 'emit', + 'module': 'openpype.lib', + 'method': 'emit_event', 'args': ['application.launched'] }, false); }; diff --git a/openpype/hosts/harmony/api/lib.py b/openpype/hosts/harmony/api/lib.py index 134f670dc4..66eeac1e3a 100644 --- a/openpype/hosts/harmony/api/lib.py +++ b/openpype/hosts/harmony/api/lib.py @@ -361,7 +361,7 @@ def zip_and_move(source, destination): log.debug(f"Saved '{source}' to '{destination}'") -def show(module_name): +def show(tool_name): """Call show on "module_name". This allows to make a QApplication ahead of time and always "exec_" to @@ -375,13 +375,6 @@ def show(module_name): # requests to be received properly. time.sleep(1) - # Get tool name from module name - # TODO this is for backwards compatibility not sure if `TB_sceneOpened.js` - # is automatically updated. - # Previous javascript sent 'module_name' which contained whole tool import - # string e.g. "avalon.tools.workfiles" now it should be only "workfiles" - tool_name = module_name.split(".")[-1] - kwargs = {} if tool_name == "loader": kwargs["use_context"] = True diff --git a/openpype/hosts/harmony/api/pipeline.py b/openpype/hosts/harmony/api/pipeline.py index 17d2870876..f967da15ca 100644 --- a/openpype/hosts/harmony/api/pipeline.py +++ b/openpype/hosts/harmony/api/pipeline.py @@ -9,6 +9,12 @@ import avalon.api from avalon.pipeline import AVALON_CONTAINER_ID from openpype import lib +from openpype.lib import register_event_callback +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) import openpype.hosts.harmony import openpype.hosts.harmony.api as harmony @@ -129,7 +135,7 @@ def check_inventory(): harmony.send({"function": "PypeHarmony.message", "args": msg}) -def application_launch(): +def application_launch(event): """Event that is executed after Harmony is launched.""" # FIXME: This is breaking server <-> client communication. # It is now moved so it it manually called. @@ -178,8 +184,8 @@ def install(): pyblish.api.register_host("harmony") pyblish.api.register_plugin_path(PUBLISH_PATH) - avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH) log.info(PUBLISH_PATH) # Register callbacks. @@ -187,13 +193,13 @@ def install(): "instanceToggled", on_pyblish_instance_toggled ) - avalon.api.on("application.launched", application_launch) + register_event_callback("application.launched", application_launch) def uninstall(): pyblish.api.deregister_plugin_path(PUBLISH_PATH) - avalon.api.deregister_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.deregister_plugin_path(avalon.api.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.api.deregister_plugin_path(LegacyCreator, CREATE_PATH) def on_pyblish_instance_toggled(instance, old_value, new_value): diff --git a/openpype/hosts/harmony/api/plugin.py b/openpype/hosts/harmony/api/plugin.py index d6d61a547a..c55d200d30 100644 --- a/openpype/hosts/harmony/api/plugin.py +++ b/openpype/hosts/harmony/api/plugin.py @@ -1,9 +1,8 @@ -import avalon.api -from openpype.api import PypeCreatorMixin +from openpype.pipeline import LegacyCreator import openpype.hosts.harmony.api as harmony -class Creator(PypeCreatorMixin, avalon.api.Creator): +class Creator(LegacyCreator): """Creator plugin to create instances in Harmony. By default a Composite node is created to support any number of nodes in diff --git a/openpype/hosts/harmony/plugins/load/load_audio.py b/openpype/hosts/harmony/plugins/load/load_audio.py index 57ea8ae312..e18a6de097 100644 --- a/openpype/hosts/harmony/plugins/load/load_audio.py +++ b/openpype/hosts/harmony/plugins/load/load_audio.py @@ -1,4 +1,7 @@ -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) import openpype.hosts.harmony.api as harmony sig = harmony.signature() @@ -29,7 +32,7 @@ function %s(args) """ % (sig, sig) -class ImportAudioLoader(api.Loader): +class ImportAudioLoader(load.LoaderPlugin): """Import audio.""" families = ["shot", "audio"] @@ -37,7 +40,7 @@ class ImportAudioLoader(api.Loader): label = "Import Audio" def load(self, context, name=None, namespace=None, data=None): - wav_file = api.get_representation_path(context["representation"]) + wav_file = get_representation_path(context["representation"]) harmony.send( {"function": func, "args": [context["subset"]["name"], wav_file]} ) diff --git a/openpype/hosts/harmony/plugins/load/load_background.py b/openpype/hosts/harmony/plugins/load/load_background.py index 686d6b5b7b..9c01fe3cd8 100644 --- a/openpype/hosts/harmony/plugins/load/load_background.py +++ b/openpype/hosts/harmony/plugins/load/load_background.py @@ -1,7 +1,10 @@ import os import json -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) import openpype.hosts.harmony.api as harmony import openpype.lib @@ -226,7 +229,7 @@ replace_files """ -class BackgroundLoader(api.Loader): +class BackgroundLoader(load.LoaderPlugin): """Load images Stores the imported asset in a container named after the asset. """ @@ -278,7 +281,7 @@ class BackgroundLoader(api.Loader): def update(self, container, representation): - path = api.get_representation_path(representation) + path = get_representation_path(representation) with open(path) as json_file: data = json.load(json_file) @@ -297,7 +300,7 @@ class BackgroundLoader(api.Loader): bg_folder = os.path.dirname(path) - path = api.get_representation_path(representation) + path = get_representation_path(representation) print(container) diff --git a/openpype/hosts/harmony/plugins/load/load_imagesequence.py b/openpype/hosts/harmony/plugins/load/load_imagesequence.py index 310f9bdb61..18695438d5 100644 --- a/openpype/hosts/harmony/plugins/load/load_imagesequence.py +++ b/openpype/hosts/harmony/plugins/load/load_imagesequence.py @@ -6,12 +6,15 @@ from pathlib import Path import clique -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) import openpype.hosts.harmony.api as harmony import openpype.lib -class ImageSequenceLoader(api.Loader): +class ImageSequenceLoader(load.LoaderPlugin): """Load image sequences. Stores the imported asset in a container named after the asset. @@ -79,7 +82,7 @@ class ImageSequenceLoader(api.Loader): self_name = self.__class__.__name__ node = container.get("nodes").pop() - path = api.get_representation_path(representation) + path = get_representation_path(representation) collections, remainder = clique.assemble( os.listdir(os.path.dirname(path)) ) diff --git a/openpype/hosts/harmony/plugins/load/load_palette.py b/openpype/hosts/harmony/plugins/load/load_palette.py index 2e0f70d135..1da3e61e1b 100644 --- a/openpype/hosts/harmony/plugins/load/load_palette.py +++ b/openpype/hosts/harmony/plugins/load/load_palette.py @@ -1,11 +1,14 @@ import os import shutil -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) import openpype.hosts.harmony.api as harmony -class ImportPaletteLoader(api.Loader): +class ImportPaletteLoader(load.LoaderPlugin): """Import palettes.""" families = ["palette", "harmony.palette"] @@ -31,7 +34,7 @@ class ImportPaletteLoader(api.Loader): scene_path = harmony.send( {"function": "scene.currentProjectPath"} )["result"] - src = api.get_representation_path(representation) + src = get_representation_path(representation) dst = os.path.join( scene_path, "palette-library", diff --git a/openpype/hosts/harmony/plugins/load/load_template.py b/openpype/hosts/harmony/plugins/load/load_template.py index 112e613ae6..c6dc9d913b 100644 --- a/openpype/hosts/harmony/plugins/load/load_template.py +++ b/openpype/hosts/harmony/plugins/load/load_template.py @@ -6,12 +6,15 @@ import os import shutil import uuid -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) import openpype.hosts.harmony.api as harmony import openpype.lib -class TemplateLoader(api.Loader): +class TemplateLoader(load.LoaderPlugin): """Load Harmony template as container. .. todo:: @@ -38,7 +41,7 @@ class TemplateLoader(api.Loader): # Load template. self_name = self.__class__.__name__ temp_dir = tempfile.mkdtemp() - zip_file = api.get_representation_path(context["representation"]) + zip_file = get_representation_path(context["representation"]) template_path = os.path.join(temp_dir, "temp.tpl") with zipfile.ZipFile(zip_file, "r") as zip_ref: zip_ref.extractall(template_path) diff --git a/openpype/hosts/harmony/plugins/load/load_template_workfile.py b/openpype/hosts/harmony/plugins/load/load_template_workfile.py index c21b8194b1..2b84a43b35 100644 --- a/openpype/hosts/harmony/plugins/load/load_template_workfile.py +++ b/openpype/hosts/harmony/plugins/load/load_template_workfile.py @@ -3,11 +3,14 @@ import zipfile import os import shutil -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) import openpype.hosts.harmony.api as harmony -class ImportTemplateLoader(api.Loader): +class ImportTemplateLoader(load.LoaderPlugin): """Import templates.""" families = ["harmony.template", "workfile"] @@ -17,7 +20,7 @@ class ImportTemplateLoader(api.Loader): def load(self, context, name=None, namespace=None, data=None): # Import template. temp_dir = tempfile.mkdtemp() - zip_file = api.get_representation_path(context["representation"]) + zip_file = get_representation_path(context["representation"]) template_path = os.path.join(temp_dir, "temp.tpl") with zipfile.ZipFile(zip_file, "r") as zip_ref: zip_ref.extractall(template_path) diff --git a/openpype/hosts/harmony/plugins/publish/collect_farm_render.py b/openpype/hosts/harmony/plugins/publish/collect_farm_render.py index 85237094e4..35b123f97d 100644 --- a/openpype/hosts/harmony/plugins/publish/collect_farm_render.py +++ b/openpype/hosts/harmony/plugins/publish/collect_farm_render.py @@ -5,6 +5,7 @@ from pathlib import Path import attr from avalon import api +from openpype.lib import get_formatted_current_time import openpype.lib.abstract_collect_render import openpype.hosts.harmony.api as harmony from openpype.lib.abstract_collect_render import RenderInstance @@ -138,7 +139,7 @@ class CollectFarmRender(openpype.lib.abstract_collect_render. render_instance = HarmonyRenderInstance( version=version, - time=api.time(), + time=get_formatted_current_time(), source=context.data["currentFile"], label=node.split("/")[1], subset=subset_name, diff --git a/openpype/hosts/harmony/plugins/publish/help/validate_audio.xml b/openpype/hosts/harmony/plugins/publish/help/validate_audio.xml new file mode 100644 index 0000000000..e9a183c675 --- /dev/null +++ b/openpype/hosts/harmony/plugins/publish/help/validate_audio.xml @@ -0,0 +1,15 @@ + + + +Missing audio file + +## Cannot locate linked audio file + +Audio file at {audio_url} cannot be found. + +### How to repair? + +Copy audio file to the highlighted location or remove audio link in the workfile. + + + \ No newline at end of file diff --git a/openpype/hosts/harmony/plugins/publish/help/validate_instances.xml b/openpype/hosts/harmony/plugins/publish/help/validate_instances.xml new file mode 100644 index 0000000000..3b040e8ea8 --- /dev/null +++ b/openpype/hosts/harmony/plugins/publish/help/validate_instances.xml @@ -0,0 +1,25 @@ + + + +Subset context + +## Invalid subset context + +Asset name found '{found}' in subsets, expected '{expected}'. + +### How to repair? + +You can fix this with `Repair` button on the right. This will use '{expected}' asset name and overwrite '{found}' asset name in scene metadata. + +After that restart `Publish` with a `Reload button`. + +If this is unwanted, close workfile and open again, that way different asset value would be used for context information. + + +### __Detailed Info__ (optional) + +This might happen if you are reuse old workfile and open it in different context. +(Eg. you created subset "renderCompositingDefault" from asset "Robot' in "your_project_Robot_compositing.aep", now you opened this workfile in a context "Sloth" but existing subset for "Robot" asset stayed in the workfile.) + + + \ No newline at end of file diff --git a/openpype/hosts/harmony/plugins/publish/help/validate_scene_settings.xml b/openpype/hosts/harmony/plugins/publish/help/validate_scene_settings.xml new file mode 100644 index 0000000000..36fa90456e --- /dev/null +++ b/openpype/hosts/harmony/plugins/publish/help/validate_scene_settings.xml @@ -0,0 +1,35 @@ + + + +Scene setting + +## Invalid scene setting found + +One of the settings in a scene doesn't match to asset settings in database. + +{invalid_setting_str} + +### How to repair? + +Change values for {invalid_keys_str} in the scene OR change them in the asset database if they are wrong there. + + +### __Detailed Info__ (optional) + +This error is shown when for example resolution in the scene doesn't match to resolution set on the asset in the database. +Either value in the database or in the scene is wrong. + + + +Scene file doesn't exist + +## Scene file doesn't exist + +Collected scene {scene_url} doesn't exist. + +### How to repair? + +Re-save file, start publish from the beginning again. + + + \ No newline at end of file diff --git a/openpype/hosts/harmony/plugins/publish/validate_audio.py b/openpype/hosts/harmony/plugins/publish/validate_audio.py index d183dadb91..cb6b2307cd 100644 --- a/openpype/hosts/harmony/plugins/publish/validate_audio.py +++ b/openpype/hosts/harmony/plugins/publish/validate_audio.py @@ -4,6 +4,8 @@ import pyblish.api import openpype.hosts.harmony.api as harmony +from openpype.pipeline import PublishXmlValidationError + class ValidateAudio(pyblish.api.InstancePlugin): """Ensures that there is an audio file in the scene. @@ -42,4 +44,9 @@ class ValidateAudio(pyblish.api.InstancePlugin): msg = "You are missing audio file:\n{}".format(audio_path) - assert os.path.isfile(audio_path), msg + formatting_data = { + "audio_url": audio_path + } + if os.path.isfile(audio_path): + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) diff --git a/openpype/hosts/harmony/plugins/publish/validate_instances.py b/openpype/hosts/harmony/plugins/publish/validate_instances.py index 1ba65573fc..373ef94cc3 100644 --- a/openpype/hosts/harmony/plugins/publish/validate_instances.py +++ b/openpype/hosts/harmony/plugins/publish/validate_instances.py @@ -2,6 +2,7 @@ import os import pyblish.api import openpype.api +from openpype.pipeline import PublishXmlValidationError import openpype.hosts.harmony.api as harmony @@ -45,4 +46,11 @@ class ValidateInstance(pyblish.api.InstancePlugin): "Instance asset is not the same as current asset:" f"\nInstance: {instance_asset}\nCurrent: {current_asset}" ) - assert instance_asset == current_asset, msg + + formatting_data = { + "found": instance_asset, + "expected": current_asset + } + if instance_asset != current_asset: + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) diff --git a/openpype/hosts/harmony/plugins/publish/validate_scene_settings.py b/openpype/hosts/harmony/plugins/publish/validate_scene_settings.py index efd9bbb212..4c3a6c4465 100644 --- a/openpype/hosts/harmony/plugins/publish/validate_scene_settings.py +++ b/openpype/hosts/harmony/plugins/publish/validate_scene_settings.py @@ -7,7 +7,7 @@ import re import pyblish.api import openpype.hosts.harmony.api as harmony -import openpype.hosts.harmony +from openpype.pipeline import PublishXmlValidationError class ValidateSceneSettingsRepair(pyblish.api.Action): @@ -19,12 +19,12 @@ class ValidateSceneSettingsRepair(pyblish.api.Action): def process(self, context, plugin): """Repair action entry point.""" - expected = openpype.hosts.harmony.api.get_asset_settings() + expected = harmony.get_asset_settings() asset_settings = _update_frames(dict.copy(expected)) asset_settings["frameStart"] = 1 asset_settings["frameEnd"] = asset_settings["frameEnd"] + \ asset_settings["handleEnd"] - openpype.hosts.harmony.api.set_scene_settings(asset_settings) + harmony.set_scene_settings(asset_settings) if not os.path.exists(context.data["scenePath"]): self.log.info("correcting scene name") scene_dir = os.path.dirname(context.data["currentFile"]) @@ -55,7 +55,7 @@ class ValidateSceneSettings(pyblish.api.InstancePlugin): def process(self, instance): """Plugin entry point.""" - expected_settings = openpype.hosts.harmony.api.get_asset_settings() + expected_settings = harmony.get_asset_settings() self.log.info("scene settings from DB:".format(expected_settings)) expected_settings = _update_frames(dict.copy(expected_settings)) @@ -102,13 +102,13 @@ class ValidateSceneSettings(pyblish.api.InstancePlugin): self.log.debug("current scene settings {}".format(current_settings)) invalid_settings = [] + invalid_keys = set() for key, value in expected_settings.items(): if value != current_settings[key]: - invalid_settings.append({ - "name": key, - "expected": value, - "current": current_settings[key] - }) + invalid_settings.append( + "{} expected: {} found: {}".format(key, value, + current_settings[key])) + invalid_keys.add(key) if ((expected_settings["handleStart"] or expected_settings["handleEnd"]) @@ -120,10 +120,30 @@ class ValidateSceneSettings(pyblish.api.InstancePlugin): msg = "Found invalid settings:\n{}".format( json.dumps(invalid_settings, sort_keys=True, indent=4) ) - assert not invalid_settings, msg - assert os.path.exists(instance.context.data.get("scenePath")), ( - "Scene file not found (saved under wrong name)" - ) + + if invalid_settings: + invalid_keys_str = ",".join(invalid_keys) + break_str = "
" + invalid_setting_str = "Found invalid settings:
{}".\ + format(break_str.join(invalid_settings)) + + formatting_data = { + "invalid_setting_str": invalid_setting_str, + "invalid_keys_str": invalid_keys_str + } + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) + + scene_url = instance.context.data.get("scenePath") + if not os.path.exists(scene_url): + msg = "Scene file {} not found (saved under wrong name)".format( + scene_url + ) + formatting_data = { + "scene_url": scene_url + } + raise PublishXmlValidationError(self, msg, key="file_not_found", + formatting_data=formatting_data) def _update_frames(expected_settings): diff --git a/openpype/hosts/hiero/api/events.py b/openpype/hosts/hiero/api/events.py index 7563503593..9439199933 100644 --- a/openpype/hosts/hiero/api/events.py +++ b/openpype/hosts/hiero/api/events.py @@ -1,12 +1,12 @@ import os import hiero.core.events -import avalon.api as avalon from openpype.api import Logger from .lib import ( sync_avalon_data_to_workfile, launch_workfiles_app, selection_changed_timeline, - before_project_save + before_project_save, + register_event_callback ) from .tags import add_tags_to_workfile from .menu import update_menu_task_label @@ -126,5 +126,5 @@ def register_events(): """ # if task changed then change notext of hiero - avalon.on("taskChanged", update_menu_task_label) + register_event_callback("taskChanged", update_menu_task_label) log.info("Installed event callback for 'taskChanged'..") diff --git a/openpype/hosts/hiero/api/menu.py b/openpype/hosts/hiero/api/menu.py index 306bef87ca..de20b86f30 100644 --- a/openpype/hosts/hiero/api/menu.py +++ b/openpype/hosts/hiero/api/menu.py @@ -14,7 +14,7 @@ self = sys.modules[__name__] self._change_context_menu = None -def update_menu_task_label(*args): +def update_menu_task_label(): """Update the task label in Avalon menu to current session""" object_name = self._change_context_menu diff --git a/openpype/hosts/hiero/api/pipeline.py b/openpype/hosts/hiero/api/pipeline.py index cbcaf23994..eff126c0b6 100644 --- a/openpype/hosts/hiero/api/pipeline.py +++ b/openpype/hosts/hiero/api/pipeline.py @@ -9,6 +9,11 @@ from avalon import api as avalon from avalon import schema from pyblish import api as pyblish from openpype.api import Logger +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) from openpype.tools.utils import host_tools from . import lib, menu, events @@ -44,8 +49,8 @@ def install(): log.info("Registering Hiero plug-ins..") pyblish.register_host("hiero") pyblish.register_plugin_path(PUBLISH_PATH) - avalon.register_plugin_path(avalon.Loader, LOAD_PATH) - avalon.register_plugin_path(avalon.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.register_plugin_path(LegacyCreator, CREATE_PATH) avalon.register_plugin_path(avalon.InventoryAction, INVENTORY_PATH) # register callback for switching publishable @@ -66,8 +71,8 @@ def uninstall(): log.info("Deregistering Hiero plug-ins..") pyblish.deregister_host("hiero") pyblish.deregister_plugin_path(PUBLISH_PATH) - avalon.deregister_plugin_path(avalon.Loader, LOAD_PATH) - avalon.deregister_plugin_path(avalon.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.deregister_plugin_path(LegacyCreator, CREATE_PATH) # register callback for switching publishable pyblish.deregister_callback("instanceToggled", on_pyblish_instance_toggled) diff --git a/openpype/hosts/hiero/api/plugin.py b/openpype/hosts/hiero/api/plugin.py index 3506af2d6a..54e66bf99a 100644 --- a/openpype/hosts/hiero/api/plugin.py +++ b/openpype/hosts/hiero/api/plugin.py @@ -1,13 +1,16 @@ -import re import os -import hiero -from Qt import QtWidgets, QtCore -from avalon.vendor import qargparse -import avalon.api as avalon -import openpype.api as openpype -from . import lib +import re from copy import deepcopy +import hiero + +from Qt import QtWidgets, QtCore +import qargparse + +import openpype.api as openpype +from openpype.pipeline import LoaderPlugin, LegacyCreator +from . import lib + log = openpype.Logger().get_logger(__name__) @@ -303,7 +306,7 @@ def get_reference_node_parents(ref): return parents -class SequenceLoader(avalon.Loader): +class SequenceLoader(LoaderPlugin): """A basic SequenceLoader for Resolve This will implement the basic behavior for a loader to inherit from that @@ -589,7 +592,7 @@ class ClipLoader: return track_item -class Creator(openpype.Creator): +class Creator(LegacyCreator): """Creator class wrapper """ clip_color = "Purple" diff --git a/openpype/hosts/hiero/plugins/load/load_clip.py b/openpype/hosts/hiero/plugins/load/load_clip.py index b905dd4431..d3908695a2 100644 --- a/openpype/hosts/hiero/plugins/load/load_clip.py +++ b/openpype/hosts/hiero/plugins/load/load_clip.py @@ -1,4 +1,5 @@ -from avalon import io, api +from avalon import io +from openpype.pipeline import get_representation_path import openpype.hosts.hiero.api as phiero # from openpype.hosts.hiero.api import plugin, lib # reload(lib) @@ -112,7 +113,7 @@ class LoadClip(phiero.SequenceLoader): version_name = version.get("name", None) colorspace = version_data.get("colorspace", None) object_name = "{}_{}".format(name, namespace) - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") clip = track_item.source() # reconnect media to new path diff --git a/openpype/hosts/houdini/api/__init__.py b/openpype/hosts/houdini/api/__init__.py index e1500aa5f5..fddf7ab98d 100644 --- a/openpype/hosts/houdini/api/__init__.py +++ b/openpype/hosts/houdini/api/__init__.py @@ -24,8 +24,7 @@ from .lib import ( lsattrs, read, - maintained_selection, - unique_name + maintained_selection ) @@ -51,8 +50,7 @@ __all__ = [ "lsattrs", "read", - "maintained_selection", - "unique_name" + "maintained_selection" ] # Backwards API compatibility diff --git a/openpype/hosts/houdini/api/lib.py b/openpype/hosts/houdini/api/lib.py index 72f1c8e71f..bd41618856 100644 --- a/openpype/hosts/houdini/api/lib.py +++ b/openpype/hosts/houdini/api/lib.py @@ -99,65 +99,6 @@ def get_id_required_nodes(): return list(nodes) -def get_additional_data(container): - """Not implemented yet!""" - return container - - -def set_parameter_callback(node, parameter, language, callback): - """Link a callback to a parameter of a node - - Args: - node(hou.Node): instance of the nodee - parameter(str): name of the parameter - language(str): name of the language, e.g.: python - callback(str): command which needs to be triggered - - Returns: - None - - """ - - template_grp = node.parmTemplateGroup() - template = template_grp.find(parameter) - if not template: - return - - script_language = (hou.scriptLanguage.Python if language == "python" else - hou.scriptLanguage.Hscript) - - template.setScriptCallbackLanguage(script_language) - template.setScriptCallback(callback) - - template.setTags({"script_callback": callback, - "script_callback_language": language.lower()}) - - # Replace the existing template with the adjusted one - template_grp.replace(parameter, template) - - node.setParmTemplateGroup(template_grp) - - -def set_parameter_callbacks(node, parameter_callbacks): - """Set callbacks for multiple parameters of a node - - Args: - node(hou.Node): instance of a hou.Node - parameter_callbacks(dict): collection of parameter and callback data - example: {"active" : - {"language": "python", - "callback": "print('hello world)'"} - } - Returns: - None - """ - for parameter, data in parameter_callbacks.items(): - language = data["language"] - callback = data["callback"] - - set_parameter_callback(node, parameter, language, callback) - - def get_output_parameter(node): """Return the render output parameter name of the given node @@ -189,19 +130,6 @@ def get_output_parameter(node): raise TypeError("Node type '%s' not supported" % node_type) -@contextmanager -def attribute_values(node, data): - - previous_attrs = {key: node.parm(key).eval() for key in data.keys()} - try: - node.setParms(data) - yield - except Exception as exc: - pass - finally: - node.setParms(previous_attrs) - - def set_scene_fps(fps): hou.setFps(fps) @@ -349,10 +277,6 @@ def render_rop(ropnode): raise RuntimeError("Render failed: {0}".format(exc)) -def children_as_string(node): - return [c.name() for c in node.children()] - - def imprint(node, data): """Store attributes with value on a node @@ -473,53 +397,6 @@ def read(node): parameter in node.spareParms()} -def unique_name(name, format="%03d", namespace="", prefix="", suffix="", - separator="_"): - """Return unique `name` - - The function takes into consideration an optional `namespace` - and `suffix`. The suffix is included in evaluating whether a - name exists - such as `name` + "_GRP" - but isn't included - in the returned value. - - If a namespace is provided, only names within that namespace - are considered when evaluating whether the name is unique. - - Arguments: - format (str, optional): The `name` is given a number, this determines - how this number is formatted. Defaults to a padding of 2. - E.g. my_name01, my_name02. - namespace (str, optional): Only consider names within this namespace. - suffix (str, optional): Only consider names with this suffix. - - Example: - >>> name = hou.node("/obj").createNode("geo", name="MyName") - >>> assert hou.node("/obj/MyName") - True - >>> unique = unique_name(name) - >>> assert hou.node("/obj/{}".format(unique)) - False - - """ - - iteration = 1 - - parts = [prefix, name, format % iteration, suffix] - if namespace: - parts.insert(0, namespace) - - unique = separator.join(parts) - children = children_as_string(hou.node("/obj")) - while unique in children: - iteration += 1 - unique = separator.join(parts) - - if suffix: - return unique[:-len(suffix)] - - return unique - - @contextmanager def maintained_selection(): """Maintain selection during context @@ -542,3 +419,37 @@ def maintained_selection(): if previous_selection: for node in previous_selection: node.setSelected(on=True) + + +def reset_framerange(): + """Set frame range to current asset""" + + asset_name = api.Session["AVALON_ASSET"] + asset = io.find_one({"name": asset_name, "type": "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: + log.warning("No edit information found for %s" % asset_name) + 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 + + frame_start -= int(handle_start) + frame_end += int(handle_end) + + hou.playbar.setFrameRange(frame_start, frame_end) + hou.playbar.setPlaybackRange(frame_start, frame_end) + hou.setFrame(frame_start) diff --git a/openpype/hosts/houdini/api/pipeline.py b/openpype/hosts/houdini/api/pipeline.py index c3dbdc5ef5..7d4e58efb7 100644 --- a/openpype/hosts/houdini/api/pipeline.py +++ b/openpype/hosts/houdini/api/pipeline.py @@ -4,17 +4,24 @@ import logging import contextlib import hou +import hdefereval import pyblish.api import avalon.api from avalon.pipeline import AVALON_CONTAINER_ID from avalon.lib import find_submodule +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, +) import openpype.hosts.houdini from openpype.hosts.houdini.api import lib from openpype.lib import ( - any_outdated + register_event_callback, + emit_event, + any_outdated, ) from .lib import get_asset_fps @@ -46,15 +53,15 @@ def install(): pyblish.api.register_host("hpython") pyblish.api.register_plugin_path(PUBLISH_PATH) - avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH) log.info("Installing callbacks ... ") - # avalon.on("init", on_init) - avalon.api.before("save", before_save) - avalon.api.on("save", on_save) - avalon.api.on("open", on_open) - avalon.api.on("new", on_new) + # register_event_callback("init", on_init) + register_event_callback("before.save", before_save) + register_event_callback("save", on_save) + register_event_callback("open", on_open) + register_event_callback("new", on_new) pyblish.api.register_callback( "instanceToggled", on_pyblish_instance_toggled @@ -66,9 +73,10 @@ def install(): sys.path.append(hou_pythonpath) - # Set asset FPS for the empty scene directly after launch of Houdini - # so it initializes into the correct scene FPS - _set_asset_fps() + # Set asset settings for the empty scene directly after launch of Houdini + # so it initializes into the correct scene FPS, Frame Range, etc. + # todo: make sure this doesn't trigger when opening with last workfile + _set_context_settings() def uninstall(): @@ -99,13 +107,13 @@ def _register_callbacks(): def on_file_event_callback(event): if event == hou.hipFileEventType.AfterLoad: - avalon.api.emit("open", [event]) + emit_event("open") elif event == hou.hipFileEventType.AfterSave: - avalon.api.emit("save", [event]) + emit_event("save") elif event == hou.hipFileEventType.BeforeSave: - avalon.api.emit("before_save", [event]) + emit_event("before.save") elif event == hou.hipFileEventType.AfterClear: - avalon.api.emit("new", [event]) + emit_event("new") def get_main_window(): @@ -227,11 +235,11 @@ def ls(): yield data -def before_save(*args): +def before_save(): return lib.validate_fps() -def on_save(*args): +def on_save(): log.info("Running callback on save..") @@ -240,7 +248,7 @@ def on_save(*args): lib.set_id(node, new_id, overwrite=False) -def on_open(*args): +def on_open(): if not hou.isUIAvailable(): log.debug("Batch mode detected, ignoring `on_open` callbacks..") @@ -277,20 +285,51 @@ def on_open(*args): dialog.show() -def on_new(_): +def on_new(): """Set project resolution and fps when create a new file""" + + if hou.hipFile.isLoadingHipFile(): + # This event also triggers when Houdini opens a file due to the + # new event being registered to 'afterClear'. As such we can skip + # 'new' logic if the user is opening a file anyway + log.debug("Skipping on new callback due to scene being opened.") + return + log.info("Running callback on new..") - _set_asset_fps() + _set_context_settings() + + # It seems that the current frame always gets reset to frame 1 on + # new scene. So we enforce current frame to be at the start of the playbar + # with execute deferred + def _enforce_start_frame(): + start = hou.playbar.playbackRange()[0] + hou.setFrame(start) + + hdefereval.executeDeferred(_enforce_start_frame) -def _set_asset_fps(): - """Set Houdini scene FPS to the default required for current asset""" +def _set_context_settings(): + """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: + fps + resolution + renderer + + Returns: + None + """ # Set new scene fps fps = get_asset_fps() print("Setting scene FPS to %i" % fps) lib.set_scene_fps(fps) + lib.reset_framerange() + def on_pyblish_instance_toggled(instance, new_value, old_value): """Toggle saver tool passthrough states on instance toggles.""" diff --git a/openpype/hosts/houdini/api/plugin.py b/openpype/hosts/houdini/api/plugin.py index 4967d01d43..2bbb65aa05 100644 --- a/openpype/hosts/houdini/api/plugin.py +++ b/openpype/hosts/houdini/api/plugin.py @@ -2,11 +2,12 @@ """Houdini specific Avalon/Pyblish plugin definitions.""" import sys import six -import avalon.api -from avalon.api import CreatorError import hou -from openpype.api import PypeCreatorMixin +from openpype.pipeline import ( + CreatorError, + LegacyCreator +) from .lib import imprint @@ -14,7 +15,7 @@ class OpenPypeCreatorError(CreatorError): pass -class Creator(PypeCreatorMixin, avalon.api.Creator): +class Creator(LegacyCreator): """Creator plugin to create instances in Houdini To support the wide range of node types for render output (Alembic, VDB, diff --git a/openpype/hosts/houdini/plugins/load/actions.py b/openpype/hosts/houdini/plugins/load/actions.py index 6e9410ff58..63d74c39a5 100644 --- a/openpype/hosts/houdini/plugins/load/actions.py +++ b/openpype/hosts/houdini/plugins/load/actions.py @@ -2,10 +2,10 @@ """ -from avalon import api +from openpype.pipeline import load -class SetFrameRangeLoader(api.Loader): +class SetFrameRangeLoader(load.LoaderPlugin): """Set Houdini frame range""" families = [ @@ -29,8 +29,8 @@ class SetFrameRangeLoader(api.Loader): version = context["version"] version_data = version.get("data", {}) - start = version_data.get("startFrame", None) - end = version_data.get("endFrame", None) + start = version_data.get("frameStart", None) + end = version_data.get("frameEnd", None) if start is None or end is None: print( @@ -43,7 +43,7 @@ class SetFrameRangeLoader(api.Loader): hou.playbar.setPlaybackRange(start, end) -class SetFrameRangeWithHandlesLoader(api.Loader): +class SetFrameRangeWithHandlesLoader(load.LoaderPlugin): """Set Maya frame range including pre- and post-handles""" families = [ @@ -67,8 +67,8 @@ class SetFrameRangeWithHandlesLoader(api.Loader): version = context["version"] version_data = version.get("data", {}) - start = version_data.get("startFrame", None) - end = version_data.get("endFrame", None) + start = version_data.get("frameStart", None) + end = version_data.get("frameEnd", None) if start is None or end is None: print( @@ -78,9 +78,8 @@ class SetFrameRangeWithHandlesLoader(api.Loader): return # Include handles - handles = version_data.get("handles", 0) - start -= handles - end += handles + start -= version_data.get("handleStart", 0) + end += version_data.get("handleEnd", 0) hou.playbar.setFrameRange(start, end) hou.playbar.setPlaybackRange(start, end) diff --git a/openpype/hosts/houdini/plugins/load/load_alembic.py b/openpype/hosts/houdini/plugins/load/load_alembic.py index eaab81f396..0214229d5a 100644 --- a/openpype/hosts/houdini/plugins/load/load_alembic.py +++ b/openpype/hosts/houdini/plugins/load/load_alembic.py @@ -1,10 +1,12 @@ import os -from avalon import api - +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.houdini.api import pipeline -class AbcLoader(api.Loader): +class AbcLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["model", "animation", "pointcache", "gpuCache"] @@ -90,7 +92,7 @@ class AbcLoader(api.Loader): return # Update the file path - file_path = api.get_representation_path(representation) + file_path = get_representation_path(representation) file_path = file_path.replace("\\", "/") alembic_node.setParms({"fileName": file_path}) diff --git a/openpype/hosts/houdini/plugins/load/load_ass.py b/openpype/hosts/houdini/plugins/load/load_ass.py index 8c272044ec..0144bbaefd 100644 --- a/openpype/hosts/houdini/plugins/load/load_ass.py +++ b/openpype/hosts/houdini/plugins/load/load_ass.py @@ -1,11 +1,15 @@ import os -from avalon import api -from avalon.houdini import pipeline import clique +from openpype.pipeline import ( + load, + get_representation_path, +) + +from openpype.hosts.houdini.api import pipeline -class AssLoader(api.Loader): +class AssLoader(load.LoaderPlugin): """Load .ass with Arnold Procedural""" families = ["ass"] @@ -88,7 +92,7 @@ class AssLoader(api.Loader): def update(self, container, representation): # Update the file path - file_path = api.get_representation_path(representation) + file_path = get_representation_path(representation) file_path = file_path.replace("\\", "/") procedural = container["node"] diff --git a/openpype/hosts/houdini/plugins/load/load_camera.py b/openpype/hosts/houdini/plugins/load/load_camera.py index 8916d3b9b7..ef57d115da 100644 --- a/openpype/hosts/houdini/plugins/load/load_camera.py +++ b/openpype/hosts/houdini/plugins/load/load_camera.py @@ -1,4 +1,7 @@ -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.houdini.api import pipeline @@ -74,7 +77,7 @@ def transfer_non_default_values(src, dest, ignore=None): dest_parm.setFromParm(parm) -class CameraLoader(api.Loader): +class CameraLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["camera"] @@ -129,7 +132,7 @@ class CameraLoader(api.Loader): node = container["node"] # Update the file path - file_path = api.get_representation_path(representation) + file_path = get_representation_path(representation) file_path = file_path.replace("\\", "/") # Update attributes diff --git a/openpype/hosts/houdini/plugins/load/load_hda.py b/openpype/hosts/houdini/plugins/load/load_hda.py index f5f2fb7481..2438570c6e 100644 --- a/openpype/hosts/houdini/plugins/load/load_hda.py +++ b/openpype/hosts/houdini/plugins/load/load_hda.py @@ -1,10 +1,13 @@ # -*- coding: utf-8 -*- -from avalon import api - +import os +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.houdini.api import pipeline -class HdaLoader(api.Loader): +class HdaLoader(load.LoaderPlugin): """Load Houdini Digital Asset file.""" families = ["hda"] @@ -15,7 +18,6 @@ class HdaLoader(api.Loader): color = "orange" def load(self, context, name=None, namespace=None, data=None): - import os import hou # Format file name, Houdini only wants forward slashes @@ -49,7 +51,7 @@ class HdaLoader(api.Loader): import hou hda_node = container["node"] - file_path = api.get_representation_path(representation) + file_path = get_representation_path(representation) file_path = file_path.replace("\\", "/") hou.hda.installFile(file_path) defs = hda_node.type().allInstalledDefinitions() diff --git a/openpype/hosts/houdini/plugins/load/load_image.py b/openpype/hosts/houdini/plugins/load/load_image.py index 39f583677b..bd9ea3eee3 100644 --- a/openpype/hosts/houdini/plugins/load/load_image.py +++ b/openpype/hosts/houdini/plugins/load/load_image.py @@ -1,6 +1,9 @@ import os -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.houdini.api import lib, pipeline import hou @@ -37,7 +40,7 @@ def get_image_avalon_container(): return image_container -class ImageLoader(api.Loader): +class ImageLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["colorbleed.imagesequence"] @@ -87,7 +90,7 @@ class ImageLoader(api.Loader): node = container["node"] # Update the file path - file_path = api.get_representation_path(representation) + file_path = get_representation_path(representation) file_path = file_path.replace("\\", "/") file_path = self._get_file_sequence(file_path) diff --git a/openpype/hosts/houdini/plugins/load/load_usd_layer.py b/openpype/hosts/houdini/plugins/load/load_usd_layer.py index 0d4378b480..d803e6abfe 100644 --- a/openpype/hosts/houdini/plugins/load/load_usd_layer.py +++ b/openpype/hosts/houdini/plugins/load/load_usd_layer.py @@ -1,8 +1,11 @@ -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.houdini.api import lib, pipeline -class USDSublayerLoader(api.Loader): +class USDSublayerLoader(load.LoaderPlugin): """Sublayer USD file in Solaris""" families = [ @@ -57,7 +60,7 @@ class USDSublayerLoader(api.Loader): node = container["node"] # Update the file path - file_path = api.get_representation_path(representation) + file_path = get_representation_path(representation) file_path = file_path.replace("\\", "/") # Update attributes diff --git a/openpype/hosts/houdini/plugins/load/load_usd_reference.py b/openpype/hosts/houdini/plugins/load/load_usd_reference.py index 0edd8d9af6..fdb443f4cf 100644 --- a/openpype/hosts/houdini/plugins/load/load_usd_reference.py +++ b/openpype/hosts/houdini/plugins/load/load_usd_reference.py @@ -1,8 +1,11 @@ -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.houdini.api import lib, pipeline -class USDReferenceLoader(api.Loader): +class USDReferenceLoader(load.LoaderPlugin): """Reference USD file in Solaris""" families = [ @@ -57,7 +60,7 @@ class USDReferenceLoader(api.Loader): node = container["node"] # Update the file path - file_path = api.get_representation_path(representation) + file_path = get_representation_path(representation) file_path = file_path.replace("\\", "/") # Update attributes diff --git a/openpype/hosts/houdini/plugins/load/load_vdb.py b/openpype/hosts/houdini/plugins/load/load_vdb.py index 40aa7a1d18..06bb9e45e4 100644 --- a/openpype/hosts/houdini/plugins/load/load_vdb.py +++ b/openpype/hosts/houdini/plugins/load/load_vdb.py @@ -1,11 +1,14 @@ import os import re -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.houdini.api import pipeline -class VdbLoader(api.Loader): +class VdbLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["vdbcache"] @@ -96,7 +99,7 @@ class VdbLoader(api.Loader): return # Update the file path - file_path = api.get_representation_path(representation) + file_path = get_representation_path(representation) file_path = self.format_path(file_path) file_node.setParms({"fileName": file_path}) diff --git a/openpype/hosts/houdini/plugins/load/show_usdview.py b/openpype/hosts/houdini/plugins/load/show_usdview.py index f23974094e..8066615181 100644 --- a/openpype/hosts/houdini/plugins/load/show_usdview.py +++ b/openpype/hosts/houdini/plugins/load/show_usdview.py @@ -1,7 +1,7 @@ -from avalon import api +from openpype.pipeline import load -class ShowInUsdview(api.Loader): +class ShowInUsdview(load.LoaderPlugin): """Open USD file in usdview""" families = ["colorbleed.usd"] diff --git a/openpype/hosts/houdini/plugins/publish/extract_usd_layered.py b/openpype/hosts/houdini/plugins/publish/extract_usd_layered.py index 645bd05d4b..3e842ae766 100644 --- a/openpype/hosts/houdini/plugins/publish/extract_usd_layered.py +++ b/openpype/hosts/houdini/plugins/publish/extract_usd_layered.py @@ -7,6 +7,7 @@ from collections import deque import pyblish.api import openpype.api +from openpype.pipeline import get_representation_path import openpype.hosts.houdini.api.usd as hou_usdlib from openpype.hosts.houdini.api.lib import render_rop @@ -308,7 +309,7 @@ class ExtractUSDLayered(openpype.api.Extractor): self.log.debug("No existing representation..") return False - old_file = api.get_representation_path(representation) + old_file = get_representation_path(representation) if not os.path.exists(old_file): return False diff --git a/openpype/hosts/houdini/plugins/publish/save_scene.py b/openpype/hosts/houdini/plugins/publish/save_scene.py index 1b12efa603..fe5962fbd3 100644 --- a/openpype/hosts/houdini/plugins/publish/save_scene.py +++ b/openpype/hosts/houdini/plugins/publish/save_scene.py @@ -2,26 +2,14 @@ import pyblish.api import avalon.api -class SaveCurrentScene(pyblish.api.InstancePlugin): +class SaveCurrentScene(pyblish.api.ContextPlugin): """Save current scene""" label = "Save current file" - order = pyblish.api.IntegratorOrder - 0.49 + order = pyblish.api.ExtractorOrder - 0.49 hosts = ["houdini"] - families = ["usdrender", - "redshift_rop"] - targets = ["local"] - def process(self, instance): - - # This should be a ContextPlugin, but this is a workaround - # for a bug in pyblish to run once for a family: issue #250 - context = instance.context - key = "__hasRun{}".format(self.__class__.__name__) - if context.data.get(key, False): - return - else: - context.data[key] = True + def process(self, context): # Filename must not have changed since collecting host = avalon.api.registered_host() diff --git a/openpype/hosts/houdini/plugins/publish/save_scene_deadline.py b/openpype/hosts/houdini/plugins/publish/save_scene_deadline.py deleted file mode 100644 index a0efd0610c..0000000000 --- a/openpype/hosts/houdini/plugins/publish/save_scene_deadline.py +++ /dev/null @@ -1,23 +0,0 @@ -import pyblish.api - - -class SaveCurrentSceneDeadline(pyblish.api.ContextPlugin): - """Save current scene""" - - label = "Save current file" - order = pyblish.api.IntegratorOrder - 0.49 - hosts = ["houdini"] - targets = ["deadline"] - - def process(self, context): - import hou - - assert ( - context.data["currentFile"] == hou.hipFile.path() - ), "Collected filename from current scene name." - - if hou.hipFile.hasUnsavedChanges(): - self.log.info("Saving current file..") - hou.hipFile.save(save_to_recent_files=True) - else: - self.log.debug("No unsaved changes, skipping file save..") diff --git a/openpype/hosts/houdini/plugins/publish/validate_abc_primitive_to_detail.py b/openpype/hosts/houdini/plugins/publish/validate_abc_primitive_to_detail.py index 8fe1b44b7a..3e17d3e8de 100644 --- a/openpype/hosts/houdini/plugins/publish/validate_abc_primitive_to_detail.py +++ b/openpype/hosts/houdini/plugins/publish/validate_abc_primitive_to_detail.py @@ -65,7 +65,7 @@ class ValidateAbcPrimitiveToDetail(pyblish.api.InstancePlugin): cls.log.debug("Checking with path attribute: %s" % path_attr) # Check if the primitive attribute exists - frame = instance.data.get("startFrame", 0) + frame = instance.data.get("frameStart", 0) geo = output.geometryAtFrame(frame) # If there are no primitives on the start frame then it might be diff --git a/openpype/hosts/houdini/plugins/publish/validate_alembic_input_node.py b/openpype/hosts/houdini/plugins/publish/validate_alembic_input_node.py index 17c9da837a..8d7e3b611f 100644 --- a/openpype/hosts/houdini/plugins/publish/validate_alembic_input_node.py +++ b/openpype/hosts/houdini/plugins/publish/validate_alembic_input_node.py @@ -38,7 +38,7 @@ class ValidateAlembicInputNode(pyblish.api.InstancePlugin): cls.log.warning("No geometry output node found, skipping check..") return - frame = instance.data.get("startFrame", 0) + frame = instance.data.get("frameStart", 0) geo = node.geometryAtFrame(frame) invalid = False diff --git a/openpype/hosts/houdini/plugins/publish/validate_output_node.py b/openpype/hosts/houdini/plugins/publish/validate_output_node.py deleted file mode 100644 index 0b60ab5c48..0000000000 --- a/openpype/hosts/houdini/plugins/publish/validate_output_node.py +++ /dev/null @@ -1,77 +0,0 @@ -import pyblish.api - - -class ValidateOutputNode(pyblish.api.InstancePlugin): - """Validate the instance SOP Output Node. - - This will ensure: - - The SOP Path is set. - - The SOP Path refers to an existing object. - - The SOP Path node is a SOP node. - - The SOP Path node has at least one input connection (has an input) - - The SOP Path has geometry data. - - """ - - order = pyblish.api.ValidatorOrder - families = ["pointcache", "vdbcache"] - hosts = ["houdini"] - label = "Validate Output Node" - - def process(self, instance): - - invalid = self.get_invalid(instance) - if invalid: - raise RuntimeError( - "Output node(s) `%s` are incorrect. " - "See plug-in log for details." % invalid - ) - - @classmethod - def get_invalid(cls, instance): - - import hou - - output_node = instance.data["output_node"] - - if output_node is None: - node = instance[0] - cls.log.error( - "SOP Output node in '%s' does not exist. " - "Ensure a valid SOP output path is set." % node.path() - ) - - return [node.path()] - - # Output node must be a Sop node. - if not isinstance(output_node, hou.SopNode): - cls.log.error( - "Output node %s is not a SOP node. " - "SOP Path must point to a SOP node, " - "instead found category type: %s" - % (output_node.path(), output_node.type().category().name()) - ) - return [output_node.path()] - - # For the sake of completeness also assert the category type - # is Sop to avoid potential edge case scenarios even though - # the isinstance check above should be stricter than this category - assert output_node.type().category().name() == "Sop", ( - "Output node %s is not of category Sop. This is a bug.." - % output_node.path() - ) - - # Check if output node has incoming connections - if not output_node.inputConnections(): - cls.log.error( - "Output node `%s` has no incoming connections" - % output_node.path() - ) - return [output_node.path()] - - # Ensure the output node has at least Geometry data - if not output_node.geometry(): - cls.log.error( - "Output node `%s` has no geometry data." % output_node.path() - ) - return [output_node.path()] diff --git a/openpype/hosts/houdini/plugins/publish/validate_primitive_hierarchy_paths.py b/openpype/hosts/houdini/plugins/publish/validate_primitive_hierarchy_paths.py index 3c15532be8..1eb36763bb 100644 --- a/openpype/hosts/houdini/plugins/publish/validate_primitive_hierarchy_paths.py +++ b/openpype/hosts/houdini/plugins/publish/validate_primitive_hierarchy_paths.py @@ -51,7 +51,7 @@ class ValidatePrimitiveHierarchyPaths(pyblish.api.InstancePlugin): cls.log.debug("Checking for attribute: %s" % path_attr) # Check if the primitive attribute exists - frame = instance.data.get("startFrame", 0) + frame = instance.data.get("frameStart", 0) geo = output.geometryAtFrame(frame) # If there are no primitives on the current frame then we can't diff --git a/openpype/hosts/houdini/startup/MainMenuCommon.xml b/openpype/hosts/houdini/startup/MainMenuCommon.xml index b8c7f93d76..abfa3f136e 100644 --- a/openpype/hosts/houdini/startup/MainMenuCommon.xml +++ b/openpype/hosts/houdini/startup/MainMenuCommon.xml @@ -66,6 +66,14 @@ host_tools.show_workfiles(parent) ]]> + + + + + diff --git a/openpype/hosts/houdini/startup/scripts/123.py b/openpype/hosts/houdini/startup/python2.7libs/pythonrc.py similarity index 100% rename from openpype/hosts/houdini/startup/scripts/123.py rename to openpype/hosts/houdini/startup/python2.7libs/pythonrc.py diff --git a/openpype/hosts/houdini/startup/scripts/houdinicore.py b/openpype/hosts/houdini/startup/python3.7libs/pythonrc.py similarity index 100% rename from openpype/hosts/houdini/startup/scripts/houdinicore.py rename to openpype/hosts/houdini/startup/python3.7libs/pythonrc.py diff --git a/openpype/hosts/maya/api/__init__.py b/openpype/hosts/maya/api/__init__.py index 9ea798e927..5d76bf0f04 100644 --- a/openpype/hosts/maya/api/__init__.py +++ b/openpype/hosts/maya/api/__init__.py @@ -10,12 +10,6 @@ from .pipeline import ( ls, containerise, - - lock, - unlock, - is_locked, - lock_ignored, - ) from .plugin import ( Creator, @@ -38,11 +32,9 @@ from .lib import ( read, apply_shaders, - without_extension, maintained_selection, suspended_refresh, - unique_name, unique_namespace, ) @@ -54,11 +46,6 @@ __all__ = [ "ls", "containerise", - "lock", - "unlock", - "is_locked", - "lock_ignored", - "Creator", "Loader", @@ -76,11 +63,9 @@ __all__ = [ "lsattrs", "read", - "unique_name", "unique_namespace", "apply_shaders", - "without_extension", "maintained_selection", "suspended_refresh", diff --git a/openpype/hosts/maya/api/commands.py b/openpype/hosts/maya/api/commands.py index c774afcc12..a1e0be2cfe 100644 --- a/openpype/hosts/maya/api/commands.py +++ b/openpype/hosts/maya/api/commands.py @@ -37,17 +37,17 @@ class ToolWindows: def edit_shader_definitions(): - from avalon.tools import lib from Qt import QtWidgets from openpype.hosts.maya.api.shader_definition_editor import ( ShaderDefinitionsEditor ) + from openpype.tools.utils import qt_app_context top_level_widgets = QtWidgets.QApplication.topLevelWidgets() main_window = next(widget for widget in top_level_widgets if widget.objectName() == "MayaWindow") - with lib.application(): + with qt_app_context(): window = ToolWindows.get_window("shader_definition_editor") if not window: window = ShaderDefinitionsEditor(parent=main_window) diff --git a/openpype/hosts/maya/api/customize.py b/openpype/hosts/maya/api/customize.py index 37fd543315..683e6b24b0 100644 --- a/openpype/hosts/maya/api/customize.py +++ b/openpype/hosts/maya/api/customize.py @@ -5,7 +5,7 @@ import logging from functools import partial -import maya.cmds as mc +import maya.cmds as cmds import maya.mel as mel from openpype.api import resources @@ -30,9 +30,9 @@ def override_component_mask_commands(): log.info("Installing override_component_mask_commands..") # Get all object mask buttons - buttons = mc.formLayout("objectMaskIcons", - query=True, - childArray=True) + buttons = cmds.formLayout("objectMaskIcons", + query=True, + childArray=True) # Skip the triangle list item buttons = [btn for btn in buttons if btn != "objPickMenuLayout"] @@ -43,14 +43,14 @@ def override_component_mask_commands(): # toggle the others based on whether any of the buttons # was remaining active after the toggle, if not then # enable all - if mc.getModifiers() == 4: # = CTRL + if cmds.getModifiers() == 4: # = CTRL state = True - active = [mc.iconTextCheckBox(btn, query=True, value=True) for btn - in buttons] + active = [cmds.iconTextCheckBox(btn, query=True, value=True) + for btn in buttons] if any(active): - mc.selectType(allObjects=False) + cmds.selectType(allObjects=False) else: - mc.selectType(allObjects=True) + cmds.selectType(allObjects=True) # Replace #1 with the current button state cmd = raw_command.replace(" #1", " {}".format(int(state))) @@ -63,13 +63,13 @@ def override_component_mask_commands(): # try to implement the fix. (This also allows us to # "uninstall" the behavior later) if btn not in COMPONENT_MASK_ORIGINAL: - original = mc.iconTextCheckBox(btn, query=True, cc=True) + original = cmds.iconTextCheckBox(btn, query=True, cc=True) COMPONENT_MASK_ORIGINAL[btn] = original # Assign the special callback original = COMPONENT_MASK_ORIGINAL[btn] new_fn = partial(on_changed_callback, original) - mc.iconTextCheckBox(btn, edit=True, cc=new_fn) + cmds.iconTextCheckBox(btn, edit=True, cc=new_fn) def override_toolbox_ui(): @@ -78,25 +78,36 @@ def override_toolbox_ui(): parent_widget = get_main_window() # Ensure the maya web icon on toolbox exists - web_button = "ToolBox|MainToolboxLayout|mayaWebButton" - if not mc.iconTextButton(web_button, query=True, exists=True): + button_names = [ + # Maya 2022.1+ with maya.cmds.iconTextStaticLabel + "ToolBox|MainToolboxLayout|mayaHomeToolboxButton", + # Older with maya.cmds.iconTextButton + "ToolBox|MainToolboxLayout|mayaWebButton" + ] + for name in button_names: + if cmds.control(name, query=True, exists=True): + web_button = name + break + else: + # Button does not exist + log.warning("Can't find Maya Home/Web button to override toolbox ui..") return - mc.iconTextButton(web_button, edit=True, visible=False) + cmds.control(web_button, edit=True, visible=False) # real = 32, but 36 with padding - according to toolbox mel script icon_size = 36 parent = web_button.rsplit("|", 1)[0] # Ensure the parent is a formLayout - if not mc.objectTypeUI(parent) == "formLayout": + if not cmds.objectTypeUI(parent) == "formLayout": return # Create our controls controls = [] controls.append( - mc.iconTextButton( + cmds.iconTextButton( "pype_toolbox_lookmanager", annotation="Look Manager", label="Look Manager", @@ -109,7 +120,7 @@ def override_toolbox_ui(): ) controls.append( - mc.iconTextButton( + cmds.iconTextButton( "pype_toolbox_workfiles", annotation="Work Files", label="Work Files", @@ -124,7 +135,7 @@ def override_toolbox_ui(): ) controls.append( - mc.iconTextButton( + cmds.iconTextButton( "pype_toolbox_loader", annotation="Loader", label="Loader", @@ -139,7 +150,7 @@ def override_toolbox_ui(): ) controls.append( - mc.iconTextButton( + cmds.iconTextButton( "pype_toolbox_manager", annotation="Inventory", label="Inventory", @@ -159,7 +170,7 @@ def override_toolbox_ui(): for i, control in enumerate(controls): previous = controls[i - 1] if i > 0 else web_button - mc.formLayout(parent, edit=True, - attachControl=[control, "bottom", 0, previous], - attachForm=([control, "left", 1], - [control, "right", 1])) + cmds.formLayout(parent, edit=True, + attachControl=[control, "bottom", 0, previous], + attachForm=([control, "left", 1], + [control, "right", 1])) diff --git a/openpype/hosts/maya/api/lib.py b/openpype/hosts/maya/api/lib.py index 09d1a68223..9f97eef2f1 100644 --- a/openpype/hosts/maya/api/lib.py +++ b/openpype/hosts/maya/api/lib.py @@ -2,14 +2,12 @@ import os import sys -import re import platform import uuid import math import json import logging -import itertools import contextlib from collections import OrderedDict, defaultdict from math import ceil @@ -19,10 +17,16 @@ import bson from maya import cmds, mel import maya.api.OpenMaya as om -from avalon import api, io, pipeline +from avalon import api, io from openpype import lib from openpype.api import get_anatomy_settings +from openpype.pipeline import ( + discover_loader_plugins, + loaders_from_representation, + get_representation_path, + load_container, +) from .commands import reset_frame_range @@ -154,73 +158,59 @@ def maintained_selection(): cmds.select(clear=True) -def unique_name(name, format="%02d", namespace="", prefix="", suffix=""): - """Return unique `name` - - The function takes into consideration an optional `namespace` - and `suffix`. The suffix is included in evaluating whether a - name exists - such as `name` + "_GRP" - but isn't included - in the returned value. - - If a namespace is provided, only names within that namespace - are considered when evaluating whether the name is unique. - - Arguments: - format (str, optional): The `name` is given a number, this determines - how this number is formatted. Defaults to a padding of 2. - E.g. my_name01, my_name02. - namespace (str, optional): Only consider names within this namespace. - suffix (str, optional): Only consider names with this suffix. - - Example: - >>> name = cmds.createNode("transform", name="MyName") - >>> cmds.objExists(name) - True - >>> unique = unique_name(name) - >>> cmds.objExists(unique) - False - - """ - - iteration = 1 - unique = prefix + (name + format % iteration) + suffix - - while cmds.objExists(namespace + ":" + unique): - iteration += 1 - unique = prefix + (name + format % iteration) + suffix - - if suffix: - return unique[:-len(suffix)] - - return unique - - def unique_namespace(namespace, format="%02d", prefix="", suffix=""): """Return unique namespace - Similar to :func:`unique_name` but evaluating namespaces - as opposed to object names. - Arguments: namespace (str): Name of namespace to consider format (str, optional): Formatting of the given iteration number suffix (str, optional): Only consider namespaces with this suffix. + >>> unique_namespace("bar") + # bar01 + >>> unique_namespace(":hello") + # :hello01 + >>> unique_namespace("bar:", suffix="_NS") + # bar01_NS: + """ + def current_namespace(): + current = cmds.namespaceInfo(currentNamespace=True, + absoluteName=True) + # When inside a namespace Maya adds no trailing : + if not current.endswith(":"): + current += ":" + return current + + # Always check against the absolute namespace root + # There's no clash with :x if we're defining namespace :a:x + ROOT = ":" if namespace.startswith(":") else current_namespace() + + # Strip trailing `:` tokens since we might want to add a suffix + start = ":" if namespace.startswith(":") else "" + end = ":" if namespace.endswith(":") else "" + namespace = namespace.strip(":") + if ":" in namespace: + # Split off any nesting that we don't uniqify anyway. + parents, namespace = namespace.rsplit(":", 1) + start += parents + ":" + ROOT += start + + def exists(n): + # Check for clash with nodes and namespaces + fullpath = ROOT + n + return cmds.objExists(fullpath) or cmds.namespace(exists=fullpath) + iteration = 1 - unique = prefix + (namespace + format % iteration) + suffix + while True: + nr_namespace = namespace + format % iteration + unique = prefix + nr_namespace + suffix + + if not exists(unique): + return start + unique + end - # The `existing` set does not just contain the namespaces but *all* nodes - # within "current namespace". We need all because the namespace could - # also clash with a node name. To be truly unique and valid one needs to - # check against all. - existing = set(cmds.namespaceInfo(listNamespace=True)) - while unique in existing: iteration += 1 - unique = prefix + (namespace + format % iteration) + suffix - - return unique def read(node): @@ -282,155 +272,10 @@ def float_round(num, places=0, direction=ceil): def pairwise(iterable): """s -> (s0,s1), (s2,s3), (s4, s5), ...""" + from six.moves import zip + a = iter(iterable) - return itertools.izip(a, a) - - -def unique(name): - assert isinstance(name, string_types), "`name` must be string" - - while cmds.objExists(name): - matches = re.findall(r"\d+$", name) - - if matches: - match = matches[-1] - name = name.rstrip(match) - number = int(match) + 1 - else: - number = 1 - - name = name + str(number) - - return name - - -def uv_from_element(element): - """Return the UV coordinate of given 'element' - - Supports components, meshes, nurbs. - - """ - - supported = ["mesh", "nurbsSurface"] - - uv = [0.5, 0.5] - - if "." not in element: - type = cmds.nodeType(element) - if type == "transform": - geometry_shape = cmds.listRelatives(element, shapes=True) - - if len(geometry_shape) >= 1: - geometry_shape = geometry_shape[0] - else: - return - - elif type in supported: - geometry_shape = element - - else: - cmds.error("Could not do what you wanted..") - return - else: - # If it is indeed a component - get the current Mesh - try: - parent = element.split(".", 1)[0] - - # Maya is funny in that when the transform of the shape - # of the component element has children, the name returned - # by that elementection is the shape. Otherwise, it is - # the transform. So lets see what type we're dealing with here. - if cmds.nodeType(parent) in supported: - geometry_shape = parent - else: - geometry_shape = cmds.listRelatives(parent, shapes=1)[0] - - if not geometry_shape: - cmds.error("Skipping %s: Could not find shape." % element) - return - - if len(cmds.ls(geometry_shape)) > 1: - cmds.warning("Multiple shapes with identical " - "names found. This might not work") - - except TypeError as e: - cmds.warning("Skipping %s: Didn't find a shape " - "for component elementection. %s" % (element, e)) - return - - try: - type = cmds.nodeType(geometry_shape) - - if type == "nurbsSurface": - # If a surfacePoint is elementected on a nurbs surface - root, u, v = element.rsplit("[", 2) - uv = [float(u[:-1]), float(v[:-1])] - - if type == "mesh": - # ----------- - # Average the U and V values - # =========== - uvs = cmds.polyListComponentConversion(element, toUV=1) - if not uvs: - cmds.warning("Couldn't derive any UV's from " - "component, reverting to default U and V") - raise TypeError - - # Flatten list of Uv's as sometimes it returns - # neighbors like this [2:3] instead of [2], [3] - flattened = [] - - for uv in uvs: - flattened.extend(cmds.ls(uv, flatten=True)) - - uvs = flattened - - sumU = 0 - sumV = 0 - for uv in uvs: - try: - u, v = cmds.polyEditUV(uv, query=True) - except Exception: - cmds.warning("Couldn't find any UV coordinated, " - "reverting to default U and V") - raise TypeError - - sumU += u - sumV += v - - averagedU = sumU / len(uvs) - averagedV = sumV / len(uvs) - - uv = [averagedU, averagedV] - except TypeError: - pass - - return uv - - -def shape_from_element(element): - """Return shape of given 'element' - - Supports components, meshes, and surfaces - - """ - - try: - # Get either shape or transform, based on element-type - node = cmds.ls(element, objectsOnly=True)[0] - except Exception: - cmds.warning("Could not find node in %s" % element) - return None - - if cmds.nodeType(node) == 'transform': - try: - return cmds.listRelatives(node, shapes=True)[0] - except Exception: - cmds.warning("Could not find shape in %s" % element) - return None - - else: - return node + return zip(a, a) def export_alembic(nodes, @@ -516,7 +361,8 @@ def collect_animation_data(fps=False): data = OrderedDict() data["frameStart"] = start data["frameEnd"] = end - data["handles"] = 0 + data["handleStart"] = 0 + data["handleEnd"] = 0 data["step"] = 1.0 if fps: @@ -577,115 +423,6 @@ def imprint(node, data): cmds.setAttr(node + "." + key, value, **set_type) -def serialise_shaders(nodes): - """Generate a shader set dictionary - - Arguments: - nodes (list): Absolute paths to nodes - - Returns: - dictionary of (shader: id) pairs - - Schema: - { - "shader1": ["id1", "id2"], - "shader2": ["id3", "id1"] - } - - Example: - { - "Bazooka_Brothers01_:blinn4SG": [ - "f9520572-ac1d-11e6-b39e-3085a99791c9.f[4922:5001]", - "f9520572-ac1d-11e6-b39e-3085a99791c9.f[4587:4634]", - "f9520572-ac1d-11e6-b39e-3085a99791c9.f[1120:1567]", - "f9520572-ac1d-11e6-b39e-3085a99791c9.f[4251:4362]" - ], - "lambert2SG": [ - "f9520571-ac1d-11e6-9dbb-3085a99791c9" - ] - } - - """ - - valid_nodes = cmds.ls( - nodes, - long=True, - recursive=True, - showType=True, - objectsOnly=True, - type="transform" - ) - - meshes_by_id = {} - for mesh in valid_nodes: - shapes = cmds.listRelatives(valid_nodes[0], - shapes=True, - fullPath=True) or list() - - if shapes: - shape = shapes[0] - if not cmds.nodeType(shape): - continue - - try: - id_ = cmds.getAttr(mesh + ".mbID") - - if id_ not in meshes_by_id: - meshes_by_id[id_] = list() - - meshes_by_id[id_].append(mesh) - - except ValueError: - continue - - meshes_by_shader = dict() - for mesh in meshes_by_id.values(): - shape = cmds.listRelatives(mesh, - shapes=True, - fullPath=True) or list() - - for shader in cmds.listConnections(shape, - type="shadingEngine") or list(): - - # Objects in this group are those that haven't got - # any shaders. These are expected to be managed - # elsewhere, such as by the default model loader. - if shader == "initialShadingGroup": - continue - - if shader not in meshes_by_shader: - meshes_by_shader[shader] = list() - - shaded = cmds.sets(shader, query=True) or list() - meshes_by_shader[shader].extend(shaded) - - shader_by_id = {} - for shader, shaded in meshes_by_shader.items(): - - if shader not in shader_by_id: - shader_by_id[shader] = list() - - for mesh in shaded: - - # Enable shader assignment to faces. - name = mesh.split(".f[")[0] - - transform = name - if cmds.objectType(transform) == "mesh": - transform = cmds.listRelatives(name, parent=True)[0] - - try: - id_ = cmds.getAttr(transform + ".mbID") - shader_by_id[shader].append(mesh.replace(name, id_)) - except KeyError: - continue - - # Remove duplicates - shader_by_id[shader] = list(set(shader_by_id[shader])) - - return shader_by_id - - def lsattr(attr, value=None): """Return nodes matching `key` and `value` @@ -764,17 +501,6 @@ def lsattrs(attrs): return list(matches) -@contextlib.contextmanager -def without_extension(): - """Use cmds.file with defaultExtensions=False""" - previous_setting = cmds.file(defaultExtensions=True, query=True) - try: - cmds.file(defaultExtensions=False) - yield - finally: - cmds.file(defaultExtensions=previous_setting) - - @contextlib.contextmanager def attribute_values(attr_values): """Remaps node attributes to values during context. @@ -853,26 +579,6 @@ def evaluation(mode="off"): cmds.evaluationManager(mode=original) -@contextlib.contextmanager -def no_refresh(): - """Temporarily disables Maya's UI updates - - Note: - This only disabled the main pane and will sometimes still - trigger updates in torn off panels. - - """ - - pane = _get_mel_global('gMainPane') - state = cmds.paneLayout(pane, query=True, manage=True) - cmds.paneLayout(pane, edit=True, manage=False) - - try: - yield - finally: - cmds.paneLayout(pane, edit=True, manage=state) - - @contextlib.contextmanager def empty_sets(sets, force=False): """Remove all members of the sets during the context""" @@ -1539,15 +1245,6 @@ def extract_alembic(file, return file -def maya_temp_folder(): - scene_dir = os.path.dirname(cmds.file(query=True, sceneName=True)) - tmp_dir = os.path.abspath(os.path.join(scene_dir, "..", "tmp")) - if not os.path.isdir(tmp_dir): - os.makedirs(tmp_dir) - - return tmp_dir - - # region ID def get_id_required_nodes(referenced_nodes=False, nodes=None): """Filter out any node which are locked (reference) or readOnly @@ -1732,22 +1429,6 @@ def set_id(node, unique_id, overwrite=False): cmds.setAttr(attr, unique_id, type="string") -def remove_id(node): - """Remove the id attribute from the input node. - - Args: - node (str): The node name - - Returns: - bool: Whether an id attribute was deleted - - """ - if cmds.attributeQuery("cbId", node=node, exists=True): - cmds.deleteAttr("{}.cbId".format(node)) - return True - return False - - # endregion ID def get_reference_node(path): """ @@ -1905,21 +1586,21 @@ def assign_look_by_version(nodes, version_id): log.info("Using look for the first time ..") # Load file - loaders = api.loaders_from_representation(api.discover(api.Loader), - representation_id) + _loaders = discover_loader_plugins() + loaders = loaders_from_representation(_loaders, representation_id) Loader = next((i for i in loaders if i.__name__ == "LookLoader"), None) if Loader is None: raise RuntimeError("Could not find LookLoader, this is a bug") # Reference the look file with maintained_selection(): - container_node = pipeline.load(Loader, look_representation) + container_node = load_container(Loader, look_representation) # Get container members shader_nodes = get_container_members(container_node) # Load relationships - shader_relation = api.get_representation_path(json_representation) + shader_relation = get_representation_path(json_representation) with open(shader_relation, "r") as f: relationships = json.load(f) @@ -2423,6 +2104,7 @@ def reset_scene_resolution(): set_scene_resolution(width, height, pixelAspect) + def set_context_settings(): """Apply the project settings from the project definition @@ -2881,7 +2563,7 @@ def get_attr_in_layer(attr, layer): def fix_incompatible_containers(): - """Return whether the current scene has any outdated content""" + """Backwards compatibility: old containers to use new ReferenceLoader""" host = api.registered_host() for container in host.ls(): @@ -3120,7 +2802,7 @@ class RenderSetupListObserver: cmds.delete(render_layer_set_name) -class RenderSetupItemObserver(): +class RenderSetupItemObserver: """Handle changes in render setup items.""" def __init__(self, item): @@ -3312,7 +2994,27 @@ def set_colorspace(): """ project_name = os.getenv("AVALON_PROJECT") imageio = get_anatomy_settings(project_name)["imageio"]["maya"] - root_dict = imageio["colorManagementPreference"] + + # Maya 2022+ introduces new OCIO v2 color management settings that + # can override the old color managenement preferences. OpenPype has + # separate settings for both so we fall back when necessary. + use_ocio_v2 = imageio["colorManagementPreference_v2"]["enabled"] + required_maya_version = 2022 + maya_version = int(cmds.about(version=True)) + maya_supports_ocio_v2 = maya_version >= required_maya_version + if use_ocio_v2 and not maya_supports_ocio_v2: + # Fallback to legacy behavior with a warning + log.warning("Color Management Preference v2 is enabled but not " + "supported by current Maya version: {} (< {}). Falling " + "back to legacy settings.".format( + maya_version, required_maya_version) + ) + use_ocio_v2 = False + + if use_ocio_v2: + root_dict = imageio["colorManagementPreference_v2"] + else: + root_dict = imageio["colorManagementPreference"] if not isinstance(root_dict, dict): msg = "set_colorspace(): argument should be dictionary" @@ -3320,11 +3022,12 @@ def set_colorspace(): log.debug(">> root_dict: {}".format(root_dict)) - # first enable color management + # enable color management cmds.colorManagementPrefs(e=True, cmEnabled=True) cmds.colorManagementPrefs(e=True, ocioRulesEnabled=True) - # second set config path + # set config path + custom_ocio_config = False if root_dict.get("configFilePath"): unresolved_path = root_dict["configFilePath"] ocio_paths = unresolved_path[platform.system().lower()] @@ -3341,22 +3044,56 @@ def set_colorspace(): cmds.colorManagementPrefs(e=True, cmConfigFileEnabled=True) log.debug("maya '{}' changed to: {}".format( "configFilePath", resolved_path)) - root_dict.pop("configFilePath") + custom_ocio_config = True else: cmds.colorManagementPrefs(e=True, cmConfigFileEnabled=False) - cmds.colorManagementPrefs(e=True, configFilePath="" ) + cmds.colorManagementPrefs(e=True, configFilePath="") - # third set rendering space and view transform - renderSpace = root_dict["renderSpace"] - cmds.colorManagementPrefs(e=True, renderingSpaceName=renderSpace) - viewTransform = root_dict["viewTransform"] - cmds.colorManagementPrefs(e=True, viewTransformName=viewTransform) + # If no custom OCIO config file was set we make sure that Maya 2022+ + # either chooses between Maya's newer default v2 or legacy config based + # on OpenPype setting to use ocio v2 or not. + if maya_supports_ocio_v2 and not custom_ocio_config: + if use_ocio_v2: + # Use Maya 2022+ default OCIO v2 config + log.info("Setting default Maya OCIO v2 config") + cmds.colorManagementPrefs(edit=True, configFilePath="") + else: + # Set the Maya default config file path + log.info("Setting default Maya OCIO v1 legacy config") + cmds.colorManagementPrefs(edit=True, configFilePath="legacy") + + # set color spaces for rendering space and view transforms + def _colormanage(**kwargs): + """Wrapper around `cmds.colorManagementPrefs`. + + This logs errors instead of raising an error so color management + settings get applied as much as possible. + + """ + assert len(kwargs) == 1, "Must receive one keyword argument" + try: + cmds.colorManagementPrefs(edit=True, **kwargs) + log.debug("Setting Color Management Preference: {}".format(kwargs)) + except RuntimeError as exc: + log.error(exc) + + if use_ocio_v2: + _colormanage(renderingSpaceName=root_dict["renderSpace"]) + _colormanage(displayName=root_dict["displayName"]) + _colormanage(viewName=root_dict["viewName"]) + else: + _colormanage(renderingSpaceName=root_dict["renderSpace"]) + if maya_supports_ocio_v2: + _colormanage(viewName=root_dict["viewTransform"]) + _colormanage(displayName="legacy") + else: + _colormanage(viewTransformName=root_dict["viewTransform"]) @contextlib.contextmanager def root_parent(nodes): # type: (list) -> list - """Context manager to un-parent provided nodes and return then back.""" + """Context manager to un-parent provided nodes and return them back.""" import pymel.core as pm # noqa node_parents = [] diff --git a/openpype/hosts/maya/api/menu.json b/openpype/hosts/maya/api/menu.json deleted file mode 100644 index a2efd5233c..0000000000 --- a/openpype/hosts/maya/api/menu.json +++ /dev/null @@ -1,924 +0,0 @@ -[ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\save_scene_incremental.py", - "sourcetype": "file", - "title": "# Version Up", - "tooltip": "Incremental save with a specific format" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\open_current_folder.py", - "sourcetype": "file", - "title": "Open working folder..", - "tooltip": "Show current scene in Explorer" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\avalon\\launch_manager.py", - "sourcetype": "file", - "title": "# Project Manager", - "tooltip": "Add assets to the project" - }, - { - "type": "action", - "command": "from openpype.tools.assetcreator import app as assetcreator; assetcreator.show(context='maya')", - "sourcetype": "python", - "title": "Asset Creator", - "tooltip": "Open the Asset Creator" - }, - { - "type": "separator" - }, - { - "type": "menu", - "title": "Modeling", - "items": [ - { - "type": "action", - "command": "import easyTreezSource; reload(easyTreezSource); easyTreezSource.easyTreez()", - "sourcetype": "python", - "tags": ["modeling", "trees", "generate", "create", "plants"], - "title": "EasyTreez", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\separateMeshPerShader.py", - "sourcetype": "file", - "tags": ["modeling", "separateMeshPerShader"], - "title": "# Separate Mesh Per Shader", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\polyDetachSeparate.py", - "sourcetype": "file", - "tags": ["modeling", "poly", "detach", "separate"], - "title": "# Polygon Detach and Separate", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\polySelectEveryNthEdgeUI.py", - "sourcetype": "file", - "tags": ["modeling", "select", "nth", "edge", "ui"], - "title": "# Select Every Nth Edge" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\djPFXUVs.py", - "sourcetype": "file", - "tags": ["modeling", "djPFX", "UVs"], - "title": "# dj PFX UVs", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "Rigging", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\advancedSkeleton.py", - "sourcetype": "file", - "tags": [ - "rigging", - "autorigger", - "advanced", - "skeleton", - "advancedskeleton", - "file" - ], - "title": "Advanced Skeleton" - } - ] - }, - { - "type": "menu", - "title": "Shading", - "items": [ - { - "type": "menu", - "title": "# VRay", - "items": [ - { - "type": "action", - "title": "# Import Proxies", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayImportProxies.py", - "sourcetype": "file", - "tags": ["shading", "vray", "import", "proxies"], - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "# Select All GES", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\selectAllGES.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "select All GES"] - }, - { - "type": "action", - "title": "# Select All GES Under Selection", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\selectAllGESUnderSelection.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "select", "all", "GES"] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "# Selection To VRay Mesh", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\selectionToVrayMesh.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "selection", "vraymesh"] - }, - { - "type": "action", - "title": "# Add VRay Round Edges Attribute", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVrayRoundEdgesAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "round edges", "attribute"] - }, - { - "type": "action", - "title": "# Add Gamma", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayAddGamma.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "add gamma"] - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\select_vraymesh_materials_with_unconnected_shader_slots.py", - "sourcetype": "file", - "title": "# Select Unconnected Shader Materials", - "tags": [ - "shading", - "vray", - "select", - "vraymesh", - "materials", - "unconnected shader slots" - ], - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayMergeSimilarVRayMeshMaterials.py", - "sourcetype": "file", - "title": "# Merge Similar VRay Mesh Materials", - "tags": [ - "shading", - "vray", - "Merge", - "VRayMesh", - "Materials" - ], - "tooltip": "" - }, - { - "type": "action", - "title": "# Create Two Sided Material", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayCreate2SidedMtlForSelectedMtlRenamed.py", - "sourcetype": "file", - "tooltip": "Creates two sided material for selected material and renames it", - "tags": ["shading", "vray", "two sided", "material"] - }, - { - "type": "action", - "title": "# Create Two Sided Material For Selected", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayCreate2SidedMtlForSelectedMtl.py", - "sourcetype": "file", - "tooltip": "Select material to create a two sided version from it", - "tags": [ - "shading", - "vray", - "Create2SidedMtlForSelectedMtl.py" - ] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "# Add OpenSubdiv Attribute", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVrayOpenSubdivAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": [ - "shading", - "vray", - "add", - "open subdiv", - "attribute" - ] - }, - { - "type": "action", - "title": "# Remove OpenSubdiv Attribute", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\removeVrayOpenSubdivAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": [ - "shading", - "vray", - "remove", - "opensubdiv", - "attributee" - ] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "# Add Subdivision Attribute", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVraySubdivisionAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": [ - "shading", - "vray", - "addVraySubdivisionAttribute" - ] - }, - { - "type": "action", - "title": "# Remove Subdivision Attribute.py", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\removeVraySubdivisionAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": [ - "shading", - "vray", - "remove", - "subdivision", - "attribute" - ] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "# Add Vray Object Ids", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVrayObjectIds.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "add", "object id"] - }, - { - "type": "action", - "title": "# Add Vray Material Ids", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVrayMaterialIds.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "addVrayMaterialIds.py"] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "# Set Physical DOF Depth", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayPhysicalDOFSetDepth.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "physical", "DOF ", "Depth"] - }, - { - "type": "action", - "title": "# Magic Vray Proxy UI", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\magicVrayProxyUI.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "magicVrayProxyUI"] - } - ] - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\pyblish\\lighting\\set_filename_prefix.py", - "sourcetype": "file", - "tags": [ - "shading", - "lookdev", - "assign", - "shaders", - "prefix", - "filename", - "render" - ], - "title": "# Set filename prefix", - "tooltip": "Set the render file name prefix." - }, - { - "type": "action", - "command": "import mayalookassigner; mayalookassigner.show()", - "sourcetype": "python", - "tags": ["shading", "look", "assign", "shaders", "auto"], - "title": "Look Manager", - "tooltip": "Open the Look Manager UI for look assignment" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\LightLinkUi.py", - "sourcetype": "file", - "tags": ["shading", "light", "link", "ui"], - "title": "# Light Link UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\vdviewer_ui.py", - "sourcetype": "file", - "tags": [ - "shading", - "look", - "vray", - "displacement", - "shaders", - "auto" - ], - "title": "# VRay Displ Viewer", - "tooltip": "Open the VRay Displacement Viewer, select and control the content of the set" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\setTexturePreviewToCLRImage.py", - "sourcetype": "file", - "tags": ["shading", "CLRImage", "textures", "preview"], - "title": "# Set Texture Preview To CLRImage", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\fixDefaultShaderSetBehavior.py", - "sourcetype": "file", - "tags": ["shading", "fix", "DefaultShaderSet", "Behavior"], - "title": "# Fix Default Shader Set Behavior", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\fixSelectedShapesReferenceAssignments.py", - "sourcetype": "file", - "tags": [ - "shading", - "fix", - "Selected", - "Shapes", - "Reference", - "Assignments" - ], - "title": "# Fix Shapes Reference Assignments", - "tooltip": "Select shapes to fix the reference assignments" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\selectLambert1Members.py", - "sourcetype": "file", - "tags": ["shading", "selectLambert1Members"], - "title": "# Select Lambert1 Members", - "tooltip": "Selects all objects which have the Lambert1 shader assigned" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\selectShapesWithoutShader.py", - "sourcetype": "file", - "tags": ["shading", "selectShapesWithoutShader"], - "title": "# Select Shapes Without Shader", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\fixRenderLayerOutAdjustmentErrors.py", - "sourcetype": "file", - "tags": ["shading", "fixRenderLayerOutAdjustmentErrors"], - "title": "# Fix RenderLayer Out Adjustment Errors", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\fix_renderlayer_missing_node_override.py", - "sourcetype": "file", - "tags": [ - "shading", - "renderlayer", - "missing", - "reference", - "switch", - "layer" - ], - "title": "# Fix RenderLayer Missing Referenced Nodes Overrides", - "tooltip": "" - }, - { - "type": "action", - "title": "# Image 2 Tiled EXR", - "command": "$OPENPYPE_SCRIPTS\\shading\\open_img2exr.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "exr"] - } - ] - }, - { - "type": "menu", - "title": "# Rendering", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\pyblish\\open_deadline_submission_settings.py", - "sourcetype": "file", - "tags": ["settings", "deadline", "globals", "render"], - "title": "# DL Submission Settings UI", - "tooltip": "Open the Deadline Submission Settings UI" - } - ] - }, - { - "type": "menu", - "title": "Animation", - "items": [ - { - "type": "menu", - "title": "# Attributes", - "tooltip": "", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyValues.py", - "sourcetype": "file", - "tags": ["animation", "copy", "attributes"], - "title": "# Copy Values", - "tooltip": "Copy attribute values" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyInConnections.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "connections", - "incoming" - ], - "title": "# Copy In Connections", - "tooltip": "Copy incoming connections" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyOutConnections.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "connections", - "out" - ], - "title": "# Copy Out Connections", - "tooltip": "Copy outcoming connections" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyTransformLocal.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "transforms", - "local" - ], - "title": "# Copy Local Transforms", - "tooltip": "Copy local transforms" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyTransformMatrix.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "transforms", - "matrix" - ], - "title": "# Copy Matrix Transforms", - "tooltip": "Copy Matrix transforms" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyTransformUI.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "transforms", - "UI" - ], - "title": "# Copy Transforms UI", - "tooltip": "Open the Copy Transforms UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\simpleCopyUI.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "transforms", - "UI", - "simple" - ], - "title": "# Simple Copy UI", - "tooltip": "Open the simple Copy Transforms UI" - } - ] - }, - { - "type": "menu", - "title": "# Optimize", - "tooltip": "Optimization scripts", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\optimize\\toggleFreezeHierarchy.py", - "sourcetype": "file", - "tags": ["animation", "hierarchy", "toggle", "freeze"], - "title": "# Toggle Freeze Hierarchy", - "tooltip": "Freeze and unfreeze hierarchy" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\optimize\\toggleParallelNucleus.py", - "sourcetype": "file", - "tags": ["animation", "nucleus", "toggle", "parallel"], - "title": "# Toggle Parallel Nucleus", - "tooltip": "Toggle parallel nucleus" - } - ] - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\bakeSelectedToWorldSpace.py", - "tags": ["animation", "bake", "selection", "worldspace.py"], - "title": "# Bake Selected To Worldspace", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\timeStepper.py", - "tags": ["animation", "time", "stepper"], - "title": "# Time Stepper", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\capture_ui.py", - "tags": [ - "animation", - "capture", - "ui", - "screen", - "movie", - "image" - ], - "title": "# Capture UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\simplePlayblastUI.py", - "tags": ["animation", "simple", "playblast", "ui"], - "title": "# Simple Playblast UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\tweenMachineUI.py", - "tags": ["animation", "tween", "machine"], - "title": "# Tween Machine UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\selectAllAnimationCurves.py", - "tags": ["animation", "select", "curves"], - "title": "# Select All Animation Curves", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\pathAnimation.py", - "tags": ["animation", "path", "along"], - "title": "# Path Animation", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\offsetSelectedObjectsUI.py", - "tags": ["animation", "offsetSelectedObjectsUI.py"], - "title": "# Offset Selected Objects UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\key_amplifier_ui.py", - "tags": ["animation", "key", "amplifier"], - "title": "# Key Amplifier UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\anim_scene_optimizer.py", - "tags": ["animation", "anim_scene_optimizer.py"], - "title": "# Anim_Scene_Optimizer", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\zvParentMaster.py", - "tags": ["animation", "zvParentMaster.py"], - "title": "# ZV Parent Master", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\animLibrary.py", - "tags": ["animation", "studiolibrary.py"], - "title": "Anim Library", - "type": "action" - } - ] - }, - { - "type": "menu", - "title": "# Layout", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\alignDistributeUI.py", - "sourcetype": "file", - "tags": ["layout", "align", "Distribute", "UI"], - "title": "# Align Distribute UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\alignSimpleUI.py", - "sourcetype": "file", - "tags": ["layout", "align", "UI", "Simple"], - "title": "# Align Simple UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\center_locator.py", - "sourcetype": "file", - "tags": ["layout", "center", "locator"], - "title": "# Center Locator", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\average_locator.py", - "sourcetype": "file", - "tags": ["layout", "average", "locator"], - "title": "# Average Locator", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\selectWithinProximityUI.py", - "sourcetype": "file", - "tags": ["layout", "select", "proximity", "ui"], - "title": "# Select Within Proximity UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\dupCurveUI.py", - "sourcetype": "file", - "tags": ["layout", "Duplicate", "Curve", "UI"], - "title": "# Duplicate Curve UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\randomDeselectUI.py", - "sourcetype": "file", - "tags": ["layout", "random", "Deselect", "UI"], - "title": "# Random Deselect UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\multiReferencerUI.py", - "sourcetype": "file", - "tags": ["layout", "multi", "reference"], - "title": "# Multi Referencer UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\duplicateOffsetUI.py", - "sourcetype": "file", - "tags": ["layout", "duplicate", "offset", "UI"], - "title": "# Duplicate Offset UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\spPaint3d.py", - "sourcetype": "file", - "tags": ["layout", "spPaint3d", "paint", "tool"], - "title": "# SP Paint 3d", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\randomizeUI.py", - "sourcetype": "file", - "tags": ["layout", "randomize", "UI"], - "title": "# Randomize UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\distributeWithinObjectUI.py", - "sourcetype": "file", - "tags": ["layout", "distribute", "ObjectUI", "within"], - "title": "# Distribute Within Object UI", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "# Particles", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\instancerToObjects.py", - "sourcetype": "file", - "tags": ["particles", "instancerToObjects"], - "title": "# Instancer To Objects", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\instancerToObjectsInstances.py", - "sourcetype": "file", - "tags": ["particles", "instancerToObjectsInstances"], - "title": "# Instancer To Objects Instances", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\instancerToObjectsInstancesWithAnimation.py", - "sourcetype": "file", - "tags": [ - "particles", - "instancerToObjectsInstancesWithAnimation" - ], - "title": "# Instancer To Objects Instances With Animation", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\instancerToObjectsWithAnimation.py", - "sourcetype": "file", - "tags": ["particles", "instancerToObjectsWithAnimation"], - "title": "# Instancer To Objects With Animation", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "Cleanup", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\repair_faulty_containers.py", - "sourcetype": "file", - "tags": ["cleanup", "repair", "containers"], - "title": "# Find and Repair Containers", - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\removeNamespaces.py", - "sourcetype": "file", - "tags": ["cleanup", "remove", "namespaces"], - "title": "# Remove Namespaces", - "tooltip": "Remove all namespaces" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\remove_user_defined_attributes.py", - "sourcetype": "file", - "tags": ["cleanup", "remove_user_defined_attributes"], - "title": "# Remove User Defined Attributes", - "tooltip": "Remove all user-defined attributes from all nodes" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\removeUnknownNodes.py", - "sourcetype": "file", - "tags": ["cleanup", "removeUnknownNodes"], - "title": "# Remove Unknown Nodes", - "tooltip": "Remove all unknown nodes" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\removeUnloadedReferences.py", - "sourcetype": "file", - "tags": ["cleanup", "removeUnloadedReferences"], - "title": "# Remove Unloaded References", - "tooltip": "Remove all unloaded references" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\removeReferencesFailedEdits.py", - "sourcetype": "file", - "tags": ["cleanup", "removeReferencesFailedEdits"], - "title": "# Remove References Failed Edits", - "tooltip": "Remove failed edits for all references" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\remove_unused_looks.py", - "sourcetype": "file", - "tags": ["cleanup", "removeUnusedLooks"], - "title": "# Remove Unused Looks", - "tooltip": "Remove all loaded yet unused Avalon look containers" - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\uniqifyNodeNames.py", - "sourcetype": "file", - "tags": ["cleanup", "uniqifyNodeNames"], - "title": "# Uniqify Node Names", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\autoRenameFileNodes.py", - "sourcetype": "file", - "tags": ["cleanup", "auto", "rename", "filenodes"], - "title": "# Auto Rename File Nodes", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\update_asset_id.py", - "sourcetype": "file", - "tags": ["cleanup", "update", "database", "asset", "id"], - "title": "# Update Asset ID", - "tooltip": "Will replace the Colorbleed ID with a new one (asset ID : Unique number)" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\ccRenameReplace.py", - "sourcetype": "file", - "tags": ["cleanup", "rename", "ui"], - "title": "Renamer", - "tooltip": "Rename UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\renameShapesToTransform.py", - "sourcetype": "file", - "tags": ["cleanup", "renameShapesToTransform"], - "title": "# Rename Shapes To Transform", - "tooltip": "" - } - ] - } -] diff --git a/openpype/hosts/maya/api/menu.py b/openpype/hosts/maya/api/menu.py index b1934c757d..5f0fc39bf3 100644 --- a/openpype/hosts/maya/api/menu.py +++ b/openpype/hosts/maya/api/menu.py @@ -36,7 +36,7 @@ def install(): return def deferred(): - from avalon.tools import publish + pyblish_icon = host_tools.get_pyblish_icon() parent_widget = get_main_window() cmds.menu( MENU_NAME, @@ -80,7 +80,7 @@ def install(): command=lambda *args: host_tools.show_publish( parent=parent_widget ), - image=publish.ICON + image=pyblish_icon ) cmds.menuItem( diff --git a/openpype/hosts/maya/api/menu_backup.json b/openpype/hosts/maya/api/menu_backup.json deleted file mode 100644 index e2a558aedc..0000000000 --- a/openpype/hosts/maya/api/menu_backup.json +++ /dev/null @@ -1,1567 +0,0 @@ -[ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\save_scene_incremental.py", - "sourcetype": "file", - "title": "Version Up", - "tooltip": "Incremental save with a specific format" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\show_current_scene_in_explorer.py", - "sourcetype": "file", - "title": "Explore current scene..", - "tooltip": "Show current scene in Explorer" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\avalon\\launch_manager.py", - "sourcetype": "file", - "title": "Project Manager", - "tooltip": "Add assets to the project" - }, - { - "type": "separator" - }, - { - "type": "menu", - "title": "Modeling", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\duplicate_normalized.py", - "sourcetype": "file", - "tags": ["modeling", "duplicate", "normalized"], - "title": "Duplicate Normalized", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\transferUVs.py", - "sourcetype": "file", - "tags": ["modeling", "transfer", "uv"], - "title": "Transfer UVs", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\mirrorSymmetry.py", - "sourcetype": "file", - "tags": ["modeling", "mirror", "symmetry"], - "title": "Mirror Symmetry", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\selectOutlineUI.py", - "sourcetype": "file", - "tags": ["modeling", "select", "outline", "ui"], - "title": "Select Outline UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\polyDeleteOtherUVSets.py", - "sourcetype": "file", - "tags": ["modeling", "polygon", "uvset", "delete"], - "title": "Polygon Delete Other UV Sets", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\polyCombineQuick.py", - "sourcetype": "file", - "tags": ["modeling", "combine", "polygon", "quick"], - "title": "Polygon Combine Quick", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\separateMeshPerShader.py", - "sourcetype": "file", - "tags": ["modeling", "separateMeshPerShader"], - "title": "Separate Mesh Per Shader", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\polyDetachSeparate.py", - "sourcetype": "file", - "tags": ["modeling", "poly", "detach", "separate"], - "title": "Polygon Detach and Separate", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\polyRelaxVerts.py", - "sourcetype": "file", - "tags": ["modeling", "relax", "verts"], - "title": "Polygon Relax Vertices", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\polySelectEveryNthEdgeUI.py", - "sourcetype": "file", - "tags": ["modeling", "select", "nth", "edge", "ui"], - "title": "Select Every Nth Edge" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\modeling\\djPFXUVs.py", - "sourcetype": "file", - "tags": ["modeling", "djPFX", "UVs"], - "title": "dj PFX UVs", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "Rigging", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\addCurveBetween.py", - "sourcetype": "file", - "tags": ["rigging", "addCurveBetween", "file"], - "title": "Add Curve Between" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\averageSkinWeights.py", - "sourcetype": "file", - "tags": ["rigging", "average", "skin weights", "file"], - "title": "Average Skin Weights" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\cbSmoothSkinWeightUI.py", - "sourcetype": "file", - "tags": ["rigging", "cbSmoothSkinWeightUI", "file"], - "title": "CB Smooth Skin Weight UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\channelBoxManagerUI.py", - "sourcetype": "file", - "tags": ["rigging", "channelBoxManagerUI", "file"], - "title": "Channel Box Manager UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\characterAutorigger.py", - "sourcetype": "file", - "tags": ["rigging", "characterAutorigger", "file"], - "title": "Character Auto Rigger" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\connectUI.py", - "sourcetype": "file", - "tags": ["rigging", "connectUI", "file"], - "title": "Connect UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\copySkinWeightsLocal.py", - "sourcetype": "file", - "tags": ["rigging", "copySkinWeightsLocal", "file"], - "title": "Copy Skin Weights Local" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\createCenterLocator.py", - "sourcetype": "file", - "tags": ["rigging", "createCenterLocator", "file"], - "title": "Create Center Locator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\freezeTransformToGroup.py", - "sourcetype": "file", - "tags": ["rigging", "freezeTransformToGroup", "file"], - "title": "Freeze Transform To Group" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\groupSelected.py", - "sourcetype": "file", - "tags": ["rigging", "groupSelected", "file"], - "title": "Group Selected" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\ikHandlePoleVectorLocator.py", - "sourcetype": "file", - "tags": ["rigging", "ikHandlePoleVectorLocator", "file"], - "title": "IK Handle Pole Vector Locator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\jointOrientUI.py", - "sourcetype": "file", - "tags": ["rigging", "jointOrientUI", "file"], - "title": "Joint Orient UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\jointsOnCurve.py", - "sourcetype": "file", - "tags": ["rigging", "jointsOnCurve", "file"], - "title": "Joints On Curve" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\resetBindSelectedSkinJoints.py", - "sourcetype": "file", - "tags": ["rigging", "resetBindSelectedSkinJoints", "file"], - "title": "Reset Bind Selected Skin Joints" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\selectSkinclusterJointsFromSelectedComponents.py", - "sourcetype": "file", - "tags": [ - "rigging", - "selectSkinclusterJointsFromSelectedComponents", - "file" - ], - "title": "Select Skincluster Joints From Selected Components" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\selectSkinclusterJointsFromSelectedMesh.py", - "sourcetype": "file", - "tags": [ - "rigging", - "selectSkinclusterJointsFromSelectedMesh", - "file" - ], - "title": "Select Skincluster Joints From Selected Mesh" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\setJointLabels.py", - "sourcetype": "file", - "tags": ["rigging", "setJointLabels", "file"], - "title": "Set Joint Labels" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\setJointOrientationFromCurrentRotation.py", - "sourcetype": "file", - "tags": [ - "rigging", - "setJointOrientationFromCurrentRotation", - "file" - ], - "title": "Set Joint Orientation From Current Rotation" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\setSelectedJointsOrientationZero.py", - "sourcetype": "file", - "tags": ["rigging", "setSelectedJointsOrientationZero", "file"], - "title": "Set Selected Joints Orientation Zero" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\mirrorCurveShape.py", - "sourcetype": "file", - "tags": ["rigging", "mirrorCurveShape", "file"], - "title": "Mirror Curve Shape" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\setRotationOrderUI.py", - "sourcetype": "file", - "tags": ["rigging", "setRotationOrderUI", "file"], - "title": "Set Rotation Order UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\paintItNowUI.py", - "sourcetype": "file", - "tags": ["rigging", "paintItNowUI", "file"], - "title": "Paint It Now UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\parentScaleConstraint.py", - "sourcetype": "file", - "tags": ["rigging", "parentScaleConstraint", "file"], - "title": "Parent Scale Constraint" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\quickSetWeightsUI.py", - "sourcetype": "file", - "tags": ["rigging", "quickSetWeightsUI", "file"], - "title": "Quick Set Weights UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\rapidRig.py", - "sourcetype": "file", - "tags": ["rigging", "rapidRig", "file"], - "title": "Rapid Rig" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\regenerate_blendshape_targets.py", - "sourcetype": "file", - "tags": ["rigging", "regenerate_blendshape_targets", "file"], - "title": "Regenerate Blendshape Targets" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\removeRotationAxis.py", - "sourcetype": "file", - "tags": ["rigging", "removeRotationAxis", "file"], - "title": "Remove Rotation Axis" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\resetBindSelectedMeshes.py", - "sourcetype": "file", - "tags": ["rigging", "resetBindSelectedMeshes", "file"], - "title": "Reset Bind Selected Meshes" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\simpleControllerOnSelection.py", - "sourcetype": "file", - "tags": ["rigging", "simpleControllerOnSelection", "file"], - "title": "Simple Controller On Selection" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\simpleControllerOnSelectionHierarchy.py", - "sourcetype": "file", - "tags": [ - "rigging", - "simpleControllerOnSelectionHierarchy", - "file" - ], - "title": "Simple Controller On Selection Hierarchy" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\superRelativeCluster.py", - "sourcetype": "file", - "tags": ["rigging", "superRelativeCluster", "file"], - "title": "Super Relative Cluster" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\tfSmoothSkinWeight.py", - "sourcetype": "file", - "tags": ["rigging", "tfSmoothSkinWeight", "file"], - "title": "TF Smooth Skin Weight" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\toggleIntermediates.py", - "sourcetype": "file", - "tags": ["rigging", "toggleIntermediates", "file"], - "title": "Toggle Intermediates" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\toggleSegmentScaleCompensate.py", - "sourcetype": "file", - "tags": ["rigging", "toggleSegmentScaleCompensate", "file"], - "title": "Toggle Segment Scale Compensate" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\rigging\\toggleSkinclusterDeformNormals.py", - "sourcetype": "file", - "tags": ["rigging", "toggleSkinclusterDeformNormals", "file"], - "title": "Toggle Skincluster Deform Normals" - } - ] - }, - { - "type": "menu", - "title": "Shading", - "items": [ - { - "type": "menu", - "title": "VRay", - "items": [ - { - "type": "action", - "title": "Import Proxies", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayImportProxies.py", - "sourcetype": "file", - "tags": ["shading", "vray", "import", "proxies"], - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "Select All GES", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\selectAllGES.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "select All GES"] - }, - { - "type": "action", - "title": "Select All GES Under Selection", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\selectAllGESUnderSelection.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "select", "all", "GES"] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "Selection To VRay Mesh", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\selectionToVrayMesh.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "selection", "vraymesh"] - }, - { - "type": "action", - "title": "Add VRay Round Edges Attribute", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVrayRoundEdgesAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "round edges", "attribute"] - }, - { - "type": "action", - "title": "Add Gamma", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayAddGamma.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "add gamma"] - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\select_vraymesh_materials_with_unconnected_shader_slots.py", - "sourcetype": "file", - "title": "Select Unconnected Shader Materials", - "tags": [ - "shading", - "vray", - "select", - "vraymesh", - "materials", - "unconnected shader slots" - ], - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayMergeSimilarVRayMeshMaterials.py", - "sourcetype": "file", - "title": "Merge Similar VRay Mesh Materials", - "tags": [ - "shading", - "vray", - "Merge", - "VRayMesh", - "Materials" - ], - "tooltip": "" - }, - { - "type": "action", - "title": "Create Two Sided Material", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayCreate2SidedMtlForSelectedMtlRenamed.py", - "sourcetype": "file", - "tooltip": "Creates two sided material for selected material and renames it", - "tags": ["shading", "vray", "two sided", "material"] - }, - { - "type": "action", - "title": "Create Two Sided Material For Selected", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayCreate2SidedMtlForSelectedMtl.py", - "sourcetype": "file", - "tooltip": "Select material to create a two sided version from it", - "tags": [ - "shading", - "vray", - "Create2SidedMtlForSelectedMtl.py" - ] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "Add OpenSubdiv Attribute", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVrayOpenSubdivAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": [ - "shading", - "vray", - "add", - "open subdiv", - "attribute" - ] - }, - { - "type": "action", - "title": "Remove OpenSubdiv Attribute", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\removeVrayOpenSubdivAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": [ - "shading", - "vray", - "remove", - "opensubdiv", - "attributee" - ] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "Add Subdivision Attribute", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVraySubdivisionAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": [ - "shading", - "vray", - "addVraySubdivisionAttribute" - ] - }, - { - "type": "action", - "title": "Remove Subdivision Attribute.py", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\removeVraySubdivisionAttribute.py", - "sourcetype": "file", - "tooltip": "", - "tags": [ - "shading", - "vray", - "remove", - "subdivision", - "attribute" - ] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "Add Vray Object Ids", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVrayObjectIds.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "add", "object id"] - }, - { - "type": "action", - "title": "Add Vray Material Ids", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\addVrayMaterialIds.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "addVrayMaterialIds.py"] - }, - { - "type": "separator" - }, - { - "type": "action", - "title": "Set Physical DOF Depth", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\vrayPhysicalDOFSetDepth.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "physical", "DOF ", "Depth"] - }, - { - "type": "action", - "title": "Magic Vray Proxy UI", - "command": "$OPENPYPE_SCRIPTS\\shading\\vray\\magicVrayProxyUI.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "magicVrayProxyUI"] - } - ] - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\pyblish\\lighting\\set_filename_prefix.py", - "sourcetype": "file", - "tags": [ - "shading", - "lookdev", - "assign", - "shaders", - "prefix", - "filename", - "render" - ], - "title": "Set filename prefix", - "tooltip": "Set the render file name prefix." - }, - { - "type": "action", - "command": "import mayalookassigner; mayalookassigner.show()", - "sourcetype": "python", - "tags": ["shading", "look", "assign", "shaders", "auto"], - "title": "Look Manager", - "tooltip": "Open the Look Manager UI for look assignment" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\LightLinkUi.py", - "sourcetype": "file", - "tags": ["shading", "light", "link", "ui"], - "title": "Light Link UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\vdviewer_ui.py", - "sourcetype": "file", - "tags": [ - "shading", - "look", - "vray", - "displacement", - "shaders", - "auto" - ], - "title": "VRay Displ Viewer", - "tooltip": "Open the VRay Displacement Viewer, select and control the content of the set" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\setTexturePreviewToCLRImage.py", - "sourcetype": "file", - "tags": ["shading", "CLRImage", "textures", "preview"], - "title": "Set Texture Preview To CLRImage", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\fixDefaultShaderSetBehavior.py", - "sourcetype": "file", - "tags": ["shading", "fix", "DefaultShaderSet", "Behavior"], - "title": "Fix Default Shader Set Behavior", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\fixSelectedShapesReferenceAssignments.py", - "sourcetype": "file", - "tags": [ - "shading", - "fix", - "Selected", - "Shapes", - "Reference", - "Assignments" - ], - "title": "Fix Shapes Reference Assignments", - "tooltip": "Select shapes to fix the reference assignments" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\selectLambert1Members.py", - "sourcetype": "file", - "tags": ["shading", "selectLambert1Members"], - "title": "Select Lambert1 Members", - "tooltip": "Selects all objects which have the Lambert1 shader assigned" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\selectShapesWithoutShader.py", - "sourcetype": "file", - "tags": ["shading", "selectShapesWithoutShader"], - "title": "Select Shapes Without Shader", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\fixRenderLayerOutAdjustmentErrors.py", - "sourcetype": "file", - "tags": ["shading", "fixRenderLayerOutAdjustmentErrors"], - "title": "Fix RenderLayer Out Adjustment Errors", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\shading\\fix_renderlayer_missing_node_override.py", - "sourcetype": "file", - "tags": [ - "shading", - "renderlayer", - "missing", - "reference", - "switch", - "layer" - ], - "title": "Fix RenderLayer Missing Referenced Nodes Overrides", - "tooltip": "" - }, - { - "type": "action", - "title": "Image 2 Tiled EXR", - "command": "$OPENPYPE_SCRIPTS\\shading\\open_img2exr.py", - "sourcetype": "file", - "tooltip": "", - "tags": ["shading", "vray", "exr"] - } - ] - }, - { - "type": "menu", - "title": "Rendering", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\pyblish\\open_deadline_submission_settings.py", - "sourcetype": "file", - "tags": ["settings", "deadline", "globals", "render"], - "title": "DL Submission Settings UI", - "tooltip": "Open the Deadline Submission Settings UI" - } - ] - }, - { - "type": "menu", - "title": "Animation", - "items": [ - { - "type": "menu", - "title": "Attributes", - "tooltip": "", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyValues.py", - "sourcetype": "file", - "tags": ["animation", "copy", "attributes"], - "title": "Copy Values", - "tooltip": "Copy attribute values" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyInConnections.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "connections", - "incoming" - ], - "title": "Copy In Connections", - "tooltip": "Copy incoming connections" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyOutConnections.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "connections", - "out" - ], - "title": "Copy Out Connections", - "tooltip": "Copy outcoming connections" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyTransformLocal.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "transforms", - "local" - ], - "title": "Copy Local Transforms", - "tooltip": "Copy local transforms" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyTransformMatrix.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "transforms", - "matrix" - ], - "title": "Copy Matrix Transforms", - "tooltip": "Copy Matrix transforms" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\copyTransformUI.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "transforms", - "UI" - ], - "title": "Copy Transforms UI", - "tooltip": "Open the Copy Transforms UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\attributes\\simpleCopyUI.py", - "sourcetype": "file", - "tags": [ - "animation", - "copy", - "attributes", - "transforms", - "UI", - "simple" - ], - "title": "Simple Copy UI", - "tooltip": "Open the simple Copy Transforms UI" - } - ] - }, - { - "type": "menu", - "title": "Optimize", - "tooltip": "Optimization scripts", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\optimize\\toggleFreezeHierarchy.py", - "sourcetype": "file", - "tags": ["animation", "hierarchy", "toggle", "freeze"], - "title": "Toggle Freeze Hierarchy", - "tooltip": "Freeze and unfreeze hierarchy" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\animation\\optimize\\toggleParallelNucleus.py", - "sourcetype": "file", - "tags": ["animation", "nucleus", "toggle", "parallel"], - "title": "Toggle Parallel Nucleus", - "tooltip": "Toggle parallel nucleus" - } - ] - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\bakeSelectedToWorldSpace.py", - "tags": ["animation", "bake", "selection", "worldspace.py"], - "title": "Bake Selected To Worldspace", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\timeStepper.py", - "tags": ["animation", "time", "stepper"], - "title": "Time Stepper", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\capture_ui.py", - "tags": [ - "animation", - "capture", - "ui", - "screen", - "movie", - "image" - ], - "title": "Capture UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\simplePlayblastUI.py", - "tags": ["animation", "simple", "playblast", "ui"], - "title": "Simple Playblast UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\tweenMachineUI.py", - "tags": ["animation", "tween", "machine"], - "title": "Tween Machine UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\selectAllAnimationCurves.py", - "tags": ["animation", "select", "curves"], - "title": "Select All Animation Curves", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\pathAnimation.py", - "tags": ["animation", "path", "along"], - "title": "Path Animation", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\offsetSelectedObjectsUI.py", - "tags": ["animation", "offsetSelectedObjectsUI.py"], - "title": "Offset Selected Objects UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\key_amplifier_ui.py", - "tags": ["animation", "key", "amplifier"], - "title": "Key Amplifier UI", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\anim_scene_optimizer.py", - "tags": ["animation", "anim_scene_optimizer.py"], - "title": "Anim_Scene_Optimizer", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\zvParentMaster.py", - "tags": ["animation", "zvParentMaster.py"], - "title": "ZV Parent Master", - "type": "action" - }, - { - "sourcetype": "file", - "command": "$OPENPYPE_SCRIPTS\\animation\\poseLibrary.py", - "tags": ["animation", "poseLibrary.py"], - "title": "Pose Library", - "type": "action" - } - ] - }, - { - "type": "menu", - "title": "Layout", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\alignDistributeUI.py", - "sourcetype": "file", - "tags": ["layout", "align", "Distribute", "UI"], - "title": "Align Distribute UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\alignSimpleUI.py", - "sourcetype": "file", - "tags": ["layout", "align", "UI", "Simple"], - "title": "Align Simple UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\center_locator.py", - "sourcetype": "file", - "tags": ["layout", "center", "locator"], - "title": "Center Locator", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\average_locator.py", - "sourcetype": "file", - "tags": ["layout", "average", "locator"], - "title": "Average Locator", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\selectWithinProximityUI.py", - "sourcetype": "file", - "tags": ["layout", "select", "proximity", "ui"], - "title": "Select Within Proximity UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\dupCurveUI.py", - "sourcetype": "file", - "tags": ["layout", "Duplicate", "Curve", "UI"], - "title": "Duplicate Curve UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\randomDeselectUI.py", - "sourcetype": "file", - "tags": ["layout", "random", "Deselect", "UI"], - "title": "Random Deselect UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\multiReferencerUI.py", - "sourcetype": "file", - "tags": ["layout", "multi", "reference"], - "title": "Multi Referencer UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\duplicateOffsetUI.py", - "sourcetype": "file", - "tags": ["layout", "duplicate", "offset", "UI"], - "title": "Duplicate Offset UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\spPaint3d.py", - "sourcetype": "file", - "tags": ["layout", "spPaint3d", "paint", "tool"], - "title": "SP Paint 3d", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\randomizeUI.py", - "sourcetype": "file", - "tags": ["layout", "randomize", "UI"], - "title": "Randomize UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\layout\\distributeWithinObjectUI.py", - "sourcetype": "file", - "tags": ["layout", "distribute", "ObjectUI", "within"], - "title": "Distribute Within Object UI", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "Particles", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\instancerToObjects.py", - "sourcetype": "file", - "tags": ["particles", "instancerToObjects"], - "title": "Instancer To Objects", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\instancerToObjectsInstances.py", - "sourcetype": "file", - "tags": ["particles", "instancerToObjectsInstances"], - "title": "Instancer To Objects Instances", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\objectsToParticlesAndInstancerCleanSource.py", - "sourcetype": "file", - "tags": [ - "particles", - "objects", - "Particles", - "Instancer", - "Clean", - "Source" - ], - "title": "Objects To Particles & Instancer - Clean Source", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\particleComponentsToLocators.py", - "sourcetype": "file", - "tags": ["particles", "components", "locators"], - "title": "Particle Components To Locators", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\objectsToParticlesAndInstancer.py", - "sourcetype": "file", - "tags": ["particles", "objects", "particles", "instancer"], - "title": "Objects To Particles And Instancer", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\spawnParticlesOnMesh.py", - "sourcetype": "file", - "tags": ["particles", "spawn", "on", "mesh"], - "title": "Spawn Particles On Mesh", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\instancerToObjectsInstancesWithAnimation.py", - "sourcetype": "file", - "tags": [ - "particles", - "instancerToObjectsInstancesWithAnimation" - ], - "title": "Instancer To Objects Instances With Animation", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\objectsToParticles.py", - "sourcetype": "file", - "tags": ["particles", "objectsToParticles"], - "title": "Objects To Particles", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\add_particle_cacheFile_attrs.py", - "sourcetype": "file", - "tags": ["particles", "add_particle_cacheFile_attrs"], - "title": "Add Particle CacheFile Attributes", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\mergeParticleSystems.py", - "sourcetype": "file", - "tags": ["particles", "mergeParticleSystems"], - "title": "Merge Particle Systems", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\particlesToLocators.py", - "sourcetype": "file", - "tags": ["particles", "particlesToLocators"], - "title": "Particles To Locators", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\instancerToObjectsWithAnimation.py", - "sourcetype": "file", - "tags": ["particles", "instancerToObjectsWithAnimation"], - "title": "Instancer To Objects With Animation", - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\mayaReplicateHoudiniTool.py", - "sourcetype": "file", - "tags": [ - "particles", - "houdini", - "houdiniTool", - "houdiniEngine" - ], - "title": "Replicate Houdini Tool", - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\clearInitialState.py", - "sourcetype": "file", - "tags": ["particles", "clearInitialState"], - "title": "Clear Initial State", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\particles\\killSelectedParticles.py", - "sourcetype": "file", - "tags": ["particles", "killSelectedParticles"], - "title": "Kill Selected Particles", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "Yeti", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\yeti\\yeti_rig_manager.py", - "sourcetype": "file", - "tags": ["yeti", "rig", "fur", "manager"], - "title": "Open Yeti Rig Manager", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "Cleanup", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\repair_faulty_containers.py", - "sourcetype": "file", - "tags": ["cleanup", "repair", "containers"], - "title": "Find and Repair Containers", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\selectByType.py", - "sourcetype": "file", - "tags": ["cleanup", "selectByType"], - "title": "Select By Type", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\selectIntermediateObjects.py", - "sourcetype": "file", - "tags": ["cleanup", "selectIntermediateObjects"], - "title": "Select Intermediate Objects", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\selectNonUniqueNames.py", - "sourcetype": "file", - "tags": ["cleanup", "select", "non unique", "names"], - "title": "Select Non Unique Names", - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\removeNamespaces.py", - "sourcetype": "file", - "tags": ["cleanup", "remove", "namespaces"], - "title": "Remove Namespaces", - "tooltip": "Remove all namespaces" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\remove_user_defined_attributes.py", - "sourcetype": "file", - "tags": ["cleanup", "remove_user_defined_attributes"], - "title": "Remove User Defined Attributes", - "tooltip": "Remove all user-defined attributes from all nodes" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\removeUnknownNodes.py", - "sourcetype": "file", - "tags": ["cleanup", "removeUnknownNodes"], - "title": "Remove Unknown Nodes", - "tooltip": "Remove all unknown nodes" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\removeUnloadedReferences.py", - "sourcetype": "file", - "tags": ["cleanup", "removeUnloadedReferences"], - "title": "Remove Unloaded References", - "tooltip": "Remove all unloaded references" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\removeReferencesFailedEdits.py", - "sourcetype": "file", - "tags": ["cleanup", "removeReferencesFailedEdits"], - "title": "Remove References Failed Edits", - "tooltip": "Remove failed edits for all references" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\remove_unused_looks.py", - "sourcetype": "file", - "tags": ["cleanup", "removeUnusedLooks"], - "title": "Remove Unused Looks", - "tooltip": "Remove all loaded yet unused Avalon look containers" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\deleteGhostIntermediateObjects.py", - "sourcetype": "file", - "tags": ["cleanup", "deleteGhostIntermediateObjects"], - "title": "Delete Ghost Intermediate Objects", - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\resetViewportCache.py", - "sourcetype": "file", - "tags": ["cleanup", "reset", "viewport", "cache"], - "title": "Reset Viewport Cache", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\uniqifyNodeNames.py", - "sourcetype": "file", - "tags": ["cleanup", "uniqifyNodeNames"], - "title": "Uniqify Node Names", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\autoRenameFileNodes.py", - "sourcetype": "file", - "tags": ["cleanup", "auto", "rename", "filenodes"], - "title": "Auto Rename File Nodes", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\update_asset_id.py", - "sourcetype": "file", - "tags": ["cleanup", "update", "database", "asset", "id"], - "title": "Update Asset ID", - "tooltip": "Will replace the Colorbleed ID with a new one (asset ID : Unique number)" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\colorbleedRename.py", - "sourcetype": "file", - "tags": ["cleanup", "rename", "ui"], - "title": "Colorbleed Renamer", - "tooltip": "Colorbleed Rename UI" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\renameShapesToTransform.py", - "sourcetype": "file", - "tags": ["cleanup", "renameShapesToTransform"], - "title": "Rename Shapes To Transform", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\reorderUI.py", - "sourcetype": "file", - "tags": ["cleanup", "reorderUI"], - "title": "Reorder UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\cleanup\\pastedCleaner.py", - "sourcetype": "file", - "tags": ["cleanup", "pastedCleaner"], - "title": "Pasted Cleaner", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "Others", - "items": [ - { - "type": "menu", - "sourcetype": "file", - "title": "Yeti", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\yeti\\cache_selected_yeti_nodes.py", - "sourcetype": "file", - "tags": ["others", "yeti", "cache", "selected"], - "title": "Cache Selected Yeti Nodes", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "title": "Hair", - "tooltip": "", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\hair\\recolorHairCurrentCurve", - "sourcetype": "file", - "tags": ["others", "selectSoftSelection"], - "title": "Select Soft Selection", - "tooltip": "" - } - ] - }, - { - "type": "menu", - "command": "$OPENPYPE_SCRIPTS\\others\\display", - "sourcetype": "file", - "tags": ["others", "display"], - "title": "Display", - "items": [ - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\display\\wireframeSelectedObjects.py", - "sourcetype": "file", - "tags": ["others", "wireframe", "selected", "objects"], - "title": "Wireframe Selected Objects", - "tooltip": "" - } - ] - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\archiveSceneUI.py", - "sourcetype": "file", - "tags": ["others", "archiveSceneUI"], - "title": "Archive Scene UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\getSimilarMeshes.py", - "sourcetype": "file", - "tags": ["others", "getSimilarMeshes"], - "title": "Get Similar Meshes", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\createBoundingBoxEachSelected.py", - "sourcetype": "file", - "tags": ["others", "createBoundingBoxEachSelected"], - "title": "Create BoundingBox Each Selected", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\curveFromPositionEveryFrame.py", - "sourcetype": "file", - "tags": ["others", "curveFromPositionEveryFrame"], - "title": "Curve From Position", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\instanceLeafSmartTransform.py", - "sourcetype": "file", - "tags": ["others", "instance", "leaf", "smart", "transform"], - "title": "Instance Leaf Smart Transform", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\instanceSmartTransform.py", - "sourcetype": "file", - "tags": ["others", "instance", "smart", "transform"], - "title": "Instance Smart Transform", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\randomizeUVShellsSelectedObjects.py", - "sourcetype": "file", - "tags": ["others", "randomizeUVShellsSelectedObjects"], - "title": "Randomize UV Shells", - "tooltip": "Select objects before running action" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\centerPivotGroup.py", - "sourcetype": "file", - "tags": ["others", "centerPivotGroup"], - "title": "Center Pivot Group", - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\locatorsOnSelectedFaces.py", - "sourcetype": "file", - "tags": ["others", "locatorsOnSelectedFaces"], - "title": "Locators On Selected Faces", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\locatorsOnEdgeSelectionPrompt.py", - "sourcetype": "file", - "tags": ["others", "locatorsOnEdgeSelectionPrompt"], - "title": "Locators On Edge Selection Prompt", - "tooltip": "" - }, - { - "type": "separator" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\copyDeformers.py", - "sourcetype": "file", - "tags": ["others", "copyDeformers"], - "title": "Copy Deformers", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\selectInReferenceEditor.py", - "sourcetype": "file", - "tags": ["others", "selectInReferenceEditor"], - "title": "Select In Reference Editor", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\selectConstrainingObject.py", - "sourcetype": "file", - "tags": ["others", "selectConstrainingObject"], - "title": "Select Constraining Object", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\deformerSetRelationsUI.py", - "sourcetype": "file", - "tags": ["others", "deformerSetRelationsUI"], - "title": "Deformer Set Relations UI", - "tooltip": "" - }, - { - "type": "action", - "command": "$OPENPYPE_SCRIPTS\\others\\recreateBaseNodesForAllLatticeNodes.py", - "sourcetype": "file", - "tags": ["others", "recreate", "base", "nodes", "lattice"], - "title": "Recreate Base Nodes For Lattice Nodes", - "tooltip": "" - } - ] - } -] diff --git a/openpype/hosts/maya/api/pipeline.py b/openpype/hosts/maya/api/pipeline.py index 14e8f4eb45..5cdc3ff4fd 100644 --- a/openpype/hosts/maya/api/pipeline.py +++ b/openpype/hosts/maya/api/pipeline.py @@ -2,7 +2,6 @@ import os import sys import errno import logging -import contextlib from maya import utils, cmds, OpenMaya import maya.api.OpenMaya as om @@ -15,8 +14,17 @@ from avalon.pipeline import AVALON_CONTAINER_ID import openpype.hosts.maya from openpype.tools.utils import host_tools -from openpype.lib import any_outdated +from openpype.lib import ( + any_outdated, + register_event_callback, + emit_event +) from openpype.lib.path_tools import HostDirmap +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) from openpype.hosts.maya.lib import copy_workspace_mel from . import menu, lib @@ -49,13 +57,13 @@ def install(): pyblish.api.register_host("mayapy") pyblish.api.register_host("maya") - avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH) avalon.api.register_plugin_path(avalon.api.InventoryAction, INVENTORY_PATH) log.info(PUBLISH_PATH) log.info("Installing callbacks ... ") - avalon.api.on("init", on_init) + register_event_callback("init", on_init) # Callbacks below are not required for headless mode, the `init` however # is important to load referenced Alembics correctly at rendertime. @@ -69,12 +77,12 @@ def install(): menu.install() - avalon.api.on("save", on_save) - avalon.api.on("open", on_open) - avalon.api.on("new", on_new) - avalon.api.before("save", on_before_save) - avalon.api.on("taskChanged", on_task_changed) - avalon.api.on("before.workfile.save", before_workfile_save) + register_event_callback("save", on_save) + register_event_callback("open", on_open) + register_event_callback("new", on_new) + register_event_callback("before.save", on_before_save) + register_event_callback("taskChanged", on_task_changed) + register_event_callback("workfile.save.before", before_workfile_save) def _set_project(): @@ -137,7 +145,7 @@ def _register_callbacks(): def _on_maya_initialized(*args): - avalon.api.emit("init", args) + emit_event("init") if cmds.about(batch=True): log.warning("Running batch mode ...") @@ -148,15 +156,15 @@ def _on_maya_initialized(*args): def _on_scene_new(*args): - avalon.api.emit("new", args) + emit_event("new") def _on_scene_save(*args): - avalon.api.emit("save", args) + emit_event("save") def _on_scene_open(*args): - avalon.api.emit("open", args) + emit_event("open") def _before_scene_save(return_code, client_data): @@ -166,7 +174,10 @@ def _before_scene_save(return_code, client_data): # in order to block the operation. OpenMaya.MScriptUtil.setBool(return_code, True) - avalon.api.emit("before_save", [return_code, client_data]) + emit_event( + "before.save", + {"return_code": return_code} + ) def uninstall(): @@ -175,8 +186,8 @@ def uninstall(): pyblish.api.deregister_host("mayapy") pyblish.api.deregister_host("maya") - avalon.api.deregister_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.deregister_plugin_path(avalon.api.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.api.deregister_plugin_path(LegacyCreator, CREATE_PATH) avalon.api.deregister_plugin_path( avalon.api.InventoryAction, INVENTORY_PATH ) @@ -184,76 +195,6 @@ def uninstall(): menu.uninstall() -def lock(): - """Lock scene - - Add an invisible node to your Maya scene with the name of the - current file, indicating that this file is "locked" and cannot - be modified any further. - - """ - - if not cmds.objExists("lock"): - with lib.maintained_selection(): - cmds.createNode("objectSet", name="lock") - cmds.addAttr("lock", ln="basename", dataType="string") - - # Permanently hide from outliner - cmds.setAttr("lock.verticesOnlySet", True) - - fname = cmds.file(query=True, sceneName=True) - basename = os.path.basename(fname) - cmds.setAttr("lock.basename", basename, type="string") - - -def unlock(): - """Permanently unlock a locked scene - - Doesn't throw an error if scene is already unlocked. - - """ - - try: - cmds.delete("lock") - except ValueError: - pass - - -def is_locked(): - """Query whether current scene is locked""" - fname = cmds.file(query=True, sceneName=True) - basename = os.path.basename(fname) - - if self._ignore_lock: - return False - - try: - return cmds.getAttr("lock.basename") == basename - except ValueError: - return False - - -@contextlib.contextmanager -def lock_ignored(): - """Context manager for temporarily ignoring the lock of a scene - - The purpose of this function is to enable locking a scene and - saving it with the lock still in place. - - Example: - >>> with lock_ignored(): - ... pass # Do things without lock - - """ - - self._ignore_lock = True - - try: - yield - finally: - self._ignore_lock = False - - def parse_container(container): """Return the container node's full container data. @@ -413,7 +354,7 @@ def containerise(name, return container -def on_init(_): +def on_init(): log.info("Running callback on init..") def safe_deferred(fn): @@ -454,12 +395,12 @@ def on_init(_): safe_deferred(override_toolbox_ui) -def on_before_save(return_code, _): +def on_before_save(): """Run validation for scene's FPS prior to saving""" return lib.validate_fps() -def on_save(_): +def on_save(): """Automatically add IDs to new nodes Any transform of a mesh, without an existing ID, is given one @@ -477,7 +418,7 @@ def on_save(_): lib.set_id(node, new_id, overwrite=False) -def on_open(_): +def on_open(): """On scene open let's assume the containers have changed.""" from Qt import QtWidgets @@ -525,7 +466,7 @@ def on_open(_): dialog.show() -def on_new(_): +def on_new(): """Set project resolution and fps when create a new file""" log.info("Running callback on new..") with lib.suspended_refresh(): @@ -541,7 +482,7 @@ def on_new(_): lib.set_context_settings() -def on_task_changed(*args): +def on_task_changed(): """Wrapped function of app initialize and maya's on task changed""" # Run menu.update_menu_task_label() @@ -579,7 +520,7 @@ def on_task_changed(*args): def before_workfile_save(event): - workdir_path = event.workdir_path + workdir_path = event["workdir_path"] if workdir_path: copy_workspace_mel(workdir_path) diff --git a/openpype/hosts/maya/api/plugin.py b/openpype/hosts/maya/api/plugin.py index bdb8fcf13a..84379bc145 100644 --- a/openpype/hosts/maya/api/plugin.py +++ b/openpype/hosts/maya/api/plugin.py @@ -2,9 +2,14 @@ import os from maya import cmds -from avalon import api -from avalon.vendor import qargparse -from openpype.api import PypeCreatorMixin +import qargparse + +from avalon.pipeline import AVALON_CONTAINER_ID +from openpype.pipeline import ( + LegacyCreator, + LoaderPlugin, + get_representation_path, +) from .pipeline import containerise from . import lib @@ -77,7 +82,7 @@ def get_reference_node_parents(ref): return parents -class Creator(PypeCreatorMixin, api.Creator): +class Creator(LegacyCreator): defaults = ['Main'] def process(self): @@ -93,7 +98,7 @@ class Creator(PypeCreatorMixin, api.Creator): return instance -class Loader(api.Loader): +class Loader(LoaderPlugin): hosts = ["maya"] @@ -168,16 +173,18 @@ class ReferenceLoader(Loader): return ref_node = get_reference_node(nodes, self.log) - loaded_containers.append(containerise( + container = containerise( name=name, namespace=namespace, nodes=[ref_node], context=context, loader=self.__class__.__name__ - )) - + ) + loaded_containers.append(container) + self._organize_containers(nodes, container) c += 1 namespace = None + return loaded_containers def process_reference(self, context, name, namespace, data): @@ -190,7 +197,7 @@ class ReferenceLoader(Loader): node = container["objectName"] - path = api.get_representation_path(representation) + path = get_representation_path(representation) # Get reference node from container members members = get_container_members(node) @@ -243,6 +250,8 @@ class ReferenceLoader(Loader): self.log.warning("Ignoring file read error:\n%s", exc) + self._organize_containers(content, container["objectName"]) + # Reapply alembic settings. if representation["name"] == "abc" and alembic_data: alembic_nodes = cmds.ls( @@ -280,7 +289,6 @@ class ReferenceLoader(Loader): to remove from scene. """ - from maya import cmds node = container["objectName"] @@ -310,3 +318,14 @@ class ReferenceLoader(Loader): deleteNamespaceContent=True) except RuntimeError: pass + + @staticmethod + def _organize_containers(nodes, container): + # type: (list, str) -> None + """Put containers in loaded data to correct hierarchy.""" + for node in nodes: + id_attr = "{}.id".format(node) + if not cmds.attributeQuery("id", node=node, exists=True): + continue + if cmds.getAttr(id_attr) == AVALON_CONTAINER_ID: + cmds.sets(node, forceElement=container) diff --git a/openpype/hosts/maya/api/setdress.py b/openpype/hosts/maya/api/setdress.py index 1a7c3933a1..96a9700b88 100644 --- a/openpype/hosts/maya/api/setdress.py +++ b/openpype/hosts/maya/api/setdress.py @@ -8,7 +8,15 @@ import copy import six from maya import cmds -from avalon import api, io +from avalon import io +from openpype.pipeline import ( + discover_loader_plugins, + loaders_from_representation, + load_container, + update_container, + remove_container, + get_representation_path, +) from openpype.hosts.maya.api.lib import ( matrix_equals, unique_namespace @@ -120,12 +128,13 @@ def load_package(filepath, name, namespace=None): root = "{}:{}".format(namespace, name) containers = [] - all_loaders = api.discover(api.Loader) + all_loaders = discover_loader_plugins() for representation_id, instances in data.items(): # Find the compatible loaders - loaders = api.loaders_from_representation(all_loaders, - representation_id) + loaders = loaders_from_representation( + all_loaders, representation_id + ) for instance in instances: container = _add(instance=instance, @@ -180,9 +189,11 @@ def _add(instance, representation_id, loaders, namespace, root="|"): instance['loader'], instance) raise RuntimeError("Loader is missing.") - container = api.load(Loader, - representation_id, - namespace=instance['namespace']) + container = load_container( + Loader, + representation_id, + namespace=instance['namespace'] + ) # Get the root from the loaded container loaded_root = get_container_transforms({"objectName": container}, @@ -320,13 +331,13 @@ def update_package(set_container, representation): "type": "representation" }) - current_file = api.get_representation_path(current_representation) + current_file = get_representation_path(current_representation) assert current_file.endswith(".json") with open(current_file, "r") as fp: current_data = json.load(fp) # Load the new package data - new_file = api.get_representation_path(representation) + new_file = get_representation_path(representation) assert new_file.endswith(".json") with open(new_file, "r") as fp: new_data = json.load(fp) @@ -460,12 +471,12 @@ def update_scene(set_container, containers, current_data, new_data, new_file): # considered as new element and added afterwards. processed_containers.pop() processed_namespaces.remove(container_ns) - api.remove(container) + remove_container(container) continue # Check whether the conversion can be done by the Loader. # They *must* use the same asset, subset and Loader for - # `api.update` to make sense. + # `update_container` to make sense. old = io.find_one({ "_id": io.ObjectId(representation_current) }) @@ -479,20 +490,21 @@ def update_scene(set_container, containers, current_data, new_data, new_file): continue new_version = new["context"]["version"] - api.update(container, version=new_version) + update_container(container, version=new_version) else: # Remove this container because it's not in the new data log.warning("Removing content: %s", container_ns) - api.remove(container) + remove_container(container) # Add new assets - all_loaders = api.discover(api.Loader) + all_loaders = discover_loader_plugins() for representation_id, instances in new_data.items(): # Find the compatible loaders - loaders = api.loaders_from_representation(all_loaders, - representation_id) + loaders = loaders_from_representation( + all_loaders, representation_id + ) for instance in instances: # Already processed in update functionality @@ -517,7 +529,7 @@ def update_scene(set_container, containers, current_data, new_data, new_file): def compare_representations(old, new): """Check if the old representation given can be updated - Due to limitations of the `api.update` function we cannot allow + Due to limitations of the `update_container` function we cannot allow differences in the following data: * Representation name (extension) diff --git a/openpype/hosts/maya/plugins/create/create_render.py b/openpype/hosts/maya/plugins/create/create_render.py index 97a190d57d..9002ae3876 100644 --- a/openpype/hosts/maya/plugins/create/create_render.py +++ b/openpype/hosts/maya/plugins/create/create_render.py @@ -19,9 +19,9 @@ from openpype.api import ( get_project_settings, get_asset) from openpype.modules import ModulesManager +from openpype.pipeline import CreatorError from avalon.api import Session -from avalon.api import CreatorError class CreateRender(plugin.Creator): @@ -253,7 +253,7 @@ class CreateRender(plugin.Creator): # get pools pool_names = [] - self.server_aliases = self.deadline_servers.keys() + self.server_aliases = list(self.deadline_servers.keys()) self.data["deadlineServers"] = self.server_aliases self.data["suspendPublishJob"] = False self.data["review"] = True @@ -286,15 +286,12 @@ class CreateRender(plugin.Creator): raise RuntimeError("Both Deadline and Muster are enabled") if deadline_enabled: - # if default server is not between selected, use first one for - # initial list of pools. try: deadline_url = self.deadline_servers["default"] except KeyError: - deadline_url = [ - self.deadline_servers[k] - for k in self.deadline_servers.keys() - ][0] + # if 'default' server is not between selected, + # use first one for initial list of pools. + deadline_url = next(iter(self.deadline_servers.values())) pool_names = self._get_deadline_pools(deadline_url) diff --git a/openpype/hosts/maya/plugins/create/create_vrayscene.py b/openpype/hosts/maya/plugins/create/create_vrayscene.py index f2096d902e..fa9c59e016 100644 --- a/openpype/hosts/maya/plugins/create/create_vrayscene.py +++ b/openpype/hosts/maya/plugins/create/create_vrayscene.py @@ -19,10 +19,10 @@ from openpype.api import ( get_project_settings ) +from openpype.pipeline import CreatorError from openpype.modules import ModulesManager from avalon.api import Session -from avalon.api import CreatorError class CreateVRayScene(plugin.Creator): diff --git a/openpype/hosts/maya/plugins/inventory/import_modelrender.py b/openpype/hosts/maya/plugins/inventory/import_modelrender.py index 119edccb7a..c5d3d0c8f4 100644 --- a/openpype/hosts/maya/plugins/inventory/import_modelrender.py +++ b/openpype/hosts/maya/plugins/inventory/import_modelrender.py @@ -1,5 +1,9 @@ import json -from avalon import api, io, pipeline +from avalon import api, io +from openpype.pipeline import ( + get_representation_context, + get_representation_path_from_context, +) from openpype.hosts.maya.api.lib import ( maintained_selection, apply_shaders @@ -73,11 +77,11 @@ class ImportModelRender(api.InventoryAction): "name": self.look_data_type, }) - context = pipeline.get_representation_context(look_repr["_id"]) - maya_file = pipeline.get_representation_path_from_context(context) + context = get_representation_context(look_repr["_id"]) + maya_file = get_representation_path_from_context(context) - context = pipeline.get_representation_context(json_repr["_id"]) - json_file = pipeline.get_representation_path_from_context(context) + context = get_representation_context(json_repr["_id"]) + json_file = get_representation_path_from_context(context) # Import the look file with maintained_selection(): diff --git a/openpype/hosts/maya/plugins/load/actions.py b/openpype/hosts/maya/plugins/load/actions.py index 1cc7ee0c03..483ad32402 100644 --- a/openpype/hosts/maya/plugins/load/actions.py +++ b/openpype/hosts/maya/plugins/load/actions.py @@ -2,14 +2,14 @@ """ -from avalon import api +from openpype.pipeline import load from openpype.hosts.maya.api.lib import ( maintained_selection, unique_namespace ) -class SetFrameRangeLoader(api.Loader): +class SetFrameRangeLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["animation", @@ -43,7 +43,7 @@ class SetFrameRangeLoader(api.Loader): animationEndTime=end) -class SetFrameRangeWithHandlesLoader(api.Loader): +class SetFrameRangeWithHandlesLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["animation", @@ -72,9 +72,8 @@ class SetFrameRangeWithHandlesLoader(api.Loader): return # Include handles - handles = version_data.get("handles", 0) - start -= handles - end += handles + start -= version_data.get("handleStart", 0) + end += version_data.get("handleEnd", 0) cmds.playbackOptions(minTime=start, maxTime=end, @@ -82,7 +81,7 @@ class SetFrameRangeWithHandlesLoader(api.Loader): animationEndTime=end) -class ImportMayaLoader(api.Loader): +class ImportMayaLoader(load.LoaderPlugin): """Import action for Maya (unmanaged) Warning: diff --git a/openpype/hosts/maya/plugins/load/load_ass.py b/openpype/hosts/maya/plugins/load/load_ass.py index 18b34d2233..18de4df3b1 100644 --- a/openpype/hosts/maya/plugins/load/load_ass.py +++ b/openpype/hosts/maya/plugins/load/load_ass.py @@ -1,8 +1,11 @@ import os import clique -from avalon import api from openpype.api import get_project_settings +from openpype.pipeline import ( + load, + get_representation_path +) import openpype.hosts.maya.api.plugin from openpype.hosts.maya.api.plugin import get_reference_node from openpype.hosts.maya.api.lib import ( @@ -106,7 +109,7 @@ class AssProxyLoader(openpype.hosts.maya.api.plugin.ReferenceLoader): node = container["objectName"] representation["context"].pop("frame", None) - path = api.get_representation_path(representation) + path = get_representation_path(representation) print(path) # path = self.fname print(self.fname) @@ -164,7 +167,7 @@ class AssProxyLoader(openpype.hosts.maya.api.plugin.ReferenceLoader): type="string") -class AssStandinLoader(api.Loader): +class AssStandinLoader(load.LoaderPlugin): """Load .ASS file as standin""" families = ["ass"] @@ -240,7 +243,7 @@ class AssStandinLoader(api.Loader): import pymel.core as pm - path = api.get_representation_path(representation) + path = get_representation_path(representation) files_in_path = os.listdir(os.path.split(path)[0]) sequence = 0 diff --git a/openpype/hosts/maya/plugins/load/load_assembly.py b/openpype/hosts/maya/plugins/load/load_assembly.py index 0151da7253..902f38695c 100644 --- a/openpype/hosts/maya/plugins/load/load_assembly.py +++ b/openpype/hosts/maya/plugins/load/load_assembly.py @@ -1,7 +1,10 @@ -from avalon import api +from openpype.pipeline import ( + load, + remove_container +) -class AssemblyLoader(api.Loader): +class AssemblyLoader(load.LoaderPlugin): families = ["assembly"] representations = ["json"] @@ -48,13 +51,11 @@ class AssemblyLoader(api.Loader): def update(self, container, representation): from openpype import setdress - return setdress.update_package(container, - representation) + return setdress.update_package(container, representation) def remove(self, container): """Remove all sub containers""" - from avalon import api from openpype import setdress import maya.cmds as cmds @@ -63,7 +64,7 @@ class AssemblyLoader(api.Loader): for member_container in member_containers: self.log.info("Removing container %s", member_container['objectName']) - api.remove(member_container) + remove_container(member_container) # Remove alembic hierarchy reference # TODO: Check whether removing all contained references is safe enough diff --git a/openpype/hosts/maya/plugins/load/load_audio.py b/openpype/hosts/maya/plugins/load/load_audio.py index 99f1f7c172..d8844ffea6 100644 --- a/openpype/hosts/maya/plugins/load/load_audio.py +++ b/openpype/hosts/maya/plugins/load/load_audio.py @@ -1,10 +1,14 @@ from maya import cmds, mel -from avalon import api, io +from avalon import io +from openpype.pipeline import ( + load, + get_representation_path +) from openpype.hosts.maya.api.pipeline import containerise from openpype.hosts.maya.api.lib import unique_namespace -class AudioLoader(api.Loader): +class AudioLoader(load.LoaderPlugin): """Specific loader of audio.""" families = ["audio"] @@ -51,7 +55,7 @@ class AudioLoader(api.Loader): assert audio_node is not None, "Audio node not found." - path = api.get_representation_path(representation) + path = get_representation_path(representation) audio_node.filename.set(path) cmds.setAttr( container["objectName"] + ".representation", diff --git a/openpype/hosts/maya/plugins/load/load_gpucache.py b/openpype/hosts/maya/plugins/load/load_gpucache.py index 2e0b7bb810..591e568e4c 100644 --- a/openpype/hosts/maya/plugins/load/load_gpucache.py +++ b/openpype/hosts/maya/plugins/load/load_gpucache.py @@ -1,9 +1,13 @@ import os -from avalon import api + +from openpype.pipeline import ( + load, + get_representation_path +) from openpype.api import get_project_settings -class GpuCacheLoader(api.Loader): +class GpuCacheLoader(load.LoaderPlugin): """Load model Alembic as gpuCache""" families = ["model"] @@ -73,7 +77,7 @@ class GpuCacheLoader(api.Loader): import maya.cmds as cmds - path = api.get_representation_path(representation) + path = get_representation_path(representation) # Update the cache members = cmds.sets(container['objectName'], query=True) diff --git a/openpype/hosts/maya/plugins/load/load_image_plane.py b/openpype/hosts/maya/plugins/load/load_image_plane.py index 8e33f51389..b250986489 100644 --- a/openpype/hosts/maya/plugins/load/load_image_plane.py +++ b/openpype/hosts/maya/plugins/load/load_image_plane.py @@ -1,6 +1,10 @@ from Qt import QtWidgets, QtCore -from avalon import api, io +from avalon import io +from openpype.pipeline import ( + load, + get_representation_path +) from openpype.hosts.maya.api.pipeline import containerise from openpype.hosts.maya.api.lib import unique_namespace @@ -74,7 +78,7 @@ class CameraWindow(QtWidgets.QDialog): self.close() -class ImagePlaneLoader(api.Loader): +class ImagePlaneLoader(load.LoaderPlugin): """Specific loader of plate for image planes on selected camera.""" families = ["image", "plate", "render"] @@ -203,7 +207,7 @@ class ImagePlaneLoader(api.Loader): assert image_plane_shape is not None, "Image plane not found." - path = api.get_representation_path(representation) + path = get_representation_path(representation) image_plane_shape.imageName.set(path) cmds.setAttr( container["objectName"] + ".representation", diff --git a/openpype/hosts/maya/plugins/load/load_look.py b/openpype/hosts/maya/plugins/load/load_look.py index 96c1ecbb20..8f02ed59b8 100644 --- a/openpype/hosts/maya/plugins/load/load_look.py +++ b/openpype/hosts/maya/plugins/load/load_look.py @@ -5,7 +5,8 @@ from collections import defaultdict from Qt import QtWidgets -from avalon import api, io +from avalon import io +from openpype.pipeline import get_representation_path import openpype.hosts.maya.api.plugin from openpype.hosts.maya.api import lib from openpype.widgets.message_window import ScrollMessageBox @@ -77,7 +78,7 @@ class LookLoader(openpype.hosts.maya.api.plugin.ReferenceLoader): }) # Load relationships - shader_relation = api.get_representation_path(json_representation) + shader_relation = get_representation_path(json_representation) with open(shader_relation, "r") as f: json_data = json.load(f) diff --git a/openpype/hosts/maya/plugins/load/load_matchmove.py b/openpype/hosts/maya/plugins/load/load_matchmove.py index abc702cde8..ee3332bd09 100644 --- a/openpype/hosts/maya/plugins/load/load_matchmove.py +++ b/openpype/hosts/maya/plugins/load/load_matchmove.py @@ -1,8 +1,8 @@ -from avalon import api from maya import mel +from openpype.pipeline import load -class MatchmoveLoader(api.Loader): +class MatchmoveLoader(load.LoaderPlugin): """ This will run matchmove script to create track in scene. diff --git a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py index fd2ae0f1d3..d93a9f02a2 100644 --- a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py @@ -5,8 +5,11 @@ import clique import maya.cmds as cmds -from avalon import api from openpype.api import get_project_settings +from openpype.pipeline import ( + load, + get_representation_path +) from openpype.hosts.maya.api.lib import ( namespaced, maintained_selection, @@ -15,7 +18,7 @@ from openpype.hosts.maya.api.lib import ( from openpype.hosts.maya.api.pipeline import containerise -class RedshiftProxyLoader(api.Loader): +class RedshiftProxyLoader(load.LoaderPlugin): """Load Redshift proxy""" families = ["redshiftproxy"] @@ -78,7 +81,7 @@ class RedshiftProxyLoader(api.Loader): rs_meshes = cmds.ls(members, type="RedshiftProxyMesh") assert rs_meshes, "Cannot find RedshiftProxyMesh in container" - filename = api.get_representation_path(representation) + filename = get_representation_path(representation) for rs_mesh in rs_meshes: cmds.setAttr("{}.fileName".format(rs_mesh), diff --git a/openpype/hosts/maya/plugins/load/load_reference.py b/openpype/hosts/maya/plugins/load/load_reference.py index 0565b0b95c..04a25f6493 100644 --- a/openpype/hosts/maya/plugins/load/load_reference.py +++ b/openpype/hosts/maya/plugins/load/load_reference.py @@ -1,8 +1,10 @@ import os from maya import cmds from avalon import api + from openpype.api import get_project_settings from openpype.lib import get_creator_by_name +from openpype.pipeline import legacy_create import openpype.hosts.maya.api.plugin from openpype.hosts.maya.api.lib import maintained_selection @@ -119,10 +121,8 @@ class ReferenceLoader(openpype.hosts.maya.api.plugin.ReferenceLoader): if family == "rig": self._post_process_rig(name, namespace, context, options) else: - if "translate" in options: cmds.setAttr(group_name + ".t", *options["translate"]) - return new_nodes def switch(self, container, representation): @@ -151,7 +151,7 @@ class ReferenceLoader(openpype.hosts.maya.api.plugin.ReferenceLoader): creator_plugin = get_creator_by_name(self.animation_creator_name) with maintained_selection(): cmds.select([output, controls] + roots, noExpand=True) - api.create( + legacy_create( creator_plugin, name=namespace, asset=asset, diff --git a/openpype/hosts/maya/plugins/load/load_rendersetup.py b/openpype/hosts/maya/plugins/load/load_rendersetup.py index efeff2f193..7a2d8b1002 100644 --- a/openpype/hosts/maya/plugins/load/load_rendersetup.py +++ b/openpype/hosts/maya/plugins/load/load_rendersetup.py @@ -7,10 +7,13 @@ instance. """ import json -import six import sys +import six -from avalon import api +from openpype.pipeline import ( + load, + get_representation_path +) from openpype.hosts.maya.api import lib from openpype.hosts.maya.api.pipeline import containerise @@ -18,7 +21,7 @@ from maya import cmds import maya.app.renderSetup.model.renderSetup as renderSetup -class RenderSetupLoader(api.Loader): +class RenderSetupLoader(load.LoaderPlugin): """Load json preset for RenderSetup overwriting current one.""" families = ["rendersetup"] @@ -87,7 +90,7 @@ class RenderSetupLoader(api.Loader): "Render setup setting will be overwritten by new version. All " "setting specified by user not included in loaded version " "will be lost.") - path = api.get_representation_path(representation) + path = get_representation_path(representation) with open(path, "r") as file: try: renderSetup.instance().decode( diff --git a/openpype/hosts/maya/plugins/load/load_vdb_to_redshift.py b/openpype/hosts/maya/plugins/load/load_vdb_to_redshift.py index 3e1d67ae9a..70bd9d22e2 100644 --- a/openpype/hosts/maya/plugins/load/load_vdb_to_redshift.py +++ b/openpype/hosts/maya/plugins/load/load_vdb_to_redshift.py @@ -1,9 +1,10 @@ import os -from avalon import api + from openpype.api import get_project_settings +from openpype.pipeline import load -class LoadVDBtoRedShift(api.Loader): +class LoadVDBtoRedShift(load.LoaderPlugin): """Load OpenVDB in a Redshift Volume Shape""" families = ["vdbcache"] diff --git a/openpype/hosts/maya/plugins/load/load_vdb_to_vray.py b/openpype/hosts/maya/plugins/load/load_vdb_to_vray.py index 099c020093..4f14235bfb 100644 --- a/openpype/hosts/maya/plugins/load/load_vdb_to_vray.py +++ b/openpype/hosts/maya/plugins/load/load_vdb_to_vray.py @@ -1,6 +1,10 @@ import os -from avalon import api + from openpype.api import get_project_settings +from openpype.pipeline import ( + load, + get_representation_path +) from maya import cmds @@ -69,7 +73,7 @@ def _fix_duplicate_vvg_callbacks(): matched.add(callback) -class LoadVDBtoVRay(api.Loader): +class LoadVDBtoVRay(load.LoaderPlugin): families = ["vdbcache"] representations = ["vdb"] @@ -174,7 +178,7 @@ class LoadVDBtoVRay(api.Loader): fname = files[0] else: # Sequence - from avalon.vendor import clique + import clique # todo: check support for negative frames as input collections, remainder = clique.assemble(files) assert len(collections) == 1, ( @@ -252,7 +256,7 @@ class LoadVDBtoVRay(api.Loader): def update(self, container, representation): - path = api.get_representation_path(representation) + path = get_representation_path(representation) # Find VRayVolumeGrid members = cmds.sets(container['objectName'], query=True) diff --git a/openpype/hosts/maya/plugins/load/load_vrayproxy.py b/openpype/hosts/maya/plugins/load/load_vrayproxy.py index ac2fe635b3..5b79b1efb3 100644 --- a/openpype/hosts/maya/plugins/load/load_vrayproxy.py +++ b/openpype/hosts/maya/plugins/load/load_vrayproxy.py @@ -9,8 +9,12 @@ import os import maya.cmds as cmds -from avalon import api, io +from avalon import io from openpype.api import get_project_settings +from openpype.pipeline import ( + load, + get_representation_path +) from openpype.hosts.maya.api.lib import ( maintained_selection, namespaced, @@ -19,7 +23,7 @@ from openpype.hosts.maya.api.lib import ( from openpype.hosts.maya.api.pipeline import containerise -class VRayProxyLoader(api.Loader): +class VRayProxyLoader(load.LoaderPlugin): """Load VRay Proxy with Alembic or VrayMesh.""" families = ["vrayproxy", "model", "pointcache", "animation"] @@ -100,7 +104,10 @@ class VRayProxyLoader(api.Loader): assert vraymeshes, "Cannot find VRayMesh in container" # get all representations for this version - filename = self._get_abc(representation["parent"]) or api.get_representation_path(representation) # noqa: E501 + filename = ( + self._get_abc(representation["parent"]) + or get_representation_path(representation) + ) for vray_mesh in vraymeshes: cmds.setAttr("{}.fileName".format(vray_mesh), @@ -185,7 +192,7 @@ class VRayProxyLoader(api.Loader): if abc_rep: self.log.debug("Found, we'll link alembic to vray proxy.") - file_name = api.get_representation_path(abc_rep) + file_name = get_representation_path(abc_rep) self.log.debug("File: {}".format(self.fname)) return file_name diff --git a/openpype/hosts/maya/plugins/load/load_vrayscene.py b/openpype/hosts/maya/plugins/load/load_vrayscene.py index 2e85514938..61132088cc 100644 --- a/openpype/hosts/maya/plugins/load/load_vrayscene.py +++ b/openpype/hosts/maya/plugins/load/load_vrayscene.py @@ -1,7 +1,11 @@ +# -*- coding: utf-8 -*- import os -import maya.cmds as cmds -from avalon import api +import maya.cmds as cmds # noqa from openpype.api import get_project_settings +from openpype.pipeline import ( + load, + get_representation_path +) from openpype.hosts.maya.api.lib import ( maintained_selection, namespaced, @@ -10,7 +14,7 @@ from openpype.hosts.maya.api.lib import ( from openpype.hosts.maya.api.pipeline import containerise -class VRaySceneLoader(api.Loader): +class VRaySceneLoader(load.LoaderPlugin): """Load Vray scene""" families = ["vrayscene_layer"] @@ -42,20 +46,20 @@ class VRaySceneLoader(api.Loader): with maintained_selection(): cmds.namespace(addNamespace=namespace) with namespaced(namespace, new=False): - nodes, group_node = self.create_vray_scene(name, - filename=self.fname) + nodes, root_node = self.create_vray_scene(name, + filename=self.fname) self[:] = nodes if not nodes: return # colour the group node - presets = get_project_settings(os.environ['AVALON_PROJECT']) - colors = presets['maya']['load']['colors'] + settings = get_project_settings(os.environ['AVALON_PROJECT']) + colors = settings['maya']['load']['colors'] c = colors.get(family) if c is not None: - cmds.setAttr("{0}.useOutlinerColor".format(group_node), 1) - cmds.setAttr("{0}.outlinerColor".format(group_node), + cmds.setAttr("{0}.useOutlinerColor".format(root_node), 1) + cmds.setAttr("{0}.outlinerColor".format(root_node), (float(c[0])/255), (float(c[1])/255), (float(c[2])/255) @@ -77,7 +81,7 @@ class VRaySceneLoader(api.Loader): vraymeshes = cmds.ls(members, type="VRayScene") assert vraymeshes, "Cannot find VRayScene in container" - filename = api.get_representation_path(representation) + filename = get_representation_path(representation) for vray_mesh in vraymeshes: cmds.setAttr("{}.FilePath".format(vray_mesh), @@ -123,17 +127,21 @@ class VRaySceneLoader(api.Loader): mesh_node_name = "VRayScene_{}".format(name) trans = cmds.createNode( - "transform", name="{}".format(mesh_node_name)) - mesh = cmds.createNode( - "mesh", name="{}_Shape".format(mesh_node_name), parent=trans) + "transform", name=mesh_node_name) vray_scene = cmds.createNode( "VRayScene", name="{}_VRSCN".format(mesh_node_name), parent=trans) + mesh = cmds.createNode( + "mesh", name="{}_Shape".format(mesh_node_name), parent=trans) cmds.connectAttr( "{}.outMesh".format(vray_scene), "{}.inMesh".format(mesh)) cmds.setAttr("{}.FilePath".format(vray_scene), filename, type="string") + # Lock the shape nodes so the user cannot delete these + cmds.lockNode(mesh, lock=True) + cmds.lockNode(vray_scene, lock=True) + # Create important connections cmds.connectAttr("time1.outTime", "{0}.inputTime".format(trans)) @@ -141,11 +149,9 @@ class VRaySceneLoader(api.Loader): # Connect mesh to initialShadingGroup cmds.sets([mesh], forceElement="initialShadingGroup") - group_node = cmds.group(empty=True, name="{}_GRP".format(name)) - cmds.parent(trans, group_node) - nodes = [trans, vray_scene, mesh, group_node] + nodes = [trans, vray_scene, mesh] # Fix: Force refresh so the mesh shows correctly after creation cmds.refresh() - return nodes, group_node + return nodes, trans diff --git a/openpype/hosts/maya/plugins/load/load_yeti_cache.py b/openpype/hosts/maya/plugins/load/load_yeti_cache.py index dfe75173ac..c64e1c540b 100644 --- a/openpype/hosts/maya/plugins/load/load_yeti_cache.py +++ b/openpype/hosts/maya/plugins/load/load_yeti_cache.py @@ -7,13 +7,17 @@ from pprint import pprint from maya import cmds -from avalon import api, io +from avalon import io from openpype.api import get_project_settings +from openpype.pipeline import ( + load, + get_representation_path +) from openpype.hosts.maya.api import lib from openpype.hosts.maya.api.pipeline import containerise -class YetiCacheLoader(api.Loader): +class YetiCacheLoader(load.LoaderPlugin): families = ["yeticache", "yetiRig"] representations = ["fur"] @@ -121,8 +125,8 @@ class YetiCacheLoader(api.Loader): "cannot find fursettings representation" ) - settings_fname = api.get_representation_path(fur_settings) - path = api.get_representation_path(representation) + settings_fname = get_representation_path(fur_settings) + path = get_representation_path(representation) # Get all node data with open(settings_fname, "r") as fp: settings = json.load(fp) diff --git a/openpype/hosts/maya/plugins/publish/collect_look.py b/openpype/hosts/maya/plugins/publish/collect_look.py index d39750e917..b6a76f1e21 100644 --- a/openpype/hosts/maya/plugins/publish/collect_look.py +++ b/openpype/hosts/maya/plugins/publish/collect_look.py @@ -320,7 +320,7 @@ class CollectLook(pyblish.api.InstancePlugin): # Collect file nodes used by shading engines (if we have any) files = [] - look_sets = sets.keys() + look_sets = list(sets.keys()) shader_attrs = [ "surfaceShader", "volumeShader", diff --git a/openpype/hosts/maya/plugins/publish/collect_render.py b/openpype/hosts/maya/plugins/publish/collect_render.py index 13ae1924b9..a525b562f3 100644 --- a/openpype/hosts/maya/plugins/publish/collect_render.py +++ b/openpype/hosts/maya/plugins/publish/collect_render.py @@ -50,6 +50,7 @@ import maya.app.renderSetup.model.renderSetup as renderSetup import pyblish.api from avalon import api +from openpype.lib import get_formatted_current_time from openpype.hosts.maya.api.lib_renderproducts import get as get_layer_render_products # noqa: E501 from openpype.hosts.maya.api import lib @@ -234,13 +235,14 @@ class CollectMayaRender(pyblish.api.ContextPlugin): publish_meta_path = None for aov in exp_files: full_paths = [] - for file in aov[aov.keys()[0]]: + aov_first_key = list(aov.keys())[0] + for file in aov[aov_first_key]: full_path = os.path.join(workspace, default_render_file, file) full_path = full_path.replace("\\", "/") full_paths.append(full_path) publish_meta_path = os.path.dirname(full_path) - aov_dict[aov.keys()[0]] = full_paths + aov_dict[aov_first_key] = full_paths frame_start_render = int(self.get_render_attribute( "startFrame", layer=layer_name)) @@ -327,7 +329,7 @@ class CollectMayaRender(pyblish.api.ContextPlugin): "family": "renderlayer", "families": ["renderlayer"], "asset": asset, - "time": api.time(), + "time": get_formatted_current_time(), "author": context.data["user"], # Add source to allow tracing back to the scene from # which was submitted originally diff --git a/openpype/hosts/maya/plugins/publish/collect_vrayscene.py b/openpype/hosts/maya/plugins/publish/collect_vrayscene.py index c1e5d388af..327fc836dc 100644 --- a/openpype/hosts/maya/plugins/publish/collect_vrayscene.py +++ b/openpype/hosts/maya/plugins/publish/collect_vrayscene.py @@ -7,6 +7,7 @@ from maya import cmds import pyblish.api from avalon import api +from openpype.lib import get_formatted_current_time from openpype.hosts.maya.api import lib @@ -117,7 +118,7 @@ class CollectVrayScene(pyblish.api.InstancePlugin): "family": "vrayscene_layer", "families": ["vrayscene_layer"], "asset": api.Session["AVALON_ASSET"], - "time": api.time(), + "time": get_formatted_current_time(), "author": context.data["user"], # Add source to allow tracing back to the scene from # which was submitted originally diff --git a/openpype/hosts/maya/plugins/publish/extract_animation.py b/openpype/hosts/maya/plugins/publish/extract_animation.py index 269972d996..8a8bd67cd8 100644 --- a/openpype/hosts/maya/plugins/publish/extract_animation.py +++ b/openpype/hosts/maya/plugins/publish/extract_animation.py @@ -38,12 +38,8 @@ class ExtractAnimation(openpype.api.Extractor): fullPath=True) or [] # Collect the start and end including handles - start = instance.data["frameStart"] - end = instance.data["frameEnd"] - handles = instance.data.get("handles", 0) or 0 - if handles: - start -= handles - end += handles + start = instance.data["frameStartHandle"] + end = instance.data["frameEndHandle"] self.log.info("Extracting animation..") dirname = self.staging_dir(instance) diff --git a/openpype/hosts/maya/plugins/publish/extract_ass.py b/openpype/hosts/maya/plugins/publish/extract_ass.py index ab149de700..760f410f91 100644 --- a/openpype/hosts/maya/plugins/publish/extract_ass.py +++ b/openpype/hosts/maya/plugins/publish/extract_ass.py @@ -38,13 +38,9 @@ class ExtractAssStandin(openpype.api.Extractor): self.log.info("Extracting ass sequence") # Collect the start and end including handles - start = instance.data.get("frameStart", 1) - end = instance.data.get("frameEnd", 1) - handles = instance.data.get("handles", 0) + start = instance.data.get("frameStartHandle", 1) + end = instance.data.get("frameEndHandle", 1) step = instance.data.get("step", 0) - if handles: - start -= handles - end += handles exported_files = cmds.arnoldExportAss(filename=file_path, selected=True, diff --git a/openpype/hosts/maya/plugins/publish/extract_camera_alembic.py b/openpype/hosts/maya/plugins/publish/extract_camera_alembic.py index 806a079940..5ad6b79d5c 100644 --- a/openpype/hosts/maya/plugins/publish/extract_camera_alembic.py +++ b/openpype/hosts/maya/plugins/publish/extract_camera_alembic.py @@ -21,17 +21,9 @@ class ExtractCameraAlembic(openpype.api.Extractor): def process(self, instance): - # get settings - framerange = [instance.data.get("frameStart", 1), - instance.data.get("frameEnd", 1)] - handle_start = instance.data.get("handleStart", 0) - handle_end = instance.data.get("handleEnd", 0) - - # TODO: deprecated attribute "handles" - - if handle_start is None: - handle_start = instance.data.get("handles", 0) - handle_end = instance.data.get("handles", 0) + # Collect the start and end including handles + start = instance.data["frameStartHandle"] + end = instance.data["frameEndHandle"] step = instance.data.get("step", 1.0) bake_to_worldspace = instance.data("bakeToWorldSpace", True) @@ -61,10 +53,7 @@ class ExtractCameraAlembic(openpype.api.Extractor): job_str = ' -selection -dataFormat "ogawa" ' job_str += ' -attrPrefix cb' - job_str += ' -frameRange {0} {1} '.format(framerange[0] - - handle_start, - framerange[1] - + handle_end) + job_str += ' -frameRange {0} {1} '.format(start, end) job_str += ' -step {0} '.format(step) if bake_to_worldspace: diff --git a/openpype/hosts/maya/plugins/publish/extract_camera_mayaScene.py b/openpype/hosts/maya/plugins/publish/extract_camera_mayaScene.py index 9d25b147de..49c156f9cd 100644 --- a/openpype/hosts/maya/plugins/publish/extract_camera_mayaScene.py +++ b/openpype/hosts/maya/plugins/publish/extract_camera_mayaScene.py @@ -43,7 +43,8 @@ def grouper(iterable, n, fillvalue=None): """ args = [iter(iterable)] * n - return itertools.izip_longest(fillvalue=fillvalue, *args) + from six.moves import zip_longest + return zip_longest(fillvalue=fillvalue, *args) def unlock(plug): @@ -117,19 +118,9 @@ class ExtractCameraMayaScene(openpype.api.Extractor): # no preset found pass - framerange = [instance.data.get("frameStart", 1), - instance.data.get("frameEnd", 1)] - handle_start = instance.data.get("handleStart", 0) - handle_end = instance.data.get("handleEnd", 0) - - # TODO: deprecated attribute "handles" - - if handle_start is None: - handle_start = instance.data.get("handles", 0) - handle_end = instance.data.get("handles", 0) - - range_with_handles = [framerange[0] - handle_start, - framerange[1] + handle_end] + # Collect the start and end including handles + start = instance.data["frameStartHandle"] + end = instance.data["frameEndHandle"] step = instance.data.get("step", 1.0) bake_to_worldspace = instance.data("bakeToWorldSpace", True) @@ -164,7 +155,7 @@ class ExtractCameraMayaScene(openpype.api.Extractor): "Performing camera bakes: {}".format(transform)) baked = lib.bake_to_world_space( transform, - frame_range=range_with_handles, + frame_range=[start, end], step=step ) baked_shapes = cmds.ls(baked, diff --git a/openpype/hosts/maya/plugins/publish/extract_fbx.py b/openpype/hosts/maya/plugins/publish/extract_fbx.py index 844084b9ab..a2adcb3091 100644 --- a/openpype/hosts/maya/plugins/publish/extract_fbx.py +++ b/openpype/hosts/maya/plugins/publish/extract_fbx.py @@ -168,12 +168,8 @@ class ExtractFBX(openpype.api.Extractor): self.log.info("Export options: {0}".format(options)) # Collect the start and end including handles - start = instance.data["frameStart"] - end = instance.data["frameEnd"] - handles = instance.data.get("handles", 0) - if handles: - start -= handles - end += handles + start = instance.data["frameStartHandle"] + end = instance.data["frameEndHandle"] options['bakeComplexStart'] = start options['bakeComplexEnd'] = end diff --git a/openpype/hosts/maya/plugins/publish/extract_look.py b/openpype/hosts/maya/plugins/publish/extract_look.py index fe89038a24..a8893072d0 100644 --- a/openpype/hosts/maya/plugins/publish/extract_look.py +++ b/openpype/hosts/maya/plugins/publish/extract_look.py @@ -62,6 +62,7 @@ def maketx(source, destination, *args): from openpype.lib import get_oiio_tools_path maketx_path = get_oiio_tools_path("maketx") + if not os.path.exists(maketx_path): print( "OIIO tool not found in {}".format(maketx_path)) @@ -216,7 +217,7 @@ class ExtractLook(openpype.api.Extractor): self.log.info("Extract sets (%s) ..." % _scene_type) lookdata = instance.data["lookData"] relationships = lookdata["relationships"] - sets = relationships.keys() + sets = list(relationships.keys()) if not sets: self.log.info("No sets found") return diff --git a/openpype/hosts/maya/plugins/publish/extract_maya_scene_raw.py b/openpype/hosts/maya/plugins/publish/extract_maya_scene_raw.py index 9c432cbc67..389995d30c 100644 --- a/openpype/hosts/maya/plugins/publish/extract_maya_scene_raw.py +++ b/openpype/hosts/maya/plugins/publish/extract_maya_scene_raw.py @@ -6,6 +6,7 @@ from maya import cmds import openpype.api from openpype.hosts.maya.api.lib import maintained_selection +from avalon.pipeline import AVALON_CONTAINER_ID class ExtractMayaSceneRaw(openpype.api.Extractor): @@ -57,10 +58,16 @@ class ExtractMayaSceneRaw(openpype.api.Extractor): else: members = instance[:] + selection = members + if set(self.add_for_families).intersection( + set(instance.data.get("families", []))) or \ + instance.data.get("family") in self.add_for_families: + selection += self._get_loaded_containers(members) + # Perform extraction self.log.info("Performing extraction ...") with maintained_selection(): - cmds.select(members, noExpand=True) + cmds.select(selection, noExpand=True) cmds.file(path, force=True, typ="mayaAscii" if self.scene_type == "ma" else "mayaBinary", # noqa: E501 @@ -83,3 +90,33 @@ class ExtractMayaSceneRaw(openpype.api.Extractor): instance.data["representations"].append(representation) self.log.info("Extracted instance '%s' to: %s" % (instance.name, path)) + + @staticmethod + def _get_loaded_containers(members): + # type: (list) -> list + refs_to_include = { + cmds.referenceQuery(node, referenceNode=True) + for node in members + if cmds.referenceQuery(node, isNodeReferenced=True) + } + + members_with_refs = refs_to_include.union(members) + + obj_sets = cmds.ls("*.id", long=True, type="objectSet", recursive=True, + objectsOnly=True) + + loaded_containers = [] + for obj_set in obj_sets: + + if not cmds.attributeQuery("id", node=obj_set, exists=True): + continue + + id_attr = "{}.id".format(obj_set) + if cmds.getAttr(id_attr) != AVALON_CONTAINER_ID: + continue + + set_content = set(cmds.sets(obj_set, query=True)) + if set_content.intersection(members_with_refs): + loaded_containers.append(obj_set) + + return loaded_containers diff --git a/openpype/hosts/maya/plugins/publish/extract_vrayproxy.py b/openpype/hosts/maya/plugins/publish/extract_vrayproxy.py index 615bc27878..562ca078e1 100644 --- a/openpype/hosts/maya/plugins/publish/extract_vrayproxy.py +++ b/openpype/hosts/maya/plugins/publish/extract_vrayproxy.py @@ -28,14 +28,19 @@ class ExtractVRayProxy(openpype.api.Extractor): if not anim_on: # Remove animation information because it is not required for # non-animated subsets - instance.data.pop("frameStart", None) - instance.data.pop("frameEnd", None) + keys = ["frameStart", "frameEnd", + "handleStart", "handleEnd", + "frameStartHandle", "frameEndHandle", + # Backwards compatibility + "handles"] + for key in keys: + instance.data.pop(key, None) start_frame = 1 end_frame = 1 else: - start_frame = instance.data["frameStart"] - end_frame = instance.data["frameEnd"] + start_frame = instance.data["frameStartHandle"] + end_frame = instance.data["frameEndHandle"] vertex_colors = instance.data.get("vertexColors", False) diff --git a/openpype/hosts/maya/plugins/publish/extract_yeti_cache.py b/openpype/hosts/maya/plugins/publish/extract_yeti_cache.py index 05fe79ecc5..0d85708789 100644 --- a/openpype/hosts/maya/plugins/publish/extract_yeti_cache.py +++ b/openpype/hosts/maya/plugins/publish/extract_yeti_cache.py @@ -29,8 +29,8 @@ class ExtractYetiCache(openpype.api.Extractor): data_file = os.path.join(dirname, "yeti.fursettings") # Collect information for writing cache - start_frame = instance.data.get("frameStart") - end_frame = instance.data.get("frameEnd") + start_frame = instance.data.get("frameStartHandle") + end_frame = instance.data.get("frameEndHandle") preroll = instance.data.get("preroll") if preroll > 0: start_frame -= preroll diff --git a/openpype/hosts/maya/plugins/publish/validate_ass_relative_paths.py b/openpype/hosts/maya/plugins/publish/validate_ass_relative_paths.py index 3625d4ab32..5fb9bd98b1 100644 --- a/openpype/hosts/maya/plugins/publish/validate_ass_relative_paths.py +++ b/openpype/hosts/maya/plugins/publish/validate_ass_relative_paths.py @@ -110,9 +110,9 @@ class ValidateAssRelativePaths(pyblish.api.InstancePlugin): Maya API will return a list of values, which need to be properly handled to evaluate properly. """ - if isinstance(attr_val, types.BooleanType): + if isinstance(attr_val, bool): return attr_val - elif isinstance(attr_val, (types.ListType, types.GeneratorType)): + elif isinstance(attr_val, (list, types.GeneratorType)): return any(attr_val) else: return bool(attr_val) diff --git a/openpype/hosts/maya/plugins/publish/validate_mesh_overlapping_uvs.py b/openpype/hosts/maya/plugins/publish/validate_mesh_overlapping_uvs.py index 5ce422239d..bf95d8ba09 100644 --- a/openpype/hosts/maya/plugins/publish/validate_mesh_overlapping_uvs.py +++ b/openpype/hosts/maya/plugins/publish/validate_mesh_overlapping_uvs.py @@ -5,6 +5,8 @@ import math import maya.api.OpenMaya as om import pymel.core as pm +from six.moves import xrange + class GetOverlappingUVs(object): diff --git a/openpype/hosts/maya/plugins/publish/validate_vray_referenced_aovs.py b/openpype/hosts/maya/plugins/publish/validate_vray_referenced_aovs.py index 6cfbd4049b..7a48c29b7d 100644 --- a/openpype/hosts/maya/plugins/publish/validate_vray_referenced_aovs.py +++ b/openpype/hosts/maya/plugins/publish/validate_vray_referenced_aovs.py @@ -82,9 +82,9 @@ class ValidateVrayReferencedAOVs(pyblish.api.InstancePlugin): bool: cast Maya attribute to Pythons boolean value. """ - if isinstance(attr_val, types.BooleanType): + if isinstance(attr_val, bool): return attr_val - elif isinstance(attr_val, (types.ListType, types.GeneratorType)): + elif isinstance(attr_val, (list, types.GeneratorType)): return any(attr_val) else: return bool(attr_val) diff --git a/openpype/hosts/nuke/api/lib.py b/openpype/hosts/nuke/api/lib.py index 6faf6cd108..dba7ec1b85 100644 --- a/openpype/hosts/nuke/api/lib.py +++ b/openpype/hosts/nuke/api/lib.py @@ -1,6 +1,5 @@ import os import re -import sys import six import platform import contextlib @@ -679,10 +678,10 @@ def get_render_path(node): } nuke_imageio_writes = get_created_node_imageio_setting(**data_preset) + host_name = os.environ.get("AVALON_APP") - application = lib.get_application(os.environ["AVALON_APP_NAME"]) data.update({ - "application": application, + "app": host_name, "nuke_imageio_writes": nuke_imageio_writes }) @@ -805,18 +804,14 @@ def create_write_node(name, data, input=None, prenodes=None, ''' imageio_writes = get_created_node_imageio_setting(**data) - app_manager = ApplicationManager() - app_name = os.environ.get("AVALON_APP_NAME") - if app_name: - app = app_manager.applications.get(app_name) - for knob in imageio_writes["knobs"]: if knob["name"] == "file_type": representation = knob["value"] + host_name = os.environ.get("AVALON_APP") try: data.update({ - "app": app.host_name, + "app": host_name, "imageio_writes": imageio_writes, "representation": representation, }) diff --git a/openpype/hosts/nuke/api/pipeline.py b/openpype/hosts/nuke/api/pipeline.py index 8c6c9ca55b..fd2e16b8d3 100644 --- a/openpype/hosts/nuke/api/pipeline.py +++ b/openpype/hosts/nuke/api/pipeline.py @@ -14,6 +14,12 @@ from openpype.api import ( BuildWorkfile, get_current_project_settings ) +from openpype.lib import register_event_callback +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) from openpype.tools.utils import host_tools from .command import viewer_update_and_undo_stop @@ -97,13 +103,13 @@ def install(): log.info("Registering Nuke plug-ins..") pyblish.api.register_plugin_path(PUBLISH_PATH) - avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH) avalon.api.register_plugin_path(avalon.api.InventoryAction, INVENTORY_PATH) # Register Avalon event for workfiles loading. - avalon.api.on("workio.open_file", check_inventory_versions) - avalon.api.on("taskChanged", change_context_label) + register_event_callback("workio.open_file", check_inventory_versions) + register_event_callback("taskChanged", change_context_label) pyblish.api.register_callback( "instanceToggled", on_pyblish_instance_toggled) @@ -123,8 +129,8 @@ def uninstall(): log.info("Deregistering Nuke plug-ins..") pyblish.deregister_host("nuke") pyblish.api.deregister_plugin_path(PUBLISH_PATH) - avalon.api.deregister_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.deregister_plugin_path(avalon.api.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.api.deregister_plugin_path(LegacyCreator, CREATE_PATH) pyblish.api.deregister_callback( "instanceToggled", on_pyblish_instance_toggled) @@ -226,7 +232,7 @@ def _uninstall_menu(): menu.removeItem(item.name()) -def change_context_label(*args): +def change_context_label(): menubar = nuke.menu("Nuke") menu = menubar.findItem(MENU_LABEL) diff --git a/openpype/hosts/nuke/api/plugin.py b/openpype/hosts/nuke/api/plugin.py index fd754203d4..d0bb45a05d 100644 --- a/openpype/hosts/nuke/api/plugin.py +++ b/openpype/hosts/nuke/api/plugin.py @@ -4,11 +4,10 @@ import string import nuke -import avalon.api - -from openpype.api import ( - get_current_project_settings, - PypeCreatorMixin +from openpype.api import get_current_project_settings +from openpype.pipeline import ( + LegacyCreator, + LoaderPlugin, ) from .lib import ( Knobby, @@ -20,7 +19,7 @@ from .lib import ( ) -class OpenPypeCreator(PypeCreatorMixin, avalon.api.Creator): +class OpenPypeCreator(LegacyCreator): """Pype Nuke Creator class wrapper""" node_color = "0xdfea5dff" @@ -87,7 +86,7 @@ def get_review_presets_config(): return [str(name) for name, _prop in outputs.items()] -class NukeLoader(avalon.api.Loader): +class NukeLoader(LoaderPlugin): container_id_knob = "containerId" container_id = None @@ -152,6 +151,7 @@ class ExporterReview(object): """ data = None + publish_on_farm = False def __init__(self, klass, @@ -210,6 +210,9 @@ class ExporterReview(object): if self.multiple_presets: repre["outputName"] = self.name + if self.publish_on_farm: + repre["tags"].append("publish_on_farm") + self.data["representations"].append(repre) def get_view_input_process_node(self): @@ -446,6 +449,9 @@ class ExporterReviewMov(ExporterReview): return path def generate_mov(self, farm=False, **kwargs): + self.publish_on_farm = farm + reformat_node_add = kwargs["reformat_node_add"] + reformat_node_config = kwargs["reformat_node_config"] bake_viewer_process = kwargs["bake_viewer_process"] bake_viewer_input_process_node = kwargs[ "bake_viewer_input_process"] @@ -483,6 +489,30 @@ class ExporterReviewMov(ExporterReview): self.previous_node = r_node self.log.debug("Read... `{}`".format(self._temp_nodes[subset])) + # add reformat node + if reformat_node_add: + # append reformated tag + add_tags.append("reformated") + + rf_node = nuke.createNode("Reformat") + for kn_conf in reformat_node_config: + _type = kn_conf["type"] + k_name = str(kn_conf["name"]) + k_value = kn_conf["value"] + + # to remove unicode as nuke doesn't like it + if _type == "string": + k_value = str(kn_conf["value"]) + + rf_node[k_name].setValue(k_value) + + # connect + rf_node.setInput(0, self.previous_node) + self._temp_nodes[subset].append(rf_node) + self.previous_node = rf_node + self.log.debug( + "Reformat... `{}`".format(self._temp_nodes[subset])) + # only create colorspace baking if toggled on if bake_viewer_process: if bake_viewer_input_process_node: @@ -537,7 +567,7 @@ class ExporterReviewMov(ExporterReview): # ---------- end nodes creation # ---------- render or save to nk - if farm: + if self.publish_on_farm: nuke.scriptSave() path_nk = self.save_file() self.data.update({ @@ -547,11 +577,12 @@ class ExporterReviewMov(ExporterReview): }) else: self.render(write_node.name()) - # ---------- generate representation data - self.get_representation_data( - tags=["review", "delete"] + add_tags, - range=True - ) + + # ---------- generate representation data + self.get_representation_data( + tags=["review", "delete"] + add_tags, + range=True + ) self.log.debug("Representation... `{}`".format(self.data)) diff --git a/openpype/hosts/nuke/plugins/inventory/repair_old_loaders.py b/openpype/hosts/nuke/plugins/inventory/repair_old_loaders.py index 49405fd213..5f834be557 100644 --- a/openpype/hosts/nuke/plugins/inventory/repair_old_loaders.py +++ b/openpype/hosts/nuke/plugins/inventory/repair_old_loaders.py @@ -1,4 +1,4 @@ -from avalon import api, style +from avalon import api from openpype.api import Logger from openpype.hosts.nuke.api.lib import set_avalon_knob_data @@ -7,7 +7,7 @@ class RepairOldLoaders(api.InventoryAction): label = "Repair Old Loaders" icon = "gears" - color = style.colors.alert + color = "#cc0000" log = Logger.get_logger(__name__) diff --git a/openpype/hosts/nuke/plugins/load/actions.py b/openpype/hosts/nuke/plugins/load/actions.py index 07dcf2d8e1..81840b3a38 100644 --- a/openpype/hosts/nuke/plugins/load/actions.py +++ b/openpype/hosts/nuke/plugins/load/actions.py @@ -2,13 +2,13 @@ """ -from avalon import api from openpype.api import Logger +from openpype.pipeline import load log = Logger().get_logger(__name__) -class SetFrameRangeLoader(api.Loader): +class SetFrameRangeLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["animation", @@ -42,7 +42,7 @@ class SetFrameRangeLoader(api.Loader): lib.update_frame_range(start, end) -class SetFrameRangeWithHandlesLoader(api.Loader): +class SetFrameRangeWithHandlesLoader(load.LoaderPlugin): """Specific loader of Alembic for the avalon.animation family""" families = ["animation", diff --git a/openpype/hosts/nuke/plugins/load/load_backdrop.py b/openpype/hosts/nuke/plugins/load/load_backdrop.py index 6619cfb414..36cec6f4c5 100644 --- a/openpype/hosts/nuke/plugins/load/load_backdrop.py +++ b/openpype/hosts/nuke/plugins/load/load_backdrop.py @@ -1,7 +1,11 @@ -from avalon import api, style, io +from avalon import io import nuke import nukescripts +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api.lib import ( find_free_space_to_paste_nodes, maintained_selection, @@ -14,7 +18,7 @@ from openpype.hosts.nuke.api.commands import viewer_update_and_undo_stop from openpype.hosts.nuke.api import containerise, update_container -class LoadBackdropNodes(api.Loader): +class LoadBackdropNodes(load.LoaderPlugin): """Loading Published Backdrop nodes (workfile, nukenodes)""" representations = ["nk"] @@ -23,7 +27,7 @@ class LoadBackdropNodes(api.Loader): label = "Iport Nuke Nodes" order = 0 icon = "eye" - color = style.colors.light + color = "white" node_color = "0x7533c1ff" def load(self, context, name, namespace, data): @@ -191,7 +195,7 @@ class LoadBackdropNodes(api.Loader): # get corresponding node GN = nuke.toNode(container['objectName']) - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") context = representation["context"] name = container['name'] version_data = version.get("data", {}) diff --git a/openpype/hosts/nuke/plugins/load/load_camera_abc.py b/openpype/hosts/nuke/plugins/load/load_camera_abc.py index 9610940619..fb5f7f8ede 100644 --- a/openpype/hosts/nuke/plugins/load/load_camera_abc.py +++ b/openpype/hosts/nuke/plugins/load/load_camera_abc.py @@ -1,6 +1,10 @@ import nuke -from avalon import api, io +from avalon import io +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api import ( containerise, update_container, @@ -11,7 +15,7 @@ from openpype.hosts.nuke.api.lib import ( ) -class AlembicCameraLoader(api.Loader): +class AlembicCameraLoader(load.LoaderPlugin): """ This will load alembic camera into script. """ @@ -127,7 +131,7 @@ class AlembicCameraLoader(api.Loader): data_imprint.update({k: version_data[k]}) # getting file path - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") with maintained_selection(): camera_node = nuke.toNode(object_name) diff --git a/openpype/hosts/nuke/plugins/load/load_clip.py b/openpype/hosts/nuke/plugins/load/load_clip.py index 21b7a6a816..2b4315a830 100644 --- a/openpype/hosts/nuke/plugins/load/load_clip.py +++ b/openpype/hosts/nuke/plugins/load/load_clip.py @@ -1,7 +1,8 @@ import nuke -from avalon.vendor import qargparse -from avalon import api, io +import qargparse +from avalon import io +from openpype.pipeline import get_representation_path from openpype.hosts.nuke.api.lib import ( get_imageio_input_colorspace, maintained_selection @@ -41,6 +42,9 @@ class LoadClip(plugin.NukeLoader): icon = "file-video-o" color = "white" + # Loaded from settings + _representations = [] + script_start = int(nuke.root()["first_frame"].value()) # option gui @@ -186,7 +190,7 @@ class LoadClip(plugin.NukeLoader): is_sequence = len(representation["files"]) > 1 read_node = nuke.toNode(container['objectName']) - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") start_at_workfile = bool("start at" in read_node['frame_mode'].value()) diff --git a/openpype/hosts/nuke/plugins/load/load_effects.py b/openpype/hosts/nuke/plugins/load/load_effects.py index f636c6b510..68c3952942 100644 --- a/openpype/hosts/nuke/plugins/load/load_effects.py +++ b/openpype/hosts/nuke/plugins/load/load_effects.py @@ -1,7 +1,13 @@ import json from collections import OrderedDict import nuke -from avalon import api, style, io + +from avalon import io + +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api import ( containerise, update_container, @@ -9,7 +15,7 @@ from openpype.hosts.nuke.api import ( ) -class LoadEffects(api.Loader): +class LoadEffects(load.LoaderPlugin): """Loading colorspace soft effect exported from nukestudio""" representations = ["effectJson"] @@ -18,7 +24,7 @@ class LoadEffects(api.Loader): label = "Load Effects - nodes" order = 0 icon = "cc" - color = style.colors.light + color = "white" ignore_attr = ["useLifetime"] @@ -149,7 +155,7 @@ class LoadEffects(api.Loader): # get corresponding node GN = nuke.toNode(container['objectName']) - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") name = container['name'] version_data = version.get("data", {}) vname = version.get("name", None) diff --git a/openpype/hosts/nuke/plugins/load/load_effects_ip.py b/openpype/hosts/nuke/plugins/load/load_effects_ip.py index 990bce54f1..9c4fd4c2c6 100644 --- a/openpype/hosts/nuke/plugins/load/load_effects_ip.py +++ b/openpype/hosts/nuke/plugins/load/load_effects_ip.py @@ -3,7 +3,12 @@ from collections import OrderedDict import nuke -from avalon import api, style, io +from avalon import io + +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api import lib from openpype.hosts.nuke.api import ( containerise, @@ -12,7 +17,7 @@ from openpype.hosts.nuke.api import ( ) -class LoadEffectsInputProcess(api.Loader): +class LoadEffectsInputProcess(load.LoaderPlugin): """Loading colorspace soft effect exported from nukestudio""" representations = ["effectJson"] @@ -21,7 +26,7 @@ class LoadEffectsInputProcess(api.Loader): label = "Load Effects - Input Process" order = 0 icon = "eye" - color = style.colors.alert + color = "#cc0000" ignore_attr = ["useLifetime"] def load(self, context, name, namespace, data): @@ -156,7 +161,7 @@ class LoadEffectsInputProcess(api.Loader): # get corresponding node GN = nuke.toNode(container['objectName']) - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") name = container['name'] version_data = version.get("data", {}) vname = version.get("name", None) diff --git a/openpype/hosts/nuke/plugins/load/load_gizmo.py b/openpype/hosts/nuke/plugins/load/load_gizmo.py index 659977d789..6f2b191be9 100644 --- a/openpype/hosts/nuke/plugins/load/load_gizmo.py +++ b/openpype/hosts/nuke/plugins/load/load_gizmo.py @@ -1,5 +1,11 @@ import nuke -from avalon import api, style, io + +from avalon import io + +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api.lib import ( maintained_selection, get_avalon_knob_data, @@ -12,7 +18,7 @@ from openpype.hosts.nuke.api import ( ) -class LoadGizmo(api.Loader): +class LoadGizmo(load.LoaderPlugin): """Loading nuke Gizmo""" representations = ["gizmo"] @@ -21,7 +27,7 @@ class LoadGizmo(api.Loader): label = "Load Gizmo" order = 0 icon = "dropbox" - color = style.colors.light + color = "white" node_color = "0x75338eff" def load(self, context, name, namespace, data): @@ -103,7 +109,7 @@ class LoadGizmo(api.Loader): # get corresponding node GN = nuke.toNode(container['objectName']) - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") name = container['name'] version_data = version.get("data", {}) vname = version.get("name", None) diff --git a/openpype/hosts/nuke/plugins/load/load_gizmo_ip.py b/openpype/hosts/nuke/plugins/load/load_gizmo_ip.py index 240bfd467d..87bebce15b 100644 --- a/openpype/hosts/nuke/plugins/load/load_gizmo_ip.py +++ b/openpype/hosts/nuke/plugins/load/load_gizmo_ip.py @@ -1,5 +1,11 @@ -from avalon import api, style, io import nuke + +from avalon import io + +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api.lib import ( maintained_selection, create_backdrop, @@ -13,7 +19,7 @@ from openpype.hosts.nuke.api import ( ) -class LoadGizmoInputProcess(api.Loader): +class LoadGizmoInputProcess(load.LoaderPlugin): """Loading colorspace soft effect exported from nukestudio""" representations = ["gizmo"] @@ -22,7 +28,7 @@ class LoadGizmoInputProcess(api.Loader): label = "Load Gizmo - Input Process" order = 0 icon = "eye" - color = style.colors.alert + color = "#cc0000" node_color = "0x7533c1ff" def load(self, context, name, namespace, data): @@ -109,7 +115,7 @@ class LoadGizmoInputProcess(api.Loader): # get corresponding node GN = nuke.toNode(container['objectName']) - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") name = container['name'] version_data = version.get("data", {}) vname = version.get("name", None) diff --git a/openpype/hosts/nuke/plugins/load/load_image.py b/openpype/hosts/nuke/plugins/load/load_image.py index d36226b139..9a175a0cba 100644 --- a/openpype/hosts/nuke/plugins/load/load_image.py +++ b/openpype/hosts/nuke/plugins/load/load_image.py @@ -1,9 +1,12 @@ -import re import nuke -from avalon.vendor import qargparse -from avalon import api, io +import qargparse +from avalon import io +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api.lib import ( get_imageio_input_colorspace ) @@ -14,7 +17,7 @@ from openpype.hosts.nuke.api import ( ) -class LoadImage(api.Loader): +class LoadImage(load.LoaderPlugin): """Load still image into Nuke""" families = [ @@ -33,6 +36,9 @@ class LoadImage(api.Loader): icon = "image" color = "white" + # Loaded from settings + _representations = [] + node_name_template = "{class_name}_{ext}" options = [ @@ -162,7 +168,7 @@ class LoadImage(api.Loader): repr_cont = representation["context"] - file = api.get_representation_path(representation) + file = get_representation_path(representation) if not file: repr_id = representation["_id"] diff --git a/openpype/hosts/nuke/plugins/load/load_matchmove.py b/openpype/hosts/nuke/plugins/load/load_matchmove.py index 60d5dc026f..f5a90706c7 100644 --- a/openpype/hosts/nuke/plugins/load/load_matchmove.py +++ b/openpype/hosts/nuke/plugins/load/load_matchmove.py @@ -1,8 +1,8 @@ -from avalon import api import nuke +from openpype.pipeline import load -class MatchmoveLoader(api.Loader): +class MatchmoveLoader(load.LoaderPlugin): """ This will run matchmove script to create track in script. """ diff --git a/openpype/hosts/nuke/plugins/load/load_model.py b/openpype/hosts/nuke/plugins/load/load_model.py index 2b52bbf00f..e445beca05 100644 --- a/openpype/hosts/nuke/plugins/load/load_model.py +++ b/openpype/hosts/nuke/plugins/load/load_model.py @@ -1,5 +1,9 @@ import nuke -from avalon import api, io +from avalon import io +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api.lib import maintained_selection from openpype.hosts.nuke.api import ( containerise, @@ -8,7 +12,7 @@ from openpype.hosts.nuke.api import ( ) -class AlembicModelLoader(api.Loader): +class AlembicModelLoader(load.LoaderPlugin): """ This will load alembic model into script. """ @@ -124,7 +128,7 @@ class AlembicModelLoader(api.Loader): data_imprint.update({k: version_data[k]}) # getting file path - file = api.get_representation_path(representation).replace("\\", "/") + file = get_representation_path(representation).replace("\\", "/") with maintained_selection(): model_node = nuke.toNode(object_name) diff --git a/openpype/hosts/nuke/plugins/load/load_script_precomp.py b/openpype/hosts/nuke/plugins/load/load_script_precomp.py index aa48b631c5..779f101682 100644 --- a/openpype/hosts/nuke/plugins/load/load_script_precomp.py +++ b/openpype/hosts/nuke/plugins/load/load_script_precomp.py @@ -1,5 +1,11 @@ import nuke -from avalon import api, style, io + +from avalon import io + +from openpype.pipeline import ( + load, + get_representation_path, +) from openpype.hosts.nuke.api.lib import get_avalon_knob_data from openpype.hosts.nuke.api import ( containerise, @@ -8,7 +14,7 @@ from openpype.hosts.nuke.api import ( ) -class LinkAsGroup(api.Loader): +class LinkAsGroup(load.LoaderPlugin): """Copy the published file to be pasted at the desired location""" representations = ["nk"] @@ -17,7 +23,7 @@ class LinkAsGroup(api.Loader): label = "Load Precomp" order = 0 icon = "file" - color = style.colors.alert + color = "#cc0000" def load(self, context, name, namespace, data): # for k, v in context.items(): @@ -108,7 +114,7 @@ class LinkAsGroup(api.Loader): """ node = nuke.toNode(container['objectName']) - root = api.get_representation_path(representation).replace("\\", "/") + root = get_representation_path(representation).replace("\\", "/") # Get start frame from version data version = io.find_one({ 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 5bbc88266a..544b9e04da 100644 --- a/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py +++ b/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py @@ -1,4 +1,5 @@ import os +import re import pyblish.api import openpype from openpype.hosts.nuke.api import plugin @@ -25,6 +26,7 @@ class ExtractReviewDataMov(openpype.api.Extractor): def process(self, instance): families = instance.data["families"] task_type = instance.context.data["taskType"] + subset = instance.data["subset"] self.log.info("Creating staging dir...") if "representations" not in instance.data: @@ -46,6 +48,7 @@ class ExtractReviewDataMov(openpype.api.Extractor): for o_name, o_data in self.outputs.items(): f_families = o_data["filter"]["families"] f_task_types = o_data["filter"]["task_types"] + f_subsets = o_data["filter"]["sebsets"] # test if family found in context test_families = any([ @@ -69,11 +72,25 @@ class ExtractReviewDataMov(openpype.api.Extractor): bool(not f_task_types) ]) + # test subsets from filter + test_subsets = any([ + # check if any of subset filter inputs + # converted to regex patern is not found in subset + # we keep strict case sensitivity + bool(next(( + s for s in f_subsets + if re.search(re.compile(s), subset) + ), None)), + # but if no subsets were set then make this acuntable too + bool(not f_subsets) + ]) + # we need all filters to be positive for this # preset to be activated test_all = all([ test_families, - test_task_types + test_task_types, + test_subsets ]) # if it is not positive then skip this preset @@ -113,13 +130,22 @@ class ExtractReviewDataMov(openpype.api.Extractor): }) else: data = exporter.generate_mov(**o_data) - generated_repres.extend(data["representations"]) - self.log.info(generated_repres) + # add representation generated by exporter + generated_repres.extend(data["representations"]) + self.log.debug( + "__ generated_repres: {}".format(generated_repres)) if generated_repres: # assign to representations instance.data["representations"] += generated_repres + else: + instance.data["families"].remove("review") + self.log.info(( + "Removing `review` from families. " + "Not available baking profile." + )) + self.log.debug(instance.data["families"]) self.log.debug( "_ representations: {}".format( diff --git a/openpype/hosts/nuke/plugins/publish/extract_slate_frame.py b/openpype/hosts/nuke/plugins/publish/extract_slate_frame.py index 50e5f995f4..e917a28046 100644 --- a/openpype/hosts/nuke/plugins/publish/extract_slate_frame.py +++ b/openpype/hosts/nuke/plugins/publish/extract_slate_frame.py @@ -48,8 +48,13 @@ class ExtractSlateFrame(openpype.api.Extractor): self.log.info( "StagingDir `{0}`...".format(instance.data["stagingDir"])) + frame_start = instance.data["frameStart"] + frame_end = instance.data["frameEnd"] + handle_start = instance.data["handleStart"] + handle_end = instance.data["handleEnd"] + frame_length = int( - instance.data["frameEnd"] - instance.data["frameStart"] + 1 + (frame_end - frame_start + 1) + (handle_start + handle_end) ) temporary_nodes = [] diff --git a/openpype/hosts/nuke/plugins/publish/precollect_instances.py b/openpype/hosts/nuke/plugins/publish/precollect_instances.py index 97ddef0a59..29c706f302 100644 --- a/openpype/hosts/nuke/plugins/publish/precollect_instances.py +++ b/openpype/hosts/nuke/plugins/publish/precollect_instances.py @@ -80,7 +80,7 @@ class PreCollectNukeInstances(pyblish.api.ContextPlugin): # Add all nodes in group instances. if node.Class() == "Group": # only alter families for render family - if "write" in families_ak.lower(): + if families_ak and "write" in families_ak.lower(): target = node["render"].value() if target == "Use existing frames": # Local rendering diff --git a/openpype/hosts/nuke/plugins/publish/precollect_writes.py b/openpype/hosts/nuke/plugins/publish/precollect_writes.py index 189f28f7c6..85e98db7ed 100644 --- a/openpype/hosts/nuke/plugins/publish/precollect_writes.py +++ b/openpype/hosts/nuke/plugins/publish/precollect_writes.py @@ -3,8 +3,9 @@ import re from pprint import pformat import nuke import pyblish.api +from avalon import io import openpype.api as pype -from avalon import io, api +from openpype.pipeline import get_representation_path @pyblish.api.log @@ -182,7 +183,7 @@ class CollectNukeWrites(pyblish.api.InstancePlugin): if repre_doc: instance.data["audio"] = [{ "offset": 0, - "filename": api.get_representation_path(repre_doc) + "filename": get_representation_path(repre_doc) }] self.log.debug("instance.data: {}".format(pformat(instance.data))) diff --git a/openpype/hosts/nuke/plugins/publish/validate_read_legacy.py b/openpype/hosts/nuke/plugins/publish/validate_read_legacy.py index 22a9b3678e..2bf1ff81f8 100644 --- a/openpype/hosts/nuke/plugins/publish/validate_read_legacy.py +++ b/openpype/hosts/nuke/plugins/publish/validate_read_legacy.py @@ -1,12 +1,16 @@ import os -import toml import nuke +import toml import pyblish.api -from avalon import api from bson.objectid import ObjectId +from openpype.pipeline import ( + discover_loader_plugins, + load_container, +) + class RepairReadLegacyAction(pyblish.api.Action): @@ -49,13 +53,13 @@ class RepairReadLegacyAction(pyblish.api.Action): loader_name = "LoadMov" loader_plugin = None - for Loader in api.discover(api.Loader): + for Loader in discover_loader_plugins(): if Loader.__name__ != loader_name: continue loader_plugin = Loader - api.load( + load_container( Loader=loader_plugin, representation=ObjectId(data["representation"]) ) diff --git a/openpype/hosts/nuke/plugins/publish/validate_write_legacy.py b/openpype/hosts/nuke/plugins/publish/validate_write_legacy.py index a73bed8edd..08f09f8097 100644 --- a/openpype/hosts/nuke/plugins/publish/validate_write_legacy.py +++ b/openpype/hosts/nuke/plugins/publish/validate_write_legacy.py @@ -34,9 +34,9 @@ class ValidateWriteLegacy(pyblish.api.InstancePlugin): # test if render in family test knob # and only one item should be available assert len(family_test) == 1, msg + " > More avalon attributes" - assert "render" in node[family_test[0]].value(), msg + \ + assert "render" in node[family_test[0]].value() \ + or "still" in node[family_test[0]].value(), msg + \ " > Not correct family" - # test if `file` knob in node, this way old # non-group-node write could be detected assert "file" not in node.knobs(), msg + \ @@ -74,6 +74,8 @@ class ValidateWriteLegacy(pyblish.api.InstancePlugin): Create_name = "CreateWriteRender" elif family == "prerender": Create_name = "CreateWritePrerender" + elif family == "still": + Create_name = "CreateWriteStill" # get appropriate plugin class creator_plugin = None diff --git a/openpype/hosts/photoshop/api/README.md b/openpype/hosts/photoshop/api/README.md index b958f53803..80792a4da0 100644 --- a/openpype/hosts/photoshop/api/README.md +++ b/openpype/hosts/photoshop/api/README.md @@ -195,11 +195,12 @@ class ExtractImage(openpype.api.Extractor): #### Loader Plugin ```python from avalon import api, photoshop +from openpype.pipeline import load, get_representation_path stub = photoshop.stub() -class ImageLoader(api.Loader): +class ImageLoader(load.LoaderPlugin): """Load images Stores the imported asset in a container named after the asset. @@ -227,7 +228,7 @@ class ImageLoader(api.Loader): with photoshop.maintained_selection(): stub.replace_smart_object( - layer, api.get_representation_path(representation) + layer, get_representation_path(representation) ) stub.imprint( @@ -245,7 +246,7 @@ https://community.adobe.com/t5/download-install/adobe-extension-debuger-problem/ Add --enable-blink-features=ShadowDOMV0,CustomElementsV0 when starting Chrome then localhost:8078 (port set in `photoshop\extension\.debug`) -Or use Visual Studio Code https://medium.com/adobetech/extendscript-debugger-for-visual-studio-code-public-release-a2ff6161fa01 +Or use Visual Studio Code https://medium.com/adobetech/extendscript-debugger-for-visual-studio-code-public-release-a2ff6161fa01 Or install CEF client from https://github.com/Adobe-CEP/CEP-Resources/tree/master/CEP_9.x ## Resources diff --git a/openpype/hosts/photoshop/api/__init__.py b/openpype/hosts/photoshop/api/__init__.py index 4cc2aa2c78..17ea957066 100644 --- a/openpype/hosts/photoshop/api/__init__.py +++ b/openpype/hosts/photoshop/api/__init__.py @@ -16,7 +16,6 @@ from .pipeline import ( ) from .plugin import ( PhotoshopLoader, - Creator, get_unique_layer_name ) from .workio import ( @@ -42,11 +41,11 @@ __all__ = [ "list_instances", "remove_instance", "install", + "uninstall", "containerise", # Plugin "PhotoshopLoader", - "Creator", "get_unique_layer_name", # workfiles diff --git a/openpype/hosts/photoshop/api/launch_logic.py b/openpype/hosts/photoshop/api/launch_logic.py index 16a1d23244..0021905cb5 100644 --- a/openpype/hosts/photoshop/api/launch_logic.py +++ b/openpype/hosts/photoshop/api/launch_logic.py @@ -14,7 +14,7 @@ from openpype.api import Logger from openpype.tools.utils import host_tools from avalon import api -from avalon.tools.webserver.app import WebServerTool +from openpype.tools.adobe_webserver.app import WebServerTool from .ws_stub import PhotoshopServerStub @@ -175,7 +175,7 @@ class ProcessLauncher(QtCore.QObject): def start(self): if self._started: return - self.log.info("Started launch logic of AfterEffects") + self.log.info("Started launch logic of Photoshop") self._started = True self._start_process_timer.start() diff --git a/openpype/hosts/photoshop/api/pipeline.py b/openpype/hosts/photoshop/api/pipeline.py index 25983f2471..e814e1ca4d 100644 --- a/openpype/hosts/photoshop/api/pipeline.py +++ b/openpype/hosts/photoshop/api/pipeline.py @@ -1,5 +1,4 @@ import os -import sys from Qt import QtWidgets import pyblish.api @@ -7,6 +6,12 @@ import avalon.api from avalon import pipeline, io from openpype.api import Logger +from openpype.lib import register_event_callback +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) import openpype.hosts.photoshop from . import lib @@ -67,21 +72,21 @@ def install(): pyblish.api.register_host("photoshop") pyblish.api.register_plugin_path(PUBLISH_PATH) - avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH) log.info(PUBLISH_PATH) pyblish.api.register_callback( "instanceToggled", on_pyblish_instance_toggled ) - avalon.api.on("application.launched", on_application_launch) + register_event_callback("application.launched", on_application_launch) def uninstall(): pyblish.api.deregister_plugin_path(PUBLISH_PATH) - avalon.api.deregister_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.deregister_plugin_path(avalon.api.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.api.deregister_plugin_path(LegacyCreator, CREATE_PATH) def ls(): diff --git a/openpype/hosts/photoshop/api/plugin.py b/openpype/hosts/photoshop/api/plugin.py index e0db67de2c..c80e6bbd06 100644 --- a/openpype/hosts/photoshop/api/plugin.py +++ b/openpype/hosts/photoshop/api/plugin.py @@ -1,6 +1,6 @@ import re -import avalon.api +from openpype.pipeline import LoaderPlugin from .launch_logic import stub @@ -29,41 +29,7 @@ def get_unique_layer_name(layers, asset_name, subset_name): return "{}_{:0>3d}".format(name, occurrences + 1) -class PhotoshopLoader(avalon.api.Loader): +class PhotoshopLoader(LoaderPlugin): @staticmethod def get_stub(): return stub() - - -class Creator(avalon.api.Creator): - """Creator plugin to create instances in Photoshop - - A LayerSet is created to support any number of layers in an instance. If - the selection is used, these layers will be added to the LayerSet. - """ - - def process(self): - # Photoshop can have multiple LayerSets with the same name, which does - # not work with Avalon. - msg = "Instance with name \"{}\" already exists.".format(self.name) - stub = lib.stub() # only after Photoshop is up - for layer in stub.get_layers(): - if self.name.lower() == layer.Name.lower(): - msg = QtWidgets.QMessageBox() - msg.setIcon(QtWidgets.QMessageBox.Warning) - msg.setText(msg) - msg.exec_() - return False - - # Store selection because adding a group will change selection. - with lib.maintained_selection(): - - # Add selection to group. - if (self.options or {}).get("useSelection"): - group = stub.group_selected_layers(self.name) - else: - group = stub.create_group(self.name) - - stub.imprint(group, self.data) - - return group diff --git a/openpype/hosts/photoshop/api/ws_stub.py b/openpype/hosts/photoshop/api/ws_stub.py index fd8377d4e0..64d89f5420 100644 --- a/openpype/hosts/photoshop/api/ws_stub.py +++ b/openpype/hosts/photoshop/api/ws_stub.py @@ -2,12 +2,11 @@ Stub handling connection from server to client. Used anywhere solution is calling client methods. """ -import sys import json import attr from wsrpc_aiohttp import WebSocketAsync -from avalon.tools.webserver.app import WebServerTool +from openpype.tools.adobe_webserver.app import WebServerTool @attr.s @@ -344,6 +343,28 @@ class PhotoshopServerStub: ) ) + def hide_all_others_layers(self, layers): + """hides all layers that are not part of the list or that are not + children of this list + + Args: + layers (list): list of PSItem - highest hierarchy + """ + extract_ids = set([ll.id for ll in self.get_layers_in_layers(layers)]) + + self.hide_all_others_layers_ids(extract_ids) + + def hide_all_others_layers_ids(self, extract_ids): + """hides all layers that are not part of the list or that are not + children of this list + + Args: + extract_ids (list): list of integer that should be visible + """ + for layer in self.get_layers(): + if layer.visible and layer.id not in extract_ids: + self.set_visible(layer.id, False) + def get_layers_metadata(self): """Reads layers metadata from Headline from active document in PS. (Headline accessible by File > File Info) diff --git a/openpype/hosts/photoshop/plugins/create/create_image.py b/openpype/hosts/photoshop/plugins/create/create_image.py index 344a53f47e..a001b5f171 100644 --- a/openpype/hosts/photoshop/plugins/create/create_image.py +++ b/openpype/hosts/photoshop/plugins/create/create_image.py @@ -1,9 +1,9 @@ from Qt import QtWidgets -import openpype.api +from openpype.pipeline import create from openpype.hosts.photoshop import api as photoshop -class CreateImage(openpype.api.Creator): +class CreateImage(create.LegacyCreator): """Image folder for publish.""" name = "imageDefault" diff --git a/openpype/hosts/photoshop/plugins/load/load_image.py b/openpype/hosts/photoshop/plugins/load/load_image.py index 3b1cfe9636..0a9421b8f2 100644 --- a/openpype/hosts/photoshop/plugins/load/load_image.py +++ b/openpype/hosts/photoshop/plugins/load/load_image.py @@ -1,6 +1,6 @@ import re -from avalon import api +from openpype.pipeline import get_representation_path from openpype.hosts.photoshop import api as photoshop from openpype.hosts.photoshop.api import get_unique_layer_name @@ -54,7 +54,7 @@ class ImageLoader(photoshop.PhotoshopLoader): else: # switching version - keep same name layer_name = container["namespace"] - path = api.get_representation_path(representation) + path = get_representation_path(representation) with photoshop.maintained_selection(): stub.replace_smart_object( layer, path, layer_name diff --git a/openpype/hosts/photoshop/plugins/load/load_image_from_sequence.py b/openpype/hosts/photoshop/plugins/load/load_image_from_sequence.py index 6627aded51..5f39121ae1 100644 --- a/openpype/hosts/photoshop/plugins/load/load_image_from_sequence.py +++ b/openpype/hosts/photoshop/plugins/load/load_image_from_sequence.py @@ -1,8 +1,8 @@ import os -from avalon.pipeline import get_representation_path_from_context -from avalon.vendor import qargparse +import qargparse +from openpype.pipeline import get_representation_path_from_context from openpype.hosts.photoshop import api as photoshop from openpype.hosts.photoshop.api import get_unique_layer_name @@ -92,4 +92,3 @@ class ImageFromSequenceLoader(photoshop.PhotoshopLoader): def remove(self, container): """No update possible, not containerized.""" pass - diff --git a/openpype/hosts/photoshop/plugins/load/load_reference.py b/openpype/hosts/photoshop/plugins/load/load_reference.py index 60142d4a1f..f5f0545d39 100644 --- a/openpype/hosts/photoshop/plugins/load/load_reference.py +++ b/openpype/hosts/photoshop/plugins/load/load_reference.py @@ -1,7 +1,6 @@ import re -from avalon import api - +from openpype.pipeline import get_representation_path from openpype.hosts.photoshop import api as photoshop from openpype.hosts.photoshop.api import get_unique_layer_name @@ -55,7 +54,7 @@ class ReferenceLoader(photoshop.PhotoshopLoader): else: # switching version - keep same name layer_name = container["namespace"] - path = api.get_representation_path(representation) + path = get_representation_path(representation) with photoshop.maintained_selection(): stub.replace_smart_object( layer, path, layer_name diff --git a/openpype/hosts/photoshop/plugins/publish/collect_color_coded_instances.py b/openpype/hosts/photoshop/plugins/publish/collect_color_coded_instances.py index c1ae88fbbb..7d44d55a80 100644 --- a/openpype/hosts/photoshop/plugins/publish/collect_color_coded_instances.py +++ b/openpype/hosts/photoshop/plugins/publish/collect_color_coded_instances.py @@ -38,10 +38,15 @@ class CollectColorCodedInstances(pyblish.api.ContextPlugin): def process(self, context): self.log.info("CollectColorCodedInstances") - self.log.debug("mapping:: {}".format(self.color_code_mapping)) + batch_dir = os.environ.get("OPENPYPE_PUBLISH_DATA") + if (os.environ.get("IS_TEST") and + (not batch_dir or not os.path.exists(batch_dir))): + self.log.debug("Automatic testing, no batch data, skipping") + return existing_subset_names = self._get_existing_subset_names(context) - asset_name, task_name, variant = self._parse_batch() + + asset_name, task_name, variant = self._parse_batch(batch_dir) stub = photoshop.stub() layers = stub.get_layers() @@ -125,9 +130,8 @@ class CollectColorCodedInstances(pyblish.api.ContextPlugin): return existing_subset_names - def _parse_batch(self): + def _parse_batch(self, batch_dir): """Parses asset_name, task_name, variant from batch manifest.""" - batch_dir = os.environ.get("OPENPYPE_PUBLISH_DATA") task_data = None if batch_dir and os.path.exists(batch_dir): task_data = parse_json(os.path.join(batch_dir, diff --git a/openpype/hosts/photoshop/plugins/publish/extract_image.py b/openpype/hosts/photoshop/plugins/publish/extract_image.py index beb904215b..04ce77ee34 100644 --- a/openpype/hosts/photoshop/plugins/publish/extract_image.py +++ b/openpype/hosts/photoshop/plugins/publish/extract_image.py @@ -26,7 +26,6 @@ class ExtractImage(openpype.api.Extractor): with photoshop.maintained_selection(): self.log.info("Extracting %s" % str(list(instance))) with photoshop.maintained_visibility(): - # Hide all other layers. layer = instance.data.get("layer") ids = set([layer.id]) add_ids = instance.data.pop("ids", None) @@ -34,11 +33,7 @@ class ExtractImage(openpype.api.Extractor): ids.update(set(add_ids)) extract_ids = set([ll.id for ll in stub. get_layers_in_layers_ids(ids)]) - - for layer in stub.get_layers(): - # limit unnecessary calls to client - if layer.visible and layer.id not in extract_ids: - stub.set_visible(layer.id, False) + stub.hide_all_others_layers_ids(extract_ids) file_basename = os.path.splitext( stub.get_active_document_name() diff --git a/openpype/hosts/photoshop/plugins/publish/extract_review.py b/openpype/hosts/photoshop/plugins/publish/extract_review.py index b6c7e2d189..b8f4470c7b 100644 --- a/openpype/hosts/photoshop/plugins/publish/extract_review.py +++ b/openpype/hosts/photoshop/plugins/publish/extract_review.py @@ -1,4 +1,5 @@ import os +import shutil import openpype.api import openpype.lib @@ -7,7 +8,7 @@ from openpype.hosts.photoshop import api as photoshop class ExtractReview(openpype.api.Extractor): """ - Produce a flattened image file from all 'image' instances. + Produce a flattened or sequence image file from all 'image' instances. If no 'image' instance is created, it produces flattened image from all visible layers. @@ -20,54 +21,58 @@ class ExtractReview(openpype.api.Extractor): # Extract Options jpg_options = None mov_options = None + make_image_sequence = None def process(self, instance): staging_dir = self.staging_dir(instance) self.log.info("Outputting image to {}".format(staging_dir)) + fps = instance.data.get("fps", 25) stub = photoshop.stub() + self.output_seq_filename = os.path.splitext( + stub.get_active_document_name())[0] + ".%04d.jpg" - layers = [] - for image_instance in instance.context: - if image_instance.data["family"] != "image": - continue - layers.append(image_instance.data.get("layer")) + layers = self._get_layers_from_image_instances(instance) + self.log.info("Layers image instance found: {}".format(layers)) - # Perform extraction - output_image = "{}.jpg".format( - os.path.splitext(stub.get_active_document_name())[0] - ) - output_image_path = os.path.join(staging_dir, output_image) - with photoshop.maintained_visibility(): - if layers: - # Hide all other layers. - extract_ids = set([ll.id for ll in stub. - get_layers_in_layers(layers)]) - self.log.debug("extract_ids {}".format(extract_ids)) - for layer in stub.get_layers(): - # limit unnecessary calls to client - if layer.visible and layer.id not in extract_ids: - stub.set_visible(layer.id, False) + if self.make_image_sequence and len(layers) > 1: + self.log.info("Extract layers to image sequence.") + img_list = self._saves_sequences_layers(staging_dir, layers) - stub.saveAs(output_image_path, 'jpg', True) + instance.data["representations"].append({ + "name": "jpg", + "ext": "jpg", + "files": img_list, + "frameStart": 0, + "frameEnd": len(img_list), + "fps": fps, + "stagingDir": staging_dir, + "tags": self.jpg_options['tags'], + }) + + else: + self.log.info("Extract layers to flatten image.") + img_list = self._saves_flattened_layers(staging_dir, layers) + + instance.data["representations"].append({ + "name": "jpg", + "ext": "jpg", + "files": img_list, + "stagingDir": staging_dir, + "tags": self.jpg_options['tags'] + }) ffmpeg_path = openpype.lib.get_ffmpeg_tool_path("ffmpeg") - instance.data["representations"].append({ - "name": "jpg", - "ext": "jpg", - "files": output_image, - "stagingDir": staging_dir, - "tags": self.jpg_options['tags'] - }) instance.data["stagingDir"] = staging_dir # Generate thumbnail. thumbnail_path = os.path.join(staging_dir, "thumbnail.jpg") + self.log.info(f"Generate thumbnail {thumbnail_path}") args = [ ffmpeg_path, "-y", - "-i", output_image_path, + "-i", os.path.join(staging_dir, self.output_seq_filename), "-vf", "scale=300:-1", "-vframes", "1", thumbnail_path @@ -81,14 +86,17 @@ class ExtractReview(openpype.api.Extractor): "stagingDir": staging_dir, "tags": ["thumbnail"] }) + # Generate mov. mov_path = os.path.join(staging_dir, "review.mov") + self.log.info(f"Generate mov review: {mov_path}") + img_number = len(img_list) args = [ ffmpeg_path, "-y", - "-i", output_image_path, + "-i", os.path.join(staging_dir, self.output_seq_filename), "-vf", "pad=ceil(iw/2)*2:ceil(ih/2)*2", - "-vframes", "1", + "-vframes", str(img_number), mov_path ] output = openpype.lib.run_subprocess(args) @@ -99,15 +107,86 @@ class ExtractReview(openpype.api.Extractor): "files": os.path.basename(mov_path), "stagingDir": staging_dir, "frameStart": 1, - "frameEnd": 1, - "fps": 25, + "frameEnd": img_number, + "fps": fps, "preview": True, "tags": self.mov_options['tags'] }) # Required for extract_review plugin (L222 onwards). instance.data["frameStart"] = 1 - instance.data["frameEnd"] = 1 + instance.data["frameEnd"] = img_number instance.data["fps"] = 25 self.log.info(f"Extracted {instance} to {staging_dir}") + + def _get_image_path_from_instances(self, instance): + img_list = [] + + for instance in sorted(instance.context): + if instance.data["family"] != "image": + continue + + for rep in instance.data["representations"]: + img_path = os.path.join( + rep["stagingDir"], + rep["files"] + ) + img_list.append(img_path) + + return img_list + + def _copy_image_to_staging_dir(self, staging_dir, img_list): + copy_files = [] + for i, img_src in enumerate(img_list): + img_filename = self.output_seq_filename % i + img_dst = os.path.join(staging_dir, img_filename) + + self.log.debug( + "Copying file .. {} -> {}".format(img_src, img_dst) + ) + shutil.copy(img_src, img_dst) + copy_files.append(img_filename) + + return copy_files + + def _get_layers_from_image_instances(self, instance): + layers = [] + for image_instance in instance.context: + if image_instance.data["family"] != "image": + continue + layers.append(image_instance.data.get("layer")) + + return sorted(layers) + + def _saves_flattened_layers(self, staging_dir, layers): + img_filename = self.output_seq_filename % 0 + output_image_path = os.path.join(staging_dir, img_filename) + stub = photoshop.stub() + + with photoshop.maintained_visibility(): + self.log.info("Extracting {}".format(layers)) + if layers: + stub.hide_all_others_layers(layers) + + stub.saveAs(output_image_path, 'jpg', True) + + return img_filename + + def _saves_sequences_layers(self, staging_dir, layers): + stub = photoshop.stub() + + list_img_filename = [] + with photoshop.maintained_visibility(): + for i, layer in enumerate(layers): + self.log.info("Extracting {}".format(layer)) + + img_filename = self.output_seq_filename % i + output_image_path = os.path.join(staging_dir, img_filename) + list_img_filename.append(img_filename) + + with photoshop.maintained_visibility(): + stub.hide_all_others_layers([layer]) + stub.saveAs(output_image_path, 'jpg', True) + + return list_img_filename diff --git a/openpype/hosts/resolve/api/pipeline.py b/openpype/hosts/resolve/api/pipeline.py index 2dc5136c8a..fa309e3503 100644 --- a/openpype/hosts/resolve/api/pipeline.py +++ b/openpype/hosts/resolve/api/pipeline.py @@ -9,6 +9,11 @@ from avalon import schema from avalon.pipeline import AVALON_CONTAINER_ID from pyblish import api as pyblish from openpype.api import Logger +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) from . import lib from . import PLUGINS_DIR from openpype.tools.utils import host_tools @@ -41,8 +46,8 @@ def install(): pyblish.register_plugin_path(PUBLISH_PATH) log.info("Registering DaVinci Resovle plug-ins..") - avalon.register_plugin_path(avalon.Loader, LOAD_PATH) - avalon.register_plugin_path(avalon.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.register_plugin_path(LegacyCreator, CREATE_PATH) avalon.register_plugin_path(avalon.InventoryAction, INVENTORY_PATH) # register callback for switching publishable @@ -66,8 +71,8 @@ def uninstall(): pyblish.deregister_plugin_path(PUBLISH_PATH) log.info("Deregistering DaVinci Resovle plug-ins..") - avalon.deregister_plugin_path(avalon.Loader, LOAD_PATH) - avalon.deregister_plugin_path(avalon.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.deregister_plugin_path(LegacyCreator, CREATE_PATH) avalon.deregister_plugin_path(avalon.InventoryAction, INVENTORY_PATH) # register callback for switching publishable diff --git a/openpype/hosts/resolve/api/plugin.py b/openpype/hosts/resolve/api/plugin.py index 8612cf82ec..8e1436021c 100644 --- a/openpype/hosts/resolve/api/plugin.py +++ b/openpype/hosts/resolve/api/plugin.py @@ -1,13 +1,17 @@ import re import uuid -from avalon import api -import openpype.api as pype -from openpype.hosts import resolve -from avalon.vendor import qargparse -from . import lib +import qargparse from Qt import QtWidgets, QtCore +import openpype.api as pype +from openpype.pipeline import ( + LegacyCreator, + LoaderPlugin, +) +from openpype.hosts import resolve +from . import lib + class CreatorWidget(QtWidgets.QDialog): @@ -289,7 +293,7 @@ class ClipLoader: """ Initialize object Arguments: - cls (avalon.api.Loader): plugin object + cls (openpype.pipeline.load.LoaderPlugin): plugin object context (dict): loader plugin context options (dict)[optional]: possible keys: projectBinPath: "path/to/binItem" @@ -445,7 +449,7 @@ class ClipLoader: return timeline_item -class TimelineItemLoader(api.Loader): +class TimelineItemLoader(LoaderPlugin): """A basic SequenceLoader for Resolve This will implement the basic behavior for a loader to inherit from that @@ -493,7 +497,7 @@ class TimelineItemLoader(api.Loader): pass -class Creator(pype.PypeCreatorMixin, api.Creator): +class Creator(LegacyCreator): """Creator class wrapper """ marker_color = "Purple" diff --git a/openpype/hosts/resolve/api/utils.py b/openpype/hosts/resolve/api/utils.py index 3dee17cb01..9b3762f328 100644 --- a/openpype/hosts/resolve/api/utils.py +++ b/openpype/hosts/resolve/api/utils.py @@ -70,9 +70,9 @@ def get_resolve_module(): sys.exit() # assign global var and return bmdvr = bmd.scriptapp("Resolve") - # bmdvf = bmd.scriptapp("Fusion") + bmdvf = bmd.scriptapp("Fusion") resolve.api.bmdvr = bmdvr - resolve.api.bmdvf = bmdvr.Fusion() + resolve.api.bmdvf = bmdvf log.info(("Assigning resolve module to " f"`pype.hosts.resolve.api.bmdvr`: {resolve.api.bmdvr}")) log.info(("Assigning resolve module to " diff --git a/openpype/hosts/resolve/plugins/load/load_clip.py b/openpype/hosts/resolve/plugins/load/load_clip.py index e20384ee6c..71850d95f6 100644 --- a/openpype/hosts/resolve/plugins/load/load_clip.py +++ b/openpype/hosts/resolve/plugins/load/load_clip.py @@ -1,11 +1,14 @@ -from avalon import io, api -from openpype.hosts import resolve from copy import deepcopy from importlib import reload + +from avalon import io +from openpype.hosts import resolve +from openpype.pipeline import get_representation_path from openpype.hosts.resolve.api import lib, plugin reload(plugin) reload(lib) + class LoadClip(resolve.TimelineItemLoader): """Load a subset to timeline as clip @@ -99,7 +102,7 @@ class LoadClip(resolve.TimelineItemLoader): version_name = version.get("name", None) colorspace = version_data.get("colorspace", None) object_name = "{}_{}".format(name, namespace) - self.fname = api.get_representation_path(representation) + self.fname = get_representation_path(representation) context["version"] = {"data": version_data} loader = resolve.ClipLoader(self, context) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/collect_texture.py b/openpype/hosts/standalonepublisher/plugins/publish/collect_texture.py index 596a8ccfd2..ea0b6cdf41 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/collect_texture.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/collect_texture.py @@ -81,14 +81,10 @@ class CollectTextures(pyblish.api.ContextPlugin): parsed_subset = instance.data["subset"].replace( instance.data["family"], '') - fill_pairs = { + explicit_data = { "subset": parsed_subset } - fill_pairs = prepare_template_data(fill_pairs) - workfile_subset = format_template_with_optional_keys( - fill_pairs, self.workfile_subset_template) - processed_instance = False for repre in instance.data["representations"]: ext = repre["ext"].replace('.', '') @@ -102,6 +98,21 @@ class CollectTextures(pyblish.api.ContextPlugin): if ext in self.main_workfile_extensions or \ ext in self.other_workfile_extensions: + formatting_data = self._get_parsed_groups( + repre_file, + self.input_naming_patterns["workfile"], + self.input_naming_groups["workfile"], + self.color_space + ) + self.log.info("Parsed groups from workfile " + "name '{}': {}".format(repre_file, + formatting_data)) + + formatting_data.update(explicit_data) + fill_pairs = prepare_template_data(formatting_data) + workfile_subset = format_template_with_optional_keys( + fill_pairs, self.workfile_subset_template) + asset_build = self._get_asset_build( repre_file, self.input_naming_patterns["workfile"], @@ -148,11 +159,23 @@ class CollectTextures(pyblish.api.ContextPlugin): resource_files[workfile_subset].append(item) if ext in self.texture_extensions: + formatting_data = self._get_parsed_groups( + repre_file, + self.input_naming_patterns["textures"], + self.input_naming_groups["textures"], + self.color_space + ) + + self.log.info("Parsed groups from texture " + "name '{}': {}".format(repre_file, + formatting_data)) + c_space = self._get_color_space( repre_file, self.color_space ) + # optional value channel = self._get_channel_name( repre_file, self.input_naming_patterns["textures"], @@ -160,6 +183,7 @@ class CollectTextures(pyblish.api.ContextPlugin): self.color_space ) + # optional value shader = self._get_shader_name( repre_file, self.input_naming_patterns["textures"], @@ -167,13 +191,15 @@ class CollectTextures(pyblish.api.ContextPlugin): self.color_space ) - formatting_data = { + explicit_data = { "color_space": c_space or '', # None throws exception "channel": channel or '', "shader": shader or '', "subset": parsed_subset or '' } + formatting_data.update(explicit_data) + fill_pairs = prepare_template_data(formatting_data) subset = format_template_with_optional_keys( fill_pairs, self.texture_subset_template) @@ -243,6 +269,13 @@ class CollectTextures(pyblish.api.ContextPlugin): for asset_build, version, subset, family in asset_builds: if not main_version: main_version = version + + try: + version_int = int(version or main_version or 1) + except ValueError: + self.log.error("Parsed version {} is not " + "an number".format(version)) + new_instance = context.create_instance(subset) new_instance.data.update( { @@ -251,7 +284,7 @@ class CollectTextures(pyblish.api.ContextPlugin): "label": subset, "name": subset, "family": family, - "version": int(version or main_version or 1), + "version": version_int, "asset_build": asset_build # remove in validator } ) @@ -320,13 +353,14 @@ class CollectTextures(pyblish.api.ContextPlugin): """ asset_name = "NOT_AVAIL" - return self._parse(name, input_naming_patterns, input_naming_groups, - color_spaces, 'asset') or asset_name + return (self._parse_key(name, input_naming_patterns, + input_naming_groups, color_spaces, 'asset') or + asset_name) def _get_version(self, name, input_naming_patterns, input_naming_groups, color_spaces): - found = self._parse(name, input_naming_patterns, input_naming_groups, - color_spaces, 'version') + found = self._parse_key(name, input_naming_patterns, + input_naming_groups, color_spaces, 'version') if found: return found.replace('v', '') @@ -336,8 +370,8 @@ class CollectTextures(pyblish.api.ContextPlugin): def _get_udim(self, name, input_naming_patterns, input_naming_groups, color_spaces): """Parses from 'name' udim value.""" - found = self._parse(name, input_naming_patterns, input_naming_groups, - color_spaces, 'udim') + found = self._parse_key(name, input_naming_patterns, + input_naming_groups, color_spaces, 'udim') if found: return found @@ -375,12 +409,15 @@ class CollectTextures(pyblish.api.ContextPlugin): Unknown format of channel name and color spaces >> cs are known list - 'color_space' used as a placeholder """ - found = self._parse(name, input_naming_patterns, input_naming_groups, - color_spaces, 'shader') - if found: - return found + found = None + try: + found = self._parse_key(name, input_naming_patterns, + input_naming_groups, color_spaces, + 'shader') + except ValueError: + self.log.warning("Didn't find shader in {}".format(name)) - self.log.warning("Didn't find shader in {}".format(name)) + return found def _get_channel_name(self, name, input_naming_patterns, input_naming_groups, color_spaces): @@ -389,15 +426,18 @@ class CollectTextures(pyblish.api.ContextPlugin): Unknown format of channel name and color spaces >> cs are known list - 'color_space' used as a placeholder """ - found = self._parse(name, input_naming_patterns, input_naming_groups, - color_spaces, 'channel') - if found: - return found + found = None + try: + found = self._parse_key(name, input_naming_patterns, + input_naming_groups, color_spaces, + 'channel') + except ValueError: + self.log.warning("Didn't find channel in {}".format(name)) - self.log.warning("Didn't find channel in {}".format(name)) + return found - def _parse(self, name, input_naming_patterns, input_naming_groups, - color_spaces, key): + def _parse_key(self, name, input_naming_patterns, input_naming_groups, + color_spaces, key): """Universal way to parse 'name' with configurable regex groups. Args: @@ -411,23 +451,47 @@ class CollectTextures(pyblish.api.ContextPlugin): Raises: ValueError - if broken 'input_naming_groups' """ + parsed_groups = self._get_parsed_groups(name, + input_naming_patterns, + input_naming_groups, + color_spaces) + + try: + parsed_value = parsed_groups[key] + return parsed_value + except (IndexError, KeyError): + msg = ("'Textures group positions' must " + + "have '{}' key".format(key)) + raise ValueError(msg) + + def _get_parsed_groups(self, name, input_naming_patterns, + input_naming_groups, color_spaces): + """Universal way to parse 'name' with configurable regex groups. + + Args: + name (str): workfile name or texture name + input_naming_patterns (list): + [workfile_pattern] or [texture_pattern] + input_naming_groups (list) + ordinal position of regex groups matching to input_naming.. + color_spaces (list) - predefined color spaces + + Returns: + (dict) {group_name:parsed_value} + """ for input_pattern in input_naming_patterns: for cs in color_spaces: pattern = input_pattern.replace('{color_space}', cs) regex_result = re.findall(pattern, name) if regex_result: - idx = list(input_naming_groups).index(key) - if idx < 0: - msg = "input_naming_groups must " +\ - "have '{}' key".format(key) - raise ValueError(msg) + if len(regex_result[0]) == len(input_naming_groups): + return dict(zip(input_naming_groups, regex_result[0])) + else: + self.log.warning("No of parsed groups doesn't match " + "no of group labels") - try: - parsed_value = regex_result[0][idx] - return parsed_value - except IndexError: - self.log.warning("Wrong index, probably " - "wrong name {}".format(name)) + raise ValueError("Name '{}' cannot be parsed by any " + "'{}' patterns".format(name, input_naming_patterns)) def _update_representations(self, upd_representations): """Frames dont have sense for textures, add collected udims instead.""" diff --git a/openpype/hosts/standalonepublisher/plugins/publish/extract_trim_video_audio.py b/openpype/hosts/standalonepublisher/plugins/publish/extract_trim_video_audio.py index c18de5bc1c..f327895b83 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/extract_trim_video_audio.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/extract_trim_video_audio.py @@ -2,6 +2,9 @@ import os import pyblish.api import openpype.api +from openpype.lib import ( + get_ffmpeg_tool_path, +) from pprint import pformat @@ -27,7 +30,7 @@ class ExtractTrimVideoAudio(openpype.api.Extractor): instance.data["representations"] = list() # get ffmpet path - ffmpeg_path = openpype.lib.get_ffmpeg_tool_path("ffmpeg") + ffmpeg_path = get_ffmpeg_tool_path("ffmpeg") # get staging dir staging_dir = self.staging_dir(instance) @@ -44,7 +47,7 @@ class ExtractTrimVideoAudio(openpype.api.Extractor): clip_trimed_path = os.path.join( staging_dir, instance.data["name"] + ext) # # check video file metadata - # input_data = plib.ffprobe_streams(video_file_path)[0] + # input_data = plib.get_ffprobe_streams(video_file_path)[0] # self.log.debug(f"__ input_data: `{input_data}`") start = float(instance.data["clipInH"]) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_editorial_resources.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_editorial_resources.xml new file mode 100644 index 0000000000..803de6bf11 --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_editorial_resources.xml @@ -0,0 +1,17 @@ + + + +Missing source video file + +## No attached video file found + +Process expects presence of source video file with same name prefix as an editorial file in same folder. +(example `simple_editorial_setup_Layer1.edl` expects `simple_editorial_setup.mp4` in same folder) + + +### How to repair? + +Copy source video file to the folder next to `.edl` file. (On a disk, do not put it into Standalone Publisher.) + + + diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_frame_ranges.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_frame_ranges.xml new file mode 100644 index 0000000000..933df1c7c5 --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_frame_ranges.xml @@ -0,0 +1,15 @@ + + + +Invalid frame range + +## Invalid frame range + +Expected duration or '{duration}' frames set in database, workfile contains only '{found}' frames. + +### How to repair? + +Modify configuration in the database or tweak frame range in the workfile. + + + \ No newline at end of file diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_shot_duplicates.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_shot_duplicates.xml new file mode 100644 index 0000000000..77b8727162 --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_shot_duplicates.xml @@ -0,0 +1,15 @@ + + + +Duplicate shots + +## Duplicate shot names + +Process contains duplicated shot names '{duplicates_str}'. + +### How to repair? + +Remove shot duplicates. + + + \ No newline at end of file diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_sources.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_sources.xml new file mode 100644 index 0000000000..d527d2173e --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_sources.xml @@ -0,0 +1,16 @@ + + + +Files not found + +## Source files not found + +Process contains duplicated shot names: +'{files_not_found}' + +### How to repair? + +Add missing files or run Publish again to collect new publishable files. + + + \ No newline at end of file diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_task_existence.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_task_existence.xml new file mode 100644 index 0000000000..a943f560d0 --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_task_existence.xml @@ -0,0 +1,16 @@ + + + +Task not found + +## Task not found in database + +Process contains tasks that don't exist in database: +'{task_not_found}' + +### How to repair? + +Remove set task or add task into database into proper place. + + + \ No newline at end of file diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_batch.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_batch.xml new file mode 100644 index 0000000000..a645df8d02 --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_batch.xml @@ -0,0 +1,15 @@ + + + +No texture files found + +## Batch doesn't contain texture files + +Batch must contain at least one texture file. + +### How to repair? + +Add texture file to the batch or check name if it follows naming convention to match texture files to the batch. + + + \ No newline at end of file diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_has_workfile.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_has_workfile.xml new file mode 100644 index 0000000000..077987a96d --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_has_workfile.xml @@ -0,0 +1,15 @@ + + + +No workfile found + +## Batch should contain workfile + +It is expected that published contains workfile that served as a source for textures. + +### How to repair? + +Add workfile to the batch, or disable this validator if you do not want workfile published. + + + \ No newline at end of file diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_name.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_name.xml new file mode 100644 index 0000000000..2610917736 --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_name.xml @@ -0,0 +1,32 @@ + + + +Asset name not found + +## Couldn't parse asset name from a file + +Unable to parse asset name from '{file_name}'. File name doesn't match configured naming convention. + +### How to repair? + +Check Settings: project_settings/standalonepublisher/publish/CollectTextures for naming convention. + + +### __Detailed Info__ (optional) + +This error happens when parsing cannot figure out name of asset texture files belong under. + + + +Missing keys + +## Texture file name is missing some required keys + +Texture '{file_name}' is missing values for {missing_str} keys. + +### How to repair? + +Fix name of texture file and Publish again. + + + diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_versions.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_versions.xml new file mode 100644 index 0000000000..1e536e604f --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_versions.xml @@ -0,0 +1,35 @@ + + + +Texture version + +## Texture version mismatch with workfile + +Workfile '{file_name}' version doesn't match with '{version}' of a texture. + +### How to repair? + +Rename either workfile or texture to contain matching versions + + +### __Detailed Info__ (optional) + +This might happen if you are trying to publish textures for older version of workfile (or the other way). +(Eg. publishing 'workfile_v001' and 'texture_file_v002') + + + +Too many versions + +## Too many versions published at same time + +It is currently expected to publish only batch with single version. + +Found {found} versions. + +### How to repair? + +Please remove files with different version and split publishing into multiple steps. + + + diff --git a/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_workfiles.xml b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_workfiles.xml new file mode 100644 index 0000000000..8187eb0bc8 --- /dev/null +++ b/openpype/hosts/standalonepublisher/plugins/publish/help/validate_texture_workfiles.xml @@ -0,0 +1,23 @@ + + + +No secondary workfile + +## No secondary workfile found + +Current process expects that primary workfile (for example with a extension '{extension}') will contain also 'secondary' workfile. + +Secondary workfile for '{file_name}' wasn't found. + +### How to repair? + +Attach secondary workfile or disable this validator and Publish again. + + +### __Detailed Info__ (optional) + +This process was implemented for a possible use case of first workfile coming from Mari, secondary workfile for textures from Substance. +Publish should contain both if primary workfile is present. + + + diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_editorial_resources.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_editorial_resources.py index 6759b87ceb..afb828474d 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_editorial_resources.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_editorial_resources.py @@ -1,5 +1,6 @@ import pyblish.api import openpype.api +from openpype.pipeline import PublishXmlValidationError class ValidateEditorialResources(pyblish.api.InstancePlugin): @@ -19,5 +20,7 @@ class ValidateEditorialResources(pyblish.api.InstancePlugin): f"Instance: {instance}, Families: " f"{[instance.data['family']] + instance.data['families']}") check_file = instance.data["editorialSourcePath"] - msg = f"Missing \"{check_file}\"." - assert check_file, msg + msg = "Missing source video file." + + if not check_file: + raise PublishXmlValidationError(self, msg) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_frame_ranges.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_frame_ranges.py index 943cb73b98..005157af62 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_frame_ranges.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_frame_ranges.py @@ -1,8 +1,10 @@ import re import pyblish.api + import openpype.api from openpype import lib +from openpype.pipeline import PublishXmlValidationError class ValidateFrameRange(pyblish.api.InstancePlugin): @@ -48,9 +50,15 @@ class ValidateFrameRange(pyblish.api.InstancePlugin): files = [files] frames = len(files) - err_msg = "Frame duration from DB:'{}' ". format(int(duration)) +\ - " doesn't match number of files:'{}'".format(frames) +\ - " Please change frame range for Asset or limit no. of files" - assert frames == duration, err_msg + msg = "Frame duration from DB:'{}' ". format(int(duration)) +\ + " doesn't match number of files:'{}'".format(frames) +\ + " Please change frame range for Asset or limit no. of files" - self.log.debug("Valid ranges {} - {}".format(int(duration), frames)) + formatting_data = {"duration": duration, + "found": frames} + if frames != duration: + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) + + self.log.debug("Valid ranges expected '{}' - found '{}'". + format(int(duration), frames)) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_shot_duplicates.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_shot_duplicates.py index 85ec9379ce..fe655f6b74 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_shot_duplicates.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_shot_duplicates.py @@ -1,6 +1,7 @@ import pyblish.api -import openpype.api +import openpype.api +from openpype.pipeline import PublishXmlValidationError class ValidateShotDuplicates(pyblish.api.ContextPlugin): """Validating no duplicate names are in context.""" @@ -20,4 +21,8 @@ class ValidateShotDuplicates(pyblish.api.ContextPlugin): shot_names.append(name) msg = "There are duplicate shot names:\n{}".format(duplicate_names) - assert not duplicate_names, msg + + formatting_data = {"duplicates_str": ','.join(duplicate_names)} + if duplicate_names: + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_sources.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_sources.py index eec675e97f..316f58988f 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_sources.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_sources.py @@ -1,8 +1,10 @@ -import pyblish.api -import openpype.api - import os +import pyblish.api + +import openpype.api +from openpype.pipeline import PublishXmlValidationError + class ValidateSources(pyblish.api.InstancePlugin): """Validates source files. @@ -11,7 +13,6 @@ class ValidateSources(pyblish.api.InstancePlugin): got deleted between starting of SP and now. """ - order = openpype.api.ValidateContentsOrder label = "Check source files" @@ -22,6 +23,7 @@ class ValidateSources(pyblish.api.InstancePlugin): def process(self, instance): self.log.info("instance {}".format(instance.data)) + missing_files = set() for repre in instance.data.get("representations") or []: files = [] if isinstance(repre["files"], str): @@ -34,4 +36,10 @@ class ValidateSources(pyblish.api.InstancePlugin): file_name) if not os.path.exists(source_file): - raise ValueError("File {} not found".format(source_file)) + missing_files.add(source_file) + + msg = "Files '{}' not found".format(','.join(missing_files)) + formatting_data = {"files_not_found": ' - {}'.join(missing_files)} + if missing_files: + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_task_existence.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_task_existence.py index e3b2ae1646..825092c81b 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_task_existence.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_task_existence.py @@ -1,6 +1,8 @@ import pyblish.api from avalon import io +from openpype.pipeline import PublishXmlValidationError + class ValidateTaskExistence(pyblish.api.ContextPlugin): """Validating tasks on instances are filled and existing.""" @@ -53,4 +55,9 @@ class ValidateTaskExistence(pyblish.api.ContextPlugin): "Asset: \"{}\" Task: \"{}\"".format(*missing_pair) ) - raise AssertionError(msg.format("\n".join(pair_msgs))) + msg = msg.format("\n".join(pair_msgs)) + + formatting_data = {"task_not_found": ' - {}'.join(pair_msgs)} + if pair_msgs: + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_batch.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_batch.py index d592a4a059..d66fb257bb 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_batch.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_batch.py @@ -1,6 +1,8 @@ import pyblish.api import openpype.api +from openpype.pipeline import PublishXmlValidationError + class ValidateTextureBatch(pyblish.api.InstancePlugin): """Validates that some texture files are present.""" @@ -15,8 +17,10 @@ class ValidateTextureBatch(pyblish.api.InstancePlugin): present = False for instance in instance.context: if instance.data["family"] == "textures": - self.log.info("Some textures present.") + self.log.info("At least some textures present.") return - assert present, "No textures found in published batch!" + msg = "No textures found in published batch!" + if not present: + raise PublishXmlValidationError(self, msg) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_has_workfile.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_has_workfile.py index 7cd540668c..0e67464f59 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_has_workfile.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_has_workfile.py @@ -1,5 +1,7 @@ import pyblish.api + import openpype.api +from openpype.pipeline import PublishXmlValidationError class ValidateTextureHasWorkfile(pyblish.api.InstancePlugin): @@ -17,4 +19,6 @@ class ValidateTextureHasWorkfile(pyblish.api.InstancePlugin): def process(self, instance): wfile = instance.data["versionData"].get("workfile") - assert wfile, "Textures are missing attached workfile" + msg = "Textures are missing attached workfile" + if not wfile: + raise PublishXmlValidationError(self, msg) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_name.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_name.py index 4bafe81020..751ad917ca 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_name.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_name.py @@ -1,6 +1,7 @@ import pyblish.api -import openpype.api +import openpype.api +from openpype.pipeline import PublishXmlValidationError class ValidateTextureBatchNaming(pyblish.api.InstancePlugin): """Validates that all instances had properly formatted name.""" @@ -19,9 +20,13 @@ class ValidateTextureBatchNaming(pyblish.api.InstancePlugin): msg = "Couldn't find asset name in '{}'\n".format(file_name) + \ "File name doesn't follow configured pattern.\n" + \ "Please rename the file." - assert "NOT_AVAIL" not in instance.data["asset_build"], msg - instance.data.pop("asset_build") + formatting_data = {"file_name": file_name} + if "NOT_AVAIL" in instance.data["asset_build"]: + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data) + + instance.data.pop("asset_build") # not needed anymore if instance.data["family"] == "textures": file_name = instance.data["representations"][0]["files"][0] @@ -47,4 +52,10 @@ class ValidateTextureBatchNaming(pyblish.api.InstancePlugin): "Name of the texture file doesn't match expected pattern.\n" + \ "Please rename file(s) {}".format(file_name) - assert not missing_key_values, msg + missing_str = ','.join(["'{}'".format(key) + for key in missing_key_values]) + formatting_data = {"file_name": file_name, + "missing_str": missing_str} + if missing_key_values: + raise PublishXmlValidationError(self, msg, key="missing_values", + formatting_data=formatting_data) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_versions.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_versions.py index 90d0e8e512..84d9def895 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_versions.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_versions.py @@ -1,5 +1,7 @@ import pyblish.api + import openpype.api +from openpype.pipeline import PublishXmlValidationError class ValidateTextureBatchVersions(pyblish.api.InstancePlugin): @@ -25,14 +27,21 @@ class ValidateTextureBatchVersions(pyblish.api.InstancePlugin): self.log.info("No workfile present for textures") return - msg = "Not matching version: texture v{:03d} - workfile {}" - assert version_str in wfile, \ + if version_str not in wfile: + msg = "Not matching version: texture v{:03d} - workfile {}" msg.format( instance.data["version"], wfile ) + raise PublishXmlValidationError(self, msg) present_versions = set() for instance in instance.context: present_versions.add(instance.data["version"]) - assert len(present_versions) == 1, "Too many versions in a batch!" + if len(present_versions) != 1: + msg = "Too many versions in a batch!" + found = ','.join(["'{}'".format(val) for val in present_versions]) + formatting_data = {"found": found} + + raise PublishXmlValidationError(self, msg, key="too_many", + formatting_data=formatting_data) diff --git a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_workfiles.py b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_workfiles.py index 25bb5aea4a..fa492a80d8 100644 --- a/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_workfiles.py +++ b/openpype/hosts/standalonepublisher/plugins/publish/validate_texture_workfiles.py @@ -1,11 +1,13 @@ import pyblish.api + import openpype.api +from openpype.pipeline import PublishXmlValidationError class ValidateTextureBatchWorkfiles(pyblish.api.InstancePlugin): """Validates that textures workfile has collected resources (optional). - Collected recourses means secondary workfiles (in most cases). + Collected resources means secondary workfiles (in most cases). """ label = "Validate Texture Workfile Has Resources" @@ -24,6 +26,13 @@ class ValidateTextureBatchWorkfiles(pyblish.api.InstancePlugin): self.log.warning("Only secondary workfile present!") return - msg = "No secondary workfiles present for workfile {}".\ - format(instance.data["name"]) - assert instance.data.get("resources"), msg + if not instance.data.get("resources"): + msg = "No secondary workfile present for workfile '{}'". \ + format(instance.data["name"]) + ext = self.main_workfile_extensions[0] + formatting_data = {"file_name": instance.data["name"], + "extension": ext} + + raise PublishXmlValidationError(self, msg, + formatting_data=formatting_data + ) diff --git a/openpype/hosts/testhost/api/instances.json b/openpype/hosts/testhost/api/instances.json index 84021eff91..d955012514 100644 --- a/openpype/hosts/testhost/api/instances.json +++ b/openpype/hosts/testhost/api/instances.json @@ -8,7 +8,7 @@ "asset": "sq01_sh0010", "task": "Compositing", "variant": "myVariant", - "uuid": "a485f148-9121-46a5-8157-aa64df0fb449", + "instance_id": "a485f148-9121-46a5-8157-aa64df0fb449", "creator_attributes": { "number_key": 10, "ha": 10 @@ -29,8 +29,8 @@ "asset": "sq01_sh0010", "task": "Compositing", "variant": "myVariant2", - "uuid": "a485f148-9121-46a5-8157-aa64df0fb444", "creator_attributes": {}, + "instance_id": "a485f148-9121-46a5-8157-aa64df0fb444", "publish_attributes": { "CollectFtrackApi": { "add_ftrack_family": true @@ -47,8 +47,8 @@ "asset": "sq01_sh0010", "task": "Compositing", "variant": "Main", - "uuid": "3607bc95-75f6-4648-a58d-e699f413d09f", "creator_attributes": {}, + "instance_id": "3607bc95-75f6-4648-a58d-e699f413d09f", "publish_attributes": { "CollectFtrackApi": { "add_ftrack_family": true @@ -65,7 +65,7 @@ "asset": "sq01_sh0020", "task": "Compositing", "variant": "Main2", - "uuid": "4ccf56f6-9982-4837-967c-a49695dbe8eb", + "instance_id": "4ccf56f6-9982-4837-967c-a49695dbe8eb", "creator_attributes": {}, "publish_attributes": { "CollectFtrackApi": { @@ -83,7 +83,7 @@ "asset": "sq01_sh0020", "task": "Compositing", "variant": "Main2", - "uuid": "4ccf56f6-9982-4837-967c-a49695dbe8ec", + "instance_id": "4ccf56f6-9982-4837-967c-a49695dbe8ec", "creator_attributes": {}, "publish_attributes": { "CollectFtrackApi": { @@ -101,7 +101,7 @@ "asset": "Alpaca_01", "task": "modeling", "variant": "Main", - "uuid": "7c9ddfc7-9f9c-4c1c-b233-38c966735fb6", + "instance_id": "7c9ddfc7-9f9c-4c1c-b233-38c966735fb6", "creator_attributes": {}, "publish_attributes": {} } diff --git a/openpype/hosts/testhost/api/pipeline.py b/openpype/hosts/testhost/api/pipeline.py index 49f1d3f33d..1f5d680705 100644 --- a/openpype/hosts/testhost/api/pipeline.py +++ b/openpype/hosts/testhost/api/pipeline.py @@ -114,7 +114,7 @@ def update_instances(update_list): instances = HostContext.get_instances() for instance_data in instances: - instance_id = instance_data["uuid"] + instance_id = instance_data["instance_id"] if instance_id in updated_instances: new_instance_data = updated_instances[instance_id] old_keys = set(instance_data.keys()) @@ -132,10 +132,10 @@ def remove_instances(instances): current_instances = HostContext.get_instances() for instance in instances: - instance_id = instance.data["uuid"] + instance_id = instance.data["instance_id"] found_idx = None for idx, _instance in enumerate(current_instances): - if instance_id == _instance["uuid"]: + if instance_id == _instance["instance_id"]: found_idx = idx break diff --git a/openpype/hosts/testhost/plugins/publish/collect_context.py b/openpype/hosts/testhost/plugins/publish/collect_context.py index bbb8477cdf..0ab98fb84b 100644 --- a/openpype/hosts/testhost/plugins/publish/collect_context.py +++ b/openpype/hosts/testhost/plugins/publish/collect_context.py @@ -19,7 +19,7 @@ class CollectContextDataTestHost( hosts = ["testhost"] @classmethod - def get_instance_attr_defs(cls): + def get_attribute_defs(cls): return [ attribute_definitions.BoolDef( "test_bool", diff --git a/openpype/hosts/testhost/plugins/publish/collect_instance_1.py b/openpype/hosts/testhost/plugins/publish/collect_instance_1.py index 979ab83f11..3c035eccb6 100644 --- a/openpype/hosts/testhost/plugins/publish/collect_instance_1.py +++ b/openpype/hosts/testhost/plugins/publish/collect_instance_1.py @@ -20,7 +20,7 @@ class CollectInstanceOneTestHost( hosts = ["testhost"] @classmethod - def get_instance_attr_defs(cls): + def get_attribute_defs(cls): return [ attribute_definitions.NumberDef( "version", diff --git a/openpype/hosts/traypublisher/api/__init__.py b/openpype/hosts/traypublisher/api/__init__.py new file mode 100644 index 0000000000..c461c0c526 --- /dev/null +++ b/openpype/hosts/traypublisher/api/__init__.py @@ -0,0 +1,20 @@ +from .pipeline import ( + install, + ls, + + set_project_name, + get_context_title, + get_context_data, + update_context_data, +) + + +__all__ = ( + "install", + "ls", + + "set_project_name", + "get_context_title", + "get_context_data", + "update_context_data", +) diff --git a/openpype/hosts/traypublisher/api/pipeline.py b/openpype/hosts/traypublisher/api/pipeline.py new file mode 100644 index 0000000000..a39e5641ae --- /dev/null +++ b/openpype/hosts/traypublisher/api/pipeline.py @@ -0,0 +1,180 @@ +import os +import json +import tempfile +import atexit + +from avalon import io +import avalon.api +import pyblish.api + +from openpype.pipeline import BaseCreator + +ROOT_DIR = os.path.dirname(os.path.dirname( + os.path.abspath(__file__) +)) +PUBLISH_PATH = os.path.join(ROOT_DIR, "plugins", "publish") +CREATE_PATH = os.path.join(ROOT_DIR, "plugins", "create") + + +class HostContext: + _context_json_path = None + + @staticmethod + def _on_exit(): + if ( + HostContext._context_json_path + and os.path.exists(HostContext._context_json_path) + ): + os.remove(HostContext._context_json_path) + + @classmethod + def get_context_json_path(cls): + if cls._context_json_path is None: + output_file = tempfile.NamedTemporaryFile( + mode="w", prefix="traypub_", suffix=".json" + ) + output_file.close() + cls._context_json_path = output_file.name + atexit.register(HostContext._on_exit) + print(cls._context_json_path) + return cls._context_json_path + + @classmethod + def _get_data(cls, group=None): + json_path = cls.get_context_json_path() + data = {} + if not os.path.exists(json_path): + with open(json_path, "w") as json_stream: + json.dump(data, json_stream) + else: + with open(json_path, "r") as json_stream: + content = json_stream.read() + if content: + data = json.loads(content) + if group is None: + return data + return data.get(group) + + @classmethod + def _save_data(cls, group, new_data): + json_path = cls.get_context_json_path() + data = cls._get_data() + data[group] = new_data + with open(json_path, "w") as json_stream: + json.dump(data, json_stream) + + @classmethod + def add_instance(cls, instance): + instances = cls.get_instances() + instances.append(instance) + cls.save_instances(instances) + + @classmethod + def get_instances(cls): + return cls._get_data("instances") or [] + + @classmethod + def save_instances(cls, instances): + cls._save_data("instances", instances) + + @classmethod + def get_context_data(cls): + return cls._get_data("context") or {} + + @classmethod + def save_context_data(cls, data): + cls._save_data("context", data) + + @classmethod + def get_project_name(cls): + return cls._get_data("project_name") + + @classmethod + def set_project_name(cls, project_name): + cls._save_data("project_name", project_name) + + @classmethod + def get_data_to_store(cls): + return { + "project_name": cls.get_project_name(), + "instances": cls.get_instances(), + "context": cls.get_context_data(), + } + + +def list_instances(): + return HostContext.get_instances() + + +def update_instances(update_list): + updated_instances = {} + for instance, _changes in update_list: + updated_instances[instance.id] = instance.data_to_store() + + instances = HostContext.get_instances() + for instance_data in instances: + instance_id = instance_data["instance_id"] + if instance_id in updated_instances: + new_instance_data = updated_instances[instance_id] + old_keys = set(instance_data.keys()) + new_keys = set(new_instance_data.keys()) + instance_data.update(new_instance_data) + for key in (old_keys - new_keys): + instance_data.pop(key) + + HostContext.save_instances(instances) + + +def remove_instances(instances): + if not isinstance(instances, (tuple, list)): + instances = [instances] + + current_instances = HostContext.get_instances() + for instance in instances: + instance_id = instance.data["instance_id"] + found_idx = None + for idx, _instance in enumerate(current_instances): + if instance_id == _instance["instance_id"]: + found_idx = idx + break + + if found_idx is not None: + current_instances.pop(found_idx) + HostContext.save_instances(current_instances) + + +def get_context_data(): + return HostContext.get_context_data() + + +def update_context_data(data, changes): + HostContext.save_context_data(data) + + +def get_context_title(): + return HostContext.get_project_name() + + +def ls(): + """Probably will never return loaded containers.""" + return [] + + +def install(): + """This is called before a project is known. + + Project is defined with 'set_project_name'. + """ + os.environ["AVALON_APP"] = "traypublisher" + + pyblish.api.register_host("traypublisher") + pyblish.api.register_plugin_path(PUBLISH_PATH) + avalon.api.register_plugin_path(BaseCreator, CREATE_PATH) + + +def set_project_name(project_name): + # TODO Deregister project specific plugins and register new project plugins + os.environ["AVALON_PROJECT"] = project_name + avalon.api.Session["AVALON_PROJECT"] = project_name + io.install() + HostContext.set_project_name(project_name) diff --git a/openpype/hosts/traypublisher/plugins/create/create_workfile.py b/openpype/hosts/traypublisher/plugins/create/create_workfile.py new file mode 100644 index 0000000000..2db4770bbc --- /dev/null +++ b/openpype/hosts/traypublisher/plugins/create/create_workfile.py @@ -0,0 +1,97 @@ +from openpype.hosts.traypublisher.api import pipeline +from openpype.pipeline import ( + Creator, + CreatedInstance, + lib +) + + +class WorkfileCreator(Creator): + identifier = "workfile" + label = "Workfile" + family = "workfile" + description = "Publish backup of workfile" + + create_allow_context_change = True + + extensions = [ + # Maya + ".ma", ".mb", + # Nuke + ".nk", + # Hiero + ".hrox", + # Houdini + ".hip", ".hiplc", ".hipnc", + # Blender + ".blend", + # Celaction + ".scn", + # TVPaint + ".tvpp", + # Fusion + ".comp", + # Harmony + ".zip", + # Premiere + ".prproj", + # Resolve + ".drp", + # Photoshop + ".psd", ".psb", + # Aftereffects + ".aep" + ] + + def get_icon(self): + return "fa.file" + + def collect_instances(self): + for instance_data in pipeline.list_instances(): + creator_id = instance_data.get("creator_identifier") + if creator_id == self.identifier: + instance = CreatedInstance.from_existing( + instance_data, self + ) + self._add_instance_to_context(instance) + + def update_instances(self, update_list): + pipeline.update_instances(update_list) + + def remove_instances(self, instances): + pipeline.remove_instances(instances) + for instance in instances: + self._remove_instance_from_context(instance) + + def create(self, subset_name, data, pre_create_data): + # Pass precreate data to creator attributes + data["creator_attributes"] = pre_create_data + # Create new instance + new_instance = CreatedInstance(self.family, subset_name, data, self) + # Host implementation of storing metadata about instance + pipeline.HostContext.add_instance(new_instance.data_to_store()) + # Add instance to current context + self._add_instance_to_context(new_instance) + + def get_default_variants(self): + return [ + "Main" + ] + + def get_instance_attr_defs(self): + output = [ + lib.FileDef( + "filepath", + folders=False, + extensions=self.extensions, + label="Filepath" + ) + ] + return output + + def get_pre_create_attr_defs(self): + # Use same attributes as for instance attrobites + return self.get_instance_attr_defs() + + def get_detail_description(self): + return """# Publish workfile backup""" diff --git a/openpype/hosts/traypublisher/plugins/publish/collect_source.py b/openpype/hosts/traypublisher/plugins/publish/collect_source.py new file mode 100644 index 0000000000..6ff22be13a --- /dev/null +++ b/openpype/hosts/traypublisher/plugins/publish/collect_source.py @@ -0,0 +1,24 @@ +import pyblish.api + + +class CollectSource(pyblish.api.ContextPlugin): + """Collecting instances from traypublisher host.""" + + label = "Collect source" + order = pyblish.api.CollectorOrder - 0.49 + hosts = ["traypublisher"] + + def process(self, context): + # get json paths from os and load them + source_name = "traypublisher" + for instance in context: + source = instance.data.get("source") + if not source: + instance.data["source"] = source_name + self.log.info(( + "Source of instance \"{}\" is changed to \"{}\"" + ).format(instance.data["name"], source_name)) + else: + self.log.info(( + "Source of instance \"{}\" was already set to \"{}\"" + ).format(instance.data["name"], source)) diff --git a/openpype/hosts/traypublisher/plugins/publish/collect_workfile.py b/openpype/hosts/traypublisher/plugins/publish/collect_workfile.py new file mode 100644 index 0000000000..d48bace047 --- /dev/null +++ b/openpype/hosts/traypublisher/plugins/publish/collect_workfile.py @@ -0,0 +1,31 @@ +import os +import pyblish.api + + +class CollectWorkfile(pyblish.api.InstancePlugin): + """Collect representation of workfile instances.""" + + label = "Collect Workfile" + order = pyblish.api.CollectorOrder - 0.49 + families = ["workfile"] + hosts = ["traypublisher"] + + def process(self, instance): + if "representations" not in instance.data: + instance.data["representations"] = [] + repres = instance.data["representations"] + + creator_attributes = instance.data["creator_attributes"] + filepath = creator_attributes["filepath"] + instance.data["sourceFilepath"] = filepath + + staging_dir = os.path.dirname(filepath) + filename = os.path.basename(filepath) + ext = os.path.splitext(filename)[-1] + + repres.append({ + "ext": ext, + "name": ext, + "stagingDir": staging_dir, + "files": filename + }) diff --git a/openpype/hosts/traypublisher/plugins/publish/validate_workfile.py b/openpype/hosts/traypublisher/plugins/publish/validate_workfile.py new file mode 100644 index 0000000000..88339d2aac --- /dev/null +++ b/openpype/hosts/traypublisher/plugins/publish/validate_workfile.py @@ -0,0 +1,24 @@ +import os +import pyblish.api +from openpype.pipeline import PublishValidationError + + +class ValidateWorkfilePath(pyblish.api.InstancePlugin): + """Validate existence of workfile instance existence.""" + + label = "Collect Workfile" + order = pyblish.api.ValidatorOrder - 0.49 + families = ["workfile"] + hosts = ["traypublisher"] + + def process(self, instance): + filepath = instance.data["sourceFilepath"] + if not filepath: + raise PublishValidationError(( + "Filepath of 'workfile' instance \"{}\" is not set" + ).format(instance.data["name"])) + + if not os.path.exists(filepath): + raise PublishValidationError(( + "Filepath of 'workfile' instance \"{}\" does not exist: {}" + ).format(instance.data["name"], filepath)) diff --git a/openpype/hosts/tvpaint/api/communication_server.py b/openpype/hosts/tvpaint/api/communication_server.py index e9c5f4c73e..65cb9aa2f3 100644 --- a/openpype/hosts/tvpaint/api/communication_server.py +++ b/openpype/hosts/tvpaint/api/communication_server.py @@ -21,7 +21,7 @@ from aiohttp_json_rpc.protocol import ( ) from aiohttp_json_rpc.exceptions import RpcError -from avalon import api +from openpype.lib import emit_event from openpype.hosts.tvpaint.tvpaint_plugin import get_plugin_files_path log = logging.getLogger(__name__) @@ -754,7 +754,7 @@ class BaseCommunicator: self._on_client_connect() - api.emit("application.launched") + emit_event("application.launched") def _on_client_connect(self): self._initial_textfile_write() @@ -938,5 +938,5 @@ class QtCommunicator(BaseCommunicator): def _exit(self, *args, **kwargs): super()._exit(*args, **kwargs) - api.emit("application.exit") + emit_event("application.exit") self.qt_app.exit(self.exit_code) diff --git a/openpype/hosts/tvpaint/api/pipeline.py b/openpype/hosts/tvpaint/api/pipeline.py index 74eb41892c..46c9d3a1dd 100644 --- a/openpype/hosts/tvpaint/api/pipeline.py +++ b/openpype/hosts/tvpaint/api/pipeline.py @@ -14,6 +14,12 @@ from avalon.pipeline import AVALON_CONTAINER_ID from openpype.hosts import tvpaint from openpype.api import get_current_project_settings +from openpype.lib import register_event_callback +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) from .lib import ( execute_george, @@ -75,8 +81,8 @@ def install(): pyblish.api.register_host("tvpaint") pyblish.api.register_plugin_path(PUBLISH_PATH) - avalon.api.register_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.register_plugin_path(avalon.api.Creator, CREATE_PATH) + register_loader_plugin_path(LOAD_PATH) + avalon.api.register_plugin_path(LegacyCreator, CREATE_PATH) registered_callbacks = ( pyblish.api.registered_callbacks().get("instanceToggled") or [] @@ -84,8 +90,8 @@ def install(): if on_instance_toggle not in registered_callbacks: pyblish.api.register_callback("instanceToggled", on_instance_toggle) - avalon.api.on("application.launched", initial_launch) - avalon.api.on("application.exit", application_exit) + register_event_callback("application.launched", initial_launch) + register_event_callback("application.exit", application_exit) def uninstall(): @@ -97,8 +103,8 @@ def uninstall(): log.info("OpenPype - Uninstalling TVPaint integration") pyblish.api.deregister_host("tvpaint") pyblish.api.deregister_plugin_path(PUBLISH_PATH) - avalon.api.deregister_plugin_path(avalon.api.Loader, LOAD_PATH) - avalon.api.deregister_plugin_path(avalon.api.Creator, CREATE_PATH) + deregister_loader_plugin_path(LOAD_PATH) + avalon.api.deregister_plugin_path(LegacyCreator, CREATE_PATH) def containerise( diff --git a/openpype/hosts/tvpaint/api/plugin.py b/openpype/hosts/tvpaint/api/plugin.py index af80c9eae2..15ad8905e0 100644 --- a/openpype/hosts/tvpaint/api/plugin.py +++ b/openpype/hosts/tvpaint/api/plugin.py @@ -1,16 +1,17 @@ import re import uuid -import avalon.api - -from openpype.api import PypeCreatorMixin +from openpype.pipeline import ( + LegacyCreator, + LoaderPlugin, +) from openpype.hosts.tvpaint.api import ( pipeline, lib ) -class Creator(PypeCreatorMixin, avalon.api.Creator): +class Creator(LegacyCreator): def __init__(self, *args, **kwargs): super(Creator, self).__init__(*args, **kwargs) # Add unified identifier created with `uuid` module @@ -74,7 +75,7 @@ class Creator(PypeCreatorMixin, avalon.api.Creator): self.write_instances(data) -class Loader(avalon.api.Loader): +class Loader(LoaderPlugin): hosts = ["tvpaint"] @staticmethod diff --git a/openpype/hosts/tvpaint/plugins/create/create_render_layer.py b/openpype/hosts/tvpaint/plugins/create/create_render_layer.py index 40a7d15990..c1af9632b1 100644 --- a/openpype/hosts/tvpaint/plugins/create/create_render_layer.py +++ b/openpype/hosts/tvpaint/plugins/create/create_render_layer.py @@ -1,5 +1,4 @@ -from avalon.api import CreatorError - +from openpype.pipeline import CreatorError from openpype.lib import prepare_template_data from openpype.hosts.tvpaint.api import ( plugin, diff --git a/openpype/hosts/tvpaint/plugins/create/create_render_pass.py b/openpype/hosts/tvpaint/plugins/create/create_render_pass.py index af962052fc..a7f717ccec 100644 --- a/openpype/hosts/tvpaint/plugins/create/create_render_pass.py +++ b/openpype/hosts/tvpaint/plugins/create/create_render_pass.py @@ -1,4 +1,4 @@ -from avalon.api import CreatorError +from openpype.pipeline import CreatorError from openpype.lib import prepare_template_data from openpype.hosts.tvpaint.api import ( plugin, diff --git a/openpype/hosts/tvpaint/plugins/load/load_image.py b/openpype/hosts/tvpaint/plugins/load/load_image.py index 7dba1e3619..f861d0119e 100644 --- a/openpype/hosts/tvpaint/plugins/load/load_image.py +++ b/openpype/hosts/tvpaint/plugins/load/load_image.py @@ -1,4 +1,4 @@ -from avalon.vendor import qargparse +import qargparse from openpype.hosts.tvpaint.api import lib, plugin diff --git a/openpype/hosts/tvpaint/plugins/load/load_reference_image.py b/openpype/hosts/tvpaint/plugins/load/load_reference_image.py index 0a85e5dc76..5e4e3965d2 100644 --- a/openpype/hosts/tvpaint/plugins/load/load_reference_image.py +++ b/openpype/hosts/tvpaint/plugins/load/load_reference_image.py @@ -1,6 +1,6 @@ import collections +import qargparse from avalon.pipeline import get_representation_context -from avalon.vendor import qargparse from openpype.hosts.tvpaint.api import lib, pipeline, plugin diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_asset_name.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_asset_name.xml new file mode 100644 index 0000000000..33a9ca4247 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_asset_name.xml @@ -0,0 +1,22 @@ + + + +Subset context +## Invalid subset context + +Context of the given subset doesn't match your current scene. + +### How to repair? + +Yout can fix this with "Repair" button on the right. This will use '{expected_asset}' asset name and overwrite '{found_asset}' asset name in scene metadata. + +After that restart publishing with Reload button. + + +### How could this happen? + +The subset was created in different scene with different context +or the scene file was copy pasted from different context. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_duplicated_layer_names.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_duplicated_layer_names.xml new file mode 100644 index 0000000000..5d798544c0 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_duplicated_layer_names.xml @@ -0,0 +1,22 @@ + + + +Layer names +## Duplicated layer names + +Can't determine which layers should be published because there are duplicated layer names in the scene. + +### Duplicated layer names + +{layer_names} + +*Check layer names for all subsets in list on left side.* + +### How to repair? + +Hide/rename/remove layers that should not be published. + +If all of them should be published then you have duplicated subset names in the scene. In that case you have to recrete them and use different variant name. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_layers_visibility.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_layers_visibility.xml new file mode 100644 index 0000000000..e7be735888 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_layers_visibility.xml @@ -0,0 +1,20 @@ + + + +Layers visiblity +## All layers are not visible + +Layers visibility was changed during publishing which caused that all layers for subset "{instance_name}" are hidden. + +### Layer names for **{instance_name}** + +{layer_names} + +*Check layer names for all subsets in the list on the left side.* + +### How to repair? + +Reset publishing and do not change visibility of layers after hitting publish button. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_marks.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_marks.xml new file mode 100644 index 0000000000..f0e01ebaa7 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_marks.xml @@ -0,0 +1,21 @@ + + + +Frame range +## Invalid render frame range + +Scene frame range which will be rendered is defined by MarkIn and MarkOut. Expected frame range is {expected_frame_range} and current frame range is {current_frame_range}. + +It is also required that MarkIn and MarkOut are enabled in the scene. Their color is highlighted on timeline when are enabled. + +- MarkIn is {mark_in_enable_state} +- MarkOut is {mark_out_enable_state} + +### How to repair? + +Yout can fix this with "Repair" button on the right. That will change MarkOut to {expected_mark_out}. + +Or you can manually modify MarkIn and MarkOut in the scene timeline. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_missing_layer_names.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_missing_layer_names.xml new file mode 100644 index 0000000000..e96e7c5044 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_missing_layer_names.xml @@ -0,0 +1,18 @@ + + + +Missing layers +## Missing layers for render pass + +Render pass subset "{instance_name}" has stored layer names that belong to it's rendering scope but layers were not found in scene. + +### Missing layer names + +{layer_names} + +### How to repair? + +Find layers that belong to subset {instance_name} and rename them back to expected layer names or remove the subset and create new with right layers. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_render_pass_group.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_render_pass_group.xml new file mode 100644 index 0000000000..df7bdf36e5 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_render_pass_group.xml @@ -0,0 +1,14 @@ + + + +Render pass group +## Invalid group of Render Pass layers + +Layers of Render Pass {instance_name} belong to Render Group which is defined by TVPaint color group {expected_group}. But the layers are not in the group. + +### How to repair? + +Change the color group to {expected_group} on layers {layer_names}. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_scene_settings.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_scene_settings.xml new file mode 100644 index 0000000000..f741c71456 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_scene_settings.xml @@ -0,0 +1,26 @@ + + + +Scene settings +## Invalid scene settings + +Scene settings do not match to expected values. + +**FPS** +- Expected value: {expected_fps} +- Current value: {current_fps} + +**Resolution** +- Expected value: {expected_width}x{expected_height} +- Current value: {current_width}x{current_height} + +**Pixel ratio** +- Expected value: {expected_pixel_ratio} +- Current value: {current_pixel_ratio} + +### How to repair? + +FPS and Pixel ratio can be modified in scene setting. Wrong resolution can be fixed with changing resolution of scene but due to TVPaint limitations it is possible that you will need to create new scene. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_start_frame.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_start_frame.xml new file mode 100644 index 0000000000..9052abf66c --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_start_frame.xml @@ -0,0 +1,14 @@ + + + +First frame +## MarkIn is not set to 0 + +MarkIn in your scene must start from 0 fram index but MarkIn is set to {current_start_frame}. + +### How to repair? + +You can modify MarkIn manually or hit the "Repair" button on the right which will change MarkIn to 0 (does not change MarkOut). + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_workfile_metadata.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_workfile_metadata.xml new file mode 100644 index 0000000000..7397f6ef0b --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_workfile_metadata.xml @@ -0,0 +1,19 @@ + + + +Missing metadata +## Your scene miss context metadata + +Your scene does not contain metadata about {missing_metadata}. + +### How to repair? + +Resave the scene using Workfiles tool or hit the "Repair" button on the right. + + +### How this could happend? + +You're using scene file that was not created using Workfiles tool. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_workfile_project_name.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_workfile_project_name.xml new file mode 100644 index 0000000000..c4ffafc8b5 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_workfile_project_name.xml @@ -0,0 +1,24 @@ + + + +Project name +## Your scene is from different project + +It is not possible to publish into project "{workfile_project_name}" when TVPaint was opened with project "{env_project_name}" in context. + +### How to repair? + +If the workfile belongs to project "{env_project_name}" then use Workfiles tool to resave it. + +Otherwise close TVPaint and launch it again from project you want to publish in. + + +### How this could happend? + +You've opened workfile from different project. You've opened TVPaint on a task from "{env_project_name}" then you've opened TVPaint again on task from "{workfile_project_name}" without closing the TVPaint. Because TVPaint can run only once the project didn't change. + +### Why it is important? +Because project may affect how TVPaint works or change publishing behavior it is dangerous to allow change project context in many ways. For example publishing will not run as expected. + + + diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_asset_name.py b/openpype/hosts/tvpaint/plugins/publish/validate_asset_name.py index 0fdeba0a21..70816f9f18 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_asset_name.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_asset_name.py @@ -1,4 +1,5 @@ import pyblish.api +from openpype.pipeline import PublishXmlValidationError from openpype.hosts.tvpaint.api import pipeline @@ -27,7 +28,7 @@ class FixAssetNames(pyblish.api.Action): pipeline._write_instances(new_instance_items) -class ValidateMissingLayers(pyblish.api.ContextPlugin): +class ValidateAssetNames(pyblish.api.ContextPlugin): """Validate assset name present on instance. Asset name on instance should be the same as context's. @@ -48,8 +49,18 @@ class ValidateMissingLayers(pyblish.api.ContextPlugin): instance_label = ( instance.data.get("label") or instance.data["name"] ) - raise AssertionError(( - "Different asset name on instance then context's." - " Instance \"{}\" has asset name: \"{}\"" - " Context asset name is: \"{}\"" - ).format(instance_label, asset_name, context_asset_name)) + + raise PublishXmlValidationError( + self, + ( + "Different asset name on instance then context's." + " Instance \"{}\" has asset name: \"{}\"" + " Context asset name is: \"{}\"" + ).format( + instance_label, asset_name, context_asset_name + ), + formatting_data={ + "expected_asset": context_asset_name, + "found_asset": asset_name + } + ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_duplicated_layer_names.py b/openpype/hosts/tvpaint/plugins/publish/validate_duplicated_layer_names.py index efccf19ef9..9f61bdbcd0 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_duplicated_layer_names.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_duplicated_layer_names.py @@ -1,4 +1,5 @@ import pyblish.api +from openpype.pipeline import PublishXmlValidationError class ValidateLayersGroup(pyblish.api.InstancePlugin): @@ -30,14 +31,20 @@ class ValidateLayersGroup(pyblish.api.InstancePlugin): "\"{}\"".format(layer_name) for layer_name in duplicated_layer_names ]) - - # Raise an error - raise AssertionError( + detail_lines = [ + "- {}".format(layer_name) + for layer_name in set(duplicated_layer_names) + ] + raise PublishXmlValidationError( + self, ( "Layers have duplicated names for instance {}." # Description what's wrong " There are layers with same name and one of them is marked" " for publishing so it is not possible to know which should" " be published. Please look for layers with names: {}" - ).format(instance.data["label"], layers_msg) + ).format(instance.data["label"], layers_msg), + formatting_data={ + "layer_names": "
".join(detail_lines) + } ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_layers_visibility.py b/openpype/hosts/tvpaint/plugins/publish/validate_layers_visibility.py index 74ef34169e..7ea0587b8f 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_layers_visibility.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_layers_visibility.py @@ -1,6 +1,8 @@ import pyblish.api +from openpype.pipeline import PublishXmlValidationError +# TODO @iLLiCiTiT add repair action to disable instances? class ValidateLayersVisiblity(pyblish.api.InstancePlugin): """Validate existence of renderPass layers.""" @@ -9,8 +11,26 @@ class ValidateLayersVisiblity(pyblish.api.InstancePlugin): families = ["review", "renderPass", "renderLayer"] def process(self, instance): + layer_names = set() for layer in instance.data["layers"]: + layer_names.add(layer["name"]) if layer["visible"]: return - raise AssertionError("All layers of instance are not visible.") + instance_label = ( + instance.data.get("label") or instance.data["name"] + ) + + raise PublishXmlValidationError( + self, + "All layers of instance \"{}\" are not visible.".format( + instance_label + ), + formatting_data={ + "instance_name": instance_label, + "layer_names": "
".join([ + "- {}".format(layer_name) + for layer_name in layer_names + ]) + } + ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_marks.py b/openpype/hosts/tvpaint/plugins/publish/validate_marks.py index f45247ceac..d1f299e006 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_marks.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_marks.py @@ -1,6 +1,7 @@ import json import pyblish.api +from openpype.pipeline import PublishXmlValidationError from openpype.hosts.tvpaint.api import lib @@ -73,9 +74,34 @@ class ValidateMarks(pyblish.api.ContextPlugin): "expected": expected_data[k] } - if invalid: - raise AssertionError( - "Marks does not match database:\n{}".format( - json.dumps(invalid, sort_keys=True, indent=4) - ) - ) + # Validation ends + if not invalid: + return + + current_frame_range = ( + (current_data["markOut"] - current_data["markIn"]) + 1 + ) + expected_frame_range = ( + (expected_data["markOut"] - expected_data["markIn"]) + 1 + ) + mark_in_enable_state = "disabled" + if current_data["markInState"]: + mark_in_enable_state = "enabled" + + mark_out_enable_state = "disabled" + if current_data["markOutState"]: + mark_out_enable_state = "enabled" + + raise PublishXmlValidationError( + self, + "Marks does not match database:\n{}".format( + json.dumps(invalid, sort_keys=True, indent=4) + ), + formatting_data={ + "current_frame_range": str(current_frame_range), + "expected_frame_range": str(expected_frame_range), + "mark_in_enable_state": mark_in_enable_state, + "mark_out_enable_state": mark_out_enable_state, + "expected_mark_out": expected_data["markOut"] + } + ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_missing_layer_names.py b/openpype/hosts/tvpaint/plugins/publish/validate_missing_layer_names.py index db9d354fcd..294ce6cf4f 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_missing_layer_names.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_missing_layer_names.py @@ -1,4 +1,5 @@ import pyblish.api +from openpype.pipeline import PublishXmlValidationError class ValidateMissingLayers(pyblish.api.InstancePlugin): @@ -30,13 +31,25 @@ class ValidateMissingLayers(pyblish.api.InstancePlugin): "\"{}\"".format(layer_name) for layer_name in missing_layer_names ]) + instance_label = ( + instance.data.get("label") or instance.data["name"] + ) + description_layer_names = "
".join([ + "- {}".format(layer_name) + for layer_name in missing_layer_names + ]) # Raise an error - raise AssertionError( + raise PublishXmlValidationError( + self, ( "Layers were not found by name for instance \"{}\"." # Description what's wrong " Layer names marked for publishing are not available" " in layers list. Missing layer names: {}" - ).format(instance.data["label"], layers_msg) + ).format(instance.data["label"], layers_msg), + formatting_data={ + "instance_name": instance_label, + "layer_names": description_layer_names + } ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_project_settings.py b/openpype/hosts/tvpaint/plugins/publish/validate_project_settings.py deleted file mode 100644 index 84c03a9857..0000000000 --- a/openpype/hosts/tvpaint/plugins/publish/validate_project_settings.py +++ /dev/null @@ -1,34 +0,0 @@ -import json - -import pyblish.api - - -class ValidateProjectSettings(pyblish.api.ContextPlugin): - """Validate project settings against database. - """ - - label = "Validate Project Settings" - order = pyblish.api.ValidatorOrder - optional = True - - def process(self, context): - scene_data = { - "fps": context.data.get("sceneFps"), - "resolutionWidth": context.data.get("sceneWidth"), - "resolutionHeight": context.data.get("sceneHeight"), - "pixelAspect": context.data.get("scenePixelAspect") - } - invalid = {} - for k in scene_data.keys(): - expected_value = context.data["assetEntity"]["data"][k] - if scene_data[k] != expected_value: - invalid[k] = { - "current": scene_data[k], "expected": expected_value - } - - if invalid: - raise AssertionError( - "Project settings does not match database:\n{}".format( - json.dumps(invalid, sort_keys=True, indent=4) - ) - ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_render_pass_group.py b/openpype/hosts/tvpaint/plugins/publish/validate_render_pass_group.py index 5047b8d729..0fbfca6c56 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_render_pass_group.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_render_pass_group.py @@ -1,5 +1,6 @@ import collections import pyblish.api +from openpype.pipeline import PublishXmlValidationError class ValidateLayersGroup(pyblish.api.InstancePlugin): @@ -26,11 +27,13 @@ class ValidateLayersGroup(pyblish.api.InstancePlugin): layer_names = instance.data["layer_names"] # Check if all layers from render pass are in right group invalid_layers_by_group_id = collections.defaultdict(list) + invalid_layer_names = set() for layer_name in layer_names: layer = layers_by_name.get(layer_name) _group_id = layer["group_id"] if _group_id != group_id: invalid_layers_by_group_id[_group_id].append(layer) + invalid_layer_names.add(layer_name) # Everything is OK and skip exception if not invalid_layers_by_group_id: @@ -61,16 +64,27 @@ class ValidateLayersGroup(pyblish.api.InstancePlugin): ) # Raise an error - raise AssertionError(( - # Short message - "Layers in wrong group." - # Description what's wrong - " Layers from render pass \"{}\" must be in group {} (id: {})." - # Detailed message - " Layers in wrong group: {}" - ).format( - instance.data["label"], - correct_group["name"], - correct_group["group_id"], - " | ".join(per_group_msgs) - )) + raise PublishXmlValidationError( + self, + ( + # Short message + "Layers in wrong group." + # Description what's wrong + " Layers from render pass \"{}\" must be in group {} (id: {})." + # Detailed message + " Layers in wrong group: {}" + ).format( + instance.data["label"], + correct_group["name"], + correct_group["group_id"], + " | ".join(per_group_msgs) + ), + formatting_data={ + "instance_name": ( + instance.data.get("label") or instance.data["name"] + ), + "expected_group": correct_group["name"], + "layer_names": ", ".join(invalid_layer_names) + + } + ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_scene_settings.py b/openpype/hosts/tvpaint/plugins/publish/validate_scene_settings.py new file mode 100644 index 0000000000..d235215ac9 --- /dev/null +++ b/openpype/hosts/tvpaint/plugins/publish/validate_scene_settings.py @@ -0,0 +1,49 @@ +import json + +import pyblish.api +from openpype.pipeline import PublishXmlValidationError + + +# TODO @iLliCiTiT add fix action for fps +class ValidateProjectSettings(pyblish.api.ContextPlugin): + """Validate scene settings against database.""" + + label = "Validate Scene Settings" + order = pyblish.api.ValidatorOrder + optional = True + + def process(self, context): + expected_data = context.data["assetEntity"]["data"] + scene_data = { + "fps": context.data.get("sceneFps"), + "resolutionWidth": context.data.get("sceneWidth"), + "resolutionHeight": context.data.get("sceneHeight"), + "pixelAspect": context.data.get("scenePixelAspect") + } + invalid = {} + for k in scene_data.keys(): + expected_value = expected_data[k] + if scene_data[k] != expected_value: + invalid[k] = { + "current": scene_data[k], "expected": expected_value + } + + if not invalid: + return + + raise PublishXmlValidationError( + self, + "Scene settings does not match database:\n{}".format( + json.dumps(invalid, sort_keys=True, indent=4) + ), + formatting_data={ + "expected_fps": expected_data["fps"], + "current_fps": scene_data["fps"], + "expected_width": expected_data["resolutionWidth"], + "expected_height": expected_data["resolutionHeight"], + "current_width": scene_data["resolutionWidth"], + "current_height": scene_data["resolutionWidth"], + "expected_pixel_ratio": expected_data["pixelAspect"], + "current_pixel_ratio": scene_data["pixelAspect"] + } + ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_start_frame.py b/openpype/hosts/tvpaint/plugins/publish/validate_start_frame.py index e2f8386757..ddc738c6ed 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_start_frame.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_start_frame.py @@ -1,4 +1,5 @@ import pyblish.api +from openpype.pipeline import PublishXmlValidationError from openpype.hosts.tvpaint.api import lib @@ -24,4 +25,13 @@ class ValidateStartFrame(pyblish.api.ContextPlugin): def process(self, context): start_frame = lib.execute_george("tv_startframe") - assert int(start_frame) == 0, "Start frame has to be frame 0." + if start_frame == 0: + return + + raise PublishXmlValidationError( + self, + "Start frame has to be frame 0.", + formatting_data={ + "current_start_frame": start_frame + } + ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_workfile_metadata.py b/openpype/hosts/tvpaint/plugins/publish/validate_workfile_metadata.py index 48fbeedb59..eac345f395 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_workfile_metadata.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_workfile_metadata.py @@ -1,4 +1,5 @@ import pyblish.api +from openpype.pipeline import PublishXmlValidationError from openpype.hosts.tvpaint.api import save_file @@ -42,8 +43,12 @@ class ValidateWorkfileMetadata(pyblish.api.ContextPlugin): missing_keys.append(key) if missing_keys: - raise AssertionError( + raise PublishXmlValidationError( + self, "Current workfile is missing metadata about {}.".format( ", ".join(missing_keys) - ) + ), + formatting_data={ + "missing_metadata": ", ".join(missing_keys) + } ) diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_workfile_project_name.py b/openpype/hosts/tvpaint/plugins/publish/validate_workfile_project_name.py index cc664d8030..0f25f2f7be 100644 --- a/openpype/hosts/tvpaint/plugins/publish/validate_workfile_project_name.py +++ b/openpype/hosts/tvpaint/plugins/publish/validate_workfile_project_name.py @@ -1,5 +1,6 @@ import os import pyblish.api +from openpype.pipeline import PublishXmlValidationError class ValidateWorkfileProjectName(pyblish.api.ContextPlugin): @@ -31,15 +32,23 @@ class ValidateWorkfileProjectName(pyblish.api.ContextPlugin): return # Raise an error - raise AssertionError(( - # Short message - "Workfile from different Project ({})." - # Description what's wrong - " It is not possible to publish when TVPaint was launched in" - "context of different project. Current context project is \"{}\"." - " Launch TVPaint in context of project \"{}\" and then publish." - ).format( - workfile_project_name, - env_project_name, - workfile_project_name, - )) + raise PublishXmlValidationError( + self, + ( + # Short message + "Workfile from different Project ({})." + # Description what's wrong + " It is not possible to publish when TVPaint was launched in" + "context of different project. Current context project is" + " \"{}\". Launch TVPaint in context of project \"{}\"" + " and then publish." + ).format( + workfile_project_name, + env_project_name, + workfile_project_name, + ), + formatting_data={ + "workfile_project_name": workfile_project_name, + "expected_project_name": env_project_name + } + ) diff --git a/openpype/hosts/unreal/__init__.py b/openpype/hosts/unreal/__init__.py index 1280442916..533f315df3 100644 --- a/openpype/hosts/unreal/__init__.py +++ b/openpype/hosts/unreal/__init__.py @@ -1,13 +1,15 @@ import os +import openpype.hosts def add_implementation_envs(env, _app): """Modify environments to contain all required for implementation.""" - # Set AVALON_UNREAL_PLUGIN required for Unreal implementation + # Set OPENPYPE_UNREAL_PLUGIN required for Unreal implementation unreal_plugin_path = os.path.join( - os.environ["OPENPYPE_REPOS_ROOT"], "repos", "avalon-unreal-integration" + os.path.dirname(os.path.abspath(openpype.hosts.__file__)), + "unreal", "integration" ) - env["AVALON_UNREAL_PLUGIN"] = unreal_plugin_path + env["OPENPYPE_UNREAL_PLUGIN"] = unreal_plugin_path # Set default environments if are not set via settings defaults = { diff --git a/openpype/hosts/unreal/api/__init__.py b/openpype/hosts/unreal/api/__init__.py index 38469e0ddb..ede71aa218 100644 --- a/openpype/hosts/unreal/api/__init__.py +++ b/openpype/hosts/unreal/api/__init__.py @@ -1,45 +1,40 @@ -import os -import logging +# -*- coding: utf-8 -*- +"""Unreal Editor OpenPype host API.""" -from avalon import api as avalon -from pyblish import api as pyblish -import openpype.hosts.unreal +from .plugin import ( + Loader, + Creator +) +from .pipeline import ( + install, + uninstall, + ls, + publish, + containerise, + show_creator, + show_loader, + show_publisher, + show_manager, + show_experimental_tools, + show_tools_dialog, + show_tools_popup, + instantiate, +) -logger = logging.getLogger("openpype.hosts.unreal") - -HOST_DIR = os.path.dirname(os.path.abspath(openpype.hosts.unreal.__file__)) -PLUGINS_DIR = os.path.join(HOST_DIR, "plugins") -PUBLISH_PATH = os.path.join(PLUGINS_DIR, "publish") -LOAD_PATH = os.path.join(PLUGINS_DIR, "load") -CREATE_PATH = os.path.join(PLUGINS_DIR, "create") -INVENTORY_PATH = os.path.join(PLUGINS_DIR, "inventory") - - -def install(): - """Install Unreal configuration for Avalon.""" - print("-=" * 40) - logo = '''. -. - ____________ - / \\ __ \\ - \\ \\ \\/_\\ \\ - \\ \\ _____/ ______ - \\ \\ \\___// \\ \\ - \\ \\____\\ \\ \\_____\\ - \\/_____/ \\/______/ PYPE Club . -. -''' - print(logo) - print("installing OpenPype for Unreal ...") - print("-=" * 40) - logger.info("installing OpenPype for Unreal") - pyblish.register_plugin_path(str(PUBLISH_PATH)) - avalon.register_plugin_path(avalon.Loader, str(LOAD_PATH)) - avalon.register_plugin_path(avalon.Creator, str(CREATE_PATH)) - - -def uninstall(): - """Uninstall Unreal configuration for Avalon.""" - pyblish.deregister_plugin_path(str(PUBLISH_PATH)) - avalon.deregister_plugin_path(avalon.Loader, str(LOAD_PATH)) - avalon.deregister_plugin_path(avalon.Creator, str(CREATE_PATH)) +__all__ = [ + "install", + "uninstall", + "Creator", + "Loader", + "ls", + "publish", + "containerise", + "show_creator", + "show_loader", + "show_publisher", + "show_manager", + "show_experimental_tools", + "show_tools_dialog", + "show_tools_popup", + "instantiate" +] diff --git a/openpype/hosts/unreal/api/helpers.py b/openpype/hosts/unreal/api/helpers.py new file mode 100644 index 0000000000..0b6f07f52f --- /dev/null +++ b/openpype/hosts/unreal/api/helpers.py @@ -0,0 +1,44 @@ +# -*- coding: utf-8 -*- +import unreal # noqa + + +class OpenPypeUnrealException(Exception): + pass + + +@unreal.uclass() +class OpenPypeHelpers(unreal.OpenPypeLib): + """Class wrapping some useful functions for OpenPype. + + This class is extending native BP class in OpenPype Integration Plugin. + + """ + + @unreal.ufunction(params=[str, unreal.LinearColor, bool]) + def set_folder_color(self, path: str, color: unreal.LinearColor) -> None: + """Set color on folder in Content Browser. + + This method sets color on folder in Content Browser. Unfortunately + there is no way to refresh Content Browser so new color isn't applied + immediately. They are saved to config file and appears correctly + only after Editor is restarted. + + Args: + path (str): Path to folder + color (:class:`unreal.LinearColor`): Color of the folder + + Example: + + OpenPypeHelpers().set_folder_color( + "/Game/Path", unreal.LinearColor(a=1.0, r=1.0, g=0.5, b=0) + ) + + Note: + This will take effect only after Editor is restarted. I couldn't + find a way to refresh it. Also this saves the color definition + into the project config, binding this path with color. So if you + delete this path and later re-create, it will set this color + again. + + """ + self.c_set_folder_color(path, color, False) diff --git a/openpype/hosts/unreal/api/pipeline.py b/openpype/hosts/unreal/api/pipeline.py new file mode 100644 index 0000000000..9ec11b942d --- /dev/null +++ b/openpype/hosts/unreal/api/pipeline.py @@ -0,0 +1,418 @@ +# -*- coding: utf-8 -*- +import os +import logging +from typing import List + +import pyblish.api +from avalon.pipeline import AVALON_CONTAINER_ID +from avalon import api + +from openpype.pipeline import ( + LegacyCreator, + register_loader_plugin_path, + deregister_loader_plugin_path, +) +from openpype.tools.utils import host_tools +import openpype.hosts.unreal + +import unreal # noqa + + +logger = logging.getLogger("openpype.hosts.unreal") +OPENPYPE_CONTAINERS = "OpenPypeContainers" + +HOST_DIR = os.path.dirname(os.path.abspath(openpype.hosts.unreal.__file__)) +PLUGINS_DIR = os.path.join(HOST_DIR, "plugins") +PUBLISH_PATH = os.path.join(PLUGINS_DIR, "publish") +LOAD_PATH = os.path.join(PLUGINS_DIR, "load") +CREATE_PATH = os.path.join(PLUGINS_DIR, "create") +INVENTORY_PATH = os.path.join(PLUGINS_DIR, "inventory") + + +def install(): + """Install Unreal configuration for OpenPype.""" + print("-=" * 40) + logo = '''. +. + ____________ + / \\ __ \\ + \\ \\ \\/_\\ \\ + \\ \\ _____/ ______ + \\ \\ \\___// \\ \\ + \\ \\____\\ \\ \\_____\\ + \\/_____/ \\/______/ PYPE Club . +. +''' + print(logo) + print("installing OpenPype for Unreal ...") + print("-=" * 40) + logger.info("installing OpenPype for Unreal") + pyblish.api.register_plugin_path(str(PUBLISH_PATH)) + register_loader_plugin_path(str(LOAD_PATH)) + api.register_plugin_path(LegacyCreator, str(CREATE_PATH)) + _register_callbacks() + _register_events() + + +def uninstall(): + """Uninstall Unreal configuration for Avalon.""" + pyblish.api.deregister_plugin_path(str(PUBLISH_PATH)) + deregister_loader_plugin_path(str(LOAD_PATH)) + api.deregister_plugin_path(LegacyCreator, str(CREATE_PATH)) + + +def _register_callbacks(): + """ + TODO: Implement callbacks if supported by UE4 + """ + pass + + +def _register_events(): + """ + TODO: Implement callbacks if supported by UE4 + """ + pass + + +class Creator(LegacyCreator): + hosts = ["unreal"] + asset_types = [] + + def process(self): + nodes = list() + + with unreal.ScopedEditorTransaction("OpenPype Creating Instance"): + if (self.options or {}).get("useSelection"): + self.log.info("setting ...") + print("settings ...") + nodes = unreal.EditorUtilityLibrary.get_selected_assets() + + asset_paths = [a.get_path_name() for a in nodes] + self.name = move_assets_to_path( + "/Game", self.name, asset_paths + ) + + instance = create_publish_instance("/Game", self.name) + imprint(instance, self.data) + + return instance + + +def ls(): + """List all containers. + + List all found in *Content Manager* of Unreal and return + metadata from them. Adding `objectName` to set. + + """ + ar = unreal.AssetRegistryHelpers.get_asset_registry() + openpype_containers = ar.get_assets_by_class("AssetContainer", True) + + # get_asset_by_class returns AssetData. To get all metadata we need to + # load asset. get_tag_values() work only on metadata registered in + # Asset Registry Project settings (and there is no way to set it with + # python short of editing ini configuration file). + for asset_data in openpype_containers: + asset = asset_data.get_asset() + data = unreal.EditorAssetLibrary.get_metadata_tag_values(asset) + data["objectName"] = asset_data.asset_name + data = cast_map_to_str_dict(data) + + yield data + + +def parse_container(container): + """To get data from container, AssetContainer must be loaded. + + Args: + container(str): path to container + + Returns: + dict: metadata stored on container + """ + asset = unreal.EditorAssetLibrary.load_asset(container) + data = unreal.EditorAssetLibrary.get_metadata_tag_values(asset) + data["objectName"] = asset.get_name() + data = cast_map_to_str_dict(data) + + return data + + +def publish(): + """Shorthand to publish from within host.""" + import pyblish.util + + return pyblish.util.publish() + + +def containerise(name, namespace, nodes, context, loader=None, suffix="_CON"): + """Bundles *nodes* (assets) into a *container* and add metadata to it. + + Unreal doesn't support *groups* of assets that you can add metadata to. + But it does support folders that helps to organize asset. Unfortunately + those folders are just that - you cannot add any additional information + to them. OpenPype Integration Plugin is providing way out - Implementing + `AssetContainer` Blueprint class. This class when added to folder can + handle metadata on it using standard + :func:`unreal.EditorAssetLibrary.set_metadata_tag()` and + :func:`unreal.EditorAssetLibrary.get_metadata_tag_values()`. It also + stores and monitor all changes in assets in path where it resides. List of + those assets is available as `assets` property. + + This is list of strings starting with asset type and ending with its path: + `Material /Game/OpenPype/Test/TestMaterial.TestMaterial` + + """ + # 1 - create directory for container + root = "/Game" + container_name = "{}{}".format(name, suffix) + new_name = move_assets_to_path(root, container_name, nodes) + + # 2 - create Asset Container there + path = "{}/{}".format(root, new_name) + create_container(container=container_name, path=path) + + namespace = path + + data = { + "schema": "openpype:container-2.0", + "id": AVALON_CONTAINER_ID, + "name": new_name, + "namespace": namespace, + "loader": str(loader), + "representation": context["representation"]["_id"], + } + # 3 - imprint data + imprint("{}/{}".format(path, container_name), data) + return path + + +def instantiate(root, name, data, assets=None, suffix="_INS"): + """Bundles *nodes* into *container*. + + Marking it with metadata as publishable instance. If assets are provided, + they are moved to new path where `OpenPypePublishInstance` class asset is + created and imprinted with metadata. + + This can then be collected for publishing by Pyblish for example. + + Args: + root (str): root path where to create instance container + name (str): name of the container + data (dict): data to imprint on container + assets (list of str): list of asset paths to include in publish + instance + suffix (str): suffix string to append to instance name + + """ + container_name = "{}{}".format(name, suffix) + + # if we specify assets, create new folder and move them there. If not, + # just create empty folder + if assets: + new_name = move_assets_to_path(root, container_name, assets) + else: + new_name = create_folder(root, name) + + path = "{}/{}".format(root, new_name) + create_publish_instance(instance=container_name, path=path) + + imprint("{}/{}".format(path, container_name), data) + + +def imprint(node, data): + loaded_asset = unreal.EditorAssetLibrary.load_asset(node) + for key, value in data.items(): + # Support values evaluated at imprint + if callable(value): + value = value() + # Unreal doesn't support NoneType in metadata values + if value is None: + value = "" + unreal.EditorAssetLibrary.set_metadata_tag( + loaded_asset, key, str(value) + ) + + with unreal.ScopedEditorTransaction("OpenPype containerising"): + unreal.EditorAssetLibrary.save_asset(node) + + +def show_tools_popup(): + """Show popup with tools. + + Popup will disappear on click or loosing focus. + """ + from openpype.hosts.unreal.api import tools_ui + + tools_ui.show_tools_popup() + + +def show_tools_dialog(): + """Show dialog with tools. + + Dialog will stay visible. + """ + from openpype.hosts.unreal.api import tools_ui + + tools_ui.show_tools_dialog() + + +def show_creator(): + host_tools.show_creator() + + +def show_loader(): + host_tools.show_loader(use_context=True) + + +def show_publisher(): + host_tools.show_publish() + + +def show_manager(): + host_tools.show_scene_inventory() + + +def show_experimental_tools(): + host_tools.show_experimental_tools_dialog() + + +def create_folder(root: str, name: str) -> str: + """Create new folder. + + If folder exists, append number at the end and try again, incrementing + if needed. + + Args: + root (str): path root + name (str): folder name + + Returns: + str: folder name + + Example: + >>> create_folder("/Game/Foo") + /Game/Foo + >>> create_folder("/Game/Foo") + /Game/Foo1 + + """ + eal = unreal.EditorAssetLibrary + index = 1 + while True: + if eal.does_directory_exist("{}/{}".format(root, name)): + name = "{}{}".format(name, index) + index += 1 + else: + eal.make_directory("{}/{}".format(root, name)) + break + + return name + + +def move_assets_to_path(root: str, name: str, assets: List[str]) -> str: + """Moving (renaming) list of asset paths to new destination. + + Args: + root (str): root of the path (eg. `/Game`) + name (str): name of destination directory (eg. `Foo` ) + assets (list of str): list of asset paths + + Returns: + str: folder name + + Example: + This will get paths of all assets under `/Game/Test` and move them + to `/Game/NewTest`. If `/Game/NewTest` already exists, then resulting + path will be `/Game/NewTest1` + + >>> assets = unreal.EditorAssetLibrary.list_assets("/Game/Test") + >>> move_assets_to_path("/Game", "NewTest", assets) + NewTest + + """ + eal = unreal.EditorAssetLibrary + name = create_folder(root, name) + + unreal.log(assets) + for asset in assets: + loaded = eal.load_asset(asset) + eal.rename_asset( + asset, "{}/{}/{}".format(root, name, loaded.get_name()) + ) + + return name + + +def create_container(container: str, path: str) -> unreal.Object: + """Helper function to create Asset Container class on given path. + + This Asset Class helps to mark given path as Container + and enable asset version control on it. + + Args: + container (str): Asset Container name + path (str): Path where to create Asset Container. This path should + point into container folder + + Returns: + :class:`unreal.Object`: instance of created asset + + Example: + + create_container( + "/Game/modelingFooCharacter_CON", + "modelingFooCharacter_CON" + ) + + """ + factory = unreal.AssetContainerFactory() + tools = unreal.AssetToolsHelpers().get_asset_tools() + + asset = tools.create_asset(container, path, None, factory) + return asset + + +def create_publish_instance(instance: str, path: str) -> unreal.Object: + """Helper function to create OpenPype Publish Instance on given path. + + This behaves similarly as :func:`create_openpype_container`. + + Args: + path (str): Path where to create Publish Instance. + This path should point into container folder + instance (str): Publish Instance name + + Returns: + :class:`unreal.Object`: instance of created asset + + Example: + + create_publish_instance( + "/Game/modelingFooCharacter_INST", + "modelingFooCharacter_INST" + ) + + """ + factory = unreal.OpenPypePublishInstanceFactory() + tools = unreal.AssetToolsHelpers().get_asset_tools() + asset = tools.create_asset(instance, path, None, factory) + return asset + + +def cast_map_to_str_dict(umap) -> dict: + """Cast Unreal Map to dict. + + Helper function to cast Unreal Map object to plain old python + dict. This will also cast values and keys to str. Useful for + metadata dicts. + + Args: + umap: Unreal Map object + + Returns: + dict + + """ + return {str(key): str(value) for (key, value) in umap.items()} diff --git a/openpype/hosts/unreal/api/plugin.py b/openpype/hosts/unreal/api/plugin.py index 5a6b236730..b24bab831d 100644 --- a/openpype/hosts/unreal/api/plugin.py +++ b/openpype/hosts/unreal/api/plugin.py @@ -1,12 +1,17 @@ -from avalon import api -import openpype.api +# -*- coding: utf-8 -*- +from abc import ABC + +from openpype.pipeline import ( + LegacyCreator, + LoaderPlugin, +) -class Creator(openpype.api.Creator): +class Creator(LegacyCreator): """This serves as skeleton for future OpenPype specific functionality""" defaults = ['Main'] -class Loader(api.Loader): +class Loader(LoaderPlugin, ABC): """This serves as skeleton for future OpenPype specific functionality""" pass diff --git a/openpype/hosts/unreal/hooks/pre_workfile_preparation.py b/openpype/hosts/unreal/hooks/pre_workfile_preparation.py index 880dba5cfb..f07e96551c 100644 --- a/openpype/hosts/unreal/hooks/pre_workfile_preparation.py +++ b/openpype/hosts/unreal/hooks/pre_workfile_preparation.py @@ -10,7 +10,7 @@ from openpype.lib import ( get_workdir_data, get_workfile_template_key ) -from openpype.hosts.unreal.api import lib as unreal_lib +import openpype.hosts.unreal.lib as unreal_lib class UnrealPrelaunchHook(PreLaunchHook): @@ -136,9 +136,9 @@ class UnrealPrelaunchHook(PreLaunchHook): f"{self.signature} creating unreal " f"project [ {unreal_project_name} ]" )) - # Set "AVALON_UNREAL_PLUGIN" to current process environment for + # Set "OPENPYPE_UNREAL_PLUGIN" to current process environment for # execution of `create_unreal_project` - env_key = "AVALON_UNREAL_PLUGIN" + env_key = "OPENPYPE_UNREAL_PLUGIN" if self.launch_context.env.get(env_key): os.environ[env_key] = self.launch_context.env[env_key] diff --git a/openpype/hosts/unreal/integration/.gitignore b/openpype/hosts/unreal/integration/.gitignore new file mode 100644 index 0000000000..b32a6f55e5 --- /dev/null +++ b/openpype/hosts/unreal/integration/.gitignore @@ -0,0 +1,35 @@ +# Prerequisites +*.d + +# Compiled Object files +*.slo +*.lo +*.o +*.obj + +# Precompiled Headers +*.gch +*.pch + +# Compiled Dynamic libraries +*.so +*.dylib +*.dll + +# Fortran module files +*.mod +*.smod + +# Compiled Static libraries +*.lai +*.la +*.a +*.lib + +# Executables +*.exe +*.out +*.app + +/Binaries +/Intermediate diff --git a/openpype/hosts/unreal/integration/Content/Python/init_unreal.py b/openpype/hosts/unreal/integration/Content/Python/init_unreal.py new file mode 100644 index 0000000000..2ecd301c25 --- /dev/null +++ b/openpype/hosts/unreal/integration/Content/Python/init_unreal.py @@ -0,0 +1,34 @@ +import unreal + +openpype_detected = True +try: + from avalon import api +except ImportError as exc: + api = None + openpype_detected = False + unreal.log_error("Avalon: cannot load Avalon [ {} ]".format(exc)) + +try: + from openpype.hosts.unreal import api as openpype_host +except ImportError as exc: + openpype_host = None + openpype_detected = False + unreal.log_error("OpenPype: cannot load OpenPype [ {} ]".format(exc)) + +if openpype_detected: + api.install(openpype_host) + + +@unreal.uclass() +class OpenPypeIntegration(unreal.OpenPypePythonBridge): + @unreal.ufunction(override=True) + def RunInPython_Popup(self): + unreal.log_warning("OpenPype: showing tools popup") + if openpype_detected: + openpype_host.show_tools_popup() + + @unreal.ufunction(override=True) + def RunInPython_Dialog(self): + unreal.log_warning("OpenPype: showing tools dialog") + if openpype_detected: + openpype_host.show_tools_dialog() diff --git a/openpype/hosts/unreal/integration/OpenPype.uplugin b/openpype/hosts/unreal/integration/OpenPype.uplugin new file mode 100644 index 0000000000..4c7a74403c --- /dev/null +++ b/openpype/hosts/unreal/integration/OpenPype.uplugin @@ -0,0 +1,24 @@ +{ + "FileVersion": 3, + "Version": 1, + "VersionName": "1.0", + "FriendlyName": "OpenPype", + "Description": "OpenPype Integration", + "Category": "OpenPype.Integration", + "CreatedBy": "Ondrej Samohel", + "CreatedByURL": "https://openpype.io", + "DocsURL": "https://openpype.io/docs/artist_hosts_unreal", + "MarketplaceURL": "", + "SupportURL": "https://pype.club/", + "CanContainContent": true, + "IsBetaVersion": true, + "IsExperimentalVersion": false, + "Installed": false, + "Modules": [ + { + "Name": "OpenPype", + "Type": "Editor", + "LoadingPhase": "Default" + } + ] +} \ No newline at end of file diff --git a/openpype/hosts/unreal/integration/README.md b/openpype/hosts/unreal/integration/README.md new file mode 100644 index 0000000000..a32d89aab8 --- /dev/null +++ b/openpype/hosts/unreal/integration/README.md @@ -0,0 +1,11 @@ +# OpenPype Unreal Integration plugin + +This is plugin for Unreal Editor, creating menu for [OpenPype](https://github.com/getavalon) tools to run. + +## How does this work + +Plugin is creating basic menu items in **Window/OpenPype** section of Unreal Editor main menu and a button +on the main toolbar with associated menu. Clicking on those menu items is calling callbacks that are +declared in c++ but needs to be implemented during Unreal Editor +startup in `Plugins/OpenPype/Content/Python/init_unreal.py` - this should be executed by Unreal Editor +automatically. diff --git a/openpype/hosts/unreal/integration/Resources/openpype128.png b/openpype/hosts/unreal/integration/Resources/openpype128.png new file mode 100644 index 0000000000..abe8a807ef Binary files /dev/null and b/openpype/hosts/unreal/integration/Resources/openpype128.png differ diff --git a/openpype/hosts/unreal/integration/Resources/openpype40.png b/openpype/hosts/unreal/integration/Resources/openpype40.png new file mode 100644 index 0000000000..f983e7a1f2 Binary files /dev/null and b/openpype/hosts/unreal/integration/Resources/openpype40.png differ diff --git a/openpype/hosts/unreal/integration/Resources/openpype512.png b/openpype/hosts/unreal/integration/Resources/openpype512.png new file mode 100644 index 0000000000..97c4d4326b Binary files /dev/null and b/openpype/hosts/unreal/integration/Resources/openpype512.png differ diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/OpenPype.Build.cs b/openpype/hosts/unreal/integration/Source/OpenPype/OpenPype.Build.cs new file mode 100644 index 0000000000..c30835b63d --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/OpenPype.Build.cs @@ -0,0 +1,57 @@ +// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved. + +using UnrealBuildTool; + +public class OpenPype : ModuleRules +{ + public OpenPype(ReadOnlyTargetRules Target) : base(Target) + { + PCHUsage = ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs; + + PublicIncludePaths.AddRange( + new string[] { + // ... add public include paths required here ... + } + ); + + + PrivateIncludePaths.AddRange( + new string[] { + // ... add other private include paths required here ... + } + ); + + + PublicDependencyModuleNames.AddRange( + new string[] + { + "Core", + // ... add other public dependencies that you statically link with here ... + } + ); + + + PrivateDependencyModuleNames.AddRange( + new string[] + { + "Projects", + "InputCore", + "UnrealEd", + "LevelEditor", + "CoreUObject", + "Engine", + "Slate", + "SlateCore", + // ... add private dependencies that you statically link with here ... + } + ); + + + DynamicallyLoadedModuleNames.AddRange( + new string[] + { + // ... add any modules that your module loads dynamically here ... + } + ); + } +} diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Private/AssetContainer.cpp b/openpype/hosts/unreal/integration/Source/OpenPype/Private/AssetContainer.cpp new file mode 100644 index 0000000000..c766f87a8e --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Private/AssetContainer.cpp @@ -0,0 +1,115 @@ +// Fill out your copyright notice in the Description page of Project Settings. + +#include "AssetContainer.h" +#include "AssetRegistryModule.h" +#include "Misc/PackageName.h" +#include "Engine.h" +#include "Containers/UnrealString.h" + +UAssetContainer::UAssetContainer(const FObjectInitializer& ObjectInitializer) +: UAssetUserData(ObjectInitializer) +{ + FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked("AssetRegistry"); + FString path = UAssetContainer::GetPathName(); + UE_LOG(LogTemp, Warning, TEXT("UAssetContainer %s"), *path); + FARFilter Filter; + Filter.PackagePaths.Add(FName(*path)); + + AssetRegistryModule.Get().OnAssetAdded().AddUObject(this, &UAssetContainer::OnAssetAdded); + AssetRegistryModule.Get().OnAssetRemoved().AddUObject(this, &UAssetContainer::OnAssetRemoved); + AssetRegistryModule.Get().OnAssetRenamed().AddUObject(this, &UAssetContainer::OnAssetRenamed); +} + +void UAssetContainer::OnAssetAdded(const FAssetData& AssetData) +{ + TArray split; + + // get directory of current container + FString selfFullPath = UAssetContainer::GetPathName(); + FString selfDir = FPackageName::GetLongPackagePath(*selfFullPath); + + // get asset path and class + FString assetPath = AssetData.GetFullName(); + FString assetFName = AssetData.AssetClass.ToString(); + + // split path + assetPath.ParseIntoArray(split, TEXT(" "), true); + + FString assetDir = FPackageName::GetLongPackagePath(*split[1]); + + // take interest only in paths starting with path of current container + if (assetDir.StartsWith(*selfDir)) + { + // exclude self + if (assetFName != "AssetContainer") + { + assets.Add(assetPath); + assetsData.Add(AssetData); + UE_LOG(LogTemp, Log, TEXT("%s: asset added to %s"), *selfFullPath, *selfDir); + } + } +} + +void UAssetContainer::OnAssetRemoved(const FAssetData& AssetData) +{ + TArray split; + + // get directory of current container + FString selfFullPath = UAssetContainer::GetPathName(); + FString selfDir = FPackageName::GetLongPackagePath(*selfFullPath); + + // get asset path and class + FString assetPath = AssetData.GetFullName(); + FString assetFName = AssetData.AssetClass.ToString(); + + // split path + assetPath.ParseIntoArray(split, TEXT(" "), true); + + FString assetDir = FPackageName::GetLongPackagePath(*split[1]); + + // take interest only in paths starting with path of current container + FString path = UAssetContainer::GetPathName(); + FString lpp = FPackageName::GetLongPackagePath(*path); + + if (assetDir.StartsWith(*selfDir)) + { + // exclude self + if (assetFName != "AssetContainer") + { + // UE_LOG(LogTemp, Warning, TEXT("%s: asset removed"), *lpp); + assets.Remove(assetPath); + assetsData.Remove(AssetData); + } + } +} + +void UAssetContainer::OnAssetRenamed(const FAssetData& AssetData, const FString& str) +{ + TArray split; + + // get directory of current container + FString selfFullPath = UAssetContainer::GetPathName(); + FString selfDir = FPackageName::GetLongPackagePath(*selfFullPath); + + // get asset path and class + FString assetPath = AssetData.GetFullName(); + FString assetFName = AssetData.AssetClass.ToString(); + + // split path + assetPath.ParseIntoArray(split, TEXT(" "), true); + + FString assetDir = FPackageName::GetLongPackagePath(*split[1]); + if (assetDir.StartsWith(*selfDir)) + { + // exclude self + if (assetFName != "AssetContainer") + { + + assets.Remove(str); + assets.Add(assetPath); + assetsData.Remove(AssetData); + // UE_LOG(LogTemp, Warning, TEXT("%s: asset renamed %s"), *lpp, *str); + } + } +} + diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Private/AssetContainerFactory.cpp b/openpype/hosts/unreal/integration/Source/OpenPype/Private/AssetContainerFactory.cpp new file mode 100644 index 0000000000..b943150bdd --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Private/AssetContainerFactory.cpp @@ -0,0 +1,20 @@ +#include "AssetContainerFactory.h" +#include "AssetContainer.h" + +UAssetContainerFactory::UAssetContainerFactory(const FObjectInitializer& ObjectInitializer) + : UFactory(ObjectInitializer) +{ + SupportedClass = UAssetContainer::StaticClass(); + bCreateNew = false; + bEditorImport = true; +} + +UObject* UAssetContainerFactory::FactoryCreateNew(UClass* Class, UObject* InParent, FName Name, EObjectFlags Flags, UObject* Context, FFeedbackContext* Warn) +{ + UAssetContainer* AssetContainer = NewObject(InParent, Class, Name, Flags); + return AssetContainer; +} + +bool UAssetContainerFactory::ShouldShowInNewMenu() const { + return false; +} diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPype.cpp b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPype.cpp new file mode 100644 index 0000000000..15c46b3862 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPype.cpp @@ -0,0 +1,103 @@ +#include "OpenPype.h" +#include "LevelEditor.h" +#include "OpenPypePythonBridge.h" +#include "OpenPypeStyle.h" + + +static const FName OpenPypeTabName("OpenPype"); + +#define LOCTEXT_NAMESPACE "FOpenPypeModule" + +// This function is triggered when the plugin is staring up +void FOpenPypeModule::StartupModule() +{ + + FOpenPypeStyle::Initialize(); + FOpenPypeStyle::SetIcon("Logo", "openpype40"); + + // Create the Extender that will add content to the menu + FLevelEditorModule& LevelEditorModule = FModuleManager::LoadModuleChecked("LevelEditor"); + + TSharedPtr MenuExtender = MakeShareable(new FExtender()); + TSharedPtr ToolbarExtender = MakeShareable(new FExtender()); + + MenuExtender->AddMenuExtension( + "LevelEditor", + EExtensionHook::After, + NULL, + FMenuExtensionDelegate::CreateRaw(this, &FOpenPypeModule::AddMenuEntry) + ); + ToolbarExtender->AddToolBarExtension( + "Settings", + EExtensionHook::After, + NULL, + FToolBarExtensionDelegate::CreateRaw(this, &FOpenPypeModule::AddToobarEntry)); + + + LevelEditorModule.GetMenuExtensibilityManager()->AddExtender(MenuExtender); + LevelEditorModule.GetToolBarExtensibilityManager()->AddExtender(ToolbarExtender); + +} + +void FOpenPypeModule::ShutdownModule() +{ + FOpenPypeStyle::Shutdown(); +} + + +void FOpenPypeModule::AddMenuEntry(FMenuBuilder& MenuBuilder) +{ + // Create Section + MenuBuilder.BeginSection("OpenPype", TAttribute(FText::FromString("OpenPype"))); + { + // Create a Submenu inside of the Section + MenuBuilder.AddMenuEntry( + FText::FromString("Tools..."), + FText::FromString("Pipeline tools"), + FSlateIcon(FOpenPypeStyle::GetStyleSetName(), "OpenPype.Logo"), + FUIAction(FExecuteAction::CreateRaw(this, &FOpenPypeModule::MenuPopup)) + ); + + MenuBuilder.AddMenuEntry( + FText::FromString("Tools dialog..."), + FText::FromString("Pipeline tools dialog"), + FSlateIcon(FOpenPypeStyle::GetStyleSetName(), "OpenPype.Logo"), + FUIAction(FExecuteAction::CreateRaw(this, &FOpenPypeModule::MenuDialog)) + ); + + } + MenuBuilder.EndSection(); +} + +void FOpenPypeModule::AddToobarEntry(FToolBarBuilder& ToolbarBuilder) +{ + ToolbarBuilder.BeginSection(TEXT("OpenPype")); + { + ToolbarBuilder.AddToolBarButton( + FUIAction( + FExecuteAction::CreateRaw(this, &FOpenPypeModule::MenuPopup), + NULL, + FIsActionChecked() + + ), + NAME_None, + LOCTEXT("OpenPype_label", "OpenPype"), + LOCTEXT("OpenPype_tooltip", "OpenPype Tools"), + FSlateIcon(FOpenPypeStyle::GetStyleSetName(), "OpenPype.Logo") + ); + } + ToolbarBuilder.EndSection(); +} + + +void FOpenPypeModule::MenuPopup() { + UOpenPypePythonBridge* bridge = UOpenPypePythonBridge::Get(); + bridge->RunInPython_Popup(); +} + +void FOpenPypeModule::MenuDialog() { + UOpenPypePythonBridge* bridge = UOpenPypePythonBridge::Get(); + bridge->RunInPython_Dialog(); +} + +IMPLEMENT_MODULE(FOpenPypeModule, OpenPype) diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypeLib.cpp b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypeLib.cpp new file mode 100644 index 0000000000..5facab7b8b --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypeLib.cpp @@ -0,0 +1,48 @@ +#include "OpenPypeLib.h" +#include "Misc/Paths.h" +#include "Misc/ConfigCacheIni.h" +#include "UObject/UnrealType.h" + +/** + * Sets color on folder icon on given path + * @param InPath - path to folder + * @param InFolderColor - color of the folder + * @warning This color will appear only after Editor restart. Is there a better way? + */ + +void UOpenPypeLib::CSetFolderColor(FString FolderPath, FLinearColor FolderColor, bool bForceAdd) +{ + auto SaveColorInternal = [](FString InPath, FLinearColor InFolderColor) + { + // Saves the color of the folder to the config + if (FPaths::FileExists(GEditorPerProjectIni)) + { + GConfig->SetString(TEXT("PathColor"), *InPath, *InFolderColor.ToString(), GEditorPerProjectIni); + } + + }; + + SaveColorInternal(FolderPath, FolderColor); + +} +/** + * Returns all poperties on given object + * @param cls - class + * @return TArray of properties + */ +TArray UOpenPypeLib::GetAllProperties(UClass* cls) +{ + TArray Ret; + if (cls != nullptr) + { + for (TFieldIterator It(cls); It; ++It) + { + FProperty* Property = *It; + if (Property->HasAnyPropertyFlags(EPropertyFlags::CPF_Edit)) + { + Ret.Add(Property->GetName()); + } + } + } + return Ret; +} diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePublishInstance.cpp b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePublishInstance.cpp new file mode 100644 index 0000000000..4f1e846c0b --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePublishInstance.cpp @@ -0,0 +1,108 @@ +#pragma once + +#include "OpenPypePublishInstance.h" +#include "AssetRegistryModule.h" + + +UOpenPypePublishInstance::UOpenPypePublishInstance(const FObjectInitializer& ObjectInitializer) + : UObject(ObjectInitializer) +{ + FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked("AssetRegistry"); + FString path = UOpenPypePublishInstance::GetPathName(); + FARFilter Filter; + Filter.PackagePaths.Add(FName(*path)); + + AssetRegistryModule.Get().OnAssetAdded().AddUObject(this, &UOpenPypePublishInstance::OnAssetAdded); + AssetRegistryModule.Get().OnAssetRemoved().AddUObject(this, &UOpenPypePublishInstance::OnAssetRemoved); + AssetRegistryModule.Get().OnAssetRenamed().AddUObject(this, &UOpenPypePublishInstance::OnAssetRenamed); +} + +void UOpenPypePublishInstance::OnAssetAdded(const FAssetData& AssetData) +{ + TArray split; + + // get directory of current container + FString selfFullPath = UOpenPypePublishInstance::GetPathName(); + FString selfDir = FPackageName::GetLongPackagePath(*selfFullPath); + + // get asset path and class + FString assetPath = AssetData.GetFullName(); + FString assetFName = AssetData.AssetClass.ToString(); + + // split path + assetPath.ParseIntoArray(split, TEXT(" "), true); + + FString assetDir = FPackageName::GetLongPackagePath(*split[1]); + + // take interest only in paths starting with path of current container + if (assetDir.StartsWith(*selfDir)) + { + // exclude self + if (assetFName != "OpenPypePublishInstance") + { + assets.Add(assetPath); + UE_LOG(LogTemp, Log, TEXT("%s: asset added to %s"), *selfFullPath, *selfDir); + } + } +} + +void UOpenPypePublishInstance::OnAssetRemoved(const FAssetData& AssetData) +{ + TArray split; + + // get directory of current container + FString selfFullPath = UOpenPypePublishInstance::GetPathName(); + FString selfDir = FPackageName::GetLongPackagePath(*selfFullPath); + + // get asset path and class + FString assetPath = AssetData.GetFullName(); + FString assetFName = AssetData.AssetClass.ToString(); + + // split path + assetPath.ParseIntoArray(split, TEXT(" "), true); + + FString assetDir = FPackageName::GetLongPackagePath(*split[1]); + + // take interest only in paths starting with path of current container + FString path = UOpenPypePublishInstance::GetPathName(); + FString lpp = FPackageName::GetLongPackagePath(*path); + + if (assetDir.StartsWith(*selfDir)) + { + // exclude self + if (assetFName != "OpenPypePublishInstance") + { + // UE_LOG(LogTemp, Warning, TEXT("%s: asset removed"), *lpp); + assets.Remove(assetPath); + } + } +} + +void UOpenPypePublishInstance::OnAssetRenamed(const FAssetData& AssetData, const FString& str) +{ + TArray split; + + // get directory of current container + FString selfFullPath = UOpenPypePublishInstance::GetPathName(); + FString selfDir = FPackageName::GetLongPackagePath(*selfFullPath); + + // get asset path and class + FString assetPath = AssetData.GetFullName(); + FString assetFName = AssetData.AssetClass.ToString(); + + // split path + assetPath.ParseIntoArray(split, TEXT(" "), true); + + FString assetDir = FPackageName::GetLongPackagePath(*split[1]); + if (assetDir.StartsWith(*selfDir)) + { + // exclude self + if (assetFName != "AssetContainer") + { + + assets.Remove(str); + assets.Add(assetPath); + // UE_LOG(LogTemp, Warning, TEXT("%s: asset renamed %s"), *lpp, *str); + } + } +} diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePublishInstanceFactory.cpp b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePublishInstanceFactory.cpp new file mode 100644 index 0000000000..e61964c689 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePublishInstanceFactory.cpp @@ -0,0 +1,20 @@ +#include "OpenPypePublishInstanceFactory.h" +#include "OpenPypePublishInstance.h" + +UOpenPypePublishInstanceFactory::UOpenPypePublishInstanceFactory(const FObjectInitializer& ObjectInitializer) + : UFactory(ObjectInitializer) +{ + SupportedClass = UOpenPypePublishInstance::StaticClass(); + bCreateNew = false; + bEditorImport = true; +} + +UObject* UOpenPypePublishInstanceFactory::FactoryCreateNew(UClass* Class, UObject* InParent, FName Name, EObjectFlags Flags, UObject* Context, FFeedbackContext* Warn) +{ + UOpenPypePublishInstance* OpenPypePublishInstance = NewObject(InParent, Class, Name, Flags); + return OpenPypePublishInstance; +} + +bool UOpenPypePublishInstanceFactory::ShouldShowInNewMenu() const { + return false; +} diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePythonBridge.cpp b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePythonBridge.cpp new file mode 100644 index 0000000000..8113231503 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypePythonBridge.cpp @@ -0,0 +1,13 @@ +#include "OpenPypePythonBridge.h" + +UOpenPypePythonBridge* UOpenPypePythonBridge::Get() +{ + TArray OpenPypePythonBridgeClasses; + GetDerivedClasses(UOpenPypePythonBridge::StaticClass(), OpenPypePythonBridgeClasses); + int32 NumClasses = OpenPypePythonBridgeClasses.Num(); + if (NumClasses > 0) + { + return Cast(OpenPypePythonBridgeClasses[NumClasses - 1]->GetDefaultObject()); + } + return nullptr; +}; \ No newline at end of file diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypeStyle.cpp b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypeStyle.cpp new file mode 100644 index 0000000000..a51c2d6aa5 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Private/OpenPypeStyle.cpp @@ -0,0 +1,70 @@ +#include "OpenPypeStyle.h" +#include "Framework/Application/SlateApplication.h" +#include "Styling/SlateStyle.h" +#include "Styling/SlateStyleRegistry.h" + + +TUniquePtr< FSlateStyleSet > FOpenPypeStyle::OpenPypeStyleInstance = nullptr; + +void FOpenPypeStyle::Initialize() +{ + if (!OpenPypeStyleInstance.IsValid()) + { + OpenPypeStyleInstance = Create(); + FSlateStyleRegistry::RegisterSlateStyle(*OpenPypeStyleInstance); + } +} + +void FOpenPypeStyle::Shutdown() +{ + if (OpenPypeStyleInstance.IsValid()) + { + FSlateStyleRegistry::UnRegisterSlateStyle(*OpenPypeStyleInstance); + OpenPypeStyleInstance.Reset(); + } +} + +FName FOpenPypeStyle::GetStyleSetName() +{ + static FName StyleSetName(TEXT("OpenPypeStyle")); + return StyleSetName; +} + +FName FOpenPypeStyle::GetContextName() +{ + static FName ContextName(TEXT("OpenPype")); + return ContextName; +} + +#define IMAGE_BRUSH(RelativePath, ...) FSlateImageBrush( Style->RootToContentDir( RelativePath, TEXT(".png") ), __VA_ARGS__ ) + +const FVector2D Icon40x40(40.0f, 40.0f); + +TUniquePtr< FSlateStyleSet > FOpenPypeStyle::Create() +{ + TUniquePtr< FSlateStyleSet > Style = MakeUnique(GetStyleSetName()); + Style->SetContentRoot(FPaths::ProjectPluginsDir() / TEXT("OpenPype/Resources")); + + return Style; +} + +void FOpenPypeStyle::SetIcon(const FString& StyleName, const FString& ResourcePath) +{ + FSlateStyleSet* Style = OpenPypeStyleInstance.Get(); + + FString Name(GetContextName().ToString()); + Name = Name + "." + StyleName; + Style->Set(*Name, new FSlateImageBrush(Style->RootToContentDir(ResourcePath, TEXT(".png")), Icon40x40)); + + + FSlateApplication::Get().GetRenderer()->ReloadTextureResources(); +} + +#undef IMAGE_BRUSH + +const ISlateStyle& FOpenPypeStyle::Get() +{ + check(OpenPypeStyleInstance); + return *OpenPypeStyleInstance; + return *OpenPypeStyleInstance; +} diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Public/AssetContainer.h b/openpype/hosts/unreal/integration/Source/OpenPype/Public/AssetContainer.h new file mode 100644 index 0000000000..3c2a360c78 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Public/AssetContainer.h @@ -0,0 +1,39 @@ +// Fill out your copyright notice in the Description page of Project Settings. + +#pragma once + +#include "CoreMinimal.h" +#include "UObject/NoExportTypes.h" +#include "Engine/AssetUserData.h" +#include "AssetData.h" +#include "AssetContainer.generated.h" + +/** + * + */ +UCLASS(Blueprintable) +class OPENPYPE_API UAssetContainer : public UAssetUserData +{ + GENERATED_BODY() + +public: + + UAssetContainer(const FObjectInitializer& ObjectInitalizer); + // ~UAssetContainer(); + + UPROPERTY(EditAnywhere, BlueprintReadOnly) + TArray assets; + + // There seems to be no reflection option to expose array of FAssetData + /* + UPROPERTY(Transient, BlueprintReadOnly, Category = "Python", meta=(DisplayName="Assets Data")) + TArray assetsData; + */ +private: + TArray assetsData; + void OnAssetAdded(const FAssetData& AssetData); + void OnAssetRemoved(const FAssetData& AssetData); + void OnAssetRenamed(const FAssetData& AssetData, const FString& str); +}; + + diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Public/AssetContainerFactory.h b/openpype/hosts/unreal/integration/Source/OpenPype/Public/AssetContainerFactory.h new file mode 100644 index 0000000000..331ce6bb50 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Public/AssetContainerFactory.h @@ -0,0 +1,21 @@ +// Fill out your copyright notice in the Description page of Project Settings. + +#pragma once + +#include "CoreMinimal.h" +#include "Factories/Factory.h" +#include "AssetContainerFactory.generated.h" + +/** + * + */ +UCLASS() +class OPENPYPE_API UAssetContainerFactory : public UFactory +{ + GENERATED_BODY() + +public: + UAssetContainerFactory(const FObjectInitializer& ObjectInitializer); + virtual UObject* FactoryCreateNew(UClass* Class, UObject* InParent, FName Name, EObjectFlags Flags, UObject* Context, FFeedbackContext* Warn) override; + virtual bool ShouldShowInNewMenu() const override; +}; \ No newline at end of file diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPype.h b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPype.h new file mode 100644 index 0000000000..db3f299354 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPype.h @@ -0,0 +1,21 @@ +// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved. + +#pragma once + +#include "Engine.h" + + +class FOpenPypeModule : public IModuleInterface +{ +public: + virtual void StartupModule() override; + virtual void ShutdownModule() override; + +private: + + void AddMenuEntry(FMenuBuilder& MenuBuilder); + void AddToobarEntry(FToolBarBuilder& ToolbarBuilder); + void MenuPopup(); + void MenuDialog(); + +}; diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypeLib.h b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypeLib.h new file mode 100644 index 0000000000..59e9c8bd76 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypeLib.h @@ -0,0 +1,19 @@ +#pragma once + +#include "Engine.h" +#include "OpenPypeLib.generated.h" + + +UCLASS(Blueprintable) +class OPENPYPE_API UOpenPypeLib : public UObject +{ + + GENERATED_BODY() + +public: + UFUNCTION(BlueprintCallable, Category = Python) + static void CSetFolderColor(FString FolderPath, FLinearColor FolderColor, bool bForceAdd); + + UFUNCTION(BlueprintCallable, Category = Python) + static TArray GetAllProperties(UClass* cls); +}; \ No newline at end of file diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePublishInstance.h b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePublishInstance.h new file mode 100644 index 0000000000..0a27a078d7 --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePublishInstance.h @@ -0,0 +1,21 @@ +#pragma once + +#include "Engine.h" +#include "OpenPypePublishInstance.generated.h" + + +UCLASS(Blueprintable) +class OPENPYPE_API UOpenPypePublishInstance : public UObject +{ + GENERATED_BODY() + +public: + UOpenPypePublishInstance(const FObjectInitializer& ObjectInitalizer); + + UPROPERTY(EditAnywhere, BlueprintReadOnly) + TArray assets; +private: + void OnAssetAdded(const FAssetData& AssetData); + void OnAssetRemoved(const FAssetData& AssetData); + void OnAssetRenamed(const FAssetData& AssetData, const FString& str); +}; \ No newline at end of file diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePublishInstanceFactory.h b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePublishInstanceFactory.h new file mode 100644 index 0000000000..a2b3abe13e --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePublishInstanceFactory.h @@ -0,0 +1,19 @@ +#pragma once + +#include "CoreMinimal.h" +#include "Factories/Factory.h" +#include "OpenPypePublishInstanceFactory.generated.h" + +/** + * + */ +UCLASS() +class OPENPYPE_API UOpenPypePublishInstanceFactory : public UFactory +{ + GENERATED_BODY() + +public: + UOpenPypePublishInstanceFactory(const FObjectInitializer& ObjectInitializer); + virtual UObject* FactoryCreateNew(UClass* Class, UObject* InParent, FName Name, EObjectFlags Flags, UObject* Context, FFeedbackContext* Warn) override; + virtual bool ShouldShowInNewMenu() const override; +}; \ No newline at end of file diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePythonBridge.h b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePythonBridge.h new file mode 100644 index 0000000000..692aab2e5e --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypePythonBridge.h @@ -0,0 +1,20 @@ +#pragma once +#include "Engine.h" +#include "OpenPypePythonBridge.generated.h" + +UCLASS(Blueprintable) +class UOpenPypePythonBridge : public UObject +{ + GENERATED_BODY() + +public: + UFUNCTION(BlueprintCallable, Category = Python) + static UOpenPypePythonBridge* Get(); + + UFUNCTION(BlueprintImplementableEvent, Category = Python) + void RunInPython_Popup() const; + + UFUNCTION(BlueprintImplementableEvent, Category = Python) + void RunInPython_Dialog() const; + +}; diff --git a/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypeStyle.h b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypeStyle.h new file mode 100644 index 0000000000..fbc8bcdd5b --- /dev/null +++ b/openpype/hosts/unreal/integration/Source/OpenPype/Public/OpenPypeStyle.h @@ -0,0 +1,22 @@ +#pragma once +#include "CoreMinimal.h" + +class FSlateStyleSet; +class ISlateStyle; + + +class FOpenPypeStyle +{ +public: + static void Initialize(); + static void Shutdown(); + static const ISlateStyle& Get(); + static FName GetStyleSetName(); + static FName GetContextName(); + + static void SetIcon(const FString& StyleName, const FString& ResourcePath); + +private: + static TUniquePtr< FSlateStyleSet > Create(); + static TUniquePtr< FSlateStyleSet > OpenPypeStyleInstance; +}; \ No newline at end of file diff --git a/openpype/hosts/unreal/api/lib.py b/openpype/hosts/unreal/lib.py similarity index 92% rename from openpype/hosts/unreal/api/lib.py rename to openpype/hosts/unreal/lib.py index 61dac46fac..d4a776e892 100644 --- a/openpype/hosts/unreal/api/lib.py +++ b/openpype/hosts/unreal/lib.py @@ -169,11 +169,11 @@ def create_unreal_project(project_name: str, env: dict = None) -> None: """This will create `.uproject` file at specified location. - As there is no way I know to create project via command line, this is - easiest option. Unreal project file is basically JSON file. If we find - `AVALON_UNREAL_PLUGIN` environment variable we assume this is location - of Avalon Integration Plugin and we copy its content to project folder - and enable this plugin. + As there is no way I know to create a project via command line, this is + easiest option. Unreal project file is basically a JSON file. If we find + the `OPENPYPE_UNREAL_PLUGIN` environment variable we assume this is the + location of the Integration Plugin and we copy its content to the project + folder and enable this plugin. Args: project_name (str): Name of the project. @@ -230,18 +230,18 @@ def create_unreal_project(project_name: str, ue_id = "{" + loaded_modules.get("BuildId") + "}" plugins_path = None - if os.path.isdir(env.get("AVALON_UNREAL_PLUGIN", "")): + if os.path.isdir(env.get("OPENPYPE_UNREAL_PLUGIN", "")): # copy plugin to correct path under project plugins_path = pr_dir / "Plugins" - avalon_plugin_path = plugins_path / "Avalon" - if not avalon_plugin_path.is_dir(): - avalon_plugin_path.mkdir(parents=True, exist_ok=True) + openpype_plugin_path = plugins_path / "OpenPype" + if not openpype_plugin_path.is_dir(): + openpype_plugin_path.mkdir(parents=True, exist_ok=True) dir_util._path_created = {} - dir_util.copy_tree(os.environ.get("AVALON_UNREAL_PLUGIN"), - avalon_plugin_path.as_posix()) + dir_util.copy_tree(os.environ.get("OPENPYPE_UNREAL_PLUGIN"), + openpype_plugin_path.as_posix()) - if not (avalon_plugin_path / "Binaries").is_dir() \ - or not (avalon_plugin_path / "Intermediate").is_dir(): + if not (openpype_plugin_path / "Binaries").is_dir() \ + or not (openpype_plugin_path / "Intermediate").is_dir(): dev_mode = True # data for project file @@ -254,14 +254,14 @@ def create_unreal_project(project_name: str, {"Name": "PythonScriptPlugin", "Enabled": True}, {"Name": "EditorScriptingUtilities", "Enabled": True}, {"Name": "SequencerScripting", "Enabled": True}, - {"Name": "Avalon", "Enabled": True} + {"Name": "OpenPype", "Enabled": True} ] } if dev_mode or preset["dev_mode"]: - # this will add project module and necessary source file to make it - # C++ project and to (hopefully) make Unreal Editor to compile all - # sources at start + # this will add the project module and necessary source file to + # make it a C++ project and to (hopefully) make Unreal Editor to + # compile all # sources at start data["Modules"] = [{ "Name": project_name, @@ -304,7 +304,7 @@ def _prepare_cpp_project(project_file: Path, engine_path: Path) -> None: """Prepare CPP Unreal Project. This function will add source files needed for project to be - rebuild along with the avalon integration plugin. + rebuild along with the OpenPype integration plugin. There seems not to be automated way to do it from command line. But there might be way to create at least those target and build files diff --git a/openpype/hosts/unreal/plugins/create/create_camera.py b/openpype/hosts/unreal/plugins/create/create_camera.py index eda2b52be3..c2905fb6dd 100644 --- a/openpype/hosts/unreal/plugins/create/create_camera.py +++ b/openpype/hosts/unreal/plugins/create/create_camera.py @@ -16,7 +16,7 @@ class CreateCamera(Creator): family = "camera" icon = "cubes" - root = "/Game/Avalon/Instances" + root = "/Game/OpenPype/Instances" suffix = "_INS" def __init__(self, *args, **kwargs): diff --git a/openpype/hosts/unreal/plugins/create/create_layout.py b/openpype/hosts/unreal/plugins/create/create_layout.py index 239b72787b..00e83cf433 100644 --- a/openpype/hosts/unreal/plugins/create/create_layout.py +++ b/openpype/hosts/unreal/plugins/create/create_layout.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- from unreal import EditorLevelLibrary as ell from openpype.hosts.unreal.api.plugin import Creator from avalon.unreal import ( @@ -6,7 +7,7 @@ from avalon.unreal import ( class CreateLayout(Creator): - """Layout output for character rigs""" + """Layout output for character rigs.""" name = "layoutMain" label = "Layout" diff --git a/openpype/hosts/unreal/plugins/create/create_look.py b/openpype/hosts/unreal/plugins/create/create_look.py index 7d3913b883..59c40d3e74 100644 --- a/openpype/hosts/unreal/plugins/create/create_look.py +++ b/openpype/hosts/unreal/plugins/create/create_look.py @@ -1,10 +1,12 @@ -import unreal +# -*- coding: utf-8 -*- +"""Create look in Unreal.""" +import unreal # noqa from openpype.hosts.unreal.api.plugin import Creator -from avalon.unreal import pipeline +from openpype.hosts.unreal.api import pipeline class CreateLook(Creator): - """Shader connections defining shape look""" + """Shader connections defining shape look.""" name = "unrealLook" label = "Unreal - Look" @@ -49,14 +51,14 @@ class CreateLook(Creator): for material in materials: name = material.get_editor_property('material_slot_name') object_path = f"{full_path}/{name}.{name}" - object = unreal.EditorAssetLibrary.duplicate_loaded_asset( + unreal_object = unreal.EditorAssetLibrary.duplicate_loaded_asset( cube.get_asset(), object_path ) # Remove the default material of the cube object - object.get_editor_property('static_materials').pop() + unreal_object.get_editor_property('static_materials').pop() - object.add_material( + unreal_object.add_material( material.get_editor_property('material_interface')) self.data["members"].append(object_path) diff --git a/openpype/hosts/unreal/plugins/create/create_staticmeshfbx.py b/openpype/hosts/unreal/plugins/create/create_staticmeshfbx.py index 4cc67e0f1f..700eac7366 100644 --- a/openpype/hosts/unreal/plugins/create/create_staticmeshfbx.py +++ b/openpype/hosts/unreal/plugins/create/create_staticmeshfbx.py @@ -1,12 +1,14 @@ -import unreal +# -*- coding: utf-8 -*- +"""Create Static Meshes as FBX geometry.""" +import unreal # noqa from openpype.hosts.unreal.api.plugin import Creator -from avalon.unreal import ( +from openpype.hosts.unreal.api.pipeline import ( instantiate, ) class CreateStaticMeshFBX(Creator): - """Static FBX geometry""" + """Static FBX geometry.""" name = "unrealStaticMeshMain" label = "Unreal - Static Mesh" diff --git a/openpype/hosts/unreal/plugins/load/load_alembic_geometrycache.py b/openpype/hosts/unreal/plugins/load/load_alembic_geometrycache.py index e2023e8b47..3508fe5ed7 100644 --- a/openpype/hosts/unreal/plugins/load/load_alembic_geometrycache.py +++ b/openpype/hosts/unreal/plugins/load/load_alembic_geometrycache.py @@ -1,12 +1,16 @@ +# -*- coding: utf-8 -*- +"""Loader for published alembics.""" import os -from avalon import api, pipeline -from avalon.unreal import lib -from avalon.unreal import pipeline as unreal_pipeline -import unreal +from avalon import pipeline +from openpype.pipeline import get_representation_path +from openpype.hosts.unreal.api import plugin +from openpype.hosts.unreal.api import pipeline as unreal_pipeline + +import unreal # noqa -class PointCacheAlembicLoader(api.Loader): +class PointCacheAlembicLoader(plugin.Loader): """Load Point Cache from Alembic""" families = ["model", "pointcache"] @@ -56,8 +60,7 @@ class PointCacheAlembicLoader(api.Loader): return task def load(self, context, name, namespace, data): - """ - Load and containerise representation into Content Browser. + """Load and containerise representation into Content Browser. This is two step process. First, import FBX to temporary path and then call `containerise()` on it - this moves all content to new @@ -76,10 +79,10 @@ class PointCacheAlembicLoader(api.Loader): Returns: list(str): list of container content - """ - # Create directory for asset and avalon container - root = "/Game/Avalon/Assets" + """ + # Create directory for asset and OpenPype container + root = "/Game/OpenPype/Assets" asset = context.get('asset').get('name') suffix = "_CON" if asset: @@ -109,7 +112,7 @@ class PointCacheAlembicLoader(api.Loader): unreal.AssetToolsHelpers.get_asset_tools().import_asset_tasks([task]) # noqa: E501 # Create Asset Container - lib.create_avalon_container( + unreal_pipeline.create_container( container=container_name, path=asset_dir) data = { @@ -138,7 +141,7 @@ class PointCacheAlembicLoader(api.Loader): def update(self, container, representation): name = container["asset_name"] - source_path = api.get_representation_path(representation) + source_path = get_representation_path(representation) destination_path = container["namespace"] task = self.get_task(source_path, destination_path, name, True) diff --git a/openpype/hosts/unreal/plugins/load/load_alembic_skeletalmesh.py b/openpype/hosts/unreal/plugins/load/load_alembic_skeletalmesh.py index b652af0b89..180942de51 100644 --- a/openpype/hosts/unreal/plugins/load/load_alembic_skeletalmesh.py +++ b/openpype/hosts/unreal/plugins/load/load_alembic_skeletalmesh.py @@ -1,12 +1,15 @@ +# -*- coding: utf-8 -*- +"""Load Skeletal Mesh alembics.""" import os -from avalon import api, pipeline -from avalon.unreal import lib -from avalon.unreal import pipeline as unreal_pipeline -import unreal +from avalon import pipeline +from openpype.pipeline import get_representation_path +from openpype.hosts.unreal.api import plugin +from openpype.hosts.unreal.api import pipeline as unreal_pipeline +import unreal # noqa -class SkeletalMeshAlembicLoader(api.Loader): +class SkeletalMeshAlembicLoader(plugin.Loader): """Load Unreal SkeletalMesh from Alembic""" families = ["pointcache"] @@ -16,8 +19,7 @@ class SkeletalMeshAlembicLoader(api.Loader): color = "orange" def load(self, context, name, namespace, data): - """ - Load and containerise representation into Content Browser. + """Load and containerise representation into Content Browser. This is two step process. First, import FBX to temporary path and then call `containerise()` on it - this moves all content to new @@ -38,8 +40,8 @@ class SkeletalMeshAlembicLoader(api.Loader): list(str): list of container content """ - # Create directory for asset and avalon container - root = "/Game/Avalon/Assets" + # Create directory for asset and openpype container + root = "/Game/OpenPype/Assets" asset = context.get('asset').get('name') suffix = "_CON" if asset: @@ -74,7 +76,7 @@ class SkeletalMeshAlembicLoader(api.Loader): unreal.AssetToolsHelpers.get_asset_tools().import_asset_tasks([task]) # noqa: E501 # Create Asset Container - lib.create_avalon_container( + unreal_pipeline.create_container( container=container_name, path=asset_dir) data = { @@ -103,7 +105,7 @@ class SkeletalMeshAlembicLoader(api.Loader): def update(self, container, representation): name = container["asset_name"] - source_path = api.get_representation_path(representation) + source_path = get_representation_path(representation) destination_path = container["namespace"] task = unreal.AssetImportTask() diff --git a/openpype/hosts/unreal/plugins/load/load_alembic_staticmesh.py b/openpype/hosts/unreal/plugins/load/load_alembic_staticmesh.py index ccec31b832..4e00af1d97 100644 --- a/openpype/hosts/unreal/plugins/load/load_alembic_staticmesh.py +++ b/openpype/hosts/unreal/plugins/load/load_alembic_staticmesh.py @@ -1,12 +1,15 @@ +# -*- coding: utf-8 -*- +"""Loader for Static Mesh alembics.""" import os -from avalon import api, pipeline -from avalon.unreal import lib -from avalon.unreal import pipeline as unreal_pipeline -import unreal +from avalon import pipeline +from openpype.pipeline import get_representation_path +from openpype.hosts.unreal.api import plugin +from openpype.hosts.unreal.api import pipeline as unreal_pipeline +import unreal # noqa -class StaticMeshAlembicLoader(api.Loader): +class StaticMeshAlembicLoader(plugin.Loader): """Load Unreal StaticMesh from Alembic""" families = ["model"] @@ -49,8 +52,7 @@ class StaticMeshAlembicLoader(api.Loader): return task def load(self, context, name, namespace, data): - """ - Load and containerise representation into Content Browser. + """Load and containerise representation into Content Browser. This is two step process. First, import FBX to temporary path and then call `containerise()` on it - this moves all content to new @@ -69,10 +71,10 @@ class StaticMeshAlembicLoader(api.Loader): Returns: list(str): list of container content - """ - # Create directory for asset and avalon container - root = "/Game/Avalon/Assets" + """ + # Create directory for asset and OpenPype container + root = "/Game/OpenPype/Assets" asset = context.get('asset').get('name') suffix = "_CON" if asset: @@ -93,7 +95,7 @@ class StaticMeshAlembicLoader(api.Loader): unreal.AssetToolsHelpers.get_asset_tools().import_asset_tasks([task]) # noqa: E501 # Create Asset Container - lib.create_avalon_container( + unreal_pipeline.create_container( container=container_name, path=asset_dir) data = { @@ -122,7 +124,7 @@ class StaticMeshAlembicLoader(api.Loader): def update(self, container, representation): name = container["asset_name"] - source_path = api.get_representation_path(representation) + source_path = get_representation_path(representation) destination_path = container["namespace"] task = self.get_task(source_path, destination_path, name, True) diff --git a/openpype/hosts/unreal/plugins/load/load_animation.py b/openpype/hosts/unreal/plugins/load/load_animation.py index 20baa30847..8ef81f7851 100644 --- a/openpype/hosts/unreal/plugins/load/load_animation.py +++ b/openpype/hosts/unreal/plugins/load/load_animation.py @@ -1,14 +1,17 @@ +# -*- coding: utf-8 -*- +"""Load FBX with animations.""" import os import json -from avalon import api, pipeline -from avalon.unreal import lib -from avalon.unreal import pipeline as unreal_pipeline -import unreal +from avalon import pipeline +from openpype.pipeline import get_representation_path +from openpype.hosts.unreal.api import plugin +from openpype.hosts.unreal.api import pipeline as unreal_pipeline +import unreal # noqa -class AnimationFBXLoader(api.Loader): - """Load Unreal SkeletalMesh from FBX""" +class AnimationFBXLoader(plugin.Loader): + """Load Unreal SkeletalMesh from FBX.""" families = ["animation"] label = "Import FBX Animation" @@ -37,10 +40,10 @@ class AnimationFBXLoader(api.Loader): Returns: list(str): list of container content - """ - # Create directory for asset and avalon container - root = "/Game/Avalon/Assets" + """ + # Create directory for asset and OpenPype container + root = "/Game/OpenPype/Assets" asset = context.get('asset').get('name') suffix = "_CON" if asset: @@ -62,9 +65,9 @@ class AnimationFBXLoader(api.Loader): task = unreal.AssetImportTask() task.options = unreal.FbxImportUI() - libpath = self.fname.replace("fbx", "json") + lib_path = self.fname.replace("fbx", "json") - with open(libpath, "r") as fp: + with open(lib_path, "r") as fp: data = json.load(fp) instance_name = data.get("instance_name") @@ -127,7 +130,7 @@ class AnimationFBXLoader(api.Loader): unreal.AssetToolsHelpers.get_asset_tools().import_asset_tasks([task]) # Create Asset Container - lib.create_avalon_container( + unreal_pipeline.create_container( container=container_name, path=asset_dir) data = { @@ -171,7 +174,7 @@ class AnimationFBXLoader(api.Loader): def update(self, container, representation): name = container["asset_name"] - source_path = api.get_representation_path(representation) + source_path = get_representation_path(representation) destination_path = container["namespace"] task = unreal.AssetImportTask() diff --git a/openpype/hosts/unreal/plugins/load/load_camera.py b/openpype/hosts/unreal/plugins/load/load_camera.py index b2b25eec73..0de9470ef9 100644 --- a/openpype/hosts/unreal/plugins/load/load_camera.py +++ b/openpype/hosts/unreal/plugins/load/load_camera.py @@ -1,12 +1,14 @@ +# -*- coding: utf-8 -*- +"""Load camera from FBX.""" import os -from avalon import api, io, pipeline -from avalon.unreal import lib -from avalon.unreal import pipeline as unreal_pipeline -import unreal +from avalon import io, pipeline +from openpype.hosts.unreal.api import plugin +from openpype.hosts.unreal.api import pipeline as unreal_pipeline +import unreal # noqa -class CameraLoader(api.Loader): +class CameraLoader(plugin.Loader): """Load Unreal StaticMesh from FBX""" families = ["camera"] @@ -38,8 +40,8 @@ class CameraLoader(api.Loader): list(str): list of container content """ - # Create directory for asset and avalon container - root = "/Game/Avalon/Assets" + # Create directory for asset and OpenPype container + root = "/Game/OpenPype/Assets" asset = context.get('asset').get('name') suffix = "_CON" if asset: @@ -109,7 +111,8 @@ class CameraLoader(api.Loader): ) # Create Asset Container - lib.create_avalon_container(container=container_name, path=asset_dir) + unreal_pipeline.create_container( + container=container_name, path=asset_dir) data = { "schema": "openpype:container-2.0", diff --git a/openpype/hosts/unreal/plugins/load/load_layout.py b/openpype/hosts/unreal/plugins/load/load_layout.py index 19d0b74e3e..19ee179d20 100644 --- a/openpype/hosts/unreal/plugins/load/load_layout.py +++ b/openpype/hosts/unreal/plugins/load/load_layout.py @@ -1,3 +1,5 @@ +# -*- coding: utf-8 -*- +"""Loader for layouts.""" import os import json from pathlib import Path @@ -9,12 +11,18 @@ from unreal import AssetToolsHelpers from unreal import FBXImportType from unreal import MathLibrary as umath -from avalon import api, pipeline -from avalon.unreal import lib -from avalon.unreal import pipeline as unreal_pipeline +from avalon.pipeline import AVALON_CONTAINER_ID +from openpype.pipeline import ( + discover_loader_plugins, + loaders_from_representation, + load_container, + get_representation_path, +) +from openpype.hosts.unreal.api import plugin +from openpype.hosts.unreal.api import pipeline as unreal_pipeline -class LayoutLoader(api.Loader): +class LayoutLoader(plugin.Loader): """Load Layout from a JSON file""" families = ["layout"] @@ -23,6 +31,7 @@ class LayoutLoader(api.Loader): label = "Load Layout" icon = "code-fork" color = "orange" + ASSET_ROOT = "/Game/OpenPype/Assets" def _get_asset_containers(self, path): ar = unreal.AssetRegistryHelpers.get_asset_registry() @@ -40,7 +49,8 @@ class LayoutLoader(api.Loader): return asset_containers - def _get_fbx_loader(self, loaders, family): + @staticmethod + def _get_fbx_loader(loaders, family): name = "" if family == 'rig': name = "SkeletalMeshFBXLoader" @@ -58,7 +68,8 @@ class LayoutLoader(api.Loader): return None - def _get_abc_loader(self, loaders, family): + @staticmethod + def _get_abc_loader(loaders, family): name = "" if family == 'rig': name = "SkeletalMeshAlembicLoader" @@ -74,14 +85,15 @@ class LayoutLoader(api.Loader): return None - def _process_family(self, assets, classname, transform, inst_name=None): + @staticmethod + def _process_family(assets, class_name, transform, inst_name=None): ar = unreal.AssetRegistryHelpers.get_asset_registry() actors = [] for asset in assets: obj = ar.get_asset_by_object_path(asset).get_asset() - if obj.get_class().get_name() == classname: + if obj.get_class().get_name() == class_name: actor = EditorLevelLibrary.spawn_actor_from_object( obj, transform.get('translation') @@ -111,8 +123,9 @@ class LayoutLoader(api.Loader): return actors + @staticmethod def _import_animation( - self, asset_dir, path, instance_name, skeleton, actors_dict, + asset_dir, path, instance_name, skeleton, actors_dict, animation_file): anim_file = Path(animation_file) anim_file_name = anim_file.with_suffix('') @@ -192,18 +205,18 @@ class LayoutLoader(api.Loader): actor.skeletal_mesh_component.animation_data.set_editor_property( 'anim_to_play', animation) - def _process(self, libpath, asset_dir, loaded=None): + def _process(self, lib_path, asset_dir, loaded=None): ar = unreal.AssetRegistryHelpers.get_asset_registry() - with open(libpath, "r") as fp: + with open(lib_path, "r") as fp: data = json.load(fp) - all_loaders = api.discover(api.Loader) + all_loaders = discover_loader_plugins() if not loaded: loaded = [] - path = Path(libpath) + path = Path(lib_path) skeleton_dict = {} actors_dict = {} @@ -228,7 +241,7 @@ class LayoutLoader(api.Loader): loaded.append(reference) family = element.get('family') - loaders = api.loaders_from_representation( + loaders = loaders_from_representation( all_loaders, reference) loader = None @@ -245,7 +258,7 @@ class LayoutLoader(api.Loader): "asset_dir": asset_dir } - assets = api.load( + assets = load_container( loader, reference, namespace=instance_name, @@ -292,17 +305,18 @@ class LayoutLoader(api.Loader): asset_dir, path, instance_name, skeleton, actors_dict, animation_file) - def _remove_family(self, assets, components, classname, propname): + @staticmethod + def _remove_family(assets, components, class_name, prop_name): ar = unreal.AssetRegistryHelpers.get_asset_registry() objects = [] for a in assets: obj = ar.get_asset_by_object_path(a) - if obj.get_asset().get_class().get_name() == classname: + if obj.get_asset().get_class().get_name() == class_name: objects.append(obj) for obj in objects: for comp in components: - if comp.get_editor_property(propname) == obj.get_asset(): + if comp.get_editor_property(prop_name) == obj.get_asset(): comp.get_owner().destroy_actor() def _remove_actors(self, path): @@ -334,8 +348,7 @@ class LayoutLoader(api.Loader): assets, skel_meshes_comp, 'SkeletalMesh', 'skeletal_mesh') def load(self, context, name, namespace, options): - """ - Load and containerise representation into Content Browser. + """Load and containerise representation into Content Browser. This is two step process. First, import FBX to temporary path and then call `containerise()` on it - this moves all content to new @@ -349,14 +362,14 @@ class LayoutLoader(api.Loader): This is not passed here, so namespace is set by `containerise()` because only then we know real path. - data (dict): Those would be data to be imprinted. This is not used - now, data are imprinted by `containerise()`. + options (dict): Those would be data to be imprinted. This is not + used now, data are imprinted by `containerise()`. Returns: list(str): list of container content """ # Create directory for asset and avalon container - root = "/Game/Avalon/Assets" + root = self.ASSET_ROOT asset = context.get('asset').get('name') suffix = "_CON" if asset: @@ -375,12 +388,12 @@ class LayoutLoader(api.Loader): self._process(self.fname, asset_dir) # Create Asset Container - lib.create_avalon_container( + unreal_pipeline.create_container( container=container_name, path=asset_dir) data = { "schema": "openpype:container-2.0", - "id": pipeline.AVALON_CONTAINER_ID, + "id": AVALON_CONTAINER_ID, "asset": asset, "namespace": asset_dir, "container_name": container_name, @@ -404,9 +417,9 @@ class LayoutLoader(api.Loader): def update(self, container, representation): ar = unreal.AssetRegistryHelpers.get_asset_registry() - source_path = api.get_representation_path(representation) + source_path = get_representation_path(representation) destination_path = container["namespace"] - libpath = Path(api.get_representation_path(representation)) + lib_path = Path(get_representation_path(representation)) self._remove_actors(destination_path) @@ -502,7 +515,7 @@ class LayoutLoader(api.Loader): if animation_file and skeleton: self._import_animation( - destination_path, libpath, + destination_path, lib_path, instance_name, skeleton, actors_dict, animation_file) diff --git a/openpype/hosts/unreal/plugins/load/load_rig.py b/openpype/hosts/unreal/plugins/load/load_rig.py index c7d095aa21..3d5616364c 100644 --- a/openpype/hosts/unreal/plugins/load/load_rig.py +++ b/openpype/hosts/unreal/plugins/load/load_rig.py @@ -1,13 +1,16 @@ +# -*- coding: utf-8 -*- +"""Load Skeletal Meshes form FBX.""" import os -from avalon import api, pipeline -from avalon.unreal import lib -from avalon.unreal import pipeline as unreal_pipeline -import unreal +from avalon import pipeline +from openpype.pipeline import get_representation_path +from openpype.hosts.unreal.api import plugin +from openpype.hosts.unreal.api import pipeline as unreal_pipeline +import unreal # noqa -class SkeletalMeshFBXLoader(api.Loader): - """Load Unreal SkeletalMesh from FBX""" +class SkeletalMeshFBXLoader(plugin.Loader): + """Load Unreal SkeletalMesh from FBX.""" families = ["rig"] label = "Import FBX Skeletal Mesh" @@ -16,8 +19,7 @@ class SkeletalMeshFBXLoader(api.Loader): color = "orange" def load(self, context, name, namespace, options): - """ - Load and containerise representation into Content Browser. + """Load and containerise representation into Content Browser. This is two step process. First, import FBX to temporary path and then call `containerise()` on it - this moves all content to new @@ -31,15 +33,15 @@ class SkeletalMeshFBXLoader(api.Loader): This is not passed here, so namespace is set by `containerise()` because only then we know real path. - data (dict): Those would be data to be imprinted. This is not used - now, data are imprinted by `containerise()`. + options (dict): Those would be data to be imprinted. This is not + used now, data are imprinted by `containerise()`. Returns: list(str): list of container content - """ - # Create directory for asset and avalon container - root = "/Game/Avalon/Assets" + """ + # Create directory for asset and OpenPype container + root = "/Game/OpenPype/Assets" if options and options.get("asset_dir"): root = options["asset_dir"] asset = context.get('asset').get('name') @@ -94,7 +96,7 @@ class SkeletalMeshFBXLoader(api.Loader): unreal.AssetToolsHelpers.get_asset_tools().import_asset_tasks([task]) # noqa: E501 # Create Asset Container - lib.create_avalon_container( + unreal_pipeline.create_container( container=container_name, path=asset_dir) data = { @@ -123,7 +125,7 @@ class SkeletalMeshFBXLoader(api.Loader): def update(self, container, representation): name = container["asset_name"] - source_path = api.get_representation_path(representation) + source_path = get_representation_path(representation) destination_path = container["namespace"] task = unreal.AssetImportTask() diff --git a/openpype/hosts/unreal/plugins/load/load_staticmeshfbx.py b/openpype/hosts/unreal/plugins/load/load_staticmeshfbx.py index 510c4331ad..587fc83a77 100644 --- a/openpype/hosts/unreal/plugins/load/load_staticmeshfbx.py +++ b/openpype/hosts/unreal/plugins/load/load_staticmeshfbx.py @@ -1,13 +1,16 @@ +# -*- coding: utf-8 -*- +"""Load Static meshes form FBX.""" import os -from avalon import api, pipeline -from avalon.unreal import lib -from avalon.unreal import pipeline as unreal_pipeline -import unreal +from avalon import pipeline +from openpype.pipeline import get_representation_path +from openpype.hosts.unreal.api import plugin +from openpype.hosts.unreal.api import pipeline as unreal_pipeline +import unreal # noqa -class StaticMeshFBXLoader(api.Loader): - """Load Unreal StaticMesh from FBX""" +class StaticMeshFBXLoader(plugin.Loader): + """Load Unreal StaticMesh from FBX.""" families = ["model", "unrealStaticMesh"] label = "Import FBX Static Mesh" @@ -15,7 +18,8 @@ class StaticMeshFBXLoader(api.Loader): icon = "cube" color = "orange" - def get_task(self, filename, asset_dir, asset_name, replace): + @staticmethod + def get_task(filename, asset_dir, asset_name, replace): task = unreal.AssetImportTask() options = unreal.FbxImportUI() import_data = unreal.FbxStaticMeshImportData() @@ -41,8 +45,7 @@ class StaticMeshFBXLoader(api.Loader): return task def load(self, context, name, namespace, options): - """ - Load and containerise representation into Content Browser. + """Load and containerise representation into Content Browser. This is two step process. First, import FBX to temporary path and then call `containerise()` on it - this moves all content to new @@ -56,15 +59,15 @@ class StaticMeshFBXLoader(api.Loader): This is not passed here, so namespace is set by `containerise()` because only then we know real path. - data (dict): Those would be data to be imprinted. This is not used - now, data are imprinted by `containerise()`. + options (dict): Those would be data to be imprinted. This is not + used now, data are imprinted by `containerise()`. Returns: list(str): list of container content """ - # Create directory for asset and avalon container - root = "/Game/Avalon/Assets" + # Create directory for asset and OpenPype container + root = "/Game/OpenPype/Assets" if options and options.get("asset_dir"): root = options["asset_dir"] asset = context.get('asset').get('name') @@ -87,7 +90,7 @@ class StaticMeshFBXLoader(api.Loader): unreal.AssetToolsHelpers.get_asset_tools().import_asset_tasks([task]) # noqa: E501 # Create Asset Container - lib.create_avalon_container( + unreal_pipeline.create_container( container=container_name, path=asset_dir) data = { @@ -116,7 +119,7 @@ class StaticMeshFBXLoader(api.Loader): def update(self, container, representation): name = container["asset_name"] - source_path = api.get_representation_path(representation) + source_path = get_representation_path(representation) destination_path = container["namespace"] task = self.get_task(source_path, destination_path, name, True) diff --git a/openpype/hosts/unreal/plugins/publish/collect_current_file.py b/openpype/hosts/unreal/plugins/publish/collect_current_file.py index 4e828933bb..acd4c5c8d2 100644 --- a/openpype/hosts/unreal/plugins/publish/collect_current_file.py +++ b/openpype/hosts/unreal/plugins/publish/collect_current_file.py @@ -1,17 +1,18 @@ -import unreal - +# -*- coding: utf-8 -*- +"""Collect current project path.""" +import unreal # noqa import pyblish.api class CollectUnrealCurrentFile(pyblish.api.ContextPlugin): - """Inject the current working file into context""" + """Inject the current working file into context.""" order = pyblish.api.CollectorOrder - 0.5 label = "Unreal Current File" hosts = ['unreal'] def process(self, context): - """Inject the current working file""" + """Inject the current working file.""" current_file = unreal.Paths.get_project_file_path() context.data['currentFile'] = current_file diff --git a/openpype/hosts/unreal/plugins/publish/collect_instances.py b/openpype/hosts/unreal/plugins/publish/collect_instances.py index 62676f9938..94e732d728 100644 --- a/openpype/hosts/unreal/plugins/publish/collect_instances.py +++ b/openpype/hosts/unreal/plugins/publish/collect_instances.py @@ -1,12 +1,14 @@ +# -*- coding: utf-8 -*- +"""Collect publishable instances in Unreal.""" import ast -import unreal +import unreal # noqa import pyblish.api class CollectInstances(pyblish.api.ContextPlugin): - """Gather instances by AvalonPublishInstance class + """Gather instances by OpenPypePublishInstance class - This collector finds all paths containing `AvalonPublishInstance` class + This collector finds all paths containing `OpenPypePublishInstance` class asset Identifier: @@ -22,7 +24,7 @@ class CollectInstances(pyblish.api.ContextPlugin): ar = unreal.AssetRegistryHelpers.get_asset_registry() instance_containers = ar.get_assets_by_class( - "AvalonPublishInstance", True) + "OpenPypePublishInstance", True) for container_data in instance_containers: asset = container_data.get_asset() diff --git a/openpype/hosts/unreal/plugins/publish/extract_camera.py b/openpype/hosts/unreal/plugins/publish/extract_camera.py index 10862fc0ef..ce53824563 100644 --- a/openpype/hosts/unreal/plugins/publish/extract_camera.py +++ b/openpype/hosts/unreal/plugins/publish/extract_camera.py @@ -1,3 +1,5 @@ +# -*- coding: utf-8 -*- +"""Extract camera from Unreal.""" import os import unreal @@ -17,7 +19,7 @@ class ExtractCamera(openpype.api.Extractor): def process(self, instance): # Define extract output file path - stagingdir = self.staging_dir(instance) + staging_dir = self.staging_dir(instance) fbx_filename = "{}.fbx".format(instance.name) # Perform extraction @@ -38,7 +40,7 @@ class ExtractCamera(openpype.api.Extractor): sequence, sequence.get_bindings(), unreal.FbxExportOption(), - os.path.join(stagingdir, fbx_filename) + os.path.join(staging_dir, fbx_filename) ) break @@ -49,6 +51,6 @@ class ExtractCamera(openpype.api.Extractor): 'name': 'fbx', 'ext': 'fbx', 'files': fbx_filename, - "stagingDir": stagingdir, + "stagingDir": staging_dir, } instance.data["representations"].append(fbx_representation) diff --git a/openpype/hosts/unreal/plugins/publish/extract_layout.py b/openpype/hosts/unreal/plugins/publish/extract_layout.py index a47187cf47..2d09b0e7bd 100644 --- a/openpype/hosts/unreal/plugins/publish/extract_layout.py +++ b/openpype/hosts/unreal/plugins/publish/extract_layout.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- import os import json import math @@ -20,7 +21,7 @@ class ExtractLayout(openpype.api.Extractor): def process(self, instance): # Define extract output file path - stagingdir = self.staging_dir(instance) + staging_dir = self.staging_dir(instance) # Perform extraction self.log.info("Performing extraction..") @@ -96,7 +97,7 @@ class ExtractLayout(openpype.api.Extractor): json_data.append(json_element) json_filename = "{}.json".format(instance.name) - json_path = os.path.join(stagingdir, json_filename) + json_path = os.path.join(staging_dir, json_filename) with open(json_path, "w+") as file: json.dump(json_data, fp=file, indent=2) @@ -108,6 +109,6 @@ class ExtractLayout(openpype.api.Extractor): 'name': 'json', 'ext': 'json', 'files': json_filename, - "stagingDir": stagingdir, + "stagingDir": staging_dir, } instance.data["representations"].append(json_representation) diff --git a/openpype/hosts/unreal/plugins/publish/extract_look.py b/openpype/hosts/unreal/plugins/publish/extract_look.py index 0f1539a7d5..ea39949417 100644 --- a/openpype/hosts/unreal/plugins/publish/extract_look.py +++ b/openpype/hosts/unreal/plugins/publish/extract_look.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- import json import os @@ -17,7 +18,7 @@ class ExtractLook(openpype.api.Extractor): def process(self, instance): # Define extract output file path - stagingdir = self.staging_dir(instance) + staging_dir = self.staging_dir(instance) resources_dir = instance.data["resourcesDir"] ar = unreal.AssetRegistryHelpers.get_asset_registry() @@ -57,7 +58,7 @@ class ExtractLook(openpype.api.Extractor): tga_export_task.set_editor_property('automated', True) tga_export_task.set_editor_property('object', texture) tga_export_task.set_editor_property( - 'filename', f"{stagingdir}/{tga_filename}") + 'filename', f"{staging_dir}/{tga_filename}") tga_export_task.set_editor_property('prompt', False) tga_export_task.set_editor_property('selected', False) @@ -66,7 +67,7 @@ class ExtractLook(openpype.api.Extractor): json_element['tga_filename'] = tga_filename transfers.append(( - f"{stagingdir}/{tga_filename}", + f"{staging_dir}/{tga_filename}", f"{resources_dir}/{tga_filename}")) fbx_filename = f"{instance.name}_{name}.fbx" @@ -84,7 +85,7 @@ class ExtractLook(openpype.api.Extractor): task.set_editor_property('automated', True) task.set_editor_property('object', object) task.set_editor_property( - 'filename', f"{stagingdir}/{fbx_filename}") + 'filename', f"{staging_dir}/{fbx_filename}") task.set_editor_property('prompt', False) task.set_editor_property('selected', False) @@ -93,13 +94,13 @@ class ExtractLook(openpype.api.Extractor): json_element['fbx_filename'] = fbx_filename transfers.append(( - f"{stagingdir}/{fbx_filename}", + f"{staging_dir}/{fbx_filename}", f"{resources_dir}/{fbx_filename}")) json_data.append(json_element) json_filename = f"{instance.name}.json" - json_path = os.path.join(stagingdir, json_filename) + json_path = os.path.join(staging_dir, json_filename) with open(json_path, "w+") as file: json.dump(json_data, fp=file, indent=2) @@ -113,7 +114,7 @@ class ExtractLook(openpype.api.Extractor): 'name': 'json', 'ext': 'json', 'files': json_filename, - "stagingDir": stagingdir, + "stagingDir": staging_dir, } instance.data["representations"].append(json_representation) diff --git a/openpype/hosts/webpublisher/api/__init__.py b/openpype/hosts/webpublisher/api/__init__.py index e40d46d662..dbeb628073 100644 --- a/openpype/hosts/webpublisher/api/__init__.py +++ b/openpype/hosts/webpublisher/api/__init__.py @@ -12,30 +12,19 @@ HOST_DIR = os.path.dirname(os.path.abspath( openpype.hosts.webpublisher.__file__)) PLUGINS_DIR = os.path.join(HOST_DIR, "plugins") PUBLISH_PATH = os.path.join(PLUGINS_DIR, "publish") -LOAD_PATH = os.path.join(PLUGINS_DIR, "load") -CREATE_PATH = os.path.join(PLUGINS_DIR, "create") - - -def application_launch(): - pass def install(): print("Installing Pype config...") pyblish.register_plugin_path(PUBLISH_PATH) - avalon.register_plugin_path(avalon.Loader, LOAD_PATH) - avalon.register_plugin_path(avalon.Creator, CREATE_PATH) log.info(PUBLISH_PATH) io.install() - avalon.on("application.launched", application_launch) def uninstall(): pyblish.deregister_plugin_path(PUBLISH_PATH) - avalon.deregister_plugin_path(avalon.Loader, LOAD_PATH) - avalon.deregister_plugin_path(avalon.Creator, CREATE_PATH) # to have required methods for interface diff --git a/openpype/hosts/webpublisher/plugins/publish/collect_published_files.py b/openpype/hosts/webpublisher/plugins/publish/collect_published_files.py index abad14106f..65cef14703 100644 --- a/openpype/hosts/webpublisher/plugins/publish/collect_published_files.py +++ b/openpype/hosts/webpublisher/plugins/publish/collect_published_files.py @@ -10,14 +10,22 @@ Provides: import os import clique import tempfile +import math + from avalon import io import pyblish.api -from openpype.lib import prepare_template_data +from openpype.lib import ( + prepare_template_data, + get_asset, + get_ffprobe_streams, + convert_ffprobe_fps_value, +) from openpype.lib.plugin_tools import ( parse_json, get_subset_name_with_asset_doc ) + class CollectPublishedFiles(pyblish.api.ContextPlugin): """ This collector will try to find json files in provided @@ -49,10 +57,7 @@ class CollectPublishedFiles(pyblish.api.ContextPlugin): self.log.info("task_sub:: {}".format(task_subfolders)) asset_name = context.data["asset"] - asset_doc = io.find_one({ - "type": "asset", - "name": asset_name - }) + asset_doc = get_asset() task_name = context.data["task"] task_type = context.data["taskType"] project_name = context.data["project_name"] @@ -97,11 +102,27 @@ class CollectPublishedFiles(pyblish.api.ContextPlugin): instance.data["frameEnd"] = \ instance.data["representations"][0]["frameEnd"] else: - instance.data["frameStart"] = 0 - instance.data["frameEnd"] = 1 + frame_start = asset_doc["data"]["frameStart"] + instance.data["frameStart"] = frame_start + instance.data["frameEnd"] = asset_doc["data"]["frameEnd"] instance.data["representations"] = self._get_single_repre( task_dir, task_data["files"], tags ) + file_url = os.path.join(task_dir, task_data["files"][0]) + no_of_frames = self._get_number_of_frames(file_url) + if no_of_frames: + try: + frame_end = int(frame_start) + math.ceil(no_of_frames) + instance.data["frameEnd"] = math.ceil(frame_end) - 1 + self.log.debug("frameEnd:: {}".format( + instance.data["frameEnd"])) + except ValueError: + self.log.warning("Unable to count frames " + "duration {}".format(no_of_frames)) + + # raise ValueError("STOP") + instance.data["handleStart"] = asset_doc["data"]["handleStart"] + instance.data["handleEnd"] = asset_doc["data"]["handleEnd"] self.log.info("instance.data:: {}".format(instance.data)) @@ -127,7 +148,7 @@ class CollectPublishedFiles(pyblish.api.ContextPlugin): return [repre_data] def _process_sequence(self, files, task_dir, tags): - """Prepare reprentations for sequence of files.""" + """Prepare representation for sequence of files.""" collections, remainder = clique.assemble(files) assert len(collections) == 1, \ "Too many collections in {}".format(files) @@ -188,6 +209,7 @@ class CollectPublishedFiles(pyblish.api.ContextPlugin): msg = "No family found for combination of " +\ "task_type: {}, is_sequence:{}, extension: {}".format( task_type, is_sequence, extension) + found_family = "render" assert found_family, msg return (found_family, @@ -243,3 +265,43 @@ class CollectPublishedFiles(pyblish.api.ContextPlugin): return version[0].get("version") or 0 else: return 0 + + def _get_number_of_frames(self, file_url): + """Return duration in frames""" + try: + streams = get_ffprobe_streams(file_url, self.log) + except Exception as exc: + raise AssertionError(( + "FFprobe couldn't read information about input file: \"{}\"." + " Error message: {}" + ).format(file_url, str(exc))) + + first_video_stream = None + for stream in streams: + if "width" in stream and "height" in stream: + first_video_stream = stream + break + + if first_video_stream: + nb_frames = stream.get("nb_frames") + if nb_frames: + try: + return int(nb_frames) + except ValueError: + self.log.warning( + "nb_frames {} not convertible".format(nb_frames)) + + duration = stream.get("duration") + frame_rate = convert_ffprobe_fps_value( + stream.get("r_frame_rate", '0/0') + ) + self.log.debug("duration:: {} frame_rate:: {}".format( + duration, frame_rate)) + try: + return float(duration) * float(frame_rate) + except ValueError: + self.log.warning( + "{} or {} cannot be converted".format(duration, + frame_rate)) + + self.log.warning("Cannot get number of frames") diff --git a/openpype/lib/__init__.py b/openpype/lib/__init__.py index ebe7648ad7..b8502ae718 100644 --- a/openpype/lib/__init__.py +++ b/openpype/lib/__init__.py @@ -16,6 +16,19 @@ sys.path.insert(0, python_version_dir) site.addsitedir(python_version_dir) +from .events import ( + emit_event, + register_event_callback +) + +from .vendor_bin_utils import ( + find_executable, + get_vendor_bin_path, + get_oiio_tools_path, + get_ffmpeg_tool_path, + is_oiio_supported +) + from .env_tools import ( env_value_to_bool, get_paths_from_environ, @@ -29,30 +42,35 @@ from .execute import ( get_linux_launcher_args, execute, run_subprocess, + run_detached_process, run_openpype_process, clean_envs_for_openpype_process, path_to_subprocess_arg, CREATE_NO_WINDOW ) from .log import PypeLogger, timeit + +from .path_templates import ( + merge_dict, + TemplateMissingKey, + TemplateUnsolved, + StringTemplate, + TemplatesDict, + FormatObject, +) + from .mongo import ( get_default_components, validate_mongo_connection, OpenPypeMongoConnection ) from .anatomy import ( - merge_dict, Anatomy ) -from .config import get_datetime_data - -from .vendor_bin_utils import ( - get_vendor_bin_path, - get_oiio_tools_path, - get_ffmpeg_tool_path, - ffprobe_streams, - is_oiio_supported +from .config import ( + get_datetime_data, + get_formatted_current_time ) from .python_module_tools import ( @@ -71,7 +89,12 @@ from .profiles_filtering import ( from .transcoding import ( get_transcode_temp_directory, should_convert_for_ffmpeg, - convert_for_ffmpeg + convert_for_ffmpeg, + get_ffprobe_data, + get_ffprobe_streams, + get_ffmpeg_codec_args, + get_ffmpeg_format_args, + convert_ffprobe_fps_value, ) from .avalon_context import ( CURRENT_DOC_SCHEMAS, @@ -130,7 +153,7 @@ from .applications import ( PostLaunchHook, EnvironmentPrepData, - prepare_host_environments, + prepare_app_environments, prepare_context_environments, get_app_environments_for_context, apply_project_environments_value @@ -149,6 +172,7 @@ from .plugin_tools import ( ) from .path_tools import ( + create_hard_link, version_up, get_version_from_path, get_last_version_from_path, @@ -183,11 +207,16 @@ from .openpype_version import ( terminal = Terminal __all__ = [ + "emit_event", + "register_event_callback", + + "find_executable", "get_openpype_execute_args", "get_pype_execute_args", "get_linux_launcher_args", "execute", "run_subprocess", + "run_detached_process", "run_openpype_process", "clean_envs_for_openpype_process", "path_to_subprocess_arg", @@ -200,7 +229,6 @@ __all__ = [ "get_vendor_bin_path", "get_oiio_tools_path", "get_ffmpeg_tool_path", - "ffprobe_streams", "is_oiio_supported", "import_filepath", @@ -212,6 +240,11 @@ __all__ = [ "get_transcode_temp_directory", "should_convert_for_ffmpeg", "convert_for_ffmpeg", + "get_ffprobe_data", + "get_ffprobe_streams", + "get_ffmpeg_codec_args", + "get_ffmpeg_format_args", + "convert_ffprobe_fps_value", "CURRENT_DOC_SCHEMAS", "PROJECT_NAME_ALLOWED_SYMBOLS", @@ -261,7 +294,7 @@ __all__ = [ "PreLaunchHook", "PostLaunchHook", "EnvironmentPrepData", - "prepare_host_environments", + "prepare_app_environments", "prepare_context_environments", "get_app_environments_for_context", "apply_project_environments_value", @@ -279,16 +312,24 @@ __all__ = [ "get_unique_layer_name", "get_background_layers", + "create_hard_link", "version_up", "get_version_from_path", "get_last_version_from_path", + "merge_dict", + "TemplateMissingKey", + "TemplateUnsolved", + "StringTemplate", + "TemplatesDict", + "FormatObject", + "terminal", - "merge_dict", "Anatomy", "get_datetime_data", + "get_formatted_current_time", "PypeLogger", "get_default_components", diff --git a/openpype/lib/abstract_collect_render.py b/openpype/lib/abstract_collect_render.py index 3839aad45d..7c768e280c 100644 --- a/openpype/lib/abstract_collect_render.py +++ b/openpype/lib/abstract_collect_render.py @@ -26,7 +26,7 @@ class RenderInstance(object): # metadata version = attr.ib() # instance version - time = attr.ib() # time of instance creation (avalon.api.time()) + time = attr.ib() # time of instance creation (get_formatted_current_time) source = attr.ib() # path to source scene file label = attr.ib() # label to show in GUI subset = attr.ib() # subset name diff --git a/openpype/lib/anatomy.py b/openpype/lib/anatomy.py index fa81a18ff7..3fbc05ee88 100644 --- a/openpype/lib/anatomy.py +++ b/openpype/lib/anatomy.py @@ -9,6 +9,12 @@ from openpype.settings.lib import ( get_default_anatomy_settings, get_anatomy_settings ) +from .path_templates import ( + TemplateUnsolved, + TemplateResult, + TemplatesDict, + FormatObject, +) from .log import PypeLogger log = PypeLogger().get_logger(__name__) @@ -19,32 +25,6 @@ except NameError: StringType = str -def merge_dict(main_dict, enhance_dict): - """Merges dictionaries by keys. - - Function call itself if value on key is again dictionary. - - Args: - main_dict (dict): First dict to merge second one into. - enhance_dict (dict): Second dict to be merged. - - Returns: - dict: Merged result. - - .. note:: does not overrides whole value on first found key - but only values differences from enhance_dict - - """ - for key, value in enhance_dict.items(): - if key not in main_dict: - main_dict[key] = value - elif isinstance(value, dict) and isinstance(main_dict[key], dict): - main_dict[key] = merge_dict(main_dict[key], value) - else: - main_dict[key] = value - return main_dict - - class ProjectNotSet(Exception): """Exception raised when is created Anatomy without project name.""" @@ -59,7 +39,7 @@ class RootCombinationError(Exception): # TODO better error message msg = ( "Combination of root with and" - " without root name in Templates. {}" + " without root name in AnatomyTemplates. {}" ).format(joined_roots) super(RootCombinationError, self).__init__(msg) @@ -68,7 +48,7 @@ class RootCombinationError(Exception): class Anatomy: """Anatomy module helps to keep project settings. - Wraps key project specifications, Templates and Roots. + Wraps key project specifications, AnatomyTemplates and Roots. Args: project_name (str): Project name to look on overrides. @@ -93,7 +73,7 @@ class Anatomy: get_anatomy_settings(project_name, site_name) ) self._site_name = site_name - self._templates_obj = Templates(self) + self._templates_obj = AnatomyTemplates(self) self._roots_obj = Roots(self) # Anatomy used as dictionary @@ -158,12 +138,12 @@ class Anatomy: @property def templates(self): - """Wrap property `templates` of Anatomy's Templates instance.""" + """Wrap property `templates` of Anatomy's AnatomyTemplates instance.""" return self._templates_obj.templates @property def templates_obj(self): - """Return `Templates` object of current Anatomy instance.""" + """Return `AnatomyTemplates` object of current Anatomy instance.""" return self._templates_obj def format(self, *args, **kwargs): @@ -375,203 +355,45 @@ class Anatomy: return rootless_path.format(**data) -class TemplateMissingKey(Exception): - """Exception for cases when key does not exist in Anatomy.""" - - msg = "Anatomy key does not exist: `anatomy{0}`." - - def __init__(self, parents): - parent_join = "".join(["[\"{0}\"]".format(key) for key in parents]) - super(TemplateMissingKey, self).__init__( - self.msg.format(parent_join) - ) - - -class TemplateUnsolved(Exception): +class AnatomyTemplateUnsolved(TemplateUnsolved): """Exception for unsolved template when strict is set to True.""" msg = "Anatomy template \"{0}\" is unsolved.{1}{2}" - invalid_types_msg = " Keys with invalid DataType: `{0}`." - missing_keys_msg = " Missing keys: \"{0}\"." - def __init__(self, template, missing_keys, invalid_types): - invalid_type_items = [] - for _key, _type in invalid_types.items(): - invalid_type_items.append( - "\"{0}\" {1}".format(_key, str(_type)) - ) - invalid_types_msg = "" - if invalid_type_items: - invalid_types_msg = self.invalid_types_msg.format( - ", ".join(invalid_type_items) - ) +class AnatomyTemplateResult(TemplateResult): + rootless = None - missing_keys_msg = "" - if missing_keys: - missing_keys_msg = self.missing_keys_msg.format( - ", ".join(missing_keys) - ) - super(TemplateUnsolved, self).__init__( - self.msg.format(template, missing_keys_msg, invalid_types_msg) + def __new__(cls, result, rootless_path): + new_obj = super(AnatomyTemplateResult, cls).__new__( + cls, + str(result), + result.template, + result.solved, + result.used_values, + result.missing_keys, + result.invalid_types ) - - -class TemplateResult(str): - """Result (formatted template) of anatomy with most of information in. - - Args: - used_values (dict): Dictionary of template filling data with - only used keys. - solved (bool): For check if all required keys were filled. - template (str): Original template. - missing_keys (list): Missing keys that were not in the data. Include - missing optional keys. - invalid_types (dict): When key was found in data, but value had not - allowed DataType. Allowed data types are `numbers`, - `str`(`basestring`) and `dict`. Dictionary may cause invalid type - when value of key in data is dictionary but template expect string - of number. - """ - - def __new__( - cls, filled_template, template, solved, rootless_path, - used_values, missing_keys, invalid_types - ): - new_obj = super(TemplateResult, cls).__new__(cls, filled_template) - new_obj.used_values = used_values - new_obj.solved = solved - new_obj.template = template new_obj.rootless = rootless_path - new_obj.missing_keys = list(set(missing_keys)) - _invalid_types = {} - for invalid_type in invalid_types: - for key, val in invalid_type.items(): - if key in _invalid_types: - continue - _invalid_types[key] = val - new_obj.invalid_types = _invalid_types return new_obj - -class TemplatesDict(dict): - """Holds and wrap TemplateResults for easy bug report.""" - - def __init__(self, in_data, key=None, parent=None, strict=None): - super(TemplatesDict, self).__init__() - for _key, _value in in_data.items(): - if isinstance(_value, dict): - _value = self.__class__(_value, _key, self) - self[_key] = _value - - self.key = key - self.parent = parent - self.strict = strict - if self.parent is None and strict is None: - self.strict = True - - def __getitem__(self, key): - # Raise error about missing key in anatomy.yaml - if key not in self.keys(): - hier = self.hierarchy() - hier.append(key) - raise TemplateMissingKey(hier) - - value = super(TemplatesDict, self).__getitem__(key) - if isinstance(value, self.__class__): - return value - - # Raise exception when expected solved templates and it is not. - if ( - self.raise_on_unsolved - and (hasattr(value, "solved") and not value.solved) - ): - raise TemplateUnsolved( - value.template, value.missing_keys, value.invalid_types + def validate(self): + if not self.solved: + raise AnatomyTemplateUnsolved( + self.template, + self.missing_keys, + self.invalid_types ) - return value - - @property - def raise_on_unsolved(self): - """To affect this change `strict` attribute.""" - if self.strict is not None: - return self.strict - return self.parent.raise_on_unsolved - - def hierarchy(self): - """Return dictionary keys one by one to root parent.""" - if self.parent is None: - return [] - - hier_keys = [] - par_hier = self.parent.hierarchy() - if par_hier: - hier_keys.extend(par_hier) - hier_keys.append(self.key) - - return hier_keys - - @property - def missing_keys(self): - """Return missing keys of all children templates.""" - missing_keys = [] - for value in self.values(): - missing_keys.extend(value.missing_keys) - return list(set(missing_keys)) - - @property - def invalid_types(self): - """Return invalid types of all children templates.""" - invalid_types = {} - for value in self.values(): - for invalid_type in value.invalid_types: - _invalid_types = {} - for key, val in invalid_type.items(): - if key in invalid_types: - continue - _invalid_types[key] = val - invalid_types = merge_dict(invalid_types, _invalid_types) - return invalid_types - - @property - def used_values(self): - """Return used values for all children templates.""" - used_values = {} - for value in self.values(): - used_values = merge_dict(used_values, value.used_values) - return used_values - - def get_solved(self): - """Get only solved key from templates.""" - result = {} - for key, value in self.items(): - if isinstance(value, self.__class__): - value = value.get_solved() - if not value: - continue - result[key] = value - - elif ( - not hasattr(value, "solved") or - value.solved - ): - result[key] = value - return self.__class__(result, key=self.key, parent=self.parent) -class Templates: - key_pattern = re.compile(r"(\{.*?[^{0]*\})") - key_padding_pattern = re.compile(r"([^:]+)\S+[><]\S+") - sub_dict_pattern = re.compile(r"([^\[\]]+)") - optional_pattern = re.compile(r"(<.*?[^{0]*>)[^0-9]*?") - +class AnatomyTemplates(TemplatesDict): inner_key_pattern = re.compile(r"(\{@.*?[^{}0]*\})") inner_key_name_pattern = re.compile(r"\{@(.*?[^{}0]*)\}") def __init__(self, anatomy): + super(AnatomyTemplates, self).__init__() self.anatomy = anatomy self.loaded_project = None - self._templates = None def __getitem__(self, key): return self.templates[key] @@ -580,7 +402,9 @@ class Templates: return self.templates.get(key, default) def reset(self): + self._raw_templates = None self._templates = None + self._objected_templates = None @property def project_name(self): @@ -592,17 +416,66 @@ class Templates: @property def templates(self): + self._validate_discovery() + return self._templates + + @property + def objected_templates(self): + self._validate_discovery() + return self._objected_templates + + def _validate_discovery(self): if self.project_name != self.loaded_project: - self._templates = None + self.reset() if self._templates is None: - self._templates = self._discover() + self._discover() self.loaded_project = self.project_name - return self._templates + + def _format_value(self, value, data): + if isinstance(value, RootItem): + return self._solve_dict(value, data) + + result = super(AnatomyTemplates, self)._format_value(value, data) + if isinstance(result, TemplateResult): + rootless_path = self._rootless_path(result, data) + result = AnatomyTemplateResult(result, rootless_path) + return result + + def set_templates(self, templates): + if not templates: + self.reset() + return + + self._raw_templates = copy.deepcopy(templates) + templates = copy.deepcopy(templates) + v_queue = collections.deque() + v_queue.append(templates) + while v_queue: + item = v_queue.popleft() + if not isinstance(item, dict): + continue + + for key in tuple(item.keys()): + value = item[key] + if isinstance(value, dict): + v_queue.append(value) + + elif ( + isinstance(value, StringType) + and "{task}" in value + ): + item[key] = value.replace("{task}", "{task[name]}") + + solved_templates = self.solve_template_inner_links(templates) + self._templates = solved_templates + self._objected_templates = self.create_ojected_templates( + solved_templates + ) def default_templates(self): """Return default templates data with solved inner keys.""" - return Templates.solve_template_inner_links( + return self.solve_template_inner_links( self.anatomy["templates"] ) @@ -613,7 +486,7 @@ class Templates: TODO: create templates if not exist. Returns: - TemplatesDict: Contain templates data for current project of + TemplatesResultDict: Contain templates data for current project of default templates. """ @@ -624,7 +497,7 @@ class Templates: " Trying to use default." ).format(self.project_name)) - return Templates.solve_template_inner_links(self.anatomy["templates"]) + self.set_templates(self.anatomy["templates"]) @classmethod def replace_inner_keys(cls, matches, value, key_values, key): @@ -791,149 +664,6 @@ class Templates: return keys_by_subkey - def _filter_optional(self, template, data): - """Filter invalid optional keys. - - Invalid keys may be missing keys of with invalid value DataType. - - Args: - template (str): Anatomy template which will be formatted. - data (dict): Containing keys to be filled into template. - - Result: - tuple: Contain origin template without missing optional keys and - without optional keys identificator ("<" and ">"), information - about missing optional keys and invalid types of optional keys. - - """ - - # Remove optional missing keys - missing_keys = [] - invalid_types = [] - for optional_group in self.optional_pattern.findall(template): - _missing_keys = [] - _invalid_types = [] - for optional_key in self.key_pattern.findall(optional_group): - key = str(optional_key[1:-1]) - key_padding = list( - self.key_padding_pattern.findall(key) - ) - if key_padding: - key = key_padding[0] - - validation_result = self._validate_data_key( - key, data - ) - missing_key = validation_result["missing_key"] - invalid_type = validation_result["invalid_type"] - - valid = True - if missing_key is not None: - _missing_keys.append(missing_key) - valid = False - - if invalid_type is not None: - _invalid_types.append(invalid_type) - valid = False - - if valid: - try: - optional_key.format(**data) - except KeyError: - _missing_keys.append(key) - valid = False - - valid = len(_invalid_types) == 0 and len(_missing_keys) == 0 - missing_keys.extend(_missing_keys) - invalid_types.extend(_invalid_types) - replacement = "" - if valid: - replacement = optional_group[1:-1] - - template = template.replace(optional_group, replacement) - return (template, missing_keys, invalid_types) - - def _validate_data_key(self, key, data): - """Check and prepare missing keys and invalid types of template.""" - result = { - "missing_key": None, - "invalid_type": None - } - - # check if key expects subdictionary keys (e.g. project[name]) - key_subdict = list(self.sub_dict_pattern.findall(key)) - used_keys = [] - if len(key_subdict) <= 1: - if key not in data: - result["missing_key"] = key - return result - - used_keys.append(key) - value = data[key] - - else: - value = data - missing_key = False - invalid_type = False - for sub_key in key_subdict: - if ( - value is None - or (hasattr(value, "items") and sub_key not in value) - ): - missing_key = True - used_keys.append(sub_key) - break - - elif not hasattr(value, "items"): - invalid_type = True - break - - used_keys.append(sub_key) - value = value.get(sub_key) - - if missing_key or invalid_type: - if len(used_keys) == 0: - invalid_key = key_subdict[0] - else: - invalid_key = used_keys[0] - for idx, sub_key in enumerate(used_keys): - if idx == 0: - continue - invalid_key += "[{0}]".format(sub_key) - - if missing_key: - result["missing_key"] = invalid_key - - elif invalid_type: - result["invalid_type"] = {invalid_key: type(value)} - - return result - - if isinstance(value, (numbers.Number, Roots, RootItem)): - return result - - for inh_class in type(value).mro(): - if inh_class == StringType: - return result - - result["missing_key"] = key - result["invalid_type"] = {key: type(value)} - return result - - def _merge_used_values(self, current_used, keys, value): - key = keys[0] - _keys = keys[1:] - if len(_keys) == 0: - current_used[key] = value - else: - next_dict = {} - if key in current_used: - next_dict = current_used[key] - current_used[key] = self._merge_used_values( - next_dict, _keys, value - ) - return current_used - def _dict_to_subkeys_list(self, subdict, pre_keys=None): if pre_keys is None: pre_keys = [] @@ -956,9 +686,11 @@ class Templates: return {key_list[0]: value} return {key_list[0]: self._keys_to_dicts(key_list[1:], value)} - def _rootless_path( - self, template, used_values, final_data, missing_keys, invalid_types - ): + def _rootless_path(self, result, final_data): + used_values = result.used_values + missing_keys = result.missing_keys + template = result.template + invalid_types = result.invalid_types if ( "root" not in used_values or "root" in missing_keys @@ -974,210 +706,49 @@ class Templates: if not root_keys: return - roots_dict = {} + output = str(result) for used_root_keys in root_keys: if not used_root_keys: continue + used_value = used_values root_key = None for key in used_root_keys: + used_value = used_value[key] if root_key is None: root_key = key else: root_key += "[{}]".format(key) root_key = "{" + root_key + "}" - - roots_dict = merge_dict( - roots_dict, - self._keys_to_dicts(used_root_keys, root_key) - ) - - final_data["root"] = roots_dict["root"] - return template.format(**final_data) - - def _format(self, orig_template, data): - """ Figure out with whole formatting. - - Separate advanced keys (*Like '{project[name]}') from string which must - be formatted separatelly in case of missing or incomplete keys in data. - - Args: - template (str): Anatomy template which will be formatted. - data (dict): Containing keys to be filled into template. - - Returns: - TemplateResult: Filled or partially filled template containing all - data needed or missing for filling template. - """ - task_data = data.get("task") - if ( - isinstance(task_data, StringType) - and "{task[name]}" in orig_template - ): - # Change task to dictionary if template expect dictionary - data["task"] = {"name": task_data} - - template, missing_optional, invalid_optional = ( - self._filter_optional(orig_template, data) - ) - # Remove optional missing keys - used_values = {} - invalid_required = [] - missing_required = [] - replace_keys = [] - - for group in self.key_pattern.findall(template): - orig_key = group[1:-1] - key = str(orig_key) - key_padding = list(self.key_padding_pattern.findall(key)) - if key_padding: - key = key_padding[0] - - validation_result = self._validate_data_key(key, data) - missing_key = validation_result["missing_key"] - invalid_type = validation_result["invalid_type"] - - if invalid_type is not None: - invalid_required.append(invalid_type) - replace_keys.append(key) - continue - - if missing_key is not None: - missing_required.append(missing_key) - replace_keys.append(key) - continue - - try: - value = group.format(**data) - key_subdict = list(self.sub_dict_pattern.findall(key)) - if len(key_subdict) <= 1: - used_values[key] = value - - else: - used_values = self._merge_used_values( - used_values, key_subdict, value - ) - - except (TypeError, KeyError): - missing_required.append(key) - replace_keys.append(key) - - final_data = copy.deepcopy(data) - for key in replace_keys: - key_subdict = list(self.sub_dict_pattern.findall(key)) - if len(key_subdict) <= 1: - final_data[key] = "{" + key + "}" - continue - - replace_key_dst = "---".join(key_subdict) - replace_key_dst_curly = "{" + replace_key_dst + "}" - replace_key_src_curly = "{" + key + "}" - template = template.replace( - replace_key_src_curly, replace_key_dst_curly - ) - final_data[replace_key_dst] = replace_key_src_curly - - solved = len(missing_required) == 0 and len(invalid_required) == 0 - - missing_keys = missing_required + missing_optional - invalid_types = invalid_required + invalid_optional - - filled_template = template.format(**final_data) - # WARNING `_rootless_path` change values in `final_data` please keep - # in midn when changing order - rootless_path = self._rootless_path( - template, used_values, final_data, missing_keys, invalid_types - ) - if rootless_path is None: - rootless_path = filled_template - - result = TemplateResult( - filled_template, orig_template, solved, rootless_path, - used_values, missing_keys, invalid_types - ) - return result - - def solve_dict(self, templates, data): - """ Solves templates with entered data. - - Args: - templates (dict): All Anatomy templates which will be formatted. - data (dict): Containing keys to be filled into template. - - Returns: - dict: With `TemplateResult` in values containing filled or - partially filled templates. - """ - output = collections.defaultdict(dict) - for key, orig_value in templates.items(): - if isinstance(orig_value, StringType): - # Replace {task} by '{task[name]}' for backward compatibility - if '{task}' in orig_value: - orig_value = orig_value.replace('{task}', '{task[name]}') - - output[key] = self._format(orig_value, data) - continue - - # Check if orig_value has items attribute (any dict inheritance) - if not hasattr(orig_value, "items"): - # TODO we should handle this case - output[key] = orig_value - continue - - for s_key, s_value in self.solve_dict(orig_value, data).items(): - output[key][s_key] = s_value + output = output.replace(str(used_value), root_key) return output + def format(self, data, strict=True): + copy_data = copy.deepcopy(data) + roots = self.roots + if roots: + copy_data["root"] = roots + result = super(AnatomyTemplates, self).format(copy_data) + result.strict = strict + return result + def format_all(self, in_data, only_keys=True): """ Solves templates based on entered data. Args: data (dict): Containing keys to be filled into template. - only_keys (bool, optional): Decides if environ will be used to - fill templates or only keys in data. Returns: - TemplatesDict: Output `TemplateResult` have `strict` attribute - set to False so accessing unfilled keys in templates won't - raise any exceptions. + TemplatesResultDict: Output `TemplateResult` have `strict` + attribute set to False so accessing unfilled keys in templates + won't raise any exceptions. """ - output = self.format(in_data, only_keys) - output.strict = False - return output - - def format(self, in_data, only_keys=True): - """ Solves templates based on entered data. - - Args: - data (dict): Containing keys to be filled into template. - only_keys (bool, optional): Decides if environ will be used to - fill templates or only keys in data. - - Returns: - TemplatesDict: Output `TemplateResult` have `strict` attribute - set to True so accessing unfilled keys in templates will - raise exceptions with explaned error. - """ - # Create a copy of inserted data - data = copy.deepcopy(in_data) - - # Add environment variable to data - if only_keys is False: - for key, val in os.environ.items(): - data["$" + key] = val - - # override root value - roots = self.roots - if roots: - data["root"] = roots - solved = self.solve_dict(self.templates, data) - - return TemplatesDict(solved) + return self.format(in_data, strict=False) -class RootItem: +class RootItem(FormatObject): """Represents one item or roots. Holds raw data of root item specification. Raw data contain value diff --git a/openpype/lib/applications.py b/openpype/lib/applications.py index 393c83e9be..ef175ac89a 100644 --- a/openpype/lib/applications.py +++ b/openpype/lib/applications.py @@ -7,7 +7,6 @@ import platform import collections import inspect import subprocess -import distutils.spawn from abc import ABCMeta, abstractmethod import six @@ -28,15 +27,18 @@ from .profiles_filtering import filter_profiles from .local_settings import get_openpype_username from .avalon_context import ( get_workdir_data, - get_workdir_with_workdir_data + get_workdir_with_workdir_data, + get_workfile_template_key ) from .python_module_tools import ( modules_from_path, classes_from_module ) -from .execute import get_linux_launcher_args - +from .execute import ( + find_executable, + get_linux_launcher_args +) _logger = None @@ -646,7 +648,7 @@ class ApplicationExecutable: def _realpath(self): """Check if path is valid executable path.""" # Check for executable in PATH - result = distutils.spawn.find_executable(self.executable_path) + result = find_executable(self.executable_path) if result is not None: return result @@ -1295,7 +1297,7 @@ def get_app_environments_for_context( "env": env }) - prepare_host_environments(data, env_group) + prepare_app_environments(data, env_group) prepare_context_environments(data, env_group) # Discard avalon connection @@ -1316,7 +1318,7 @@ def _merge_env(env, current_env): return result -def prepare_host_environments(data, env_group=None, implementation_envs=True): +def prepare_app_environments(data, env_group=None, implementation_envs=True): """Modify launch environments based on launched app and context. Args: @@ -1474,6 +1476,22 @@ def prepare_context_environments(data, env_group=None): ) app = data["app"] + context_env = { + "AVALON_PROJECT": project_doc["name"], + "AVALON_ASSET": asset_doc["name"], + "AVALON_TASK": task_name, + "AVALON_APP_NAME": app.full_name + } + + log.debug( + "Context environments set:\n{}".format( + json.dumps(context_env, indent=4) + ) + ) + data["env"].update(context_env) + if not app.is_host: + return + workdir_data = get_workdir_data( project_doc, asset_doc, task_name, app.host_name ) @@ -1504,20 +1522,8 @@ def prepare_context_environments(data, env_group=None): "Couldn't create workdir because: {}".format(str(exc)) ) - context_env = { - "AVALON_PROJECT": project_doc["name"], - "AVALON_ASSET": asset_doc["name"], - "AVALON_TASK": task_name, - "AVALON_APP": app.host_name, - "AVALON_APP_NAME": app.full_name, - "AVALON_WORKDIR": workdir - } - log.debug( - "Context environments set:\n{}".format( - json.dumps(context_env, indent=4) - ) - ) - data["env"].update(context_env) + data["env"]["AVALON_APP"] = app.host_name + data["env"]["AVALON_WORKDIR"] = workdir _prepare_last_workfile(data, workdir) @@ -1587,14 +1593,15 @@ def _prepare_last_workfile(data, workdir): last_workfile_path = data.get("last_workfile_path") or "" if not last_workfile_path: extensions = avalon.api.HOST_WORKFILE_EXTENSIONS.get(app.host_name) - if extensions: anatomy = data["anatomy"] + project_settings = data["project_settings"] + task_type = workdir_data["task"]["type"] + template_key = get_workfile_template_key( + task_type, app.host_name, project_settings=project_settings + ) # Find last workfile - file_template = anatomy.templates["work"]["file"] - # Replace {task} by '{task[name]}' for backward compatibility - if '{task}' in file_template: - file_template = file_template.replace('{task}', '{task[name]}') + file_template = str(anatomy.templates[template_key]["file"]) workdir_data.update({ "version": 1, diff --git a/openpype/lib/avalon_context.py b/openpype/lib/avalon_context.py index 3ce205c499..26beba41ee 100644 --- a/openpype/lib/avalon_context.py +++ b/openpype/lib/avalon_context.py @@ -15,6 +15,7 @@ from openpype.settings import ( ) from .anatomy import Anatomy from .profiles_filtering import filter_profiles +from .events import emit_event # avalon module is not imported at the top # - may not be in path at the time of pype.lib initialization @@ -644,6 +645,165 @@ def get_workdir( ) +def template_data_from_session(session=None): + """ Return dictionary with template from session keys. + + Args: + session (dict, Optional): The Session to use. If not provided use the + currently active global Session. + Returns: + dict: All available data from session. + """ + from avalon import io + import avalon.api + + if session is None: + session = avalon.api.Session + + project_name = session["AVALON_PROJECT"] + project_doc = io._database[project_name].find_one({"type": "project"}) + asset_doc = io._database[project_name].find_one({ + "type": "asset", + "name": session["AVALON_ASSET"] + }) + task_name = session["AVALON_TASK"] + host_name = session["AVALON_APP"] + return get_workdir_data(project_doc, asset_doc, task_name, host_name) + + +def compute_session_changes( + session, task=None, asset=None, app=None, template_key=None +): + """Compute the changes for a Session object on asset, task or app switch + + This does *NOT* update the Session object, but returns the changes + required for a valid update of the Session. + + Args: + session (dict): The initial session to compute changes to. + This is required for computing the full Work Directory, as that + also depends on the values that haven't changed. + task (str, Optional): Name of task to switch to. + asset (str or dict, Optional): Name of asset to switch to. + You can also directly provide the Asset dictionary as returned + from the database to avoid an additional query. (optimization) + app (str, Optional): Name of app to switch to. + + Returns: + dict: The required changes in the Session dictionary. + + """ + changes = dict() + + # If no changes, return directly + if not any([task, asset, app]): + return changes + + # Get asset document and asset + asset_document = None + asset_tasks = None + if isinstance(asset, dict): + # Assume asset database document + asset_document = asset + asset_tasks = asset_document.get("data", {}).get("tasks") + asset = asset["name"] + + if not asset_document or not asset_tasks: + from avalon import io + + # Assume asset name + asset_document = io.find_one( + { + "name": asset, + "type": "asset" + }, + {"data.tasks": True} + ) + assert asset_document, "Asset must exist" + + # Detect any changes compared session + mapping = { + "AVALON_ASSET": asset, + "AVALON_TASK": task, + "AVALON_APP": app, + } + changes = { + key: value + for key, value in mapping.items() + if value and value != session.get(key) + } + if not changes: + return changes + + # Compute work directory (with the temporary changed session so far) + _session = session.copy() + _session.update(changes) + + changes["AVALON_WORKDIR"] = get_workdir_from_session(_session) + + return changes + + +def get_workdir_from_session(session=None, template_key=None): + import avalon.api + + if session is None: + session = avalon.api.Session + project_name = session["AVALON_PROJECT"] + host_name = session["AVALON_APP"] + anatomy = Anatomy(project_name) + template_data = template_data_from_session(session) + anatomy_filled = anatomy.format(template_data) + + if not template_key: + task_type = template_data["task"]["type"] + template_key = get_workfile_template_key( + task_type, + host_name, + project_name=project_name + ) + return anatomy_filled[template_key]["folder"] + + +def update_current_task(task=None, asset=None, app=None, template_key=None): + """Update active Session to a new task work area. + + This updates the live Session to a different `asset`, `task` or `app`. + + Args: + task (str): The task to set. + asset (str): The asset to set. + app (str): The app to set. + + Returns: + dict: The changed key, values in the current Session. + + """ + import avalon.api + + changes = compute_session_changes( + avalon.api.Session, + task=task, + asset=asset, + app=app, + template_key=template_key + ) + + # Update the Session and environments. Pop from environments all keys with + # value set to None. + for key, value in changes.items(): + avalon.api.Session[key] = value + if value is None: + os.environ.pop(key, None) + else: + os.environ[key] = value + + # Emit session change + emit_event("taskChanged", changes.copy()) + + return changes + + @with_avalon def get_workfile_doc(asset_id, task_name, filename, dbcon=None): """Return workfile document for entered context. @@ -820,6 +980,8 @@ class BuildWorkfile: ... }] """ + from openpype.pipeline import discover_loader_plugins + # Get current asset name and entity current_asset_name = avalon.io.Session["AVALON_ASSET"] current_asset_entity = avalon.io.find_one({ @@ -836,7 +998,7 @@ class BuildWorkfile: # Prepare available loaders loaders_by_name = {} - for loader in avalon.api.discover(avalon.api.Loader): + for loader in discover_loader_plugins(): loader_name = loader.__name__ if loader_name in loaders_by_name: raise KeyError( @@ -952,7 +1114,7 @@ class BuildWorkfile: Returns: (dict): preset per entered task name """ - host_name = avalon.api.registered_host().__name__.rsplit(".", 1)[-1] + host_name = os.environ["AVALON_APP"] project_settings = get_project_settings( avalon.io.Session["AVALON_PROJECT"] ) @@ -1230,6 +1392,11 @@ class BuildWorkfile: Returns: (list) Objects of loaded containers. """ + from openpype.pipeline import ( + IncompatibleLoaderError, + load_container, + ) + loaded_containers = [] # Get subset id order from build presets. @@ -1291,7 +1458,7 @@ class BuildWorkfile: if not loader: continue try: - container = avalon.api.load( + container = load_container( loader, repre["_id"], name=subset_name @@ -1300,7 +1467,7 @@ class BuildWorkfile: is_loaded = True except Exception as exc: - if exc == avalon.pipeline.IncompatibleLoaderError: + if exc == IncompatibleLoaderError: self.log.info(( "Loader `{}` is not compatible with" " representation `{}`" @@ -1434,11 +1601,13 @@ def get_creator_by_name(creator_name, case_sensitive=False): Returns: Creator: Return first matching plugin or `None`. """ + from openpype.pipeline import LegacyCreator + # Lower input creator name if is not case sensitive if not case_sensitive: creator_name = creator_name.lower() - for creator_plugin in avalon.api.discover(avalon.api.Creator): + for creator_plugin in avalon.api.discover(LegacyCreator): _creator_name = creator_plugin.__name__ # Lower creator plugin name if is not case sensitive diff --git a/openpype/lib/config.py b/openpype/lib/config.py index ba394cfd56..57e8efa57d 100644 --- a/openpype/lib/config.py +++ b/openpype/lib/config.py @@ -74,3 +74,9 @@ def get_datetime_data(datetime_obj=None): "S": str(int(seconds)), "SS": str(seconds), } + + +def get_formatted_current_time(): + return datetime.datetime.now().strftime( + "%Y%m%dT%H%M%SZ" + ) diff --git a/openpype/lib/delivery.py b/openpype/lib/delivery.py index 01fcc907ed..9fc65aae8e 100644 --- a/openpype/lib/delivery.py +++ b/openpype/lib/delivery.py @@ -17,7 +17,7 @@ def collect_frames(files): Returns: (dict): {'/asset/subset_v001.0001.png': '0001', ....} """ - collections, remainder = clique.assemble(files) + collections, remainder = clique.assemble(files, minimum_items=1) sources_and_frames = {} if collections: @@ -71,15 +71,14 @@ def path_from_representation(representation, anatomy): def copy_file(src_path, dst_path): """Hardlink file if possible(to save space), copy if not""" - from avalon.vendor import filelink # safer importing + from openpype.lib import create_hard_link # safer importing if os.path.exists(dst_path): return try: - filelink.create( + create_hard_link( src_path, - dst_path, - filelink.HARDLINK + dst_path ) except OSError: shutil.copyfile(src_path, dst_path) diff --git a/openpype/lib/events.py b/openpype/lib/events.py new file mode 100644 index 0000000000..7bec6ee30d --- /dev/null +++ b/openpype/lib/events.py @@ -0,0 +1,268 @@ +"""Events holding data about specific event.""" +import os +import re +import inspect +import logging +import weakref +from uuid import uuid4 +try: + from weakref import WeakMethod +except Exception: + from openpype.lib.python_2_comp import WeakMethod + + +class EventCallback(object): + """Callback registered to a topic. + + The callback function is registered to a topic. Topic is a string which + may contain '*' that will be handled as "any characters". + + # Examples: + - "workfile.save" Callback will be triggered if the event topic is + exactly "workfile.save" . + - "workfile.*" Callback will be triggered an event topic starts with + "workfile." so "workfile.save" and "workfile.open" + will trigger the callback. + - "*" Callback will listen to all events. + + Callback can be function or method. In both cases it should expect one + or none arguments. When 1 argument is expected then the processed 'Event' + object is passed in. + + The registered callbacks don't keep function in memory so it is not + possible to store lambda function as callback. + + Args: + topic(str): Topic which will be listened. + func(func): Callback to a topic. + + Raises: + TypeError: When passed function is not a callable object. + """ + + def __init__(self, topic, func): + self._log = None + self._topic = topic + # Replace '*' with any character regex and escape rest of text + # - when callback is registered for '*' topic it will receive all + # events + # - it is possible to register to a partial topis 'my.event.*' + # - it will receive all matching event topics + # e.g. 'my.event.start' and 'my.event.end' + topic_regex_str = "^{}$".format( + ".+".join( + re.escape(part) + for part in topic.split("*") + ) + ) + topic_regex = re.compile(topic_regex_str) + self._topic_regex = topic_regex + + # Convert callback into references + # - deleted functions won't cause crashes + if inspect.ismethod(func): + func_ref = WeakMethod(func) + elif callable(func): + func_ref = weakref.ref(func) + else: + raise TypeError(( + "Registered callback is not callable. \"{}\"" + ).format(str(func))) + + # Collect additional data about function + # - name + # - path + # - if expect argument or not + func_name = func.__name__ + func_path = os.path.abspath(inspect.getfile(func)) + if hasattr(inspect, "signature"): + sig = inspect.signature(func) + expect_args = len(sig.parameters) > 0 + else: + expect_args = len(inspect.getargspec(func)[0]) > 0 + + self._func_ref = func_ref + self._func_name = func_name + self._func_path = func_path + self._expect_args = expect_args + self._ref_valid = func_ref is not None + self._enabled = True + + def __repr__(self): + return "< {} - {} > {}".format( + self.__class__.__name__, self._func_name, self._func_path + ) + + @property + def log(self): + if self._log is None: + self._log = logging.getLogger(self.__class__.__name__) + return self._log + + @property + def is_ref_valid(self): + return self._ref_valid + + def validate_ref(self): + if not self._ref_valid: + return + + callback = self._func_ref() + if not callback: + self._ref_valid = False + + @property + def enabled(self): + """Is callback enabled.""" + return self._enabled + + def set_enabled(self, enabled): + """Change if callback is enabled.""" + self._enabled = enabled + + def deregister(self): + """Calling this funcion will cause that callback will be removed.""" + # Fake reference + self._ref_valid = False + + def topic_matches(self, topic): + """Check if event topic matches callback's topic.""" + return self._topic_regex.match(topic) + + def process_event(self, event): + """Process event. + + Args: + event(Event): Event that was triggered. + """ + + # Skip if callback is not enabled or has invalid reference + if not self._ref_valid or not self._enabled: + return + + # Get reference + callback = self._func_ref() + # Check if reference is valid or callback's topic matches the event + if not callback: + # Change state if is invalid so the callback is removed + self._ref_valid = False + + elif self.topic_matches(event.topic): + # Try execute callback + try: + if self._expect_args: + callback(event) + else: + callback() + + except Exception: + self.log.warning( + "Failed to execute event callback {}".format( + str(repr(self)) + ), + exc_info=True + ) + + +# Inherit from 'object' for Python 2 hosts +class Event(object): + """Base event object. + + Can be used for any event because is not specific. Only required argument + is topic which defines why event is happening and may be used for + filtering. + + Arg: + topic (str): Identifier of event. + data (Any): Data specific for event. Dictionary is recommended. + source (str): Identifier of source. + """ + _data = {} + + def __init__(self, topic, data=None, source=None): + self._id = str(uuid4()) + self._topic = topic + if data is None: + data = {} + self._data = data + self._source = source + + def __getitem__(self, key): + return self._data[key] + + def get(self, key, *args, **kwargs): + return self._data.get(key, *args, **kwargs) + + @property + def id(self): + return self._id + + @property + def source(self): + return self._source + + @property + def data(self): + return self._data + + @property + def topic(self): + return self._topic + + def emit(self): + """Emit event and trigger callbacks.""" + StoredCallbacks.emit_event(self) + + +class StoredCallbacks: + _registered_callbacks = [] + + @classmethod + def add_callback(cls, topic, callback): + callback = EventCallback(topic, callback) + cls._registered_callbacks.append(callback) + return callback + + @classmethod + def emit_event(cls, event): + invalid_callbacks = [] + for callback in cls._registered_callbacks: + callback.process_event(event) + if not callback.is_ref_valid: + invalid_callbacks.append(callback) + + for callback in invalid_callbacks: + cls._registered_callbacks.remove(callback) + + +def register_event_callback(topic, callback): + """Add callback that will be executed on specific topic. + + Args: + topic(str): Topic on which will callback be triggered. + callback(function): Callback that will be triggered when a topic + is triggered. Callback should expect none or 1 argument where + `Event` object is passed. + + Returns: + EventCallback: Object wrapping the callback. It can be used to + enable/disable listening to a topic or remove the callback from + the topic completely. + """ + return StoredCallbacks.add_callback(topic, callback) + + +def emit_event(topic, data=None, source=None): + """Emit event with topic and data. + + Arg: + topic(str): Event's topic. + data(dict): Event's additional data. Optional. + source(str): Who emitted the topic. Optional. + + Returns: + Event: Object of event that was emitted. + """ + event = Event(topic, data, source) + event.emit() + return event diff --git a/openpype/lib/execute.py b/openpype/lib/execute.py index afde844f2d..c3e35772f3 100644 --- a/openpype/lib/execute.py +++ b/openpype/lib/execute.py @@ -1,8 +1,12 @@ import os +import sys import subprocess -import distutils.spawn +import platform +import json +import tempfile from .log import PypeLogger as Logger +from .vendor_bin_utils import find_executable # MSDN process creation flag (Windows only) CREATE_NO_WINDOW = 0x08000000 @@ -181,6 +185,80 @@ def run_openpype_process(*args, **kwargs): return run_subprocess(args, env=env, **kwargs) +def run_detached_process(args, **kwargs): + """Execute process with passed arguments as separated process. + + Values from 'os.environ' are used for environments if are not passed. + They are cleaned using 'clean_envs_for_openpype_process' function. + + Example: + ``` + run_detached_openpype_process("run", "") + ``` + + Args: + *args (tuple): OpenPype cli arguments. + **kwargs (dict): Keyword arguments for for subprocess.Popen. + + Returns: + subprocess.Popen: Pointer to launched process but it is possible that + launched process is already killed (on linux). + """ + env = kwargs.pop("env", None) + # Keep env untouched if are passed and not empty + if not env: + env = os.environ + + # Create copy of passed env + kwargs["env"] = {k: v for k, v in env.items()} + + low_platform = platform.system().lower() + if low_platform == "darwin": + new_args = ["open", "-na", args.pop(0), "--args"] + new_args.extend(args) + args = new_args + + elif low_platform == "windows": + flags = ( + subprocess.CREATE_NEW_PROCESS_GROUP + | subprocess.DETACHED_PROCESS + ) + kwargs["creationflags"] = flags + + if not sys.stdout: + kwargs["stdout"] = subprocess.DEVNULL + kwargs["stderr"] = subprocess.DEVNULL + + elif low_platform == "linux" and get_linux_launcher_args() is not None: + json_data = { + "args": args, + "env": kwargs.pop("env") + } + json_temp = tempfile.NamedTemporaryFile( + mode="w", prefix="op_app_args", suffix=".json", delete=False + ) + json_temp.close() + json_temp_filpath = json_temp.name + with open(json_temp_filpath, "w") as stream: + json.dump(json_data, stream) + + new_args = get_linux_launcher_args() + new_args.append(json_temp_filpath) + + # Create mid-process which will launch application + process = subprocess.Popen(new_args, **kwargs) + # Wait until the process finishes + # - This is important! The process would stay in "open" state. + process.wait() + # Remove the temp file + os.remove(json_temp_filpath) + # Return process which is already terminated + return process + + process = subprocess.Popen(args, **kwargs) + return process + + def path_to_subprocess_arg(path): """Prepare path for subprocess arguments. @@ -263,7 +341,7 @@ def get_linux_launcher_args(*args): os.path.dirname(openpype_executable), filename ) - executable_path = distutils.spawn.find_executable(new_executable) + executable_path = find_executable(new_executable) if executable_path is None: return None launch_args = [executable_path] diff --git a/openpype/lib/path_templates.py b/openpype/lib/path_templates.py new file mode 100644 index 0000000000..14e5fe59f8 --- /dev/null +++ b/openpype/lib/path_templates.py @@ -0,0 +1,788 @@ +import os +import re +import copy +import numbers +import collections + +import six + +from .log import PypeLogger + +log = PypeLogger.get_logger(__name__) + + +KEY_PATTERN = re.compile(r"(\{.*?[^{0]*\})") +KEY_PADDING_PATTERN = re.compile(r"([^:]+)\S+[><]\S+") +SUB_DICT_PATTERN = re.compile(r"([^\[\]]+)") +OPTIONAL_PATTERN = re.compile(r"(<.*?[^{0]*>)[^0-9]*?") + + +def merge_dict(main_dict, enhance_dict): + """Merges dictionaries by keys. + + Function call itself if value on key is again dictionary. + + Args: + main_dict (dict): First dict to merge second one into. + enhance_dict (dict): Second dict to be merged. + + Returns: + dict: Merged result. + + .. note:: does not overrides whole value on first found key + but only values differences from enhance_dict + + """ + for key, value in enhance_dict.items(): + if key not in main_dict: + main_dict[key] = value + elif isinstance(value, dict) and isinstance(main_dict[key], dict): + main_dict[key] = merge_dict(main_dict[key], value) + else: + main_dict[key] = value + return main_dict + + +class TemplateMissingKey(Exception): + """Exception for cases when key does not exist in template.""" + + msg = "Template key does not exist: `{}`." + + def __init__(self, parents): + parent_join = "".join(["[\"{0}\"]".format(key) for key in parents]) + super(TemplateMissingKey, self).__init__( + self.msg.format(parent_join) + ) + + +class TemplateUnsolved(Exception): + """Exception for unsolved template when strict is set to True.""" + + msg = "Template \"{0}\" is unsolved.{1}{2}" + invalid_types_msg = " Keys with invalid DataType: `{0}`." + missing_keys_msg = " Missing keys: \"{0}\"." + + def __init__(self, template, missing_keys, invalid_types): + invalid_type_items = [] + for _key, _type in invalid_types.items(): + invalid_type_items.append( + "\"{0}\" {1}".format(_key, str(_type)) + ) + + invalid_types_msg = "" + if invalid_type_items: + invalid_types_msg = self.invalid_types_msg.format( + ", ".join(invalid_type_items) + ) + + missing_keys_msg = "" + if missing_keys: + missing_keys_msg = self.missing_keys_msg.format( + ", ".join(missing_keys) + ) + super(TemplateUnsolved, self).__init__( + self.msg.format(template, missing_keys_msg, invalid_types_msg) + ) + + +class StringTemplate(object): + """String that can be formatted.""" + def __init__(self, template): + if not isinstance(template, six.string_types): + raise TypeError("<{}> argument must be a string, not {}.".format( + self.__class__.__name__, str(type(template)) + )) + + self._template = template + parts = [] + last_end_idx = 0 + for item in KEY_PATTERN.finditer(template): + start, end = item.span() + if start > last_end_idx: + parts.append(template[last_end_idx:start]) + parts.append(FormattingPart(template[start:end])) + last_end_idx = end + + if last_end_idx < len(template): + parts.append(template[last_end_idx:len(template)]) + + new_parts = [] + for part in parts: + if not isinstance(part, six.string_types): + new_parts.append(part) + continue + + substr = "" + for char in part: + if char not in ("<", ">"): + substr += char + else: + if substr: + new_parts.append(substr) + new_parts.append(char) + substr = "" + if substr: + new_parts.append(substr) + + self._parts = self.find_optional_parts(new_parts) + + def __str__(self): + return self.template + + def __repr__(self): + return "<{}> {}".format(self.__class__.__name__, self.template) + + def __contains__(self, other): + return other in self.template + + def replace(self, *args, **kwargs): + self._template = self.template.replace(*args, **kwargs) + return self + + @property + def template(self): + return self._template + + def format(self, data): + """ Figure out with whole formatting. + + Separate advanced keys (*Like '{project[name]}') from string which must + be formatted separatelly in case of missing or incomplete keys in data. + + Args: + data (dict): Containing keys to be filled into template. + + Returns: + TemplateResult: Filled or partially filled template containing all + data needed or missing for filling template. + """ + result = TemplatePartResult() + for part in self._parts: + if isinstance(part, six.string_types): + result.add_output(part) + else: + part.format(data, result) + + invalid_types = result.invalid_types + invalid_types.update(result.invalid_optional_types) + invalid_types = result.split_keys_to_subdicts(invalid_types) + + missing_keys = result.missing_keys + missing_keys |= result.missing_optional_keys + + solved = result.solved + used_values = result.get_clean_used_values() + + return TemplateResult( + result.output, + self.template, + solved, + used_values, + missing_keys, + invalid_types + ) + + def format_strict(self, *args, **kwargs): + result = self.format(*args, **kwargs) + result.validate() + return result + + @classmethod + def format_template(cls, template, data): + objected_template = cls(template) + return objected_template.format(data) + + @classmethod + def format_strict_template(cls, template, data): + objected_template = cls(template) + return objected_template.format_strict(data) + + @staticmethod + def find_optional_parts(parts): + new_parts = [] + tmp_parts = {} + counted_symb = -1 + for part in parts: + if part == "<": + counted_symb += 1 + tmp_parts[counted_symb] = [] + + elif part == ">": + if counted_symb > -1: + parts = tmp_parts.pop(counted_symb) + counted_symb -= 1 + if parts: + # Remove optional start char + parts.pop(0) + if counted_symb < 0: + out_parts = new_parts + else: + out_parts = tmp_parts[counted_symb] + # Store temp parts + out_parts.append(OptionalPart(parts)) + continue + + if counted_symb < 0: + new_parts.append(part) + else: + tmp_parts[counted_symb].append(part) + + if tmp_parts: + for idx in sorted(tmp_parts.keys()): + new_parts.extend(tmp_parts[idx]) + return new_parts + + +class TemplatesDict(object): + def __init__(self, templates=None): + self._raw_templates = None + self._templates = None + self._objected_templates = None + self.set_templates(templates) + + def set_templates(self, templates): + if templates is None: + self._raw_templates = None + self._templates = None + self._objected_templates = None + elif isinstance(templates, dict): + self._raw_templates = copy.deepcopy(templates) + self._templates = templates + self._objected_templates = self.create_ojected_templates(templates) + else: + raise TypeError("<{}> argument must be a dict, not {}.".format( + self.__class__.__name__, str(type(templates)) + )) + + def __getitem__(self, key): + return self.templates[key] + + def get(self, key, *args, **kwargs): + return self.templates.get(key, *args, **kwargs) + + @property + def raw_templates(self): + return self._raw_templates + + @property + def templates(self): + return self._templates + + @property + def objected_templates(self): + return self._objected_templates + + @classmethod + def create_ojected_templates(cls, templates): + if not isinstance(templates, dict): + raise TypeError("Expected dict object, got {}".format( + str(type(templates)) + )) + + objected_templates = copy.deepcopy(templates) + inner_queue = collections.deque() + inner_queue.append(objected_templates) + while inner_queue: + item = inner_queue.popleft() + if not isinstance(item, dict): + continue + for key in tuple(item.keys()): + value = item[key] + if isinstance(value, six.string_types): + item[key] = StringTemplate(value) + elif isinstance(value, dict): + inner_queue.append(value) + return objected_templates + + def _format_value(self, value, data): + if isinstance(value, StringTemplate): + return value.format(data) + + if isinstance(value, dict): + return self._solve_dict(value, data) + return value + + def _solve_dict(self, templates, data): + """ Solves templates with entered data. + + Args: + templates (dict): All templates which will be formatted. + data (dict): Containing keys to be filled into template. + + Returns: + dict: With `TemplateResult` in values containing filled or + partially filled templates. + """ + output = collections.defaultdict(dict) + for key, value in templates.items(): + output[key] = self._format_value(value, data) + + return output + + def format(self, in_data, only_keys=True, strict=True): + """ Solves templates based on entered data. + + Args: + data (dict): Containing keys to be filled into template. + only_keys (bool, optional): Decides if environ will be used to + fill templates or only keys in data. + + Returns: + TemplatesResultDict: Output `TemplateResult` have `strict` + attribute set to True so accessing unfilled keys in templates + will raise exceptions with explaned error. + """ + # Create a copy of inserted data + data = copy.deepcopy(in_data) + + # Add environment variable to data + if only_keys is False: + for key, val in os.environ.items(): + env_key = "$" + key + if env_key not in data: + data[env_key] = val + + solved = self._solve_dict(self.objected_templates, data) + + output = TemplatesResultDict(solved) + output.strict = strict + return output + + +class TemplateResult(str): + """Result of template format with most of information in. + + Args: + used_values (dict): Dictionary of template filling data with + only used keys. + solved (bool): For check if all required keys were filled. + template (str): Original template. + missing_keys (list): Missing keys that were not in the data. Include + missing optional keys. + invalid_types (dict): When key was found in data, but value had not + allowed DataType. Allowed data types are `numbers`, + `str`(`basestring`) and `dict`. Dictionary may cause invalid type + when value of key in data is dictionary but template expect string + of number. + """ + used_values = None + solved = None + template = None + missing_keys = None + invalid_types = None + + def __new__( + cls, filled_template, template, solved, + used_values, missing_keys, invalid_types + ): + new_obj = super(TemplateResult, cls).__new__(cls, filled_template) + new_obj.used_values = used_values + new_obj.solved = solved + new_obj.template = template + new_obj.missing_keys = list(set(missing_keys)) + new_obj.invalid_types = invalid_types + return new_obj + + def validate(self): + if not self.solved: + raise TemplateUnsolved( + self.template, + self.missing_keys, + self.invalid_types + ) + + +class TemplatesResultDict(dict): + """Holds and wrap TemplateResults for easy bug report.""" + + def __init__(self, in_data, key=None, parent=None, strict=None): + super(TemplatesResultDict, self).__init__() + for _key, _value in in_data.items(): + if isinstance(_value, dict): + _value = self.__class__(_value, _key, self) + self[_key] = _value + + self.key = key + self.parent = parent + self.strict = strict + if self.parent is None and strict is None: + self.strict = True + + def __getitem__(self, key): + if key not in self.keys(): + hier = self.hierarchy() + hier.append(key) + raise TemplateMissingKey(hier) + + value = super(TemplatesResultDict, self).__getitem__(key) + if isinstance(value, self.__class__): + return value + + # Raise exception when expected solved templates and it is not. + if self.raise_on_unsolved and hasattr(value, "validate"): + value.validate() + return value + + @property + def raise_on_unsolved(self): + """To affect this change `strict` attribute.""" + if self.strict is not None: + return self.strict + return self.parent.raise_on_unsolved + + def hierarchy(self): + """Return dictionary keys one by one to root parent.""" + if self.parent is None: + return [] + + hier_keys = [] + par_hier = self.parent.hierarchy() + if par_hier: + hier_keys.extend(par_hier) + hier_keys.append(self.key) + + return hier_keys + + @property + def missing_keys(self): + """Return missing keys of all children templates.""" + missing_keys = set() + for value in self.values(): + missing_keys |= value.missing_keys + return missing_keys + + @property + def invalid_types(self): + """Return invalid types of all children templates.""" + invalid_types = {} + for value in self.values(): + invalid_types = merge_dict(invalid_types, value.invalid_types) + return invalid_types + + @property + def used_values(self): + """Return used values for all children templates.""" + used_values = {} + for value in self.values(): + used_values = merge_dict(used_values, value.used_values) + return used_values + + def get_solved(self): + """Get only solved key from templates.""" + result = {} + for key, value in self.items(): + if isinstance(value, self.__class__): + value = value.get_solved() + if not value: + continue + result[key] = value + + elif ( + not hasattr(value, "solved") or + value.solved + ): + result[key] = value + return self.__class__(result, key=self.key, parent=self.parent) + + +class TemplatePartResult: + """Result to store result of template parts.""" + def __init__(self, optional=False): + # Missing keys or invalid value types of required keys + self._missing_keys = set() + self._invalid_types = {} + # Missing keys or invalid value types of optional keys + self._missing_optional_keys = set() + self._invalid_optional_types = {} + + # Used values stored by key with origin type + # - key without any padding or key modifiers + # - value from filling data + # Example: {"version": 1} + self._used_values = {} + # Used values stored by key with all modifirs + # - value is already formatted string + # Example: {"version:0>3": "001"} + self._realy_used_values = {} + # Concatenated string output after formatting + self._output = "" + # Is this result from optional part + self._optional = True + + def add_output(self, other): + if isinstance(other, six.string_types): + self._output += other + + elif isinstance(other, TemplatePartResult): + self._output += other.output + + self._missing_keys |= other.missing_keys + self._missing_optional_keys |= other.missing_optional_keys + + self._invalid_types.update(other.invalid_types) + self._invalid_optional_types.update(other.invalid_optional_types) + + if other.optional and not other.solved: + return + self._used_values.update(other.used_values) + self._realy_used_values.update(other.realy_used_values) + + else: + raise TypeError("Cannot add data from \"{}\" to \"{}\"".format( + str(type(other)), self.__class__.__name__) + ) + + @property + def solved(self): + if self.optional: + if ( + len(self.missing_optional_keys) > 0 + or len(self.invalid_optional_types) > 0 + ): + return False + return ( + len(self.missing_keys) == 0 + and len(self.invalid_types) == 0 + ) + + @property + def optional(self): + return self._optional + + @property + def output(self): + return self._output + + @property + def missing_keys(self): + return self._missing_keys + + @property + def missing_optional_keys(self): + return self._missing_optional_keys + + @property + def invalid_types(self): + return self._invalid_types + + @property + def invalid_optional_types(self): + return self._invalid_optional_types + + @property + def realy_used_values(self): + return self._realy_used_values + + @property + def used_values(self): + return self._used_values + + @staticmethod + def split_keys_to_subdicts(values): + output = {} + for key, value in values.items(): + key_padding = list(KEY_PADDING_PATTERN.findall(key)) + if key_padding: + key = key_padding[0] + key_subdict = list(SUB_DICT_PATTERN.findall(key)) + data = output + last_key = key_subdict.pop(-1) + for subkey in key_subdict: + if subkey not in data: + data[subkey] = {} + data = data[subkey] + data[last_key] = value + return output + + def get_clean_used_values(self): + new_used_values = {} + for key, value in self.used_values.items(): + if isinstance(value, FormatObject): + value = str(value) + new_used_values[key] = value + + return self.split_keys_to_subdicts(new_used_values) + + def add_realy_used_value(self, key, value): + self._realy_used_values[key] = value + + def add_used_value(self, key, value): + self._used_values[key] = value + + def add_missing_key(self, key): + if self._optional: + self._missing_optional_keys.add(key) + else: + self._missing_keys.add(key) + + def add_invalid_type(self, key, value): + if self._optional: + self._invalid_optional_types[key] = type(value) + else: + self._invalid_types[key] = type(value) + + +class FormatObject(object): + """Object that can be used for formatting. + + This is base that is valid for to be used in 'StringTemplate' value. + """ + def __init__(self): + self.value = "" + + def __format__(self, *args, **kwargs): + return self.value.__format__(*args, **kwargs) + + def __str__(self): + return str(self.value) + + def __repr__(self): + return self.__str__() + + +class FormattingPart: + """String with formatting template. + + Containt only single key to format e.g. "{project[name]}". + + Args: + template(str): String containing the formatting key. + """ + def __init__(self, template): + self._template = template + + @property + def template(self): + return self._template + + def __repr__(self): + return "".format(self._template) + + def __str__(self): + return self._template + + @staticmethod + def validate_value_type(value): + """Check if value can be used for formatting of single key.""" + if isinstance(value, (numbers.Number, FormatObject)): + return True + + for inh_class in type(value).mro(): + if inh_class in six.string_types: + return True + return False + + def format(self, data, result): + """Format the formattings string. + + Args: + data(dict): Data that should be used for formatting. + result(TemplatePartResult): Object where result is stored. + """ + key = self.template[1:-1] + if key in result.realy_used_values: + result.add_output(result.realy_used_values[key]) + return result + + # check if key expects subdictionary keys (e.g. project[name]) + existence_check = key + key_padding = list(KEY_PADDING_PATTERN.findall(existence_check)) + if key_padding: + existence_check = key_padding[0] + key_subdict = list(SUB_DICT_PATTERN.findall(existence_check)) + + value = data + missing_key = False + invalid_type = False + used_keys = [] + for sub_key in key_subdict: + if ( + value is None + or (hasattr(value, "items") and sub_key not in value) + ): + missing_key = True + used_keys.append(sub_key) + break + + if not hasattr(value, "items"): + invalid_type = True + break + + used_keys.append(sub_key) + value = value.get(sub_key) + + if missing_key or invalid_type: + if len(used_keys) == 0: + invalid_key = key_subdict[0] + else: + invalid_key = used_keys[0] + for idx, sub_key in enumerate(used_keys): + if idx == 0: + continue + invalid_key += "[{0}]".format(sub_key) + + if missing_key: + result.add_missing_key(invalid_key) + + elif invalid_type: + result.add_invalid_type(invalid_key, value) + + result.add_output(self.template) + return result + + if self.validate_value_type(value): + fill_data = {} + first_value = True + for used_key in reversed(used_keys): + if first_value: + first_value = False + fill_data[used_key] = value + else: + _fill_data = {used_key: fill_data} + fill_data = _fill_data + + formatted_value = self.template.format(**fill_data) + result.add_realy_used_value(key, formatted_value) + result.add_used_value(existence_check, formatted_value) + result.add_output(formatted_value) + return result + + result.add_invalid_type(key, value) + result.add_output(self.template) + + return result + + +class OptionalPart: + """Template part which contains optional formatting strings. + + If this part can't be filled the result is empty string. + + Args: + parts(list): Parts of template. Can contain 'str', 'OptionalPart' or + 'FormattingPart'. + """ + def __init__(self, parts): + self._parts = parts + + @property + def parts(self): + return self._parts + + def __str__(self): + return "<{}>".format("".join([str(p) for p in self._parts])) + + def __repr__(self): + return "".format("".join([str(p) for p in self._parts])) + + def format(self, data, result): + new_result = TemplatePartResult(True) + for part in self._parts: + if isinstance(part, six.string_types): + new_result.add_output(part) + else: + part.format(data, new_result) + + if new_result.solved: + result.add_output(new_result) + return result diff --git a/openpype/lib/path_tools.py b/openpype/lib/path_tools.py index d6c32ad9e8..851bc872fb 100644 --- a/openpype/lib/path_tools.py +++ b/openpype/lib/path_tools.py @@ -4,9 +4,9 @@ import abc import json import logging import six +import platform from openpype.settings import get_project_settings -from openpype.settings.lib import get_site_local_overrides from .anatomy import Anatomy from .profiles_filtering import filter_profiles @@ -14,6 +14,42 @@ from .profiles_filtering import filter_profiles log = logging.getLogger(__name__) +def create_hard_link(src_path, dst_path): + """Create hardlink of file. + + Args: + src_path(str): Full path to a file which is used as source for + hardlink. + dst_path(str): Full path to a file where a link of source will be + added. + """ + # Use `os.link` if is available + # - should be for all platforms with newer python versions + if hasattr(os, "link"): + os.link(src_path, dst_path) + return + + # Windows implementation of hardlinks + # - used in Python 2 + if platform.system().lower() == "windows": + import ctypes + from ctypes.wintypes import BOOL + CreateHardLink = ctypes.windll.kernel32.CreateHardLinkW + CreateHardLink.argtypes = [ + ctypes.c_wchar_p, ctypes.c_wchar_p, ctypes.c_void_p + ] + CreateHardLink.restype = BOOL + + res = CreateHardLink(dst_path, src_path, None) + if res == 0: + raise ctypes.WinError() + return + # Raises not implemented error if gets here + raise NotImplementedError( + "Implementation of hardlink for current environment is missing." + ) + + def _rreplace(s, a, b, n=1): """Replace a with b in string s from right side n times.""" return b.join(s.rsplit(a, n)) diff --git a/openpype/lib/plugin_tools.py b/openpype/lib/plugin_tools.py index 183aad939a..f11ba56865 100644 --- a/openpype/lib/plugin_tools.py +++ b/openpype/lib/plugin_tools.py @@ -280,6 +280,7 @@ def set_plugin_attributes_from_settings( project_name (str): Name of project for which settings will be loaded. Value from environment `AVALON_PROJECT` is used if not entered. """ + from openpype.pipeline import LegacyCreator, LoaderPlugin # determine host application to use for finding presets if host_name is None: @@ -289,11 +290,11 @@ def set_plugin_attributes_from_settings( project_name = os.environ.get("AVALON_PROJECT") # map plugin superclass to preset json. Currently supported is load and - # create (avalon.api.Loader and avalon.api.Creator) + # create (LoaderPlugin and LegacyCreator) plugin_type = None - if superclass.__name__.split(".")[-1] in ("Loader", "SubsetLoader"): + if superclass is LoaderPlugin or issubclass(superclass, LoaderPlugin): plugin_type = "load" - elif superclass.__name__.split(".")[-1] == "Creator": + elif superclass is LegacyCreator or issubclass(superclass, LegacyCreator): plugin_type = "create" if not host_name or not project_name or plugin_type is None: diff --git a/openpype/lib/terminal.py b/openpype/lib/terminal.py index bc0744931a..5121b6ec26 100644 --- a/openpype/lib/terminal.py +++ b/openpype/lib/terminal.py @@ -49,11 +49,13 @@ class Terminal: """ from openpype.lib import env_value_to_bool - use_colors = env_value_to_bool( - "OPENPYPE_LOG_NO_COLORS", default=Terminal.use_colors + log_no_colors = env_value_to_bool( + "OPENPYPE_LOG_NO_COLORS", default=None ) - if not use_colors: - Terminal.use_colors = use_colors + if log_no_colors is not None: + Terminal.use_colors = not log_no_colors + + if not Terminal.use_colors: Terminal._initialized = True return diff --git a/openpype/lib/transcoding.py b/openpype/lib/transcoding.py index e89fa6331e..6bab6a8160 100644 --- a/openpype/lib/transcoding.py +++ b/openpype/lib/transcoding.py @@ -1,15 +1,18 @@ import os import re import logging +import json import collections import tempfile +import subprocess import xml.etree.ElementTree from .execute import run_subprocess from .vendor_bin_utils import ( + get_ffmpeg_tool_path, get_oiio_tools_path, - is_oiio_supported + is_oiio_supported, ) # Max length of string that is supported by ffmpeg @@ -90,7 +93,7 @@ class RationalToInt: if len(parts) != 1: bottom = float(parts[1]) - self._value = top / bottom + self._value = float(top) / float(bottom) self._string_value = string_value @property @@ -170,6 +173,23 @@ def convert_value_by_type_name(value_type, value, logger=None): if value_type == "rational2i": return RationalToInt(value) + if value_type == "vector": + parts = [part.strip() for part in value.split(",")] + output = [] + for part in parts: + if part == "-nan": + output.append(None) + continue + try: + part = float(part) + except ValueError: + pass + output.append(part) + return output + + if value_type == "timecode": + return value + # Array of other types is converted to list re_result = ARRAY_TYPE_REGEX.findall(value_type) if re_result: @@ -466,3 +486,290 @@ def convert_for_ffmpeg( logger.debug("Conversion command: {}".format(" ".join(oiio_cmd))) run_subprocess(oiio_cmd, logger=logger) + + +# FFMPEG functions +def get_ffprobe_data(path_to_file, logger=None): + """Load data about entered filepath via ffprobe. + + Args: + path_to_file (str): absolute path + logger (logging.Logger): injected logger, if empty new is created + """ + if not logger: + logger = logging.getLogger(__name__) + logger.info( + "Getting information about input \"{}\".".format(path_to_file) + ) + args = [ + get_ffmpeg_tool_path("ffprobe"), + "-hide_banner", + "-loglevel", "fatal", + "-show_error", + "-show_format", + "-show_streams", + "-show_programs", + "-show_chapters", + "-show_private_data", + "-print_format", "json", + path_to_file + ] + + logger.debug("FFprobe command: {}".format( + subprocess.list2cmdline(args) + )) + popen = subprocess.Popen( + args, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE + ) + + popen_stdout, popen_stderr = popen.communicate() + if popen_stdout: + logger.debug("FFprobe stdout:\n{}".format( + popen_stdout.decode("utf-8") + )) + + if popen_stderr: + logger.warning("FFprobe stderr:\n{}".format( + popen_stderr.decode("utf-8") + )) + + return json.loads(popen_stdout) + + +def get_ffprobe_streams(path_to_file, logger=None): + """Load streams from entered filepath via ffprobe. + + Args: + path_to_file (str): absolute path + logger (logging.Logger): injected logger, if empty new is created + """ + return get_ffprobe_data(path_to_file, logger)["streams"] + + +def get_ffmpeg_format_args(ffprobe_data, source_ffmpeg_cmd=None): + """Copy format from input metadata for output. + + Args: + ffprobe_data(dict): Data received from ffprobe. + source_ffmpeg_cmd(str): Command that created input if available. + """ + input_format = ffprobe_data.get("format") or {} + if input_format.get("format_name") == "mxf": + return _ffmpeg_mxf_format_args(ffprobe_data, source_ffmpeg_cmd) + return [] + + +def _ffmpeg_mxf_format_args(ffprobe_data, source_ffmpeg_cmd): + input_format = ffprobe_data["format"] + format_tags = input_format.get("tags") or {} + product_name = format_tags.get("product_name") or "" + output = [] + if "opatom" in product_name.lower(): + output.extend(["-f", "mxf_opatom"]) + return output + + +def get_ffmpeg_codec_args(ffprobe_data, source_ffmpeg_cmd=None, logger=None): + """Copy codec from input metadata for output. + + Args: + ffprobe_data(dict): Data received from ffprobe. + source_ffmpeg_cmd(str): Command that created input if available. + """ + if logger is None: + logger = logging.getLogger(__name__) + + video_stream = None + no_audio_stream = None + for stream in ffprobe_data["streams"]: + codec_type = stream["codec_type"] + if codec_type == "video": + video_stream = stream + break + elif no_audio_stream is None and codec_type != "audio": + no_audio_stream = stream + + if video_stream is None: + if no_audio_stream is None: + logger.warning( + "Couldn't find stream that is not an audio file." + ) + return [] + logger.info( + "Didn't find video stream. Using first non audio stream." + ) + video_stream = no_audio_stream + + codec_name = video_stream.get("codec_name") + # Codec "prores" + if codec_name == "prores": + return _ffmpeg_prores_codec_args(video_stream, source_ffmpeg_cmd) + + # Codec "h264" + if codec_name == "h264": + return _ffmpeg_h264_codec_args(video_stream, source_ffmpeg_cmd) + + # Coded DNxHD + if codec_name == "dnxhd": + return _ffmpeg_dnxhd_codec_args(video_stream, source_ffmpeg_cmd) + + output = [] + if codec_name: + output.extend(["-codec:v", codec_name]) + + bit_rate = video_stream.get("bit_rate") + if bit_rate: + output.extend(["-b:v", bit_rate]) + + pix_fmt = video_stream.get("pix_fmt") + if pix_fmt: + output.extend(["-pix_fmt", pix_fmt]) + + output.extend(["-g", "1"]) + + return output + + +def _ffmpeg_prores_codec_args(stream_data, source_ffmpeg_cmd): + output = [] + + tags = stream_data.get("tags") or {} + encoder = tags.get("encoder") or "" + if encoder.endswith("prores_ks"): + codec_name = "prores_ks" + + elif encoder.endswith("prores_aw"): + codec_name = "prores_aw" + + else: + codec_name = "prores" + + output.extend(["-codec:v", codec_name]) + + pix_fmt = stream_data.get("pix_fmt") + if pix_fmt: + output.extend(["-pix_fmt", pix_fmt]) + + # Rest of arguments is prores_kw specific + if codec_name == "prores_ks": + codec_tag_to_profile_map = { + "apco": "proxy", + "apcs": "lt", + "apcn": "standard", + "apch": "hq", + "ap4h": "4444", + "ap4x": "4444xq" + } + codec_tag_str = stream_data.get("codec_tag_string") + if codec_tag_str: + profile = codec_tag_to_profile_map.get(codec_tag_str) + if profile: + output.extend(["-profile:v", profile]) + + return output + + +def _ffmpeg_h264_codec_args(stream_data, source_ffmpeg_cmd): + output = ["-codec:v", "h264"] + + # Use arguments from source if are available source arguments + if source_ffmpeg_cmd: + copy_args = ( + "-crf", + "-b:v", "-vb", + "-minrate", "-minrate:", + "-maxrate", "-maxrate:", + "-bufsize", "-bufsize:" + ) + args = source_ffmpeg_cmd.split(" ") + for idx, arg in enumerate(args): + if arg in copy_args: + output.extend([arg, args[idx + 1]]) + + pix_fmt = stream_data.get("pix_fmt") + if pix_fmt: + output.extend(["-pix_fmt", pix_fmt]) + + output.extend(["-intra"]) + output.extend(["-g", "1"]) + + return output + + +def _ffmpeg_dnxhd_codec_args(stream_data, source_ffmpeg_cmd): + output = ["-codec:v", "dnxhd"] + + # Use source profile (profiles in metadata are not usable in args directly) + profile = stream_data.get("profile") or "" + # Lower profile and replace space with underscore + cleaned_profile = profile.lower().replace(" ", "_") + + # TODO validate this statement + # Looks like using 'dnxhd' profile must have set bit rate and in that case + # should be used bitrate from source. + # - related attributes 'bit_rate_defined', 'bit_rate_must_be_defined' + bit_rate_must_be_defined = True + dnx_profiles = { + "dnxhd", + "dnxhr_lb", + "dnxhr_sq", + "dnxhr_hq", + "dnxhr_hqx", + "dnxhr_444" + } + if cleaned_profile in dnx_profiles: + if cleaned_profile != "dnxhd": + bit_rate_must_be_defined = False + output.extend(["-profile:v", cleaned_profile]) + + pix_fmt = stream_data.get("pix_fmt") + if pix_fmt: + output.extend(["-pix_fmt", pix_fmt]) + + # Use arguments from source if are available source arguments + bit_rate_defined = False + if source_ffmpeg_cmd: + # Define bitrate arguments + bit_rate_args = ("-b:v", "-vb",) + # Seprate the two variables in case something else should be copied + # from source command + copy_args = [] + copy_args.extend(bit_rate_args) + + args = source_ffmpeg_cmd.split(" ") + for idx, arg in enumerate(args): + if arg in copy_args: + if arg in bit_rate_args: + bit_rate_defined = True + output.extend([arg, args[idx + 1]]) + + # Add bitrate if needed + if bit_rate_must_be_defined and not bit_rate_defined: + src_bit_rate = stream_data.get("bit_rate") + if src_bit_rate: + output.extend(["-b:v", src_bit_rate]) + + output.extend(["-g", "1"]) + return output + + +def convert_ffprobe_fps_value(str_value): + """Returns (str) value of fps from ffprobe frame format (120/1)""" + if str_value == "0/0": + print("WARNING: Source has \"r_frame_rate\" value set to \"0/0\".") + return "Unknown" + + items = str_value.split("/") + if len(items) == 1: + fps = float(items[0]) + + elif len(items) == 2: + fps = float(items[0]) / float(items[1]) + + # Check if fps is integer or float number + if int(fps) == fps: + fps = int(fps) + + return str(fps) diff --git a/openpype/lib/vendor_bin_utils.py b/openpype/lib/vendor_bin_utils.py index 4c2cf93dfa..23e28ea304 100644 --- a/openpype/lib/vendor_bin_utils.py +++ b/openpype/lib/vendor_bin_utils.py @@ -1,11 +1,87 @@ import os import logging -import json import platform -import subprocess -import distutils -log = logging.getLogger("FFmpeg utils") +log = logging.getLogger("Vendor utils") + + +def is_file_executable(filepath): + """Filepath lead to executable file. + + Args: + filepath(str): Full path to file. + """ + if not filepath: + return False + + if os.path.isfile(filepath): + if os.access(filepath, os.X_OK): + return True + + log.info( + "Filepath is not available for execution \"{}\"".format(filepath) + ) + return False + + +def find_executable(executable): + """Find full path to executable. + + Also tries additional extensions if passed executable does not contain one. + + Paths where it is looked for executable is defined by 'PATH' environment + variable, 'os.confstr("CS_PATH")' or 'os.defpath'. + + Args: + executable(str): Name of executable with or without extension. Can be + path to file. + + Returns: + str: Full path to executable with extension (is file). + None: When the executable was not found. + """ + # Skip if passed path is file + if is_file_executable(executable): + return executable + + low_platform = platform.system().lower() + _, ext = os.path.splitext(executable) + + # Prepare variants for which it will be looked + variants = [executable] + # Add other extension variants only if passed executable does not have one + if not ext: + if low_platform == "windows": + exts = [".exe", ".ps1", ".bat"] + for ext in os.getenv("PATHEXT", "").split(os.pathsep): + ext = ext.lower() + if ext and ext not in exts: + exts.append(ext) + else: + exts = [".sh"] + + for ext in exts: + variant = executable + ext + if is_file_executable(variant): + return variant + variants.append(variant) + + # Get paths where to look for executable + path_str = os.environ.get("PATH", None) + if path_str is None: + if hasattr(os, "confstr"): + path_str = os.confstr("CS_PATH") + elif hasattr(os, "defpath"): + path_str = os.defpath + + if path_str: + paths = path_str.split(os.pathsep) + for path in paths: + for variant in variants: + filepath = os.path.abspath(os.path.join(path, variant)) + if is_file_executable(filepath): + return filepath + return None def get_vendor_bin_path(bin_app): @@ -41,11 +117,7 @@ def get_oiio_tools_path(tool="oiiotool"): Default is "oiiotool". """ oiio_dir = get_vendor_bin_path("oiio") - if platform.system().lower() == "windows" and not tool.lower().endswith( - ".exe" - ): - tool = "{}.exe".format(tool) - return os.path.join(oiio_dir, tool) + return find_executable(os.path.join(oiio_dir, tool)) def get_ffmpeg_tool_path(tool="ffmpeg"): @@ -61,57 +133,7 @@ def get_ffmpeg_tool_path(tool="ffmpeg"): ffmpeg_dir = get_vendor_bin_path("ffmpeg") if platform.system().lower() == "windows": ffmpeg_dir = os.path.join(ffmpeg_dir, "bin") - return os.path.join(ffmpeg_dir, tool) - - -def ffprobe_streams(path_to_file, logger=None): - """Load streams from entered filepath via ffprobe. - - Args: - path_to_file (str): absolute path - logger (logging.getLogger): injected logger, if empty new is created - - """ - if not logger: - logger = log - logger.info( - "Getting information about input \"{}\".".format(path_to_file) - ) - args = [ - get_ffmpeg_tool_path("ffprobe"), - "-hide_banner", - "-loglevel", "fatal", - "-show_error", - "-show_format", - "-show_streams", - "-show_programs", - "-show_chapters", - "-show_private_data", - "-print_format", "json", - path_to_file - ] - - logger.debug("FFprobe command: {}".format( - subprocess.list2cmdline(args) - )) - popen = subprocess.Popen( - args, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE - ) - - popen_stdout, popen_stderr = popen.communicate() - if popen_stdout: - logger.debug("FFprobe stdout:\n{}".format( - popen_stdout.decode("utf-8") - )) - - if popen_stderr: - logger.warning("FFprobe stderr:\n{}".format( - popen_stderr.decode("utf-8") - )) - - return json.loads(popen_stdout)["streams"] + return find_executable(os.path.join(ffmpeg_dir, tool)) def is_oiio_supported(): @@ -122,7 +144,7 @@ def is_oiio_supported(): """ loaded_path = oiio_path = get_oiio_tools_path() if oiio_path: - oiio_path = distutils.spawn.find_executable(oiio_path) + oiio_path = find_executable(oiio_path) if not oiio_path: log.debug("OIIOTool is not configured or not present at {}".format( diff --git a/openpype/modules/base.py b/openpype/modules/base.py index d566692439..175957ae39 100644 --- a/openpype/modules/base.py +++ b/openpype/modules/base.py @@ -33,16 +33,21 @@ DEFAULT_OPENPYPE_MODULES = ( "avalon_apps", "clockify", "log_viewer", + "deadline", "muster", + "royalrender", "python_console_interpreter", + "ftrack", "slack", "webserver", "launcher_action", "project_manager_action", "settings_action", "standalonepublish_action", + "traypublish_action", "job_queue", "timers_manager", + "sync_server", ) @@ -56,6 +61,7 @@ class _ModuleClass(object): def __init__(self, name): # Call setattr on super class super(_ModuleClass, self).__setattr__("name", name) + super(_ModuleClass, self).__setattr__("__name__", name) # Where modules and interfaces are stored super(_ModuleClass, self).__setattr__("__attributes__", dict()) @@ -67,7 +73,7 @@ class _ModuleClass(object): if attr_name not in self.__attributes__: if attr_name in ("__path__", "__file__"): return None - raise ImportError("No module named {}.{}".format( + raise AttributeError("'{}' has not attribute '{}'".format( self.name, attr_name )) return self.__attributes__[attr_name] @@ -218,8 +224,6 @@ def load_interfaces(force=False): def _load_interfaces(): # Key under which will be modules imported in `sys.modules` - from openpype.lib import import_filepath - modules_key = "openpype_interfaces" sys.modules[modules_key] = openpype_interfaces = ( @@ -844,6 +848,7 @@ class TrayModulesManager(ModulesManager): "avalon", "clockify", "standalonepublish_tool", + "traypublish_tool", "log_viewer", "local_settings", "settings" diff --git a/openpype/modules/default_modules/deadline/__init__.py b/openpype/modules/deadline/__init__.py similarity index 100% rename from openpype/modules/default_modules/deadline/__init__.py rename to openpype/modules/deadline/__init__.py diff --git a/openpype/lib/abstract_submit_deadline.py b/openpype/modules/deadline/abstract_submit_deadline.py similarity index 99% rename from openpype/lib/abstract_submit_deadline.py rename to openpype/modules/deadline/abstract_submit_deadline.py index f54a2501a3..22902d79ea 100644 --- a/openpype/lib/abstract_submit_deadline.py +++ b/openpype/modules/deadline/abstract_submit_deadline.py @@ -15,7 +15,7 @@ import attr import requests import pyblish.api -from .abstract_metaplugins import AbstractMetaInstancePlugin +from openpype.lib.abstract_metaplugins import AbstractMetaInstancePlugin def requests_post(*args, **kwargs): diff --git a/openpype/modules/default_modules/deadline/deadline_module.py b/openpype/modules/deadline/deadline_module.py similarity index 100% rename from openpype/modules/default_modules/deadline/deadline_module.py rename to openpype/modules/deadline/deadline_module.py diff --git a/openpype/modules/default_modules/deadline/plugins/publish/collect_deadline_server_from_instance.py b/openpype/modules/deadline/plugins/publish/collect_deadline_server_from_instance.py similarity index 100% rename from openpype/modules/default_modules/deadline/plugins/publish/collect_deadline_server_from_instance.py rename to openpype/modules/deadline/plugins/publish/collect_deadline_server_from_instance.py diff --git a/openpype/modules/default_modules/deadline/plugins/publish/collect_default_deadline_server.py b/openpype/modules/deadline/plugins/publish/collect_default_deadline_server.py similarity index 100% rename from openpype/modules/default_modules/deadline/plugins/publish/collect_default_deadline_server.py rename to openpype/modules/deadline/plugins/publish/collect_default_deadline_server.py diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_aftereffects_deadline.py b/openpype/modules/deadline/plugins/publish/submit_aftereffects_deadline.py similarity index 95% rename from openpype/modules/default_modules/deadline/plugins/publish/submit_aftereffects_deadline.py rename to openpype/modules/deadline/plugins/publish/submit_aftereffects_deadline.py index 1fff55500e..2918b54d4a 100644 --- a/openpype/modules/default_modules/deadline/plugins/publish/submit_aftereffects_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_aftereffects_deadline.py @@ -5,9 +5,9 @@ import pyblish.api from avalon import api -from openpype.lib import abstract_submit_deadline -from openpype.lib.abstract_submit_deadline import DeadlineJobInfo from openpype.lib import env_value_to_bool +from openpype_modules.deadline import abstract_submit_deadline +from openpype_modules.deadline.abstract_submit_deadline import DeadlineJobInfo @attr.s @@ -24,7 +24,9 @@ class DeadlinePluginInfo(): MultiProcess = attr.ib(default=None) -class AfterEffectsSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline): +class AfterEffectsSubmitDeadline( + abstract_submit_deadline.AbstractSubmitDeadline +): label = "Submit AE to Deadline" order = pyblish.api.IntegratorOrder + 0.1 diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_harmony_deadline.py b/openpype/modules/deadline/plugins/publish/submit_harmony_deadline.py similarity index 98% rename from openpype/modules/default_modules/deadline/plugins/publish/submit_harmony_deadline.py rename to openpype/modules/deadline/plugins/publish/submit_harmony_deadline.py index 9d55d43ba6..918efb6630 100644 --- a/openpype/modules/default_modules/deadline/plugins/publish/submit_harmony_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_harmony_deadline.py @@ -8,11 +8,11 @@ import re import attr import pyblish.api - -import openpype.lib.abstract_submit_deadline -from openpype.lib.abstract_submit_deadline import DeadlineJobInfo from avalon import api +from openpype_modules.deadline import abstract_submit_deadline +from openpype_modules.deadline.abstract_submit_deadline import DeadlineJobInfo + class _ZipFile(ZipFile): """Extended check for windows invalid characters.""" @@ -217,7 +217,8 @@ class PluginInfo(object): class HarmonySubmitDeadline( - openpype.lib.abstract_submit_deadline.AbstractSubmitDeadline): + abstract_submit_deadline.AbstractSubmitDeadline +): """Submit render write of Harmony scene to Deadline. Renders are submitted to a Deadline Web Service as diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_houdini_remote_publish.py b/openpype/modules/deadline/plugins/publish/submit_houdini_remote_publish.py similarity index 100% rename from openpype/modules/default_modules/deadline/plugins/publish/submit_houdini_remote_publish.py rename to openpype/modules/deadline/plugins/publish/submit_houdini_remote_publish.py diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_houdini_render_deadline.py b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py similarity index 98% rename from openpype/modules/default_modules/deadline/plugins/publish/submit_houdini_render_deadline.py rename to openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py index 2cd6b0e6b0..59aeb68b79 100644 --- a/openpype/modules/default_modules/deadline/plugins/publish/submit_houdini_render_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py @@ -50,8 +50,8 @@ class HoudiniSubmitRenderDeadline(pyblish.api.InstancePlugin): # StartFrame to EndFrame by byFrameStep frames = "{start}-{end}x{step}".format( - start=int(instance.data["startFrame"]), - end=int(instance.data["endFrame"]), + start=int(instance.data["frameStart"]), + end=int(instance.data["frameEnd"]), step=int(instance.data["byFrameStep"]), ) diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_maya_deadline.py b/openpype/modules/deadline/plugins/publish/submit_maya_deadline.py similarity index 100% rename from openpype/modules/default_modules/deadline/plugins/publish/submit_maya_deadline.py rename to openpype/modules/deadline/plugins/publish/submit_maya_deadline.py diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_nuke_deadline.py b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py similarity index 100% rename from openpype/modules/default_modules/deadline/plugins/publish/submit_nuke_deadline.py rename to openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_publish_job.py b/openpype/modules/deadline/plugins/publish/submit_publish_job.py similarity index 98% rename from openpype/modules/default_modules/deadline/plugins/publish/submit_publish_job.py rename to openpype/modules/deadline/plugins/publish/submit_publish_job.py index a77a968815..19d504b6c9 100644 --- a/openpype/modules/default_modules/deadline/plugins/publish/submit_publish_job.py +++ b/openpype/modules/deadline/plugins/publish/submit_publish_job.py @@ -13,6 +13,8 @@ from avalon import api, io import pyblish.api +from openpype.pipeline import get_representation_path + def get_resources(version, extension=None): """Get the files from the specific version.""" @@ -23,7 +25,7 @@ def get_resources(version, extension=None): representation = io.find_one(query) assert representation, "This is a bug" - directory = api.get_representation_path(representation) + directory = get_representation_path(representation) print("Source: ", directory) resources = sorted( [ @@ -316,8 +318,8 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin): import speedcopy self.log.info("Preparing to copy ...") - start = instance.data.get("startFrame") - end = instance.data.get("endFrame") + start = instance.data.get("frameStart") + end = instance.data.get("frameEnd") # get latest version of subset # this will stop if subset wasn't published yet @@ -516,7 +518,6 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin): """ representations = [] collections, remainders = clique.assemble(exp_files) - bake_renders = instance.get("bakingNukeScripts", []) # create representation for every collected sequento ce for collection in collections: @@ -534,9 +535,6 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin): preview = True break - if bake_renders: - preview = False - # toggle preview on if multipart is on if instance.get("multipartExr", False): preview = True @@ -610,16 +608,6 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin): }) self._solve_families(instance, True) - if (bake_renders - and remainder in bake_renders[0]["bakeRenderPath"]): - rep.update({ - "fps": instance.get("fps"), - "tags": ["review", "delete"] - }) - # solve families with `preview` attributes - self._solve_families(instance, True) - representations.append(rep) - return representations def _solve_families(self, instance, preview=False): diff --git a/openpype/modules/default_modules/deadline/plugins/publish/validate_deadline_connection.py b/openpype/modules/deadline/plugins/publish/validate_deadline_connection.py similarity index 100% rename from openpype/modules/default_modules/deadline/plugins/publish/validate_deadline_connection.py rename to openpype/modules/deadline/plugins/publish/validate_deadline_connection.py 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 new file mode 100644 index 0000000000..c2426e0d78 --- /dev/null +++ b/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py @@ -0,0 +1,209 @@ +import os +import requests + +import pyblish.api + +from openpype.lib.delivery import collect_frames +from openpype_modules.deadline.abstract_submit_deadline import requests_get + + +class ValidateExpectedFiles(pyblish.api.InstancePlugin): + """Compare rendered and expected files""" + + label = "Validate rendered files from Deadline" + order = pyblish.api.ValidatorOrder + families = ["render"] + targets = ["deadline"] + + # check if actual frame range on render job wasn't different + # case when artists wants to render only subset of frames + allow_user_override = True + + def process(self, instance): + self.instance = instance + frame_list = self._get_frame_list(instance.data["render_job_id"]) + + for repre in instance.data["representations"]: + expected_files = self._get_expected_files(repre) + + staging_dir = repre["stagingDir"] + existing_files = self._get_existing_files(staging_dir) + + if self.allow_user_override: + # We always check for user override because the user might have + # also overridden the Job frame list to be longer than the + # originally submitted frame range + # todo: We should first check if Job frame range was overridden + # at all so we don't unnecessarily override anything + file_name_template, frame_placeholder = \ + self._get_file_name_template_and_placeholder( + expected_files) + + if not file_name_template: + raise RuntimeError("Unable to retrieve file_name template" + "from files: {}".format(expected_files)) + + job_expected_files = self._get_job_expected_files( + file_name_template, + frame_placeholder, + frame_list) + + job_files_diff = job_expected_files.difference(expected_files) + if job_files_diff: + self.log.debug( + "Detected difference in expected output files from " + "Deadline job. Assuming an updated frame list by the " + "user. Difference: {}".format(sorted(job_files_diff)) + ) + + # Update the representation expected files + self.log.info("Update range from actual job range " + "to frame list: {}".format(frame_list)) + repre["files"] = sorted(job_expected_files) + + # Update the expected files + expected_files = job_expected_files + + # We don't use set.difference because we do allow other existing + # 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))) + + def _get_frame_list(self, original_job_id): + """Returns list of frame ranges from all render job. + + Render job might be re-submitted so job_id in metadata.json could be + invalid. GlobalJobPreload injects current job id to RENDER_JOB_IDS. + + Args: + original_job_id (str) + Returns: + (list) + """ + all_frame_lists = [] + render_job_ids = os.environ.get("RENDER_JOB_IDS") + if render_job_ids: + render_job_ids = render_job_ids.split(',') + else: # fallback + render_job_ids = [original_job_id] + + for job_id in render_job_ids: + job_info = self._get_job_info(job_id) + frame_list = job_info["Props"]["Frames"] + if frame_list: + all_frame_lists.extend(frame_list.split(',')) + + return all_frame_lists + + def _get_job_expected_files(self, + file_name_template, + frame_placeholder, + frame_list): + """Calculates list of names of expected rendered files. + + Might be different from expected files from submission if user + explicitly and manually changed the frame list on the Deadline job. + + """ + # no frames in file name at all, eg 'renderCompositingMain.withLut.mov' + if not frame_placeholder: + return set([file_name_template]) + + real_expected_rendered = set() + src_padding_exp = "%0{}d".format(len(frame_placeholder)) + for frames in frame_list: + if '-' not in frames: # single frame + frames = "{}-{}".format(frames, frames) + + start, end = frames.split('-') + for frame in range(int(start), int(end) + 1): + ren_name = file_name_template.replace( + frame_placeholder, src_padding_exp % frame) + real_expected_rendered.add(ren_name) + + return real_expected_rendered + + def _get_file_name_template_and_placeholder(self, files): + """Returns file name with frame replaced with # and this placeholder""" + sources_and_frames = collect_frames(files) + + file_name_template = frame_placeholder = None + for file_name, frame in sources_and_frames.items(): + + # There might be cases where clique was unable to collect + # collections in `collect_frames` - thus we capture that case + if frame is not None: + frame_placeholder = "#" * len(frame) + + file_name_template = os.path.basename( + file_name.replace(frame, frame_placeholder)) + else: + file_name_template = file_name + break + + return file_name_template, frame_placeholder + + def _get_job_info(self, job_id): + """Calls DL for actual job info for 'job_id' + + Might be different than job info saved in metadata.json if user + manually changes job pre/during rendering. + + """ + # get default deadline webservice url from deadline module + deadline_url = self.instance.context.data["defaultDeadline"] + # if custom one is set in instance, use that + if self.instance.data.get("deadlineUrl"): + deadline_url = self.instance.data.get("deadlineUrl") + assert deadline_url, "Requires Deadline Webservice URL" + + url = "{}/api/jobs?JobID={}".format(deadline_url, job_id) + try: + response = requests_get(url) + except requests.exceptions.ConnectionError: + self.log.error("Deadline is not accessible at " + "{}".format(deadline_url)) + return {} + + if not response.ok: + self.log.error("Submission failed!") + self.log.error(response.status_code) + self.log.error(response.content) + raise RuntimeError(response.text) + + json_content = response.json() + if json_content: + return json_content.pop() + return {} + + def _get_existing_files(self, staging_dir): + """Returns set of existing file names from 'staging_dir'""" + existing_files = set() + for file_name in os.listdir(staging_dir): + existing_files.add(file_name) + return existing_files + + def _get_expected_files(self, repre): + """Returns set of file names in representation['files'] + + The representations are collected from `CollectRenderedFiles` using + the metadata.json file submitted along with the render job. + + Args: + repre (dict): The representation containing 'files' + + Returns: + set: Set of expected file_names in the staging directory. + + """ + expected_files = set() + + files = repre["files"] + if not isinstance(files, list): + files = [files] + + for file_name in files: + expected_files.add(file_name) + return expected_files diff --git a/vendor/deadline/custom/plugins/GlobalJobPreLoad.py b/openpype/modules/deadline/repository/custom/plugins/GlobalJobPreLoad.py similarity index 96% rename from vendor/deadline/custom/plugins/GlobalJobPreLoad.py rename to openpype/modules/deadline/repository/custom/plugins/GlobalJobPreLoad.py index ee137a2ee3..82c2494e7a 100644 --- a/vendor/deadline/custom/plugins/GlobalJobPreLoad.py +++ b/openpype/modules/deadline/repository/custom/plugins/GlobalJobPreLoad.py @@ -1,10 +1,11 @@ # -*- coding: utf-8 -*- import os import tempfile -import time +from datetime import datetime import subprocess import json import platform +import uuid from Deadline.Scripting import RepositoryUtils, FileUtils @@ -36,9 +37,11 @@ def inject_openpype_environment(deadlinePlugin): print("--- OpenPype executable: {}".format(openpype_app)) # tempfile.TemporaryFile cannot be used because of locking - export_url = os.path.join(tempfile.gettempdir(), - time.strftime('%Y%m%d%H%M%S'), - 'env.json') # add HHMMSS + delete later + temp_file_name = "{}_{}.json".format( + datetime.utcnow().strftime('%Y%m%d%H%M%S%f'), + str(uuid.uuid1()) + ) + export_url = os.path.join(tempfile.gettempdir(), temp_file_name) print(">>> Temporary path: {}".format(export_url)) args = [ diff --git a/vendor/deadline/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.ico b/openpype/modules/deadline/repository/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.ico similarity index 100% rename from vendor/deadline/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.ico rename to openpype/modules/deadline/repository/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.ico diff --git a/vendor/deadline/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.options b/openpype/modules/deadline/repository/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.options similarity index 100% rename from vendor/deadline/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.options rename to openpype/modules/deadline/repository/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.options diff --git a/vendor/deadline/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.param b/openpype/modules/deadline/repository/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.param similarity index 100% rename from vendor/deadline/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.param rename to openpype/modules/deadline/repository/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.param diff --git a/vendor/deadline/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.py b/openpype/modules/deadline/repository/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.py similarity index 100% rename from vendor/deadline/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.py rename to openpype/modules/deadline/repository/custom/plugins/HarmonyOpenPype/HarmonyOpenPype.py diff --git a/vendor/deadline/custom/plugins/OpenPype/OpenPype.ico b/openpype/modules/deadline/repository/custom/plugins/OpenPype/OpenPype.ico similarity index 100% rename from vendor/deadline/custom/plugins/OpenPype/OpenPype.ico rename to openpype/modules/deadline/repository/custom/plugins/OpenPype/OpenPype.ico diff --git a/vendor/deadline/custom/plugins/OpenPype/OpenPype.options b/openpype/modules/deadline/repository/custom/plugins/OpenPype/OpenPype.options similarity index 100% rename from vendor/deadline/custom/plugins/OpenPype/OpenPype.options rename to openpype/modules/deadline/repository/custom/plugins/OpenPype/OpenPype.options diff --git a/vendor/deadline/custom/plugins/OpenPype/OpenPype.param b/openpype/modules/deadline/repository/custom/plugins/OpenPype/OpenPype.param similarity index 100% rename from vendor/deadline/custom/plugins/OpenPype/OpenPype.param rename to openpype/modules/deadline/repository/custom/plugins/OpenPype/OpenPype.param diff --git a/vendor/deadline/custom/plugins/OpenPype/OpenPype.py b/openpype/modules/deadline/repository/custom/plugins/OpenPype/OpenPype.py similarity index 100% rename from vendor/deadline/custom/plugins/OpenPype/OpenPype.py rename to openpype/modules/deadline/repository/custom/plugins/OpenPype/OpenPype.py diff --git a/vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.ico b/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.ico similarity index 100% rename from vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.ico rename to openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.ico diff --git a/vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.options b/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.options similarity index 100% rename from vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.options rename to openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.options diff --git a/vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.param b/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.param similarity index 100% rename from vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.param rename to openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.param diff --git a/vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py b/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py similarity index 65% rename from vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py rename to openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py index cf864b03d3..9fca1b5391 100644 --- a/vendor/deadline/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py +++ b/openpype/modules/deadline/repository/custom/plugins/OpenPypeTileAssembler/OpenPypeTileAssembler.py @@ -5,8 +5,9 @@ Todo: Currently we support only EXRs with their data window set. """ import os +import re import subprocess -from xml.dom import minidom +import xml.etree.ElementTree from System.IO import Path @@ -15,17 +16,220 @@ from Deadline.Scripting import ( FileUtils, RepositoryUtils, SystemUtils) -INT_KEYS = { - "x", "y", "height", "width", "full_x", "full_y", - "full_width", "full_height", "full_depth", "full_z", - "tile_width", "tile_height", "tile_depth", "deep", "depth", - "nchannels", "z_channel", "alpha_channel", "subimages" +STRING_TAGS = { + "format" } -LIST_KEYS = { - "channelnames" +INT_TAGS = { + "x", "y", "z", + "width", "height", "depth", + "full_x", "full_y", "full_z", + "full_width", "full_height", "full_depth", + "tile_width", "tile_height", "tile_depth", + "nchannels", + "alpha_channel", + "z_channel", + "deep", + "subimages", } +XML_CHAR_REF_REGEX_HEX = re.compile(r"&#x?[0-9a-fA-F]+;") + +# Regex to parse array attributes +ARRAY_TYPE_REGEX = re.compile(r"^(int|float|string)\[\d+\]$") + + +def convert_value_by_type_name(value_type, value): + """Convert value to proper type based on type name. + + In some cases value types have custom python class. + """ + + # Simple types + if value_type == "string": + return value + + if value_type == "int": + return int(value) + + if value_type == "float": + return float(value) + + # Vectors will probably have more types + if value_type == "vec2f": + return [float(item) for item in value.split(",")] + + # Matrix should be always have square size of element 3x3, 4x4 + # - are returned as list of lists + if value_type == "matrix": + output = [] + current_index = -1 + parts = value.split(",") + parts_len = len(parts) + if parts_len == 1: + divisor = 1 + elif parts_len == 4: + divisor = 2 + elif parts_len == 9: + divisor == 3 + elif parts_len == 16: + divisor = 4 + else: + print("Unknown matrix resolution {}. Value: \"{}\"".format( + parts_len, value + )) + for part in parts: + output.append(float(part)) + return output + + for idx, item in enumerate(parts): + list_index = idx % divisor + if list_index > current_index: + current_index = list_index + output.append([]) + output[list_index].append(float(item)) + return output + + if value_type == "rational2i": + parts = value.split("/") + top = float(parts[0]) + bottom = 1.0 + if len(parts) != 1: + bottom = float(parts[1]) + return float(top) / float(bottom) + + if value_type == "vector": + parts = [part.strip() for part in value.split(",")] + output = [] + for part in parts: + if part == "-nan": + output.append(None) + continue + try: + part = float(part) + except ValueError: + pass + output.append(part) + return output + + if value_type == "timecode": + return value + + # Array of other types is converted to list + re_result = ARRAY_TYPE_REGEX.findall(value_type) + if re_result: + array_type = re_result[0] + output = [] + for item in value.split(","): + output.append( + convert_value_by_type_name(array_type, item) + ) + return output + + print(( + "MISSING IMPLEMENTATION:" + " Unknown attrib type \"{}\". Value: {}" + ).format(value_type, value)) + return value + + +def parse_oiio_xml_output(xml_string): + """Parse xml output from OIIO info command.""" + output = {} + if not xml_string: + return output + + # Fix values with ampresand (lazy fix) + # - oiiotool exports invalid xml which ElementTree can't handle + # e.g. "" + # WARNING: this will affect even valid character entities. If you need + # those values correctly, this must take care of valid character ranges. + # See https://github.com/pypeclub/OpenPype/pull/2729 + matches = XML_CHAR_REF_REGEX_HEX.findall(xml_string) + for match in matches: + new_value = match.replace("&", "&") + xml_string = xml_string.replace(match, new_value) + + tree = xml.etree.ElementTree.fromstring(xml_string) + attribs = {} + output["attribs"] = attribs + for child in tree: + tag_name = child.tag + if tag_name == "attrib": + attrib_def = child.attrib + value = convert_value_by_type_name( + attrib_def["type"], child.text + ) + + attribs[attrib_def["name"]] = value + continue + + # Channels are stored as tex on each child + if tag_name == "channelnames": + value = [] + for channel in child: + value.append(channel.text) + + # Convert known integer type tags to int + elif tag_name in INT_TAGS: + value = int(child.text) + + # Keep value of known string tags + elif tag_name in STRING_TAGS: + value = child.text + + # Keep value as text for unknown tags + # - feel free to add more tags + else: + value = child.text + print(( + "MISSING IMPLEMENTATION:" + " Unknown tag \"{}\". Value \"{}\"" + ).format(tag_name, value)) + + output[child.tag] = value + + return output + + +def info_about_input(oiiotool_path, filepath): + args = [ + oiiotool_path, + "--info", + "-v", + "-i:infoformat=xml", + filepath + ] + popen = subprocess.Popen(args, stdout=subprocess.PIPE) + _stdout, _stderr = popen.communicate() + output = "" + if _stdout: + output += _stdout.decode("utf-8") + + if _stderr: + output += _stderr.decode("utf-8") + + output = output.replace("\r\n", "\n") + xml_started = False + lines = [] + for line in output.split("\n"): + if not xml_started: + if not line.startswith("<"): + continue + xml_started = True + if xml_started: + lines.append(line) + + if not xml_started: + raise ValueError( + "Failed to read input file \"{}\".\nOutput:\n{}".format( + filepath, output + ) + ) + xml_text = "\n".join(lines) + return parse_oiio_xml_output(xml_text) + + def GetDeadlinePlugin(): # noqa: N802 """Helper.""" return OpenPypeTileAssembler() @@ -218,8 +422,9 @@ class OpenPypeTileAssembler(DeadlinePlugin): # Create new image with output resolution, and with same type and # channels as input + oiiotool_path = self.render_executable() first_tile_path = tile_info[0]["filepath"] - first_tile_info = self.info_about_input(first_tile_path) + first_tile_info = info_about_input(oiiotool_path, first_tile_path) create_arg_template = "--create{} {}x{} {}" image_type = "" @@ -236,7 +441,7 @@ class OpenPypeTileAssembler(DeadlinePlugin): for tile in tile_info: path = tile["filepath"] pos_x = tile["pos_x"] - tile_height = self.info_about_input(path)["height"] + tile_height = info_about_input(oiiotool_path, path)["height"] if self.renderer == "vray": pos_y = tile["pos_y"] else: @@ -326,47 +531,3 @@ class OpenPypeTileAssembler(DeadlinePlugin): ffmpeg_args.append("\"{}\"".format(output_path)) return ffmpeg_args - - def info_about_input(self, input_path): - args = [self.render_executable(), "--info:format=xml", input_path] - popen = subprocess.Popen( - " ".join(args), - shell=True, - stdout=subprocess.PIPE - ) - popen_output = popen.communicate()[0].replace(b"\r\n", b"") - - xmldoc = minidom.parseString(popen_output) - image_spec = None - for main_child in xmldoc.childNodes: - if main_child.nodeName.lower() == "imagespec": - image_spec = main_child - break - - info = {} - if not image_spec: - return info - - def child_check(node): - if len(node.childNodes) != 1: - self.FailRender(( - "Implementation BUG. Node {} has more children than 1" - ).format(node.nodeName)) - - for child in image_spec.childNodes: - if child.nodeName in LIST_KEYS: - values = [] - for node in child.childNodes: - child_check(node) - values.append(node.childNodes[0].nodeValue) - - info[child.nodeName] = values - - elif child.nodeName in INT_KEYS: - child_check(child) - info[child.nodeName] = int(child.childNodes[0].nodeValue) - - else: - child_check(child) - info[child.nodeName] = child.childNodes[0].nodeValue - return info diff --git a/vendor/deadline/readme.md b/openpype/modules/deadline/repository/readme.md similarity index 100% rename from vendor/deadline/readme.md rename to openpype/modules/deadline/repository/readme.md diff --git a/openpype/modules/default_modules/deadline/plugins/publish/validate_expected_and_rendered_files.py b/openpype/modules/default_modules/deadline/plugins/publish/validate_expected_and_rendered_files.py deleted file mode 100644 index 719c7dfe3e..0000000000 --- a/openpype/modules/default_modules/deadline/plugins/publish/validate_expected_and_rendered_files.py +++ /dev/null @@ -1,189 +0,0 @@ -import os -import json -import requests - -import pyblish.api - -from openpype.lib.abstract_submit_deadline import requests_get -from openpype.lib.delivery import collect_frames - - -class ValidateExpectedFiles(pyblish.api.InstancePlugin): - """Compare rendered and expected files""" - - label = "Validate rendered files from Deadline" - order = pyblish.api.ValidatorOrder - families = ["render"] - targets = ["deadline"] - - # check if actual frame range on render job wasn't different - # case when artists wants to render only subset of frames - allow_user_override = True - - def process(self, instance): - self.instance = instance - frame_list = self._get_frame_list(instance.data["render_job_id"]) - - for repre in instance.data["representations"]: - expected_files = self._get_expected_files(repre) - - staging_dir = repre["stagingDir"] - existing_files = self._get_existing_files(staging_dir) - - expected_non_existent = expected_files.difference( - existing_files) - if len(expected_non_existent) != 0: - self.log.info("Some expected files missing {}".format( - expected_non_existent)) - - if self.allow_user_override: - file_name_template, frame_placeholder = \ - self._get_file_name_template_and_placeholder( - expected_files) - - if not file_name_template: - return - - real_expected_rendered = self._get_real_render_expected( - file_name_template, - frame_placeholder, - frame_list) - - real_expected_non_existent = \ - real_expected_rendered.difference(existing_files) - if len(real_expected_non_existent) != 0: - raise RuntimeError("Still missing some files {}". - format(real_expected_non_existent)) - self.log.info("Update range from actual job range") - repre["files"] = sorted(list(real_expected_rendered)) - else: - raise RuntimeError("Some expected files missing {}".format( - expected_non_existent)) - - def _get_frame_list(self, original_job_id): - """ - Returns list of frame ranges from all render job. - - Render job might be requeried so job_id in metadata.json is invalid - GlobalJobPreload injects current ids to RENDER_JOB_IDS. - - Args: - original_job_id (str) - Returns: - (list) - """ - all_frame_lists = [] - render_job_ids = os.environ.get("RENDER_JOB_IDS") - if render_job_ids: - render_job_ids = render_job_ids.split(',') - else: # fallback - render_job_ids = [original_job_id] - - for job_id in render_job_ids: - job_info = self._get_job_info(job_id) - frame_list = job_info["Props"]["Frames"] - if frame_list: - all_frame_lists.extend(frame_list.split(',')) - - return all_frame_lists - - def _get_real_render_expected(self, file_name_template, frame_placeholder, - frame_list): - """ - Calculates list of names of expected rendered files. - - Might be different from job expected files if user explicitly and - manually change frame list on Deadline job. - """ - real_expected_rendered = set() - src_padding_exp = "%0{}d".format(len(frame_placeholder)) - for frames in frame_list: - if '-' not in frames: # single frame - frames = "{}-{}".format(frames, frames) - - start, end = frames.split('-') - for frame in range(int(start), int(end) + 1): - ren_name = file_name_template.replace( - frame_placeholder, src_padding_exp % frame) - real_expected_rendered.add(ren_name) - - return real_expected_rendered - - def _get_file_name_template_and_placeholder(self, files): - """Returns file name with frame replaced with # and this placeholder""" - sources_and_frames = collect_frames(files) - - file_name_template = frame_placeholder = None - for file_name, frame in sources_and_frames.items(): - frame_placeholder = "#" * len(frame) - file_name_template = os.path.basename( - file_name.replace(frame, frame_placeholder)) - break - - return file_name_template, frame_placeholder - - def _get_job_info(self, job_id): - """ - Calls DL for actual job info for 'job_id' - - Might be different than job info saved in metadata.json if user - manually changes job pre/during rendering. - """ - # get default deadline webservice url from deadline module - deadline_url = self.instance.context.data["defaultDeadline"] - # if custom one is set in instance, use that - if self.instance.data.get("deadlineUrl"): - deadline_url = self.instance.data.get("deadlineUrl") - assert deadline_url, "Requires Deadline Webservice URL" - - url = "{}/api/jobs?JobID={}".format(deadline_url, job_id) - try: - response = requests_get(url) - except requests.exceptions.ConnectionError: - print("Deadline is not accessible at {}".format(deadline_url)) - # self.log("Deadline is not accessible at {}".format(deadline_url)) - return {} - - if not response.ok: - self.log.error("Submission failed!") - self.log.error(response.status_code) - self.log.error(response.content) - raise RuntimeError(response.text) - - json_content = response.json() - if json_content: - return json_content.pop() - return {} - - def _parse_metadata_json(self, json_path): - if not os.path.exists(json_path): - msg = "Metadata file {} doesn't exist".format(json_path) - raise RuntimeError(msg) - - with open(json_path) as fp: - try: - return json.load(fp) - except Exception as exc: - self.log.error( - "Error loading json: " - "{} - Exception: {}".format(json_path, exc) - ) - - def _get_existing_files(self, out_dir): - """Returns set of existing file names from 'out_dir'""" - existing_files = set() - for file_name in os.listdir(out_dir): - existing_files.add(file_name) - return existing_files - - def _get_expected_files(self, repre): - """Returns set of file names from metadata.json""" - expected_files = set() - - files = repre["files"] - if not isinstance(files, list): - files = [files] - - for file_name in files: - expected_files.add(file_name) - return expected_files diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_job_killer.py b/openpype/modules/default_modules/ftrack/event_handlers_user/action_job_killer.py deleted file mode 100644 index af24e0280d..0000000000 --- a/openpype/modules/default_modules/ftrack/event_handlers_user/action_job_killer.py +++ /dev/null @@ -1,117 +0,0 @@ -import json -from openpype_modules.ftrack.lib import BaseAction, statics_icon - - -class JobKiller(BaseAction): - '''Edit meta data action.''' - - #: Action identifier. - identifier = 'job.killer' - #: Action label. - label = "OpenPype Admin" - variant = '- Job Killer' - #: Action description. - description = 'Killing selected running jobs' - #: roles that are allowed to register this action - icon = statics_icon("ftrack", "action_icons", "OpenPypeAdmin.svg") - settings_key = "job_killer" - - def discover(self, session, entities, event): - ''' Validation ''' - return self.valid_roles(session, entities, event) - - def interface(self, session, entities, event): - if not event['data'].get('values', {}): - title = 'Select jobs to kill' - - jobs = session.query( - 'select id, status from Job' - ' where status in ("queued", "running")' - ).all() - - items = [] - - item_splitter = {'type': 'label', 'value': '---'} - for job in jobs: - try: - data = json.loads(job['data']) - desctiption = data['description'] - except Exception: - desctiption = '*No description*' - user = job['user']['username'] - created = job['created_at'].strftime('%d.%m.%Y %H:%M:%S') - label = '{} - {} - {}'.format( - desctiption, created, user - ) - item_label = { - 'type': 'label', - 'value': label - } - item = { - 'name': job['id'], - 'type': 'boolean', - 'value': False - } - if len(items) > 0: - items.append(item_splitter) - items.append(item_label) - items.append(item) - - if len(items) == 0: - return { - 'success': False, - 'message': 'Didn\'t found any running jobs' - } - else: - return { - 'items': items, - 'title': title - } - - def launch(self, session, entities, event): - """ GET JOB """ - if 'values' not in event['data']: - return - - values = event['data']['values'] - if len(values) <= 0: - return { - 'success': True, - 'message': 'No jobs to kill!' - } - jobs = [] - job_ids = [] - - for k, v in values.items(): - if v is True: - job_ids.append(k) - - for id in job_ids: - query = 'Job where id is "{}"'.format(id) - jobs.append(session.query(query).one()) - # Update all the queried jobs, setting the status to failed. - for job in jobs: - try: - origin_status = job["status"] - job['status'] = 'failed' - session.commit() - self.log.debug(( - 'Changing Job ({}) status: {} -> failed' - ).format(job['id'], origin_status)) - except Exception: - session.rollback() - self.log.warning(( - 'Changing Job ({}) has failed' - ).format(job['id'])) - - self.log.info('All running jobs were killed Successfully!') - return { - 'success': True, - 'message': 'All running jobs were killed Successfully!' - } - - -def register(session): - '''Register plugin. Called when used as an plugin.''' - - JobKiller(session).register() diff --git a/openpype/modules/default_modules/ftrack/python2_vendor/arrow b/openpype/modules/default_modules/ftrack/python2_vendor/arrow deleted file mode 160000 index b746fedf72..0000000000 --- a/openpype/modules/default_modules/ftrack/python2_vendor/arrow +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b746fedf7286c3755a46f07ab72f4c414cd41fc0 diff --git a/openpype/modules/default_modules/ftrack/python2_vendor/ftrack-python-api b/openpype/modules/default_modules/ftrack/python2_vendor/ftrack-python-api deleted file mode 160000 index d277f474ab..0000000000 --- a/openpype/modules/default_modules/ftrack/python2_vendor/ftrack-python-api +++ /dev/null @@ -1 +0,0 @@ -Subproject commit d277f474ab016e7b53479c36af87cb861d0cc53e diff --git a/openpype/modules/default_modules/ftrack/__init__.py b/openpype/modules/ftrack/__init__.py similarity index 100% rename from openpype/modules/default_modules/ftrack/__init__.py rename to openpype/modules/ftrack/__init__.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/action_clone_review_session.py b/openpype/modules/ftrack/event_handlers_server/action_clone_review_session.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/action_clone_review_session.py rename to openpype/modules/ftrack/event_handlers_server/action_clone_review_session.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/action_multiple_notes.py b/openpype/modules/ftrack/event_handlers_server/action_multiple_notes.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/action_multiple_notes.py rename to openpype/modules/ftrack/event_handlers_server/action_multiple_notes.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/action_prepare_project.py b/openpype/modules/ftrack/event_handlers_server/action_prepare_project.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/action_prepare_project.py rename to openpype/modules/ftrack/event_handlers_server/action_prepare_project.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/action_private_project_detection.py b/openpype/modules/ftrack/event_handlers_server/action_private_project_detection.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/action_private_project_detection.py rename to openpype/modules/ftrack/event_handlers_server/action_private_project_detection.py diff --git a/openpype/modules/default_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 similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/action_push_frame_values_to_task.py rename to openpype/modules/ftrack/event_handlers_server/action_push_frame_values_to_task.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/action_sync_to_avalon.py b/openpype/modules/ftrack/event_handlers_server/action_sync_to_avalon.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/action_sync_to_avalon.py rename to openpype/modules/ftrack/event_handlers_server/action_sync_to_avalon.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_del_avalon_id_from_new.py b/openpype/modules/ftrack/event_handlers_server/event_del_avalon_id_from_new.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_del_avalon_id_from_new.py rename to openpype/modules/ftrack/event_handlers_server/event_del_avalon_id_from_new.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_first_version_status.py b/openpype/modules/ftrack/event_handlers_server/event_first_version_status.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_first_version_status.py rename to openpype/modules/ftrack/event_handlers_server/event_first_version_status.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_next_task_update.py b/openpype/modules/ftrack/event_handlers_server/event_next_task_update.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_next_task_update.py rename to openpype/modules/ftrack/event_handlers_server/event_next_task_update.py diff --git a/openpype/modules/default_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 similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_push_frame_values_to_task.py rename to openpype/modules/ftrack/event_handlers_server/event_push_frame_values_to_task.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_radio_buttons.py b/openpype/modules/ftrack/event_handlers_server/event_radio_buttons.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_radio_buttons.py rename to openpype/modules/ftrack/event_handlers_server/event_radio_buttons.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_sync_links.py b/openpype/modules/ftrack/event_handlers_server/event_sync_links.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_sync_links.py rename to openpype/modules/ftrack/event_handlers_server/event_sync_links.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_sync_to_avalon.py b/openpype/modules/ftrack/event_handlers_server/event_sync_to_avalon.py similarity index 98% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_sync_to_avalon.py rename to openpype/modules/ftrack/event_handlers_server/event_sync_to_avalon.py index 9f85000dbb..eea6436b53 100644 --- a/openpype/modules/default_modules/ftrack/event_handlers_server/event_sync_to_avalon.py +++ b/openpype/modules/ftrack/event_handlers_server/event_sync_to_avalon.py @@ -20,11 +20,16 @@ from openpype_modules.ftrack.lib import ( query_custom_attributes, CUST_ATTR_ID_KEY, CUST_ATTR_AUTO_SYNC, + FPS_KEYS, avalon_sync, BaseEvent ) +from openpype_modules.ftrack.lib.avalon_sync import ( + convert_to_fps, + InvalidFpsValue +) from openpype.lib import CURRENT_DOC_SCHEMAS @@ -1149,12 +1154,31 @@ class SyncToAvalonEvent(BaseEvent): "description": ftrack_ent["description"] } } + invalid_fps_items = [] cust_attrs = self.get_cust_attr_values(ftrack_ent) for key, val in cust_attrs.items(): if key.startswith("avalon_"): continue + + if key in FPS_KEYS: + try: + val = convert_to_fps(val) + except InvalidFpsValue: + invalid_fps_items.append((ftrack_ent["id"], val)) + continue + final_entity["data"][key] = val + if invalid_fps_items: + fps_msg = ( + "These entities have invalid fps value in custom attributes" + ) + items = [] + for entity_id, value in invalid_fps_items: + ent_path = self.get_ent_path(entity_id) + items.append("{} - \"{}\"".format(ent_path, value)) + self.report_items["error"][fps_msg] = items + _mongo_id_str = cust_attrs.get(CUST_ATTR_ID_KEY) if _mongo_id_str: try: @@ -2155,11 +2179,19 @@ class SyncToAvalonEvent(BaseEvent): ) convert_types_by_id[attr_id] = convert_type + default_value = attr["default"] + if key in FPS_KEYS: + try: + default_value = convert_to_fps(default_value) + except InvalidFpsValue: + pass + entities_dict[ftrack_project_id]["hier_attrs"][key] = ( attr["default"] ) # PREPARE DATA BEFORE THIS + invalid_fps_items = [] avalon_hier = [] for item in values: value = item["value"] @@ -2173,8 +2205,25 @@ class SyncToAvalonEvent(BaseEvent): if convert_type: value = convert_type(value) + + if key in FPS_KEYS: + try: + value = convert_to_fps(value) + except InvalidFpsValue: + invalid_fps_items.append((entity_id, value)) + continue entities_dict[entity_id]["hier_attrs"][key] = value + if invalid_fps_items: + fps_msg = ( + "These entities have invalid fps value in custom attributes" + ) + items = [] + for entity_id, value in invalid_fps_items: + ent_path = self.get_ent_path(entity_id) + items.append("{} - \"{}\"".format(ent_path, value)) + self.report_items["error"][fps_msg] = items + # Get dictionary with not None hierarchical values to pull to childs project_values = {} for key, value in ( diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_task_to_parent_status.py b/openpype/modules/ftrack/event_handlers_server/event_task_to_parent_status.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_task_to_parent_status.py rename to openpype/modules/ftrack/event_handlers_server/event_task_to_parent_status.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_task_to_version_status.py b/openpype/modules/ftrack/event_handlers_server/event_task_to_version_status.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_task_to_version_status.py rename to openpype/modules/ftrack/event_handlers_server/event_task_to_version_status.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_thumbnail_updates.py b/openpype/modules/ftrack/event_handlers_server/event_thumbnail_updates.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_thumbnail_updates.py rename to openpype/modules/ftrack/event_handlers_server/event_thumbnail_updates.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_user_assigment.py b/openpype/modules/ftrack/event_handlers_server/event_user_assigment.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_user_assigment.py rename to openpype/modules/ftrack/event_handlers_server/event_user_assigment.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_version_to_task_statuses.py b/openpype/modules/ftrack/event_handlers_server/event_version_to_task_statuses.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_server/event_version_to_task_statuses.py rename to openpype/modules/ftrack/event_handlers_server/event_version_to_task_statuses.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_applications.py b/openpype/modules/ftrack/event_handlers_user/action_applications.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_applications.py rename to openpype/modules/ftrack/event_handlers_user/action_applications.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_batch_task_creation.py b/openpype/modules/ftrack/event_handlers_user/action_batch_task_creation.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_batch_task_creation.py rename to openpype/modules/ftrack/event_handlers_user/action_batch_task_creation.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_clean_hierarchical_attributes.py b/openpype/modules/ftrack/event_handlers_user/action_clean_hierarchical_attributes.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_clean_hierarchical_attributes.py rename to openpype/modules/ftrack/event_handlers_user/action_clean_hierarchical_attributes.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_client_review_sort.py b/openpype/modules/ftrack/event_handlers_user/action_client_review_sort.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_client_review_sort.py rename to openpype/modules/ftrack/event_handlers_user/action_client_review_sort.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_component_open.py b/openpype/modules/ftrack/event_handlers_user/action_component_open.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_component_open.py rename to openpype/modules/ftrack/event_handlers_user/action_component_open.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_create_cust_attrs.py b/openpype/modules/ftrack/event_handlers_user/action_create_cust_attrs.py similarity index 97% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_create_cust_attrs.py rename to openpype/modules/ftrack/event_handlers_user/action_create_cust_attrs.py index cb5b88ad50..88dc8213bd 100644 --- a/openpype/modules/default_modules/ftrack/event_handlers_user/action_create_cust_attrs.py +++ b/openpype/modules/ftrack/event_handlers_user/action_create_cust_attrs.py @@ -11,6 +11,7 @@ from openpype_modules.ftrack.lib import ( CUST_ATTR_TOOLS, CUST_ATTR_APPLICATIONS, CUST_ATTR_INTENT, + FPS_KEYS, default_custom_attributes_definition, app_definitions_from_app_manager, @@ -519,20 +520,28 @@ class CustomAttributes(BaseAction): self.show_message(event, msg) def process_attribute(self, data): - existing_attrs = self.session.query( - "CustomAttributeConfiguration" - ).all() + existing_attrs = self.session.query(( + "select is_hierarchical, key, type, entity_type, object_type_id" + " from CustomAttributeConfiguration" + )).all() matching = [] + is_hierarchical = data.get("is_hierarchical", False) for attr in existing_attrs: if ( - attr["key"] != data["key"] or - attr["type"]["name"] != data["type"]["name"] + is_hierarchical != attr["is_hierarchical"] + or attr["key"] != data["key"] ): continue - if data.get("is_hierarchical") is True: - if attr["is_hierarchical"] is True: - matching.append(attr) + if attr["type"]["name"] != data["type"]["name"]: + if data["key"] in FPS_KEYS and attr["type"]["name"] == "text": + self.log.info("Kept 'fps' as text custom attribute.") + return + continue + + if is_hierarchical: + matching.append(attr) + elif "object_type_id" in data: if ( attr["entity_type"] == data["entity_type"] and diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_create_folders.py b/openpype/modules/ftrack/event_handlers_user/action_create_folders.py similarity index 99% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_create_folders.py rename to openpype/modules/ftrack/event_handlers_user/action_create_folders.py index 8bbef9ad73..d15a865124 100644 --- a/openpype/modules/default_modules/ftrack/event_handlers_user/action_create_folders.py +++ b/openpype/modules/ftrack/event_handlers_user/action_create_folders.py @@ -97,7 +97,6 @@ class CreateFolders(BaseAction): all_entities = self.get_notask_children(entity) anatomy = Anatomy(project_name) - project_settings = get_project_settings(project_name) work_keys = ["work", "folder"] work_template = anatomy.templates diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_create_project_structure.py b/openpype/modules/ftrack/event_handlers_user/action_create_project_structure.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_create_project_structure.py rename to openpype/modules/ftrack/event_handlers_user/action_create_project_structure.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_delete_asset.py b/openpype/modules/ftrack/event_handlers_user/action_delete_asset.py similarity index 96% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_delete_asset.py rename to openpype/modules/ftrack/event_handlers_user/action_delete_asset.py index 676dd80e93..94385a36c5 100644 --- a/openpype/modules/default_modules/ftrack/event_handlers_user/action_delete_asset.py +++ b/openpype/modules/ftrack/event_handlers_user/action_delete_asset.py @@ -3,8 +3,9 @@ import uuid from datetime import datetime from bson.objectid import ObjectId -from openpype_modules.ftrack.lib import BaseAction, statics_icon from avalon.api import AvalonMongoDB +from openpype_modules.ftrack.lib import BaseAction, statics_icon +from openpype_modules.ftrack.lib.avalon_sync import create_chunks class DeleteAssetSubset(BaseAction): @@ -554,8 +555,8 @@ class DeleteAssetSubset(BaseAction): ftrack_proc_txt, ", ".join(ftrack_ids_to_delete) )) - entities_by_link_len = ( - self._filter_entities_to_delete(ftrack_ids_to_delete, session) + entities_by_link_len = self._prepare_entities_before_delete( + ftrack_ids_to_delete, session ) for link_len in sorted(entities_by_link_len.keys(), reverse=True): for entity in entities_by_link_len[link_len]: @@ -609,7 +610,7 @@ class DeleteAssetSubset(BaseAction): return self.report_handle(report_messages, project_name, event) - def _filter_entities_to_delete(self, ftrack_ids_to_delete, session): + def _prepare_entities_before_delete(self, ftrack_ids_to_delete, session): """Filter children entities to avoid CircularDependencyError.""" joined_ids_to_delete = ", ".join( ["\"{}\"".format(id) for id in ftrack_ids_to_delete] @@ -638,6 +639,21 @@ class DeleteAssetSubset(BaseAction): parent_ids_to_delete.append(entity["id"]) to_delete_entities.append(entity) + # Unset 'task_id' from AssetVersion entities + # - when task is deleted the asset version is not marked for deletion + task_ids = set( + entity["id"] + for entity in to_delete_entities + if entity.entity_type.lower() == "task" + ) + for chunk in create_chunks(task_ids): + asset_versions = session.query(( + "select id, task_id from AssetVersion where task_id in ({})" + ).format(self.join_query_keys(chunk))).all() + for asset_version in asset_versions: + asset_version["task_id"] = None + session.commit() + entities_by_link_len = collections.defaultdict(list) for entity in to_delete_entities: entities_by_link_len[len(entity["link"])].append(entity) diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_delete_old_versions.py b/openpype/modules/ftrack/event_handlers_user/action_delete_old_versions.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_delete_old_versions.py rename to openpype/modules/ftrack/event_handlers_user/action_delete_old_versions.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_delivery.py b/openpype/modules/ftrack/event_handlers_user/action_delivery.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_delivery.py rename to openpype/modules/ftrack/event_handlers_user/action_delivery.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_djvview.py b/openpype/modules/ftrack/event_handlers_user/action_djvview.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_djvview.py rename to openpype/modules/ftrack/event_handlers_user/action_djvview.py diff --git a/openpype/modules/ftrack/event_handlers_user/action_job_killer.py b/openpype/modules/ftrack/event_handlers_user/action_job_killer.py new file mode 100644 index 0000000000..f489c0c54c --- /dev/null +++ b/openpype/modules/ftrack/event_handlers_user/action_job_killer.py @@ -0,0 +1,134 @@ +import json +from openpype_modules.ftrack.lib import BaseAction, statics_icon + + +class JobKiller(BaseAction): + """Kill jobs that are marked as running.""" + + identifier = "job.killer" + label = "OpenPype Admin" + variant = "- Job Killer" + description = "Killing selected running jobs" + icon = statics_icon("ftrack", "action_icons", "OpenPypeAdmin.svg") + settings_key = "job_killer" + + def discover(self, session, entities, event): + """Check if action is available for user role.""" + return self.valid_roles(session, entities, event) + + def interface(self, session, entities, event): + if event["data"].get("values"): + return + + title = "Select jobs to kill" + + jobs = session.query( + "select id, user_id, status, created_at, data from Job" + " where status in (\"queued\", \"running\")" + ).all() + if not jobs: + return { + "success": True, + "message": "Didn't found any running jobs" + } + + # Collect user ids from jobs + user_ids = set() + for job in jobs: + user_id = job["user_id"] + if user_id: + user_ids.add(user_id) + + # Store usernames by their ids + usernames_by_id = {} + if user_ids: + users = session.query( + "select id, username from User where id in ({})".format( + self.join_query_keys(user_ids) + ) + ).all() + for user in users: + usernames_by_id[user["id"]] = user["username"] + + items = [] + for job in jobs: + try: + data = json.loads(job["data"]) + desctiption = data["description"] + except Exception: + desctiption = "*No description*" + user_id = job["user_id"] + username = usernames_by_id.get(user_id) or "Unknown user" + created = job["created_at"].strftime('%d.%m.%Y %H:%M:%S') + label = "{} - {} - {}".format( + username, desctiption, created + ) + item_label = { + "type": "label", + "value": label + } + item = { + "name": job["id"], + "type": "boolean", + "value": False + } + if len(items) > 0: + items.append({"type": "label", "value": "---"}) + items.append(item_label) + items.append(item) + + return { + "items": items, + "title": title + } + + def launch(self, session, entities, event): + if "values" not in event["data"]: + return + + values = event["data"]["values"] + if len(values) < 1: + return { + "success": True, + "message": "No jobs to kill!" + } + + job_ids = set() + for job_id, kill_job in values.items(): + if kill_job: + job_ids.add(job_id) + + jobs = session.query( + "select id, status from Job where id in ({})".format( + self.join_query_keys(job_ids) + ) + ).all() + + # Update all the queried jobs, setting the status to failed. + for job in jobs: + try: + origin_status = job["status"] + self.log.debug(( + 'Changing Job ({}) status: {} -> failed' + ).format(job["id"], origin_status)) + + job["status"] = "failed" + session.commit() + + except Exception: + session.rollback() + self.log.warning(( + "Changing Job ({}) has failed" + ).format(job["id"])) + + self.log.info("All selected jobs were killed Successfully!") + return { + "success": True, + "message": "All selected jobs were killed Successfully!" + } + + +def register(session): + '''Register plugin. Called when used as an plugin.''' + + JobKiller(session).register() diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_multiple_notes.py b/openpype/modules/ftrack/event_handlers_user/action_multiple_notes.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_multiple_notes.py rename to openpype/modules/ftrack/event_handlers_user/action_multiple_notes.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_prepare_project.py b/openpype/modules/ftrack/event_handlers_user/action_prepare_project.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_prepare_project.py rename to openpype/modules/ftrack/event_handlers_user/action_prepare_project.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_rv.py b/openpype/modules/ftrack/event_handlers_user/action_rv.py similarity index 98% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_rv.py rename to openpype/modules/ftrack/event_handlers_user/action_rv.py index 71d790f7e7..bdb0eaf250 100644 --- a/openpype/modules/default_modules/ftrack/event_handlers_user/action_rv.py +++ b/openpype/modules/ftrack/event_handlers_user/action_rv.py @@ -3,9 +3,10 @@ import subprocess import traceback import json -from openpype_modules.ftrack.lib import BaseAction, statics_icon import ftrack_api from avalon import io, api +from openpype.pipeline import get_representation_path +from openpype_modules.ftrack.lib import BaseAction, statics_icon class RVAction(BaseAction): @@ -307,7 +308,7 @@ class RVAction(BaseAction): "name": "preview" } ) - paths.append(api.get_representation_path(representation)) + paths.append(get_representation_path(representation)) return paths diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_seed.py b/openpype/modules/ftrack/event_handlers_user/action_seed.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_seed.py rename to openpype/modules/ftrack/event_handlers_user/action_seed.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_store_thumbnails_to_avalon.py b/openpype/modules/ftrack/event_handlers_user/action_store_thumbnails_to_avalon.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_store_thumbnails_to_avalon.py rename to openpype/modules/ftrack/event_handlers_user/action_store_thumbnails_to_avalon.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_sync_to_avalon.py b/openpype/modules/ftrack/event_handlers_user/action_sync_to_avalon.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_sync_to_avalon.py rename to openpype/modules/ftrack/event_handlers_user/action_sync_to_avalon.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_test.py b/openpype/modules/ftrack/event_handlers_user/action_test.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_test.py rename to openpype/modules/ftrack/event_handlers_user/action_test.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_thumbnail_to_childern.py b/openpype/modules/ftrack/event_handlers_user/action_thumbnail_to_childern.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_thumbnail_to_childern.py rename to openpype/modules/ftrack/event_handlers_user/action_thumbnail_to_childern.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_thumbnail_to_parent.py b/openpype/modules/ftrack/event_handlers_user/action_thumbnail_to_parent.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_thumbnail_to_parent.py rename to openpype/modules/ftrack/event_handlers_user/action_thumbnail_to_parent.py diff --git a/openpype/modules/default_modules/ftrack/event_handlers_user/action_where_run_ask.py b/openpype/modules/ftrack/event_handlers_user/action_where_run_ask.py similarity index 100% rename from openpype/modules/default_modules/ftrack/event_handlers_user/action_where_run_ask.py rename to openpype/modules/ftrack/event_handlers_user/action_where_run_ask.py diff --git a/openpype/modules/default_modules/ftrack/ftrack_module.py b/openpype/modules/ftrack/ftrack_module.py similarity index 100% rename from openpype/modules/default_modules/ftrack/ftrack_module.py rename to openpype/modules/ftrack/ftrack_module.py diff --git a/openpype/modules/default_modules/ftrack/ftrack_server/__init__.py b/openpype/modules/ftrack/ftrack_server/__init__.py similarity index 100% rename from openpype/modules/default_modules/ftrack/ftrack_server/__init__.py rename to openpype/modules/ftrack/ftrack_server/__init__.py diff --git a/openpype/modules/default_modules/ftrack/ftrack_server/event_server_cli.py b/openpype/modules/ftrack/ftrack_server/event_server_cli.py similarity index 100% rename from openpype/modules/default_modules/ftrack/ftrack_server/event_server_cli.py rename to openpype/modules/ftrack/ftrack_server/event_server_cli.py diff --git a/openpype/modules/default_modules/ftrack/ftrack_server/ftrack_server.py b/openpype/modules/ftrack/ftrack_server/ftrack_server.py similarity index 100% rename from openpype/modules/default_modules/ftrack/ftrack_server/ftrack_server.py rename to openpype/modules/ftrack/ftrack_server/ftrack_server.py diff --git a/openpype/modules/default_modules/ftrack/ftrack_server/lib.py b/openpype/modules/ftrack/ftrack_server/lib.py similarity index 100% rename from openpype/modules/default_modules/ftrack/ftrack_server/lib.py rename to openpype/modules/ftrack/ftrack_server/lib.py diff --git a/openpype/modules/default_modules/ftrack/ftrack_server/socket_thread.py b/openpype/modules/ftrack/ftrack_server/socket_thread.py similarity index 100% rename from openpype/modules/default_modules/ftrack/ftrack_server/socket_thread.py rename to openpype/modules/ftrack/ftrack_server/socket_thread.py diff --git a/openpype/modules/default_modules/ftrack/launch_hooks/post_ftrack_changes.py b/openpype/modules/ftrack/launch_hooks/post_ftrack_changes.py similarity index 100% rename from openpype/modules/default_modules/ftrack/launch_hooks/post_ftrack_changes.py rename to openpype/modules/ftrack/launch_hooks/post_ftrack_changes.py diff --git a/openpype/modules/default_modules/ftrack/launch_hooks/pre_python2_vendor.py b/openpype/modules/ftrack/launch_hooks/pre_python2_vendor.py similarity index 100% rename from openpype/modules/default_modules/ftrack/launch_hooks/pre_python2_vendor.py rename to openpype/modules/ftrack/launch_hooks/pre_python2_vendor.py diff --git a/openpype/modules/default_modules/ftrack/lib/__init__.py b/openpype/modules/ftrack/lib/__init__.py similarity index 93% rename from openpype/modules/default_modules/ftrack/lib/__init__.py rename to openpype/modules/ftrack/lib/__init__.py index 80b4db9dd6..7fc2bc99eb 100644 --- a/openpype/modules/default_modules/ftrack/lib/__init__.py +++ b/openpype/modules/ftrack/lib/__init__.py @@ -4,7 +4,8 @@ from .constants import ( CUST_ATTR_GROUP, CUST_ATTR_TOOLS, CUST_ATTR_APPLICATIONS, - CUST_ATTR_INTENT + CUST_ATTR_INTENT, + FPS_KEYS ) from .settings import ( get_ftrack_event_mongo_info @@ -30,6 +31,8 @@ __all__ = ( "CUST_ATTR_GROUP", "CUST_ATTR_TOOLS", "CUST_ATTR_APPLICATIONS", + "CUST_ATTR_INTENT", + "FPS_KEYS", "get_ftrack_event_mongo_info", diff --git a/openpype/modules/default_modules/ftrack/lib/avalon_sync.py b/openpype/modules/ftrack/lib/avalon_sync.py similarity index 95% rename from openpype/modules/default_modules/ftrack/lib/avalon_sync.py rename to openpype/modules/ftrack/lib/avalon_sync.py index 06e8784287..5301ec568e 100644 --- a/openpype/modules/default_modules/ftrack/lib/avalon_sync.py +++ b/openpype/modules/ftrack/lib/avalon_sync.py @@ -2,6 +2,9 @@ import re import json import collections import copy +import numbers + +import six from avalon.api import AvalonMongoDB @@ -14,7 +17,7 @@ from openpype.api import ( ) from openpype.lib import ApplicationManager -from .constants import CUST_ATTR_ID_KEY +from .constants import CUST_ATTR_ID_KEY, FPS_KEYS from .custom_attributes import get_openpype_attr, query_custom_attributes from bson.objectid import ObjectId @@ -33,6 +36,130 @@ CURRENT_DOC_SCHEMAS = { } +class InvalidFpsValue(Exception): + pass + + +def is_string_number(value): + """Can string value be converted to number (float).""" + if not isinstance(value, six.string_types): + raise TypeError("Expected {} got {}".format( + ", ".join(str(t) for t in six.string_types), str(type(value)) + )) + if value == ".": + return False + + if value.startswith("."): + value = "0" + value + elif value.endswith("."): + value = value + "0" + + if re.match(r"^\d+(\.\d+)?$", value) is None: + return False + return True + + +def convert_to_fps(source_value): + """Convert value into fps value. + + Non string values are kept untouched. String is tried to convert. + Valid values: + "1000" + "1000.05" + "1000,05" + ",05" + ".05" + "1000," + "1000." + "1000/1000" + "1000.05/1000" + "1000/1000.05" + "1000.05/1000.05" + "1000,05/1000" + "1000/1000,05" + "1000,05/1000,05" + + Invalid values: + "/" + "/1000" + "1000/" + "," + "." + ...any other string + + Returns: + float: Converted value. + + Raises: + InvalidFpsValue: When value can't be converted to float. + """ + if not isinstance(source_value, six.string_types): + if isinstance(source_value, numbers.Number): + return float(source_value) + return source_value + + value = source_value.strip().replace(",", ".") + if not value: + raise InvalidFpsValue("Got empty value") + + subs = value.split("/") + if len(subs) == 1: + str_value = subs[0] + if not is_string_number(str_value): + raise InvalidFpsValue( + "Value \"{}\" can't be converted to number.".format(value) + ) + return float(str_value) + + elif len(subs) == 2: + divident, divisor = subs + if not divident or not is_string_number(divident): + raise InvalidFpsValue( + "Divident value \"{}\" can't be converted to number".format( + divident + ) + ) + + if not divisor or not is_string_number(divisor): + raise InvalidFpsValue( + "Divisor value \"{}\" can't be converted to number".format( + divident + ) + ) + divisor_float = float(divisor) + if divisor_float == 0.0: + raise InvalidFpsValue("Can't divide by zero") + return float(divident) / divisor_float + + raise InvalidFpsValue( + "Value can't be converted to number \"{}\"".format(source_value) + ) + + +def create_chunks(iterable, chunk_size=None): + """Separate iterable into multiple chunks by size. + + Args: + iterable(list|tuple|set): Object that will be separated into chunks. + chunk_size(int): Size of one chunk. Default value is 200. + + Returns: + list: Chunked items. + """ + chunks = [] + if not iterable: + return chunks + + tupled_iterable = tuple(iterable) + iterable_size = len(tupled_iterable) + if chunk_size is None: + chunk_size = 200 + + for idx in range(0, iterable_size, chunk_size): + chunks.append(tupled_iterable[idx:idx + chunk_size]) + return chunks + + def check_regex(name, entity_type, in_schema=None, schema_patterns=None): schema_name = "asset-3.0" if in_schema: @@ -956,6 +1083,7 @@ class SyncEntitiesFactory: sync_ids ) + invalid_fps_items = [] for item in items: entity_id = item["entity_id"] attr_id = item["configuration_id"] @@ -968,8 +1096,24 @@ class SyncEntitiesFactory: value = item["value"] if convert_type: value = convert_type(value) + + if key in FPS_KEYS: + try: + value = convert_to_fps(value) + except InvalidFpsValue: + invalid_fps_items.append((entity_id, value)) self.entities_dict[entity_id][store_key][key] = value + if invalid_fps_items: + fps_msg = ( + "These entities have invalid fps value in custom attributes" + ) + items = [] + for entity_id, value in invalid_fps_items: + ent_path = self.get_ent_path(entity_id) + items.append("{} - \"{}\"".format(ent_path, value)) + self.report_items["error"][fps_msg] = items + # process hierarchical attributes self.set_hierarchical_attribute( hier_attrs, sync_ids, cust_attr_type_name_by_id @@ -1002,8 +1146,15 @@ class SyncEntitiesFactory: if key.startswith("avalon_"): store_key = "avalon_attrs" + default_value = attr["default"] + if key in FPS_KEYS: + try: + default_value = convert_to_fps(default_value) + except InvalidFpsValue: + pass + self.entities_dict[self.ft_project_id][store_key][key] = ( - attr["default"] + default_value ) # Add attribute ids to entities dictionary @@ -1045,6 +1196,7 @@ class SyncEntitiesFactory: True ) + invalid_fps_items = [] avalon_hier = [] for item in items: value = item["value"] @@ -1064,6 +1216,13 @@ class SyncEntitiesFactory: entity_id = item["entity_id"] key = attribute_key_by_id[attr_id] + if key in FPS_KEYS: + try: + value = convert_to_fps(value) + except InvalidFpsValue: + invalid_fps_items.append((entity_id, value)) + continue + if key.startswith("avalon_"): store_key = "avalon_attrs" avalon_hier.append(key) @@ -1071,6 +1230,16 @@ class SyncEntitiesFactory: store_key = "hier_attrs" self.entities_dict[entity_id][store_key][key] = value + if invalid_fps_items: + fps_msg = ( + "These entities have invalid fps value in custom attributes" + ) + items = [] + for entity_id, value in invalid_fps_items: + ent_path = self.get_ent_path(entity_id) + items.append("{} - \"{}\"".format(ent_path, value)) + self.report_items["error"][fps_msg] = items + # Get dictionary with not None hierarchical values to pull to childs top_id = self.ft_project_id project_values = {} @@ -1147,10 +1316,8 @@ class SyncEntitiesFactory: ids_len = len(tupled_ids) chunk_size = int(5000 / ids_len) all_links = [] - for idx in range(0, ids_len, chunk_size): - entity_ids_joined = join_query_keys( - tupled_ids[idx:idx + chunk_size] - ) + for chunk in create_chunks(ftrack_ids, chunk_size): + entity_ids_joined = join_query_keys(chunk) all_links.extend(self.session.query(( "select from_id, to_id from" diff --git a/openpype/modules/default_modules/ftrack/lib/constants.py b/openpype/modules/ftrack/lib/constants.py similarity index 85% rename from openpype/modules/default_modules/ftrack/lib/constants.py rename to openpype/modules/ftrack/lib/constants.py index e6e2013d2b..636dcfbc3d 100644 --- a/openpype/modules/default_modules/ftrack/lib/constants.py +++ b/openpype/modules/ftrack/lib/constants.py @@ -12,3 +12,9 @@ CUST_ATTR_APPLICATIONS = "applications" CUST_ATTR_TOOLS = "tools_env" # Intent custom attribute name CUST_ATTR_INTENT = "intent" + +FPS_KEYS = { + "fps", + # For development purposes + "fps_string" +} diff --git a/openpype/modules/default_modules/ftrack/lib/credentials.py b/openpype/modules/ftrack/lib/credentials.py similarity index 100% rename from openpype/modules/default_modules/ftrack/lib/credentials.py rename to openpype/modules/ftrack/lib/credentials.py diff --git a/openpype/modules/default_modules/ftrack/lib/custom_attributes.json b/openpype/modules/ftrack/lib/custom_attributes.json similarity index 100% rename from openpype/modules/default_modules/ftrack/lib/custom_attributes.json rename to openpype/modules/ftrack/lib/custom_attributes.json diff --git a/openpype/modules/default_modules/ftrack/lib/custom_attributes.py b/openpype/modules/ftrack/lib/custom_attributes.py similarity index 100% rename from openpype/modules/default_modules/ftrack/lib/custom_attributes.py rename to openpype/modules/ftrack/lib/custom_attributes.py diff --git a/openpype/modules/default_modules/ftrack/lib/ftrack_action_handler.py b/openpype/modules/ftrack/lib/ftrack_action_handler.py similarity index 100% rename from openpype/modules/default_modules/ftrack/lib/ftrack_action_handler.py rename to openpype/modules/ftrack/lib/ftrack_action_handler.py diff --git a/openpype/modules/default_modules/ftrack/lib/ftrack_base_handler.py b/openpype/modules/ftrack/lib/ftrack_base_handler.py similarity index 100% rename from openpype/modules/default_modules/ftrack/lib/ftrack_base_handler.py rename to openpype/modules/ftrack/lib/ftrack_base_handler.py diff --git a/openpype/modules/default_modules/ftrack/lib/ftrack_event_handler.py b/openpype/modules/ftrack/lib/ftrack_event_handler.py similarity index 100% rename from openpype/modules/default_modules/ftrack/lib/ftrack_event_handler.py rename to openpype/modules/ftrack/lib/ftrack_event_handler.py diff --git a/openpype/modules/default_modules/ftrack/lib/settings.py b/openpype/modules/ftrack/lib/settings.py similarity index 100% rename from openpype/modules/default_modules/ftrack/lib/settings.py rename to openpype/modules/ftrack/lib/settings.py diff --git a/openpype/modules/default_modules/ftrack/plugins/_unused_publish/integrate_ftrack_comments.py b/openpype/modules/ftrack/plugins/_unused_publish/integrate_ftrack_comments.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/_unused_publish/integrate_ftrack_comments.py rename to openpype/modules/ftrack/plugins/_unused_publish/integrate_ftrack_comments.py diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/collect_ftrack_api.py b/openpype/modules/ftrack/plugins/publish/collect_ftrack_api.py similarity index 84% rename from openpype/modules/default_modules/ftrack/plugins/publish/collect_ftrack_api.py rename to openpype/modules/ftrack/plugins/publish/collect_ftrack_api.py index a348617cfc..07af217fb6 100644 --- a/openpype/modules/default_modules/ftrack/plugins/publish/collect_ftrack_api.py +++ b/openpype/modules/ftrack/plugins/publish/collect_ftrack_api.py @@ -1,4 +1,3 @@ -import os import logging import pyblish.api import avalon.api @@ -43,37 +42,48 @@ class CollectFtrackApi(pyblish.api.ContextPlugin): ).format(project_name)) project_entity = project_entities[0] + self.log.debug("Project found: {0}".format(project_entity)) - # Find asset entity - entity_query = ( - 'TypedContext where project_id is "{0}"' - ' and name is "{1}"' - ).format(project_entity["id"], asset_name) - self.log.debug("Asset entity query: < {0} >".format(entity_query)) - asset_entities = [] - for entity in session.query(entity_query).all(): - # Skip tasks - if entity.entity_type.lower() != "task": - asset_entities.append(entity) + asset_entity = None + if asset_name: + # Find asset entity + entity_query = ( + 'TypedContext where project_id is "{0}"' + ' and name is "{1}"' + ).format(project_entity["id"], asset_name) + self.log.debug("Asset entity query: < {0} >".format(entity_query)) + asset_entities = [] + for entity in session.query(entity_query).all(): + # Skip tasks + if entity.entity_type.lower() != "task": + asset_entities.append(entity) - if len(asset_entities) == 0: - raise AssertionError(( - "Entity with name \"{0}\" not found" - " in Ftrack project \"{1}\"." - ).format(asset_name, project_name)) + if len(asset_entities) == 0: + raise AssertionError(( + "Entity with name \"{0}\" not found" + " in Ftrack project \"{1}\"." + ).format(asset_name, project_name)) - elif len(asset_entities) > 1: - raise AssertionError(( - "Found more than one entity with name \"{0}\"" - " in Ftrack project \"{1}\"." - ).format(asset_name, project_name)) + elif len(asset_entities) > 1: + raise AssertionError(( + "Found more than one entity with name \"{0}\"" + " in Ftrack project \"{1}\"." + ).format(asset_name, project_name)) + + asset_entity = asset_entities[0] - asset_entity = asset_entities[0] self.log.debug("Asset found: {0}".format(asset_entity)) + task_entity = None # Find task entity if task is set - if task_name: + if not asset_entity: + self.log.warning( + "Asset entity is not set. Skipping query of task entity." + ) + elif not task_name: + self.log.warning("Task name is not set.") + else: task_query = ( 'Task where name is "{0}" and parent_id is "{1}"' ).format(task_name, asset_entity["id"]) @@ -88,10 +98,6 @@ class CollectFtrackApi(pyblish.api.ContextPlugin): else: self.log.debug("Task entity found: {0}".format(task_entity)) - else: - task_entity = None - self.log.warning("Task name is not set.") - context.data["ftrackSession"] = session context.data["ftrackPythonModule"] = ftrack_api context.data["ftrackProject"] = project_entity diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/collect_ftrack_family.py b/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/publish/collect_ftrack_family.py rename to openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/collect_local_ftrack_creds.py b/openpype/modules/ftrack/plugins/publish/collect_local_ftrack_creds.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/publish/collect_local_ftrack_creds.py rename to openpype/modules/ftrack/plugins/publish/collect_local_ftrack_creds.py diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/collect_username.py b/openpype/modules/ftrack/plugins/publish/collect_username.py similarity index 80% rename from openpype/modules/default_modules/ftrack/plugins/publish/collect_username.py rename to openpype/modules/ftrack/plugins/publish/collect_username.py index 303490189b..a9b746ea51 100644 --- a/openpype/modules/default_modules/ftrack/plugins/publish/collect_username.py +++ b/openpype/modules/ftrack/plugins/publish/collect_username.py @@ -23,8 +23,11 @@ class CollectUsername(pyblish.api.ContextPlugin): Expects "pype.club" user created on Ftrack and FTRACK_BOT_API_KEY env var set up. + Resets `context.data["user"] to correctly populate `version.author` and + `representation.context.username` + """ - order = pyblish.api.CollectorOrder - 0.488 + order = pyblish.api.CollectorOrder + 0.0015 label = "Collect ftrack username" hosts = ["webpublisher", "photoshop"] targets = ["remotepublish", "filespublish", "tvpaint_worker"] @@ -33,7 +36,6 @@ class CollectUsername(pyblish.api.ContextPlugin): def process(self, context): self.log.info("CollectUsername") - os.environ["FTRACK_API_USER"] = os.environ["FTRACK_BOT_API_USER"] os.environ["FTRACK_API_KEY"] = os.environ["FTRACK_BOT_API_KEY"] @@ -57,7 +59,13 @@ class CollectUsername(pyblish.api.ContextPlugin): if not user: raise ValueError( "Couldn't find user with {} email".format(user_email)) - - username = user[0].get("username") + user = user[0] + username = user.get("username") self.log.debug("Resolved ftrack username:: {}".format(username)) os.environ["FTRACK_API_USER"] = username + + burnin_name = username + if '@' in burnin_name: + burnin_name = burnin_name[:burnin_name.index('@')] + os.environ["WEBPUBLISH_OPENPYPE_USERNAME"] = burnin_name + context.data["user"] = burnin_name diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_api.py b/openpype/modules/ftrack/plugins/publish/integrate_ftrack_api.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_api.py rename to openpype/modules/ftrack/plugins/publish/integrate_ftrack_api.py diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_component_overwrite.py b/openpype/modules/ftrack/plugins/publish/integrate_ftrack_component_overwrite.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_component_overwrite.py rename to openpype/modules/ftrack/plugins/publish/integrate_ftrack_component_overwrite.py diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_instances.py b/openpype/modules/ftrack/plugins/publish/integrate_ftrack_instances.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_instances.py rename to openpype/modules/ftrack/plugins/publish/integrate_ftrack_instances.py diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_note.py b/openpype/modules/ftrack/plugins/publish/integrate_ftrack_note.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_note.py rename to openpype/modules/ftrack/plugins/publish/integrate_ftrack_note.py diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_hierarchy_ftrack.py b/openpype/modules/ftrack/plugins/publish/integrate_hierarchy_ftrack.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/publish/integrate_hierarchy_ftrack.py rename to openpype/modules/ftrack/plugins/publish/integrate_hierarchy_ftrack.py diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/validate_custom_ftrack_attributes.py b/openpype/modules/ftrack/plugins/publish/validate_custom_ftrack_attributes.py similarity index 100% rename from openpype/modules/default_modules/ftrack/plugins/publish/validate_custom_ftrack_attributes.py rename to openpype/modules/ftrack/plugins/publish/validate_custom_ftrack_attributes.py diff --git a/openpype/modules/ftrack/python2_vendor/arrow/.gitignore b/openpype/modules/ftrack/python2_vendor/arrow/.gitignore new file mode 100644 index 0000000000..0448d0cf0c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/.gitignore @@ -0,0 +1,211 @@ +README.rst.new + +# Small entry point file for debugging tasks +test.py + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +local/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# Swap +[._]*.s[a-v][a-z] +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] + +# Session +Session.vim +Sessionx.vim + +# Temporary +.netrwhist +*~ +# Auto-generated tag files +tags +# Persistent undo +[._]*.un~ + +.idea/ +.vscode/ + +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk diff --git a/openpype/modules/ftrack/python2_vendor/arrow/.pre-commit-config.yaml b/openpype/modules/ftrack/python2_vendor/arrow/.pre-commit-config.yaml new file mode 100644 index 0000000000..1f5128595b --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/.pre-commit-config.yaml @@ -0,0 +1,41 @@ +default_language_version: + python: python3 +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v3.2.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: fix-encoding-pragma + exclude: ^arrow/_version.py + - id: requirements-txt-fixer + - id: check-ast + - id: check-yaml + - id: check-case-conflict + - id: check-docstring-first + - id: check-merge-conflict + - id: debug-statements + - repo: https://github.com/timothycrosley/isort + rev: 5.4.2 + hooks: + - id: isort + - repo: https://github.com/asottile/pyupgrade + rev: v2.7.2 + hooks: + - id: pyupgrade + - repo: https://github.com/pre-commit/pygrep-hooks + rev: v1.6.0 + hooks: + - id: python-no-eval + - id: python-check-blanket-noqa + - id: rst-backticks + - repo: https://github.com/psf/black + rev: 20.8b1 + hooks: + - id: black + args: [--safe, --quiet] + - repo: https://gitlab.com/pycqa/flake8 + rev: 3.8.3 + hooks: + - id: flake8 + additional_dependencies: [flake8-bugbear] diff --git a/openpype/modules/ftrack/python2_vendor/arrow/CHANGELOG.rst b/openpype/modules/ftrack/python2_vendor/arrow/CHANGELOG.rst new file mode 100644 index 0000000000..0b55a4522c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/CHANGELOG.rst @@ -0,0 +1,598 @@ +Changelog +========= + +0.17.0 (2020-10-2) +------------------- + +- [WARN] Arrow will **drop support** for Python 2.7 and 3.5 in the upcoming 1.0.0 release. This is the last major release to support Python 2.7 and Python 3.5. +- [NEW] Arrow now properly handles imaginary datetimes during DST shifts. For example: + +..code-block:: python + >>> just_before = arrow.get(2013, 3, 31, 1, 55, tzinfo="Europe/Paris") + >>> just_before.shift(minutes=+10) + + +..code-block:: python + >>> before = arrow.get("2018-03-10 23:00:00", "YYYY-MM-DD HH:mm:ss", tzinfo="US/Pacific") + >>> after = arrow.get("2018-03-11 04:00:00", "YYYY-MM-DD HH:mm:ss", tzinfo="US/Pacific") + >>> result=[(t, t.to("utc")) for t in arrow.Arrow.range("hour", before, after)] + >>> for r in result: + ... print(r) + ... + (, ) + (, ) + (, ) + (, ) + (, ) + +- [NEW] Added ``humanize`` week granularity translation for Tagalog. +- [CHANGE] Calls to the ``timestamp`` property now emit a ``DeprecationWarning``. In a future release, ``timestamp`` will be changed to a method to align with Python's datetime module. If you would like to continue using the property, please change your code to use the ``int_timestamp`` or ``float_timestamp`` properties instead. +- [CHANGE] Expanded and improved Catalan locale. +- [FIX] Fixed a bug that caused ``Arrow.range()`` to incorrectly cut off ranges in certain scenarios when using month, quarter, or year endings. +- [FIX] Fixed a bug that caused day of week token parsing to be case sensitive. +- [INTERNAL] A number of functions were reordered in arrow.py for better organization and grouping of related methods. This change will have no impact on usage. +- [INTERNAL] A minimum tox version is now enforced for compatibility reasons. Contributors must use tox >3.18.0 going forward. + +0.16.0 (2020-08-23) +------------------- + +- [WARN] Arrow will **drop support** for Python 2.7 and 3.5 in the upcoming 1.0.0 release. The 0.16.x and 0.17.x releases are the last to support Python 2.7 and 3.5. +- [NEW] Implemented `PEP 495 `_ to handle ambiguous datetimes. This is achieved by the addition of the ``fold`` attribute for Arrow objects. For example: + +.. code-block:: python + + >>> before = Arrow(2017, 10, 29, 2, 0, tzinfo='Europe/Stockholm') + + >>> before.fold + 0 + >>> before.ambiguous + True + >>> after = Arrow(2017, 10, 29, 2, 0, tzinfo='Europe/Stockholm', fold=1) + + >>> after = before.replace(fold=1) + + +- [NEW] Added ``normalize_whitespace`` flag to ``arrow.get``. This is useful for parsing log files and/or any files that may contain inconsistent spacing. For example: + +.. code-block:: python + + >>> arrow.get("Jun 1 2005 1:33PM", "MMM D YYYY H:mmA", normalize_whitespace=True) + + >>> arrow.get("2013-036 \t 04:05:06Z", normalize_whitespace=True) + + +0.15.8 (2020-07-23) +------------------- + +- [WARN] Arrow will **drop support** for Python 2.7 and 3.5 in the upcoming 1.0.0 release. The 0.15.x, 0.16.x, and 0.17.x releases are the last to support Python 2.7 and 3.5. +- [NEW] Added ``humanize`` week granularity translation for Czech. +- [FIX] ``arrow.get`` will now pick sane defaults when weekdays are passed with particular token combinations, see `#446 `_. +- [INTERNAL] Moved arrow to an organization. The repo can now be found `here `_. +- [INTERNAL] Started issuing deprecation warnings for Python 2.7 and 3.5. +- [INTERNAL] Added Python 3.9 to CI pipeline. + +0.15.7 (2020-06-19) +------------------- + +- [NEW] Added a number of built-in format strings. See the `docs `_ for a complete list of supported formats. For example: + +.. code-block:: python + + >>> arw = arrow.utcnow() + >>> arw.format(arrow.FORMAT_COOKIE) + 'Wednesday, 27-May-2020 10:30:35 UTC' + +- [NEW] Arrow is now fully compatible with Python 3.9 and PyPy3. +- [NEW] Added Makefile, tox.ini, and requirements.txt files to the distribution bundle. +- [NEW] Added French Canadian and Swahili locales. +- [NEW] Added ``humanize`` week granularity translation for Hebrew, Greek, Macedonian, Swedish, Slovak. +- [FIX] ms and μs timestamps are now normalized in ``arrow.get()``, ``arrow.fromtimestamp()``, and ``arrow.utcfromtimestamp()``. For example: + +.. code-block:: python + + >>> ts = 1591161115194556 + >>> arw = arrow.get(ts) + + >>> arw.timestamp + 1591161115 + +- [FIX] Refactored and updated Macedonian, Hebrew, Korean, and Portuguese locales. + +0.15.6 (2020-04-29) +------------------- + +- [NEW] Added support for parsing and formatting `ISO 8601 week dates `_ via a new token ``W``, for example: + +.. code-block:: python + + >>> arrow.get("2013-W29-6", "W") + + >>> utc=arrow.utcnow() + >>> utc + + >>> utc.format("W") + '2020-W04-4' + +- [NEW] Formatting with ``x`` token (microseconds) is now possible, for example: + +.. code-block:: python + + >>> dt = arrow.utcnow() + >>> dt.format("x") + '1585669870688329' + >>> dt.format("X") + '1585669870' + +- [NEW] Added ``humanize`` week granularity translation for German, Italian, Polish & Taiwanese locales. +- [FIX] Consolidated and simplified German locales. +- [INTERNAL] Moved testing suite from nosetest/Chai to pytest/pytest-mock. +- [INTERNAL] Converted xunit-style setup and teardown functions in tests to pytest fixtures. +- [INTERNAL] Setup Github Actions for CI alongside Travis. +- [INTERNAL] Help support Arrow's future development by donating to the project on `Open Collective `_. + +0.15.5 (2020-01-03) +------------------- + +- [WARN] Python 2 reached EOL on 2020-01-01. arrow will **drop support** for Python 2 in a future release to be decided (see `#739 `_). +- [NEW] Added bounds parameter to ``span_range``, ``interval`` and ``span`` methods. This allows you to include or exclude the start and end values. +- [NEW] ``arrow.get()`` can now create arrow objects from a timestamp with a timezone, for example: + +.. code-block:: python + + >>> arrow.get(1367900664, tzinfo=tz.gettz('US/Pacific')) + + +- [NEW] ``humanize`` can now combine multiple levels of granularity, for example: + +.. code-block:: python + + >>> later140 = arrow.utcnow().shift(seconds=+8400) + >>> later140.humanize(granularity="minute") + 'in 139 minutes' + >>> later140.humanize(granularity=["hour", "minute"]) + 'in 2 hours and 19 minutes' + +- [NEW] Added Hong Kong locale (``zh_hk``). +- [NEW] Added ``humanize`` week granularity translation for Dutch. +- [NEW] Numbers are now displayed when using the seconds granularity in ``humanize``. +- [CHANGE] ``range`` now supports both the singular and plural forms of the ``frames`` argument (e.g. day and days). +- [FIX] Improved parsing of strings that contain punctuation. +- [FIX] Improved behaviour of ``humanize`` when singular seconds are involved. + +0.15.4 (2019-11-02) +------------------- + +- [FIX] Fixed an issue that caused package installs to fail on Conda Forge. + +0.15.3 (2019-11-02) +------------------- + +- [NEW] ``factory.get()`` can now create arrow objects from a ISO calendar tuple, for example: + +.. code-block:: python + + >>> arrow.get((2013, 18, 7)) + + +- [NEW] Added a new token ``x`` to allow parsing of integer timestamps with milliseconds and microseconds. +- [NEW] Formatting now supports escaping of characters using the same syntax as parsing, for example: + +.. code-block:: python + + >>> arw = arrow.now() + >>> fmt = "YYYY-MM-DD h [h] m" + >>> arw.format(fmt) + '2019-11-02 3 h 32' + +- [NEW] Added ``humanize`` week granularity translations for Chinese, Spanish and Vietnamese. +- [CHANGE] Added ``ParserError`` to module exports. +- [FIX] Added support for midnight at end of day. See `#703 `_ for details. +- [INTERNAL] Created Travis build for macOS. +- [INTERNAL] Test parsing and formatting against full timezone database. + +0.15.2 (2019-09-14) +------------------- + +- [NEW] Added ``humanize`` week granularity translations for Portuguese and Brazilian Portuguese. +- [NEW] Embedded changelog within docs and added release dates to versions. +- [FIX] Fixed a bug that caused test failures on Windows only, see `#668 `_ for details. + +0.15.1 (2019-09-10) +------------------- + +- [NEW] Added ``humanize`` week granularity translations for Japanese. +- [FIX] Fixed a bug that caused Arrow to fail when passed a negative timestamp string. +- [FIX] Fixed a bug that caused Arrow to fail when passed a datetime object with ``tzinfo`` of type ``StaticTzInfo``. + +0.15.0 (2019-09-08) +------------------- + +- [NEW] Added support for DDD and DDDD ordinal date tokens. The following functionality is now possible: ``arrow.get("1998-045")``, ``arrow.get("1998-45", "YYYY-DDD")``, ``arrow.get("1998-045", "YYYY-DDDD")``. +- [NEW] ISO 8601 basic format for dates and times is now supported (e.g. ``YYYYMMDDTHHmmssZ``). +- [NEW] Added ``humanize`` week granularity translations for French, Russian and Swiss German locales. +- [CHANGE] Timestamps of type ``str`` are no longer supported **without a format string** in the ``arrow.get()`` method. This change was made to support the ISO 8601 basic format and to address bugs such as `#447 `_. + +The following will NOT work in v0.15.0: + +.. code-block:: python + + >>> arrow.get("1565358758") + >>> arrow.get("1565358758.123413") + +The following will work in v0.15.0: + +.. code-block:: python + + >>> arrow.get("1565358758", "X") + >>> arrow.get("1565358758.123413", "X") + >>> arrow.get(1565358758) + >>> arrow.get(1565358758.123413) + +- [CHANGE] When a meridian token (a|A) is passed and no meridians are available for the specified locale (e.g. unsupported or untranslated) a ``ParserError`` is raised. +- [CHANGE] The timestamp token (``X``) will now match float timestamps of type ``str``: ``arrow.get(“1565358758.123415”, “X”)``. +- [CHANGE] Strings with leading and/or trailing whitespace will no longer be parsed without a format string. Please see `the docs `_ for ways to handle this. +- [FIX] The timestamp token (``X``) will now only match on strings that **strictly contain integers and floats**, preventing incorrect matches. +- [FIX] Most instances of ``arrow.get()`` returning an incorrect ``Arrow`` object from a partial parsing match have been eliminated. The following issue have been addressed: `#91 `_, `#196 `_, `#396 `_, `#434 `_, `#447 `_, `#456 `_, `#519 `_, `#538 `_, `#560 `_. + +0.14.7 (2019-09-04) +------------------- + +- [CHANGE] ``ArrowParseWarning`` will no longer be printed on every call to ``arrow.get()`` with a datetime string. The purpose of the warning was to start a conversation about the upcoming 0.15.0 changes and we appreciate all the feedback that the community has given us! + +0.14.6 (2019-08-28) +------------------- + +- [NEW] Added support for ``week`` granularity in ``Arrow.humanize()``. For example, ``arrow.utcnow().shift(weeks=-1).humanize(granularity="week")`` outputs "a week ago". This change introduced two new untranslated words, ``week`` and ``weeks``, to all locale dictionaries, so locale contributions are welcome! +- [NEW] Fully translated the Brazilian Portugese locale. +- [CHANGE] Updated the Macedonian locale to inherit from a Slavic base. +- [FIX] Fixed a bug that caused ``arrow.get()`` to ignore tzinfo arguments of type string (e.g. ``arrow.get(tzinfo="Europe/Paris")``). +- [FIX] Fixed a bug that occurred when ``arrow.Arrow()`` was instantiated with a ``pytz`` tzinfo object. +- [FIX] Fixed a bug that caused Arrow to fail when passed a sub-second token, that when rounded, had a value greater than 999999 (e.g. ``arrow.get("2015-01-12T01:13:15.9999995")``). Arrow should now accurately propagate the rounding for large sub-second tokens. + +0.14.5 (2019-08-09) +------------------- + +- [NEW] Added Afrikaans locale. +- [CHANGE] Removed deprecated ``replace`` shift functionality. Users looking to pass plural properties to the ``replace`` function to shift values should use ``shift`` instead. +- [FIX] Fixed bug that occurred when ``factory.get()`` was passed a locale kwarg. + +0.14.4 (2019-07-30) +------------------- + +- [FIX] Fixed a regression in 0.14.3 that prevented a tzinfo argument of type string to be passed to the ``get()`` function. Functionality such as ``arrow.get("2019072807", "YYYYMMDDHH", tzinfo="UTC")`` should work as normal again. +- [CHANGE] Moved ``backports.functools_lru_cache`` dependency from ``extra_requires`` to ``install_requires`` for ``Python 2.7`` installs to fix `#495 `_. + +0.14.3 (2019-07-28) +------------------- + +- [NEW] Added full support for Python 3.8. +- [CHANGE] Added warnings for upcoming factory.get() parsing changes in 0.15.0. Please see `#612 `_ for full details. +- [FIX] Extensive refactor and update of documentation. +- [FIX] factory.get() can now construct from kwargs. +- [FIX] Added meridians to Spanish Locale. + +0.14.2 (2019-06-06) +------------------- + +- [CHANGE] Travis CI builds now use tox to lint and run tests. +- [FIX] Fixed UnicodeDecodeError on certain locales (#600). + +0.14.1 (2019-06-06) +------------------- + +- [FIX] Fixed ``ImportError: No module named 'dateutil'`` (#598). + +0.14.0 (2019-06-06) +------------------- + +- [NEW] Added provisional support for Python 3.8. +- [CHANGE] Removed support for EOL Python 3.4. +- [FIX] Updated setup.py with modern Python standards. +- [FIX] Upgraded dependencies to latest versions. +- [FIX] Enabled flake8 and black on travis builds. +- [FIX] Formatted code using black and isort. + +0.13.2 (2019-05-30) +------------------- + +- [NEW] Add is_between method. +- [FIX] Improved humanize behaviour for near zero durations (#416). +- [FIX] Correct humanize behaviour with future days (#541). +- [FIX] Documentation updates. +- [FIX] Improvements to German Locale. + +0.13.1 (2019-02-17) +------------------- + +- [NEW] Add support for Python 3.7. +- [CHANGE] Remove deprecation decorators for Arrow.range(), Arrow.span_range() and Arrow.interval(), all now return generators, wrap with list() to get old behavior. +- [FIX] Documentation and docstring updates. + +0.13.0 (2019-01-09) +------------------- + +- [NEW] Added support for Python 3.6. +- [CHANGE] Drop support for Python 2.6/3.3. +- [CHANGE] Return generator instead of list for Arrow.range(), Arrow.span_range() and Arrow.interval(). +- [FIX] Make arrow.get() work with str & tzinfo combo. +- [FIX] Make sure special RegEx characters are escaped in format string. +- [NEW] Added support for ZZZ when formatting. +- [FIX] Stop using datetime.utcnow() in internals, use datetime.now(UTC) instead. +- [FIX] Return NotImplemented instead of TypeError in arrow math internals. +- [NEW] Added Estonian Locale. +- [FIX] Small fixes to Greek locale. +- [FIX] TagalogLocale improvements. +- [FIX] Added test requirements to setup. +- [FIX] Improve docs for get, now and utcnow methods. +- [FIX] Correct typo in depreciation warning. + +0.12.1 +------ + +- [FIX] Allow universal wheels to be generated and reliably installed. +- [FIX] Make humanize respect only_distance when granularity argument is also given. + +0.12.0 +------ + +- [FIX] Compatibility fix for Python 2.x + +0.11.0 +------ + +- [FIX] Fix grammar of ArabicLocale +- [NEW] Add Nepali Locale +- [FIX] Fix month name + rename AustriaLocale -> AustrianLocale +- [FIX] Fix typo in Basque Locale +- [FIX] Fix grammar in PortugueseBrazilian locale +- [FIX] Remove pip --user-mirrors flag +- [NEW] Add Indonesian Locale + +0.10.0 +------ + +- [FIX] Fix getattr off by one for quarter +- [FIX] Fix negative offset for UTC +- [FIX] Update arrow.py + +0.9.0 +----- + +- [NEW] Remove duplicate code +- [NEW] Support gnu date iso 8601 +- [NEW] Add support for universal wheels +- [NEW] Slovenian locale +- [NEW] Slovak locale +- [NEW] Romanian locale +- [FIX] respect limit even if end is defined range +- [FIX] Separate replace & shift functions +- [NEW] Added tox +- [FIX] Fix supported Python versions in documentation +- [NEW] Azerbaijani locale added, locale issue fixed in Turkish. +- [FIX] Format ParserError's raise message + +0.8.0 +----- + +- [] + +0.7.1 +----- + +- [NEW] Esperanto locale (batisteo) + +0.7.0 +----- + +- [FIX] Parse localized strings #228 (swistakm) +- [FIX] Modify tzinfo parameter in ``get`` api #221 (bottleimp) +- [FIX] Fix Czech locale (PrehistoricTeam) +- [FIX] Raise TypeError when adding/subtracting non-dates (itsmeolivia) +- [FIX] Fix pytz conversion error (Kudo) +- [FIX] Fix overzealous time truncation in span_range (kdeldycke) +- [NEW] Humanize for time duration #232 (ybrs) +- [NEW] Add Thai locale (sipp11) +- [NEW] Adding Belarusian (be) locale (oire) +- [NEW] Search date in strings (beenje) +- [NEW] Note that arrow's tokens differ from strptime's. (offby1) + +0.6.0 +----- + +- [FIX] Added support for Python 3 +- [FIX] Avoid truncating oversized epoch timestamps. Fixes #216. +- [FIX] Fixed month abbreviations for Ukrainian +- [FIX] Fix typo timezone +- [FIX] A couple of dialect fixes and two new languages +- [FIX] Spanish locale: ``Miercoles`` should have acute accent +- [Fix] Fix Finnish grammar +- [FIX] Fix typo in 'Arrow.floor' docstring +- [FIX] Use read() utility to open README +- [FIX] span_range for week frame +- [NEW] Add minimal support for fractional seconds longer than six digits. +- [NEW] Adding locale support for Marathi (mr) +- [NEW] Add count argument to span method +- [NEW] Improved docs + +0.5.1 - 0.5.4 +------------- + +- [FIX] test the behavior of simplejson instead of calling for_json directly (tonyseek) +- [FIX] Add Hebrew Locale (doodyparizada) +- [FIX] Update documentation location (andrewelkins) +- [FIX] Update setup.py Development Status level (andrewelkins) +- [FIX] Case insensitive month match (cshowe) + +0.5.0 +----- + +- [NEW] struct_time addition. (mhworth) +- [NEW] Version grep (eirnym) +- [NEW] Default to ISO 8601 format (emonty) +- [NEW] Raise TypeError on comparison (sniekamp) +- [NEW] Adding Macedonian(mk) locale (krisfremen) +- [FIX] Fix for ISO seconds and fractional seconds (sdispater) (andrewelkins) +- [FIX] Use correct Dutch wording for "hours" (wbolster) +- [FIX] Complete the list of english locales (indorilftw) +- [FIX] Change README to reStructuredText (nyuszika7h) +- [FIX] Parse lower-cased 'h' (tamentis) +- [FIX] Slight modifications to Dutch locale (nvie) + +0.4.4 +----- + +- [NEW] Include the docs in the released tarball +- [NEW] Czech localization Czech localization for Arrow +- [NEW] Add fa_ir to locales +- [FIX] Fixes parsing of time strings with a final Z +- [FIX] Fixes ISO parsing and formatting for fractional seconds +- [FIX] test_fromtimestamp sp +- [FIX] some typos fixed +- [FIX] removed an unused import statement +- [FIX] docs table fix +- [FIX] Issue with specify 'X' template and no template at all to arrow.get +- [FIX] Fix "import" typo in docs/index.rst +- [FIX] Fix unit tests for zero passed +- [FIX] Update layout.html +- [FIX] In Norwegian and new Norwegian months and weekdays should not be capitalized +- [FIX] Fixed discrepancy between specifying 'X' to arrow.get and specifying no template + +0.4.3 +----- + +- [NEW] Turkish locale (Emre) +- [NEW] Arabic locale (Mosab Ahmad) +- [NEW] Danish locale (Holmars) +- [NEW] Icelandic locale (Holmars) +- [NEW] Hindi locale (Atmb4u) +- [NEW] Malayalam locale (Atmb4u) +- [NEW] Finnish locale (Stormpat) +- [NEW] Portuguese locale (Danielcorreia) +- [NEW] ``h`` and ``hh`` strings are now supported (Averyonghub) +- [FIX] An incorrect inflection in the Polish locale has been fixed (Avalanchy) +- [FIX] ``arrow.get`` now properly handles ``Date`` (Jaapz) +- [FIX] Tests are now declared in ``setup.py`` and the manifest (Pypingou) +- [FIX] ``__version__`` has been added to ``__init__.py`` (Sametmax) +- [FIX] ISO 8601 strings can be parsed without a separator (Ivandiguisto / Root) +- [FIX] Documentation is now more clear regarding some inputs on ``arrow.get`` (Eriktaubeneck) +- [FIX] Some documentation links have been fixed (Vrutsky) +- [FIX] Error messages for parse errors are now more descriptive (Maciej Albin) +- [FIX] The parser now correctly checks for separators in strings (Mschwager) + +0.4.2 +----- + +- [NEW] Factory ``get`` method now accepts a single ``Arrow`` argument. +- [NEW] Tokens SSSS, SSSSS and SSSSSS are supported in parsing. +- [NEW] ``Arrow`` objects have a ``float_timestamp`` property. +- [NEW] Vietnamese locale (Iu1nguoi) +- [NEW] Factory ``get`` method now accepts a list of format strings (Dgilland) +- [NEW] A MANIFEST.in file has been added (Pypingou) +- [NEW] Tests can be run directly from ``setup.py`` (Pypingou) +- [FIX] Arrow docs now list 'day of week' format tokens correctly (Rudolphfroger) +- [FIX] Several issues with the Korean locale have been resolved (Yoloseem) +- [FIX] ``humanize`` now correctly returns unicode (Shvechikov) +- [FIX] ``Arrow`` objects now pickle / unpickle correctly (Yoloseem) + +0.4.1 +----- + +- [NEW] Table / explanation of formatting & parsing tokens in docs +- [NEW] Brazilian locale (Augusto2112) +- [NEW] Dutch locale (OrangeTux) +- [NEW] Italian locale (Pertux) +- [NEW] Austrain locale (LeChewbacca) +- [NEW] Tagalog locale (Marksteve) +- [FIX] Corrected spelling and day numbers in German locale (LeChewbacca) +- [FIX] Factory ``get`` method should now handle unicode strings correctly (Bwells) +- [FIX] Midnight and noon should now parse and format correctly (Bwells) + +0.4.0 +----- + +- [NEW] Format-free ISO 8601 parsing in factory ``get`` method +- [NEW] Support for 'week' / 'weeks' in ``span``, ``range``, ``span_range``, ``floor`` and ``ceil`` +- [NEW] Support for 'weeks' in ``replace`` +- [NEW] Norwegian locale (Martinp) +- [NEW] Japanese locale (CortYuming) +- [FIX] Timezones no longer show the wrong sign when formatted (Bean) +- [FIX] Microseconds are parsed correctly from strings (Bsidhom) +- [FIX] Locale day-of-week is no longer off by one (Cynddl) +- [FIX] Corrected plurals of Ukrainian and Russian nouns (Catchagain) +- [CHANGE] Old 0.1 ``arrow`` module method removed +- [CHANGE] Dropped timestamp support in ``range`` and ``span_range`` (never worked correctly) +- [CHANGE] Dropped parsing of single string as tz string in factory ``get`` method (replaced by ISO 8601) + +0.3.5 +----- + +- [NEW] French locale (Cynddl) +- [NEW] Spanish locale (Slapresta) +- [FIX] Ranges handle multiple timezones correctly (Ftobia) + +0.3.4 +----- + +- [FIX] Humanize no longer sometimes returns the wrong month delta +- [FIX] ``__format__`` works correctly with no format string + +0.3.3 +----- + +- [NEW] Python 2.6 support +- [NEW] Initial support for locale-based parsing and formatting +- [NEW] ArrowFactory class, now proxied as the module API +- [NEW] ``factory`` api method to obtain a factory for a custom type +- [FIX] Python 3 support and tests completely ironed out + +0.3.2 +----- + +- [NEW] Python 3+ support + +0.3.1 +----- + +- [FIX] The old ``arrow`` module function handles timestamps correctly as it used to + +0.3.0 +----- + +- [NEW] ``Arrow.replace`` method +- [NEW] Accept timestamps, datetimes and Arrows for datetime inputs, where reasonable +- [FIX] ``range`` and ``span_range`` respect end and limit parameters correctly +- [CHANGE] Arrow objects are no longer mutable +- [CHANGE] Plural attribute name semantics altered: single -> absolute, plural -> relative +- [CHANGE] Plural names no longer supported as properties (e.g. ``arrow.utcnow().years``) + +0.2.1 +----- + +- [NEW] Support for localized humanization +- [NEW] English, Russian, Greek, Korean, Chinese locales + +0.2.0 +----- + +- **REWRITE** +- [NEW] Date parsing +- [NEW] Date formatting +- [NEW] ``floor``, ``ceil`` and ``span`` methods +- [NEW] ``datetime`` interface implementation +- [NEW] ``clone`` method +- [NEW] ``get``, ``now`` and ``utcnow`` API methods + +0.1.6 +----- + +- [NEW] Humanized time deltas +- [NEW] ``__eq__`` implemented +- [FIX] Issues with conversions related to daylight savings time resolved +- [CHANGE] ``__str__`` uses ISO formatting + +0.1.5 +----- + +- **Started tracking changes** +- [NEW] Parsing of ISO-formatted time zone offsets (e.g. '+02:30', '-05:00') +- [NEW] Resolved some issues with timestamps and delta / Olson time zones diff --git a/openpype/modules/ftrack/python2_vendor/arrow/LICENSE b/openpype/modules/ftrack/python2_vendor/arrow/LICENSE new file mode 100644 index 0000000000..2bef500de7 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2019 Chris Smith + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/openpype/modules/ftrack/python2_vendor/arrow/MANIFEST.in b/openpype/modules/ftrack/python2_vendor/arrow/MANIFEST.in new file mode 100644 index 0000000000..d9955ed96a --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/MANIFEST.in @@ -0,0 +1,3 @@ +include LICENSE CHANGELOG.rst README.rst Makefile requirements.txt tox.ini +recursive-include tests *.py +recursive-include docs *.py *.rst *.bat Makefile diff --git a/openpype/modules/ftrack/python2_vendor/arrow/Makefile b/openpype/modules/ftrack/python2_vendor/arrow/Makefile new file mode 100644 index 0000000000..f294985dc6 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/Makefile @@ -0,0 +1,44 @@ +.PHONY: auto test docs clean + +auto: build38 + +build27: PYTHON_VER = python2.7 +build35: PYTHON_VER = python3.5 +build36: PYTHON_VER = python3.6 +build37: PYTHON_VER = python3.7 +build38: PYTHON_VER = python3.8 +build39: PYTHON_VER = python3.9 + +build27 build35 build36 build37 build38 build39: clean + virtualenv venv --python=$(PYTHON_VER) + . venv/bin/activate; \ + pip install -r requirements.txt; \ + pre-commit install + +test: + rm -f .coverage coverage.xml + . venv/bin/activate; pytest + +lint: + . venv/bin/activate; pre-commit run --all-files --show-diff-on-failure + +docs: + rm -rf docs/_build + . venv/bin/activate; cd docs; make html + +clean: clean-dist + rm -rf venv .pytest_cache ./**/__pycache__ + rm -f .coverage coverage.xml ./**/*.pyc + +clean-dist: + rm -rf dist build .egg .eggs arrow.egg-info + +build-dist: + . venv/bin/activate; \ + pip install -U setuptools twine wheel; \ + python setup.py sdist bdist_wheel + +upload-dist: + . venv/bin/activate; twine upload dist/* + +publish: test clean-dist build-dist upload-dist clean-dist diff --git a/openpype/modules/ftrack/python2_vendor/arrow/README.rst b/openpype/modules/ftrack/python2_vendor/arrow/README.rst new file mode 100644 index 0000000000..69f6c50d81 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/README.rst @@ -0,0 +1,133 @@ +Arrow: Better dates & times for Python +====================================== + +.. start-inclusion-marker-do-not-remove + +.. image:: https://github.com/arrow-py/arrow/workflows/tests/badge.svg?branch=master + :alt: Build Status + :target: https://github.com/arrow-py/arrow/actions?query=workflow%3Atests+branch%3Amaster + +.. image:: https://codecov.io/gh/arrow-py/arrow/branch/master/graph/badge.svg + :alt: Coverage + :target: https://codecov.io/gh/arrow-py/arrow + +.. image:: https://img.shields.io/pypi/v/arrow.svg + :alt: PyPI Version + :target: https://pypi.python.org/pypi/arrow + +.. image:: https://img.shields.io/pypi/pyversions/arrow.svg + :alt: Supported Python Versions + :target: https://pypi.python.org/pypi/arrow + +.. image:: https://img.shields.io/pypi/l/arrow.svg + :alt: License + :target: https://pypi.python.org/pypi/arrow + +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :alt: Code Style: Black + :target: https://github.com/psf/black + + +**Arrow** is a Python library that offers a sensible and human-friendly approach to creating, manipulating, formatting and converting dates, times and timestamps. It implements and updates the datetime type, plugging gaps in functionality and providing an intelligent module API that supports many common creation scenarios. Simply put, it helps you work with dates and times with fewer imports and a lot less code. + +Arrow is named after the `arrow of time `_ and is heavily inspired by `moment.js `_ and `requests `_. + +Why use Arrow over built-in modules? +------------------------------------ + +Python's standard library and some other low-level modules have near-complete date, time and timezone functionality, but don't work very well from a usability perspective: + +- Too many modules: datetime, time, calendar, dateutil, pytz and more +- Too many types: date, time, datetime, tzinfo, timedelta, relativedelta, etc. +- Timezones and timestamp conversions are verbose and unpleasant +- Timezone naivety is the norm +- Gaps in functionality: ISO 8601 parsing, timespans, humanization + +Features +-------- + +- Fully-implemented, drop-in replacement for datetime +- Supports Python 2.7, 3.5, 3.6, 3.7, 3.8 and 3.9 +- Timezone-aware and UTC by default +- Provides super-simple creation options for many common input scenarios +- :code:`shift` method with support for relative offsets, including weeks +- Formats and parses strings automatically +- Wide support for ISO 8601 +- Timezone conversion +- Timestamp available as a property +- Generates time spans, ranges, floors and ceilings for time frames ranging from microsecond to year +- Humanizes and supports a growing list of contributed locales +- Extensible for your own Arrow-derived types + +Quick Start +----------- + +Installation +~~~~~~~~~~~~ + +To install Arrow, use `pip `_ or `pipenv `_: + +.. code-block:: console + + $ pip install -U arrow + +Example Usage +~~~~~~~~~~~~~ + +.. code-block:: python + + >>> import arrow + >>> arrow.get('2013-05-11T21:23:58.970460+07:00') + + + >>> utc = arrow.utcnow() + >>> utc + + + >>> utc = utc.shift(hours=-1) + >>> utc + + + >>> local = utc.to('US/Pacific') + >>> local + + + >>> local.timestamp + 1368303838 + + >>> local.format() + '2013-05-11 13:23:58 -07:00' + + >>> local.format('YYYY-MM-DD HH:mm:ss ZZ') + '2013-05-11 13:23:58 -07:00' + + >>> local.humanize() + 'an hour ago' + + >>> local.humanize(locale='ko_kr') + '1시간 전' + +.. end-inclusion-marker-do-not-remove + +Documentation +------------- + +For full documentation, please visit `arrow.readthedocs.io `_. + +Contributing +------------ + +Contributions are welcome for both code and localizations (adding and updating locales). Begin by gaining familiarity with the Arrow library and its features. Then, jump into contributing: + +#. Find an issue or feature to tackle on the `issue tracker `_. Issues marked with the `"good first issue" label `_ may be a great place to start! +#. Fork `this repository `_ on GitHub and begin making changes in a branch. +#. Add a few tests to ensure that the bug was fixed or the feature works as expected. +#. Run the entire test suite and linting checks by running one of the following commands: :code:`tox` (if you have `tox `_ installed) **OR** :code:`make build38 && make test && make lint` (if you do not have Python 3.8 installed, replace :code:`build38` with the latest Python version on your system). +#. Submit a pull request and await feedback 😃. + +If you have any questions along the way, feel free to ask them `here `_. + +Support Arrow +------------- + +`Open Collective `_ is an online funding platform that provides tools to raise money and share your finances with full transparency. It is the platform of choice for individuals and companies to make one-time or recurring donations directly to the project. If you are interested in making a financial contribution, please visit the `Arrow collective `_. diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/__init__.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/__init__.py new file mode 100644 index 0000000000..2883527be8 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/__init__.py @@ -0,0 +1,18 @@ +# -*- coding: utf-8 -*- +from ._version import __version__ +from .api import get, now, utcnow +from .arrow import Arrow +from .factory import ArrowFactory +from .formatter import ( + FORMAT_ATOM, + FORMAT_COOKIE, + FORMAT_RFC822, + FORMAT_RFC850, + FORMAT_RFC1036, + FORMAT_RFC1123, + FORMAT_RFC2822, + FORMAT_RFC3339, + FORMAT_RSS, + FORMAT_W3C, +) +from .parser import ParserError diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/_version.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/_version.py new file mode 100644 index 0000000000..fd86b3ee91 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/_version.py @@ -0,0 +1 @@ +__version__ = "0.17.0" diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/api.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/api.py new file mode 100644 index 0000000000..a6b7be3de2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/api.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +""" +Provides the default implementation of :class:`ArrowFactory ` +methods for use as a module API. + +""" + +from __future__ import absolute_import + +from arrow.factory import ArrowFactory + +# internal default factory. +_factory = ArrowFactory() + + +def get(*args, **kwargs): + """Calls the default :class:`ArrowFactory ` ``get`` method.""" + + return _factory.get(*args, **kwargs) + + +get.__doc__ = _factory.get.__doc__ + + +def utcnow(): + """Calls the default :class:`ArrowFactory ` ``utcnow`` method.""" + + return _factory.utcnow() + + +utcnow.__doc__ = _factory.utcnow.__doc__ + + +def now(tz=None): + """Calls the default :class:`ArrowFactory ` ``now`` method.""" + + return _factory.now(tz) + + +now.__doc__ = _factory.now.__doc__ + + +def factory(type): + """Returns an :class:`.ArrowFactory` for the specified :class:`Arrow ` + or derived type. + + :param type: the type, :class:`Arrow ` or derived. + + """ + + return ArrowFactory(type) + + +__all__ = ["get", "utcnow", "now", "factory"] diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/arrow.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/arrow.py new file mode 100644 index 0000000000..4fe9541789 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/arrow.py @@ -0,0 +1,1584 @@ +# -*- coding: utf-8 -*- +""" +Provides the :class:`Arrow ` class, an enhanced ``datetime`` +replacement. + +""" + +from __future__ import absolute_import + +import calendar +import sys +import warnings +from datetime import datetime, timedelta +from datetime import tzinfo as dt_tzinfo +from math import trunc + +from dateutil import tz as dateutil_tz +from dateutil.relativedelta import relativedelta + +from arrow import formatter, locales, parser, util + +if sys.version_info[:2] < (3, 6): # pragma: no cover + with warnings.catch_warnings(): + warnings.simplefilter("default", DeprecationWarning) + warnings.warn( + "Arrow will drop support for Python 2.7 and 3.5 in the upcoming v1.0.0 release. Please upgrade to " + "Python 3.6+ to continue receiving updates for Arrow.", + DeprecationWarning, + ) + + +class Arrow(object): + """An :class:`Arrow ` object. + + Implements the ``datetime`` interface, behaving as an aware ``datetime`` while implementing + additional functionality. + + :param year: the calendar year. + :param month: the calendar month. + :param day: the calendar day. + :param hour: (optional) the hour. Defaults to 0. + :param minute: (optional) the minute, Defaults to 0. + :param second: (optional) the second, Defaults to 0. + :param microsecond: (optional) the microsecond. Defaults to 0. + :param tzinfo: (optional) A timezone expression. Defaults to UTC. + :param fold: (optional) 0 or 1, used to disambiguate repeated times. Defaults to 0. + + .. _tz-expr: + + Recognized timezone expressions: + + - A ``tzinfo`` object. + - A ``str`` describing a timezone, similar to 'US/Pacific', or 'Europe/Berlin'. + - A ``str`` in ISO 8601 style, as in '+07:00'. + - A ``str``, one of the following: 'local', 'utc', 'UTC'. + + Usage:: + + >>> import arrow + >>> arrow.Arrow(2013, 5, 5, 12, 30, 45) + + + """ + + resolution = datetime.resolution + + _ATTRS = ["year", "month", "day", "hour", "minute", "second", "microsecond"] + _ATTRS_PLURAL = ["{}s".format(a) for a in _ATTRS] + _MONTHS_PER_QUARTER = 3 + _SECS_PER_MINUTE = float(60) + _SECS_PER_HOUR = float(60 * 60) + _SECS_PER_DAY = float(60 * 60 * 24) + _SECS_PER_WEEK = float(60 * 60 * 24 * 7) + _SECS_PER_MONTH = float(60 * 60 * 24 * 30.5) + _SECS_PER_YEAR = float(60 * 60 * 24 * 365.25) + + def __init__( + self, + year, + month, + day, + hour=0, + minute=0, + second=0, + microsecond=0, + tzinfo=None, + **kwargs + ): + if tzinfo is None: + tzinfo = dateutil_tz.tzutc() + # detect that tzinfo is a pytz object (issue #626) + elif ( + isinstance(tzinfo, dt_tzinfo) + and hasattr(tzinfo, "localize") + and hasattr(tzinfo, "zone") + and tzinfo.zone + ): + tzinfo = parser.TzinfoParser.parse(tzinfo.zone) + elif util.isstr(tzinfo): + tzinfo = parser.TzinfoParser.parse(tzinfo) + + fold = kwargs.get("fold", 0) + + # use enfold here to cover direct arrow.Arrow init on 2.7/3.5 + self._datetime = dateutil_tz.enfold( + datetime(year, month, day, hour, minute, second, microsecond, tzinfo), + fold=fold, + ) + + # factories: single object, both original and from datetime. + + @classmethod + def now(cls, tzinfo=None): + """Constructs an :class:`Arrow ` object, representing "now" in the given + timezone. + + :param tzinfo: (optional) a ``tzinfo`` object. Defaults to local time. + + Usage:: + + >>> arrow.now('Asia/Baku') + + + """ + + if tzinfo is None: + tzinfo = dateutil_tz.tzlocal() + + dt = datetime.now(tzinfo) + + return cls( + dt.year, + dt.month, + dt.day, + dt.hour, + dt.minute, + dt.second, + dt.microsecond, + dt.tzinfo, + fold=getattr(dt, "fold", 0), + ) + + @classmethod + def utcnow(cls): + """Constructs an :class:`Arrow ` object, representing "now" in UTC + time. + + Usage:: + + >>> arrow.utcnow() + + + """ + + dt = datetime.now(dateutil_tz.tzutc()) + + return cls( + dt.year, + dt.month, + dt.day, + dt.hour, + dt.minute, + dt.second, + dt.microsecond, + dt.tzinfo, + fold=getattr(dt, "fold", 0), + ) + + @classmethod + def fromtimestamp(cls, timestamp, tzinfo=None): + """Constructs an :class:`Arrow ` object from a timestamp, converted to + the given timezone. + + :param timestamp: an ``int`` or ``float`` timestamp, or a ``str`` that converts to either. + :param tzinfo: (optional) a ``tzinfo`` object. Defaults to local time. + """ + + if tzinfo is None: + tzinfo = dateutil_tz.tzlocal() + elif util.isstr(tzinfo): + tzinfo = parser.TzinfoParser.parse(tzinfo) + + if not util.is_timestamp(timestamp): + raise ValueError( + "The provided timestamp '{}' is invalid.".format(timestamp) + ) + + timestamp = util.normalize_timestamp(float(timestamp)) + dt = datetime.fromtimestamp(timestamp, tzinfo) + + return cls( + dt.year, + dt.month, + dt.day, + dt.hour, + dt.minute, + dt.second, + dt.microsecond, + dt.tzinfo, + fold=getattr(dt, "fold", 0), + ) + + @classmethod + def utcfromtimestamp(cls, timestamp): + """Constructs an :class:`Arrow ` object from a timestamp, in UTC time. + + :param timestamp: an ``int`` or ``float`` timestamp, or a ``str`` that converts to either. + + """ + + if not util.is_timestamp(timestamp): + raise ValueError( + "The provided timestamp '{}' is invalid.".format(timestamp) + ) + + timestamp = util.normalize_timestamp(float(timestamp)) + dt = datetime.utcfromtimestamp(timestamp) + + return cls( + dt.year, + dt.month, + dt.day, + dt.hour, + dt.minute, + dt.second, + dt.microsecond, + dateutil_tz.tzutc(), + fold=getattr(dt, "fold", 0), + ) + + @classmethod + def fromdatetime(cls, dt, tzinfo=None): + """Constructs an :class:`Arrow ` object from a ``datetime`` and + optional replacement timezone. + + :param dt: the ``datetime`` + :param tzinfo: (optional) A :ref:`timezone expression `. Defaults to ``dt``'s + timezone, or UTC if naive. + + If you only want to replace the timezone of naive datetimes:: + + >>> dt + datetime.datetime(2013, 5, 5, 0, 0, tzinfo=tzutc()) + >>> arrow.Arrow.fromdatetime(dt, dt.tzinfo or 'US/Pacific') + + + """ + + if tzinfo is None: + if dt.tzinfo is None: + tzinfo = dateutil_tz.tzutc() + else: + tzinfo = dt.tzinfo + + return cls( + dt.year, + dt.month, + dt.day, + dt.hour, + dt.minute, + dt.second, + dt.microsecond, + tzinfo, + fold=getattr(dt, "fold", 0), + ) + + @classmethod + def fromdate(cls, date, tzinfo=None): + """Constructs an :class:`Arrow ` object from a ``date`` and optional + replacement timezone. Time values are set to 0. + + :param date: the ``date`` + :param tzinfo: (optional) A :ref:`timezone expression `. Defaults to UTC. + """ + + if tzinfo is None: + tzinfo = dateutil_tz.tzutc() + + return cls(date.year, date.month, date.day, tzinfo=tzinfo) + + @classmethod + def strptime(cls, date_str, fmt, tzinfo=None): + """Constructs an :class:`Arrow ` object from a date string and format, + in the style of ``datetime.strptime``. Optionally replaces the parsed timezone. + + :param date_str: the date string. + :param fmt: the format string. + :param tzinfo: (optional) A :ref:`timezone expression `. Defaults to the parsed + timezone if ``fmt`` contains a timezone directive, otherwise UTC. + + Usage:: + + >>> arrow.Arrow.strptime('20-01-2019 15:49:10', '%d-%m-%Y %H:%M:%S') + + + """ + + dt = datetime.strptime(date_str, fmt) + if tzinfo is None: + tzinfo = dt.tzinfo + + return cls( + dt.year, + dt.month, + dt.day, + dt.hour, + dt.minute, + dt.second, + dt.microsecond, + tzinfo, + fold=getattr(dt, "fold", 0), + ) + + # factories: ranges and spans + + @classmethod + def range(cls, frame, start, end=None, tz=None, limit=None): + """Returns an iterator of :class:`Arrow ` objects, representing + points in time between two inputs. + + :param frame: The timeframe. Can be any ``datetime`` property (day, hour, minute...). + :param start: A datetime expression, the start of the range. + :param end: (optional) A datetime expression, the end of the range. + :param tz: (optional) A :ref:`timezone expression `. Defaults to + ``start``'s timezone, or UTC if ``start`` is naive. + :param limit: (optional) A maximum number of tuples to return. + + **NOTE**: The ``end`` or ``limit`` must be provided. Call with ``end`` alone to + return the entire range. Call with ``limit`` alone to return a maximum # of results from + the start. Call with both to cap a range at a maximum # of results. + + **NOTE**: ``tz`` internally **replaces** the timezones of both ``start`` and ``end`` before + iterating. As such, either call with naive objects and ``tz``, or aware objects from the + same timezone and no ``tz``. + + Supported frame values: year, quarter, month, week, day, hour, minute, second. + + Recognized datetime expressions: + + - An :class:`Arrow ` object. + - A ``datetime`` object. + + Usage:: + + >>> start = datetime(2013, 5, 5, 12, 30) + >>> end = datetime(2013, 5, 5, 17, 15) + >>> for r in arrow.Arrow.range('hour', start, end): + ... print(repr(r)) + ... + + + + + + + **NOTE**: Unlike Python's ``range``, ``end`` *may* be included in the returned iterator:: + + >>> start = datetime(2013, 5, 5, 12, 30) + >>> end = datetime(2013, 5, 5, 13, 30) + >>> for r in arrow.Arrow.range('hour', start, end): + ... print(repr(r)) + ... + + + + """ + + _, frame_relative, relative_steps = cls._get_frames(frame) + + tzinfo = cls._get_tzinfo(start.tzinfo if tz is None else tz) + + start = cls._get_datetime(start).replace(tzinfo=tzinfo) + end, limit = cls._get_iteration_params(end, limit) + end = cls._get_datetime(end).replace(tzinfo=tzinfo) + + current = cls.fromdatetime(start) + original_day = start.day + day_is_clipped = False + i = 0 + + while current <= end and i < limit: + i += 1 + yield current + + values = [getattr(current, f) for f in cls._ATTRS] + current = cls(*values, tzinfo=tzinfo).shift( + **{frame_relative: relative_steps} + ) + + if frame in ["month", "quarter", "year"] and current.day < original_day: + day_is_clipped = True + + if day_is_clipped and not cls._is_last_day_of_month(current): + current = current.replace(day=original_day) + + def span(self, frame, count=1, bounds="[)"): + """Returns two new :class:`Arrow ` objects, representing the timespan + of the :class:`Arrow ` object in a given timeframe. + + :param frame: the timeframe. Can be any ``datetime`` property (day, hour, minute...). + :param count: (optional) the number of frames to span. + :param bounds: (optional) a ``str`` of either '()', '(]', '[)', or '[]' that specifies + whether to include or exclude the start and end values in the span. '(' excludes + the start, '[' includes the start, ')' excludes the end, and ']' includes the end. + If the bounds are not specified, the default bound '[)' is used. + + Supported frame values: year, quarter, month, week, day, hour, minute, second. + + Usage:: + + >>> arrow.utcnow() + + + >>> arrow.utcnow().span('hour') + (, ) + + >>> arrow.utcnow().span('day') + (, ) + + >>> arrow.utcnow().span('day', count=2) + (, ) + + >>> arrow.utcnow().span('day', bounds='[]') + (, ) + + """ + + util.validate_bounds(bounds) + + frame_absolute, frame_relative, relative_steps = self._get_frames(frame) + + if frame_absolute == "week": + attr = "day" + elif frame_absolute == "quarter": + attr = "month" + else: + attr = frame_absolute + + index = self._ATTRS.index(attr) + frames = self._ATTRS[: index + 1] + + values = [getattr(self, f) for f in frames] + + for _ in range(3 - len(values)): + values.append(1) + + floor = self.__class__(*values, tzinfo=self.tzinfo) + + if frame_absolute == "week": + floor = floor.shift(days=-(self.isoweekday() - 1)) + elif frame_absolute == "quarter": + floor = floor.shift(months=-((self.month - 1) % 3)) + + ceil = floor.shift(**{frame_relative: count * relative_steps}) + + if bounds[0] == "(": + floor = floor.shift(microseconds=+1) + + if bounds[1] == ")": + ceil = ceil.shift(microseconds=-1) + + return floor, ceil + + def floor(self, frame): + """Returns a new :class:`Arrow ` object, representing the "floor" + of the timespan of the :class:`Arrow ` object in a given timeframe. + Equivalent to the first element in the 2-tuple returned by + :func:`span `. + + :param frame: the timeframe. Can be any ``datetime`` property (day, hour, minute...). + + Usage:: + + >>> arrow.utcnow().floor('hour') + + """ + + return self.span(frame)[0] + + def ceil(self, frame): + """Returns a new :class:`Arrow ` object, representing the "ceiling" + of the timespan of the :class:`Arrow ` object in a given timeframe. + Equivalent to the second element in the 2-tuple returned by + :func:`span `. + + :param frame: the timeframe. Can be any ``datetime`` property (day, hour, minute...). + + Usage:: + + >>> arrow.utcnow().ceil('hour') + + """ + + return self.span(frame)[1] + + @classmethod + def span_range(cls, frame, start, end, tz=None, limit=None, bounds="[)"): + """Returns an iterator of tuples, each :class:`Arrow ` objects, + representing a series of timespans between two inputs. + + :param frame: The timeframe. Can be any ``datetime`` property (day, hour, minute...). + :param start: A datetime expression, the start of the range. + :param end: (optional) A datetime expression, the end of the range. + :param tz: (optional) A :ref:`timezone expression `. Defaults to + ``start``'s timezone, or UTC if ``start`` is naive. + :param limit: (optional) A maximum number of tuples to return. + :param bounds: (optional) a ``str`` of either '()', '(]', '[)', or '[]' that specifies + whether to include or exclude the start and end values in each span in the range. '(' excludes + the start, '[' includes the start, ')' excludes the end, and ']' includes the end. + If the bounds are not specified, the default bound '[)' is used. + + **NOTE**: The ``end`` or ``limit`` must be provided. Call with ``end`` alone to + return the entire range. Call with ``limit`` alone to return a maximum # of results from + the start. Call with both to cap a range at a maximum # of results. + + **NOTE**: ``tz`` internally **replaces** the timezones of both ``start`` and ``end`` before + iterating. As such, either call with naive objects and ``tz``, or aware objects from the + same timezone and no ``tz``. + + Supported frame values: year, quarter, month, week, day, hour, minute, second. + + Recognized datetime expressions: + + - An :class:`Arrow ` object. + - A ``datetime`` object. + + **NOTE**: Unlike Python's ``range``, ``end`` will *always* be included in the returned + iterator of timespans. + + Usage: + + >>> start = datetime(2013, 5, 5, 12, 30) + >>> end = datetime(2013, 5, 5, 17, 15) + >>> for r in arrow.Arrow.span_range('hour', start, end): + ... print(r) + ... + (, ) + (, ) + (, ) + (, ) + (, ) + (, ) + + """ + + tzinfo = cls._get_tzinfo(start.tzinfo if tz is None else tz) + start = cls.fromdatetime(start, tzinfo).span(frame)[0] + _range = cls.range(frame, start, end, tz, limit) + return (r.span(frame, bounds=bounds) for r in _range) + + @classmethod + def interval(cls, frame, start, end, interval=1, tz=None, bounds="[)"): + """Returns an iterator of tuples, each :class:`Arrow ` objects, + representing a series of intervals between two inputs. + + :param frame: The timeframe. Can be any ``datetime`` property (day, hour, minute...). + :param start: A datetime expression, the start of the range. + :param end: (optional) A datetime expression, the end of the range. + :param interval: (optional) Time interval for the given time frame. + :param tz: (optional) A timezone expression. Defaults to UTC. + :param bounds: (optional) a ``str`` of either '()', '(]', '[)', or '[]' that specifies + whether to include or exclude the start and end values in the intervals. '(' excludes + the start, '[' includes the start, ')' excludes the end, and ']' includes the end. + If the bounds are not specified, the default bound '[)' is used. + + Supported frame values: year, quarter, month, week, day, hour, minute, second + + Recognized datetime expressions: + + - An :class:`Arrow ` object. + - A ``datetime`` object. + + Recognized timezone expressions: + + - A ``tzinfo`` object. + - A ``str`` describing a timezone, similar to 'US/Pacific', or 'Europe/Berlin'. + - A ``str`` in ISO 8601 style, as in '+07:00'. + - A ``str``, one of the following: 'local', 'utc', 'UTC'. + + Usage: + + >>> start = datetime(2013, 5, 5, 12, 30) + >>> end = datetime(2013, 5, 5, 17, 15) + >>> for r in arrow.Arrow.interval('hour', start, end, 2): + ... print r + ... + (, ) + (, ) + (, ) + """ + if interval < 1: + raise ValueError("interval has to be a positive integer") + + spanRange = iter(cls.span_range(frame, start, end, tz, bounds=bounds)) + while True: + try: + intvlStart, intvlEnd = next(spanRange) + for _ in range(interval - 1): + _, intvlEnd = next(spanRange) + yield intvlStart, intvlEnd + except StopIteration: + return + + # representations + + def __repr__(self): + return "<{} [{}]>".format(self.__class__.__name__, self.__str__()) + + def __str__(self): + return self._datetime.isoformat() + + def __format__(self, formatstr): + + if len(formatstr) > 0: + return self.format(formatstr) + + return str(self) + + def __hash__(self): + return self._datetime.__hash__() + + # attributes and properties + + def __getattr__(self, name): + + if name == "week": + return self.isocalendar()[1] + + if name == "quarter": + return int((self.month - 1) / self._MONTHS_PER_QUARTER) + 1 + + if not name.startswith("_"): + value = getattr(self._datetime, name, None) + + if value is not None: + return value + + return object.__getattribute__(self, name) + + @property + def tzinfo(self): + """Gets the ``tzinfo`` of the :class:`Arrow ` object. + + Usage:: + + >>> arw=arrow.utcnow() + >>> arw.tzinfo + tzutc() + + """ + + return self._datetime.tzinfo + + @tzinfo.setter + def tzinfo(self, tzinfo): + """ Sets the ``tzinfo`` of the :class:`Arrow ` object. """ + + self._datetime = self._datetime.replace(tzinfo=tzinfo) + + @property + def datetime(self): + """Returns a datetime representation of the :class:`Arrow ` object. + + Usage:: + + >>> arw=arrow.utcnow() + >>> arw.datetime + datetime.datetime(2019, 1, 24, 16, 35, 27, 276649, tzinfo=tzutc()) + + """ + + return self._datetime + + @property + def naive(self): + """Returns a naive datetime representation of the :class:`Arrow ` + object. + + Usage:: + + >>> nairobi = arrow.now('Africa/Nairobi') + >>> nairobi + + >>> nairobi.naive + datetime.datetime(2019, 1, 23, 19, 27, 12, 297999) + + """ + + return self._datetime.replace(tzinfo=None) + + @property + def timestamp(self): + """Returns a timestamp representation of the :class:`Arrow ` object, in + UTC time. + + Usage:: + + >>> arrow.utcnow().timestamp + 1548260567 + + """ + + warnings.warn( + "For compatibility with the datetime.timestamp() method this property will be replaced with a method in " + "the 1.0.0 release, please switch to the .int_timestamp property for identical behaviour as soon as " + "possible.", + DeprecationWarning, + ) + return calendar.timegm(self._datetime.utctimetuple()) + + @property + def int_timestamp(self): + """Returns a timestamp representation of the :class:`Arrow ` object, in + UTC time. + + Usage:: + + >>> arrow.utcnow().int_timestamp + 1548260567 + + """ + + return calendar.timegm(self._datetime.utctimetuple()) + + @property + def float_timestamp(self): + """Returns a floating-point representation of the :class:`Arrow ` + object, in UTC time. + + Usage:: + + >>> arrow.utcnow().float_timestamp + 1548260516.830896 + + """ + + # IDEA get rid of this in 1.0.0 and wrap datetime.timestamp() + # Or for compatibility retain this but make it call the timestamp method + with warnings.catch_warnings(): + warnings.simplefilter("ignore", DeprecationWarning) + return self.timestamp + float(self.microsecond) / 1000000 + + @property + def fold(self): + """ Returns the ``fold`` value of the :class:`Arrow ` object. """ + + # in python < 3.6 _datetime will be a _DatetimeWithFold if fold=1 and a datetime with no fold attribute + # otherwise, so we need to return zero to cover the latter case + return getattr(self._datetime, "fold", 0) + + @property + def ambiguous(self): + """ Returns a boolean indicating whether the :class:`Arrow ` object is ambiguous.""" + + return dateutil_tz.datetime_ambiguous(self._datetime) + + @property + def imaginary(self): + """Indicates whether the :class: `Arrow ` object exists in the current timezone.""" + + return not dateutil_tz.datetime_exists(self._datetime) + + # mutation and duplication. + + def clone(self): + """Returns a new :class:`Arrow ` object, cloned from the current one. + + Usage: + + >>> arw = arrow.utcnow() + >>> cloned = arw.clone() + + """ + + return self.fromdatetime(self._datetime) + + def replace(self, **kwargs): + """Returns a new :class:`Arrow ` object with attributes updated + according to inputs. + + Use property names to set their value absolutely:: + + >>> import arrow + >>> arw = arrow.utcnow() + >>> arw + + >>> arw.replace(year=2014, month=6) + + + You can also replace the timezone without conversion, using a + :ref:`timezone expression `:: + + >>> arw.replace(tzinfo=tz.tzlocal()) + + + """ + + absolute_kwargs = {} + + for key, value in kwargs.items(): + + if key in self._ATTRS: + absolute_kwargs[key] = value + elif key in ["week", "quarter"]: + raise AttributeError("setting absolute {} is not supported".format(key)) + elif key not in ["tzinfo", "fold"]: + raise AttributeError('unknown attribute: "{}"'.format(key)) + + current = self._datetime.replace(**absolute_kwargs) + + tzinfo = kwargs.get("tzinfo") + + if tzinfo is not None: + tzinfo = self._get_tzinfo(tzinfo) + current = current.replace(tzinfo=tzinfo) + + fold = kwargs.get("fold") + + # TODO revisit this once we drop support for 2.7/3.5 + if fold is not None: + current = dateutil_tz.enfold(current, fold=fold) + + return self.fromdatetime(current) + + def shift(self, **kwargs): + """Returns a new :class:`Arrow ` object with attributes updated + according to inputs. + + Use pluralized property names to relatively shift their current value: + + >>> import arrow + >>> arw = arrow.utcnow() + >>> arw + + >>> arw.shift(years=1, months=-1) + + + Day-of-the-week relative shifting can use either Python's weekday numbers + (Monday = 0, Tuesday = 1 .. Sunday = 6) or using dateutil.relativedelta's + day instances (MO, TU .. SU). When using weekday numbers, the returned + date will always be greater than or equal to the starting date. + + Using the above code (which is a Saturday) and asking it to shift to Saturday: + + >>> arw.shift(weekday=5) + + + While asking for a Monday: + + >>> arw.shift(weekday=0) + + + """ + + relative_kwargs = {} + additional_attrs = ["weeks", "quarters", "weekday"] + + for key, value in kwargs.items(): + + if key in self._ATTRS_PLURAL or key in additional_attrs: + relative_kwargs[key] = value + else: + raise AttributeError( + "Invalid shift time frame. Please select one of the following: {}.".format( + ", ".join(self._ATTRS_PLURAL + additional_attrs) + ) + ) + + # core datetime does not support quarters, translate to months. + relative_kwargs.setdefault("months", 0) + relative_kwargs["months"] += ( + relative_kwargs.pop("quarters", 0) * self._MONTHS_PER_QUARTER + ) + + current = self._datetime + relativedelta(**relative_kwargs) + + if not dateutil_tz.datetime_exists(current): + current = dateutil_tz.resolve_imaginary(current) + + return self.fromdatetime(current) + + def to(self, tz): + """Returns a new :class:`Arrow ` object, converted + to the target timezone. + + :param tz: A :ref:`timezone expression `. + + Usage:: + + >>> utc = arrow.utcnow() + >>> utc + + + >>> utc.to('US/Pacific') + + + >>> utc.to(tz.tzlocal()) + + + >>> utc.to('-07:00') + + + >>> utc.to('local') + + + >>> utc.to('local').to('utc') + + + """ + + if not isinstance(tz, dt_tzinfo): + tz = parser.TzinfoParser.parse(tz) + + dt = self._datetime.astimezone(tz) + + return self.__class__( + dt.year, + dt.month, + dt.day, + dt.hour, + dt.minute, + dt.second, + dt.microsecond, + dt.tzinfo, + fold=getattr(dt, "fold", 0), + ) + + # string output and formatting + + def format(self, fmt="YYYY-MM-DD HH:mm:ssZZ", locale="en_us"): + """Returns a string representation of the :class:`Arrow ` object, + formatted according to a format string. + + :param fmt: the format string. + + Usage:: + + >>> arrow.utcnow().format('YYYY-MM-DD HH:mm:ss ZZ') + '2013-05-09 03:56:47 -00:00' + + >>> arrow.utcnow().format('X') + '1368071882' + + >>> arrow.utcnow().format('MMMM DD, YYYY') + 'May 09, 2013' + + >>> arrow.utcnow().format() + '2013-05-09 03:56:47 -00:00' + + """ + + return formatter.DateTimeFormatter(locale).format(self._datetime, fmt) + + def humanize( + self, other=None, locale="en_us", only_distance=False, granularity="auto" + ): + """Returns a localized, humanized representation of a relative difference in time. + + :param other: (optional) an :class:`Arrow ` or ``datetime`` object. + Defaults to now in the current :class:`Arrow ` object's timezone. + :param locale: (optional) a ``str`` specifying a locale. Defaults to 'en_us'. + :param only_distance: (optional) returns only time difference eg: "11 seconds" without "in" or "ago" part. + :param granularity: (optional) defines the precision of the output. Set it to strings 'second', 'minute', + 'hour', 'day', 'week', 'month' or 'year' or a list of any combination of these strings + + Usage:: + + >>> earlier = arrow.utcnow().shift(hours=-2) + >>> earlier.humanize() + '2 hours ago' + + >>> later = earlier.shift(hours=4) + >>> later.humanize(earlier) + 'in 4 hours' + + """ + + locale_name = locale + locale = locales.get_locale(locale) + + if other is None: + utc = datetime.utcnow().replace(tzinfo=dateutil_tz.tzutc()) + dt = utc.astimezone(self._datetime.tzinfo) + + elif isinstance(other, Arrow): + dt = other._datetime + + elif isinstance(other, datetime): + if other.tzinfo is None: + dt = other.replace(tzinfo=self._datetime.tzinfo) + else: + dt = other.astimezone(self._datetime.tzinfo) + + else: + raise TypeError( + "Invalid 'other' argument of type '{}'. " + "Argument must be of type None, Arrow, or datetime.".format( + type(other).__name__ + ) + ) + + if isinstance(granularity, list) and len(granularity) == 1: + granularity = granularity[0] + + delta = int(round(util.total_seconds(self._datetime - dt))) + sign = -1 if delta < 0 else 1 + diff = abs(delta) + delta = diff + + try: + if granularity == "auto": + if diff < 10: + return locale.describe("now", only_distance=only_distance) + + if diff < 45: + seconds = sign * delta + return locale.describe( + "seconds", seconds, only_distance=only_distance + ) + + elif diff < 90: + return locale.describe("minute", sign, only_distance=only_distance) + elif diff < 2700: + minutes = sign * int(max(delta / 60, 2)) + return locale.describe( + "minutes", minutes, only_distance=only_distance + ) + + elif diff < 5400: + return locale.describe("hour", sign, only_distance=only_distance) + elif diff < 79200: + hours = sign * int(max(delta / 3600, 2)) + return locale.describe("hours", hours, only_distance=only_distance) + + # anything less than 48 hours should be 1 day + elif diff < 172800: + return locale.describe("day", sign, only_distance=only_distance) + elif diff < 554400: + days = sign * int(max(delta / 86400, 2)) + return locale.describe("days", days, only_distance=only_distance) + + elif diff < 907200: + return locale.describe("week", sign, only_distance=only_distance) + elif diff < 2419200: + weeks = sign * int(max(delta / 604800, 2)) + return locale.describe("weeks", weeks, only_distance=only_distance) + + elif diff < 3888000: + return locale.describe("month", sign, only_distance=only_distance) + elif diff < 29808000: + self_months = self._datetime.year * 12 + self._datetime.month + other_months = dt.year * 12 + dt.month + + months = sign * int(max(abs(other_months - self_months), 2)) + + return locale.describe( + "months", months, only_distance=only_distance + ) + + elif diff < 47260800: + return locale.describe("year", sign, only_distance=only_distance) + else: + years = sign * int(max(delta / 31536000, 2)) + return locale.describe("years", years, only_distance=only_distance) + + elif util.isstr(granularity): + if granularity == "second": + delta = sign * delta + if abs(delta) < 2: + return locale.describe("now", only_distance=only_distance) + elif granularity == "minute": + delta = sign * delta / self._SECS_PER_MINUTE + elif granularity == "hour": + delta = sign * delta / self._SECS_PER_HOUR + elif granularity == "day": + delta = sign * delta / self._SECS_PER_DAY + elif granularity == "week": + delta = sign * delta / self._SECS_PER_WEEK + elif granularity == "month": + delta = sign * delta / self._SECS_PER_MONTH + elif granularity == "year": + delta = sign * delta / self._SECS_PER_YEAR + else: + raise AttributeError( + "Invalid level of granularity. Please select between 'second', 'minute', 'hour', 'day', 'week', 'month' or 'year'" + ) + + if trunc(abs(delta)) != 1: + granularity += "s" + return locale.describe(granularity, delta, only_distance=only_distance) + + else: + timeframes = [] + if "year" in granularity: + years = sign * delta / self._SECS_PER_YEAR + delta %= self._SECS_PER_YEAR + timeframes.append(["year", years]) + + if "month" in granularity: + months = sign * delta / self._SECS_PER_MONTH + delta %= self._SECS_PER_MONTH + timeframes.append(["month", months]) + + if "week" in granularity: + weeks = sign * delta / self._SECS_PER_WEEK + delta %= self._SECS_PER_WEEK + timeframes.append(["week", weeks]) + + if "day" in granularity: + days = sign * delta / self._SECS_PER_DAY + delta %= self._SECS_PER_DAY + timeframes.append(["day", days]) + + if "hour" in granularity: + hours = sign * delta / self._SECS_PER_HOUR + delta %= self._SECS_PER_HOUR + timeframes.append(["hour", hours]) + + if "minute" in granularity: + minutes = sign * delta / self._SECS_PER_MINUTE + delta %= self._SECS_PER_MINUTE + timeframes.append(["minute", minutes]) + + if "second" in granularity: + seconds = sign * delta + timeframes.append(["second", seconds]) + + if len(timeframes) < len(granularity): + raise AttributeError( + "Invalid level of granularity. " + "Please select between 'second', 'minute', 'hour', 'day', 'week', 'month' or 'year'." + ) + + for tf in timeframes: + # Make granularity plural if the delta is not equal to 1 + if trunc(abs(tf[1])) != 1: + tf[0] += "s" + return locale.describe_multi(timeframes, only_distance=only_distance) + + except KeyError as e: + raise ValueError( + "Humanization of the {} granularity is not currently translated in the '{}' locale. " + "Please consider making a contribution to this locale.".format( + e, locale_name + ) + ) + + # query functions + + def is_between(self, start, end, bounds="()"): + """Returns a boolean denoting whether the specified date and time is between + the start and end dates and times. + + :param start: an :class:`Arrow ` object. + :param end: an :class:`Arrow ` object. + :param bounds: (optional) a ``str`` of either '()', '(]', '[)', or '[]' that specifies + whether to include or exclude the start and end values in the range. '(' excludes + the start, '[' includes the start, ')' excludes the end, and ']' includes the end. + If the bounds are not specified, the default bound '()' is used. + + Usage:: + + >>> start = arrow.get(datetime(2013, 5, 5, 12, 30, 10)) + >>> end = arrow.get(datetime(2013, 5, 5, 12, 30, 36)) + >>> arrow.get(datetime(2013, 5, 5, 12, 30, 27)).is_between(start, end) + True + + >>> start = arrow.get(datetime(2013, 5, 5)) + >>> end = arrow.get(datetime(2013, 5, 8)) + >>> arrow.get(datetime(2013, 5, 8)).is_between(start, end, '[]') + True + + >>> start = arrow.get(datetime(2013, 5, 5)) + >>> end = arrow.get(datetime(2013, 5, 8)) + >>> arrow.get(datetime(2013, 5, 8)).is_between(start, end, '[)') + False + + """ + + util.validate_bounds(bounds) + + if not isinstance(start, Arrow): + raise TypeError( + "Can't parse start date argument type of '{}'".format(type(start)) + ) + + if not isinstance(end, Arrow): + raise TypeError( + "Can't parse end date argument type of '{}'".format(type(end)) + ) + + include_start = bounds[0] == "[" + include_end = bounds[1] == "]" + + target_timestamp = self.float_timestamp + start_timestamp = start.float_timestamp + end_timestamp = end.float_timestamp + + if include_start and include_end: + return ( + target_timestamp >= start_timestamp + and target_timestamp <= end_timestamp + ) + elif include_start and not include_end: + return ( + target_timestamp >= start_timestamp and target_timestamp < end_timestamp + ) + elif not include_start and include_end: + return ( + target_timestamp > start_timestamp and target_timestamp <= end_timestamp + ) + else: + return ( + target_timestamp > start_timestamp and target_timestamp < end_timestamp + ) + + # datetime methods + + def date(self): + """Returns a ``date`` object with the same year, month and day. + + Usage:: + + >>> arrow.utcnow().date() + datetime.date(2019, 1, 23) + + """ + + return self._datetime.date() + + def time(self): + """Returns a ``time`` object with the same hour, minute, second, microsecond. + + Usage:: + + >>> arrow.utcnow().time() + datetime.time(12, 15, 34, 68352) + + """ + + return self._datetime.time() + + def timetz(self): + """Returns a ``time`` object with the same hour, minute, second, microsecond and + tzinfo. + + Usage:: + + >>> arrow.utcnow().timetz() + datetime.time(12, 5, 18, 298893, tzinfo=tzutc()) + + """ + + return self._datetime.timetz() + + def astimezone(self, tz): + """Returns a ``datetime`` object, converted to the specified timezone. + + :param tz: a ``tzinfo`` object. + + Usage:: + + >>> pacific=arrow.now('US/Pacific') + >>> nyc=arrow.now('America/New_York').tzinfo + >>> pacific.astimezone(nyc) + datetime.datetime(2019, 1, 20, 10, 24, 22, 328172, tzinfo=tzfile('/usr/share/zoneinfo/America/New_York')) + + """ + + return self._datetime.astimezone(tz) + + def utcoffset(self): + """Returns a ``timedelta`` object representing the whole number of minutes difference from + UTC time. + + Usage:: + + >>> arrow.now('US/Pacific').utcoffset() + datetime.timedelta(-1, 57600) + + """ + + return self._datetime.utcoffset() + + def dst(self): + """Returns the daylight savings time adjustment. + + Usage:: + + >>> arrow.utcnow().dst() + datetime.timedelta(0) + + """ + + return self._datetime.dst() + + def timetuple(self): + """Returns a ``time.struct_time``, in the current timezone. + + Usage:: + + >>> arrow.utcnow().timetuple() + time.struct_time(tm_year=2019, tm_mon=1, tm_mday=20, tm_hour=15, tm_min=17, tm_sec=8, tm_wday=6, tm_yday=20, tm_isdst=0) + + """ + + return self._datetime.timetuple() + + def utctimetuple(self): + """Returns a ``time.struct_time``, in UTC time. + + Usage:: + + >>> arrow.utcnow().utctimetuple() + time.struct_time(tm_year=2019, tm_mon=1, tm_mday=19, tm_hour=21, tm_min=41, tm_sec=7, tm_wday=5, tm_yday=19, tm_isdst=0) + + """ + + return self._datetime.utctimetuple() + + def toordinal(self): + """Returns the proleptic Gregorian ordinal of the date. + + Usage:: + + >>> arrow.utcnow().toordinal() + 737078 + + """ + + return self._datetime.toordinal() + + def weekday(self): + """Returns the day of the week as an integer (0-6). + + Usage:: + + >>> arrow.utcnow().weekday() + 5 + + """ + + return self._datetime.weekday() + + def isoweekday(self): + """Returns the ISO day of the week as an integer (1-7). + + Usage:: + + >>> arrow.utcnow().isoweekday() + 6 + + """ + + return self._datetime.isoweekday() + + def isocalendar(self): + """Returns a 3-tuple, (ISO year, ISO week number, ISO weekday). + + Usage:: + + >>> arrow.utcnow().isocalendar() + (2019, 3, 6) + + """ + + return self._datetime.isocalendar() + + def isoformat(self, sep="T"): + """Returns an ISO 8601 formatted representation of the date and time. + + Usage:: + + >>> arrow.utcnow().isoformat() + '2019-01-19T18:30:52.442118+00:00' + + """ + + return self._datetime.isoformat(sep) + + def ctime(self): + """Returns a ctime formatted representation of the date and time. + + Usage:: + + >>> arrow.utcnow().ctime() + 'Sat Jan 19 18:26:50 2019' + + """ + + return self._datetime.ctime() + + def strftime(self, format): + """Formats in the style of ``datetime.strftime``. + + :param format: the format string. + + Usage:: + + >>> arrow.utcnow().strftime('%d-%m-%Y %H:%M:%S') + '23-01-2019 12:28:17' + + """ + + return self._datetime.strftime(format) + + def for_json(self): + """Serializes for the ``for_json`` protocol of simplejson. + + Usage:: + + >>> arrow.utcnow().for_json() + '2019-01-19T18:25:36.760079+00:00' + + """ + + return self.isoformat() + + # math + + def __add__(self, other): + + if isinstance(other, (timedelta, relativedelta)): + return self.fromdatetime(self._datetime + other, self._datetime.tzinfo) + + return NotImplemented + + def __radd__(self, other): + return self.__add__(other) + + def __sub__(self, other): + + if isinstance(other, (timedelta, relativedelta)): + return self.fromdatetime(self._datetime - other, self._datetime.tzinfo) + + elif isinstance(other, datetime): + return self._datetime - other + + elif isinstance(other, Arrow): + return self._datetime - other._datetime + + return NotImplemented + + def __rsub__(self, other): + + if isinstance(other, datetime): + return other - self._datetime + + return NotImplemented + + # comparisons + + def __eq__(self, other): + + if not isinstance(other, (Arrow, datetime)): + return False + + return self._datetime == self._get_datetime(other) + + def __ne__(self, other): + + if not isinstance(other, (Arrow, datetime)): + return True + + return not self.__eq__(other) + + def __gt__(self, other): + + if not isinstance(other, (Arrow, datetime)): + return NotImplemented + + return self._datetime > self._get_datetime(other) + + def __ge__(self, other): + + if not isinstance(other, (Arrow, datetime)): + return NotImplemented + + return self._datetime >= self._get_datetime(other) + + def __lt__(self, other): + + if not isinstance(other, (Arrow, datetime)): + return NotImplemented + + return self._datetime < self._get_datetime(other) + + def __le__(self, other): + + if not isinstance(other, (Arrow, datetime)): + return NotImplemented + + return self._datetime <= self._get_datetime(other) + + def __cmp__(self, other): + if sys.version_info[0] < 3: # pragma: no cover + if not isinstance(other, (Arrow, datetime)): + raise TypeError( + "can't compare '{}' to '{}'".format(type(self), type(other)) + ) + + # internal methods + + @staticmethod + def _get_tzinfo(tz_expr): + + if tz_expr is None: + return dateutil_tz.tzutc() + if isinstance(tz_expr, dt_tzinfo): + return tz_expr + else: + try: + return parser.TzinfoParser.parse(tz_expr) + except parser.ParserError: + raise ValueError("'{}' not recognized as a timezone".format(tz_expr)) + + @classmethod + def _get_datetime(cls, expr): + """Get datetime object for a specified expression.""" + if isinstance(expr, Arrow): + return expr.datetime + elif isinstance(expr, datetime): + return expr + elif util.is_timestamp(expr): + timestamp = float(expr) + return cls.utcfromtimestamp(timestamp).datetime + else: + raise ValueError( + "'{}' not recognized as a datetime or timestamp.".format(expr) + ) + + @classmethod + def _get_frames(cls, name): + + if name in cls._ATTRS: + return name, "{}s".format(name), 1 + elif name[-1] == "s" and name[:-1] in cls._ATTRS: + return name[:-1], name, 1 + elif name in ["week", "weeks"]: + return "week", "weeks", 1 + elif name in ["quarter", "quarters"]: + return "quarter", "months", 3 + + supported = ", ".join( + [ + "year(s)", + "month(s)", + "day(s)", + "hour(s)", + "minute(s)", + "second(s)", + "microsecond(s)", + "week(s)", + "quarter(s)", + ] + ) + raise AttributeError( + "range/span over frame {} not supported. Supported frames: {}".format( + name, supported + ) + ) + + @classmethod + def _get_iteration_params(cls, end, limit): + + if end is None: + + if limit is None: + raise ValueError("one of 'end' or 'limit' is required") + + return cls.max, limit + + else: + if limit is None: + return end, sys.maxsize + return end, limit + + @staticmethod + def _is_last_day_of_month(date): + return date.day == calendar.monthrange(date.year, date.month)[1] + + +Arrow.min = Arrow.fromdatetime(datetime.min) +Arrow.max = Arrow.fromdatetime(datetime.max) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/constants.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/constants.py new file mode 100644 index 0000000000..81e37b26de --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/constants.py @@ -0,0 +1,9 @@ +# -*- coding: utf-8 -*- + +# Output of time.mktime(datetime.max.timetuple()) on macOS +# This value must be hardcoded for compatibility with Windows +# Platform-independent max timestamps are hard to form +# https://stackoverflow.com/q/46133223 +MAX_TIMESTAMP = 253402318799.0 +MAX_TIMESTAMP_MS = MAX_TIMESTAMP * 1000 +MAX_TIMESTAMP_US = MAX_TIMESTAMP * 1000000 diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/factory.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/factory.py new file mode 100644 index 0000000000..05933e8151 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/factory.py @@ -0,0 +1,301 @@ +# -*- coding: utf-8 -*- +""" +Implements the :class:`ArrowFactory ` class, +providing factory methods for common :class:`Arrow ` +construction scenarios. + +""" + +from __future__ import absolute_import + +import calendar +from datetime import date, datetime +from datetime import tzinfo as dt_tzinfo +from time import struct_time + +from dateutil import tz as dateutil_tz + +from arrow import parser +from arrow.arrow import Arrow +from arrow.util import is_timestamp, iso_to_gregorian, isstr + + +class ArrowFactory(object): + """A factory for generating :class:`Arrow ` objects. + + :param type: (optional) the :class:`Arrow `-based class to construct from. + Defaults to :class:`Arrow `. + + """ + + def __init__(self, type=Arrow): + self.type = type + + def get(self, *args, **kwargs): + """Returns an :class:`Arrow ` object based on flexible inputs. + + :param locale: (optional) a ``str`` specifying a locale for the parser. Defaults to 'en_us'. + :param tzinfo: (optional) a :ref:`timezone expression ` or tzinfo object. + Replaces the timezone unless using an input form that is explicitly UTC or specifies + the timezone in a positional argument. Defaults to UTC. + :param normalize_whitespace: (optional) a ``bool`` specifying whether or not to normalize + redundant whitespace (spaces, tabs, and newlines) in a datetime string before parsing. + Defaults to false. + + Usage:: + + >>> import arrow + + **No inputs** to get current UTC time:: + + >>> arrow.get() + + + **None** to also get current UTC time:: + + >>> arrow.get(None) + + + **One** :class:`Arrow ` object, to get a copy. + + >>> arw = arrow.utcnow() + >>> arrow.get(arw) + + + **One** ``float`` or ``int``, convertible to a floating-point timestamp, to get + that timestamp in UTC:: + + >>> arrow.get(1367992474.293378) + + + >>> arrow.get(1367992474) + + + **One** ISO 8601-formatted ``str``, to parse it:: + + >>> arrow.get('2013-09-29T01:26:43.830580') + + + **One** ISO 8601-formatted ``str``, in basic format, to parse it:: + + >>> arrow.get('20160413T133656.456289') + + + **One** ``tzinfo``, to get the current time **converted** to that timezone:: + + >>> arrow.get(tz.tzlocal()) + + + **One** naive ``datetime``, to get that datetime in UTC:: + + >>> arrow.get(datetime(2013, 5, 5)) + + + **One** aware ``datetime``, to get that datetime:: + + >>> arrow.get(datetime(2013, 5, 5, tzinfo=tz.tzlocal())) + + + **One** naive ``date``, to get that date in UTC:: + + >>> arrow.get(date(2013, 5, 5)) + + + **One** time.struct time:: + + >>> arrow.get(gmtime(0)) + + + **One** iso calendar ``tuple``, to get that week date in UTC:: + + >>> arrow.get((2013, 18, 7)) + + + **Two** arguments, a naive or aware ``datetime``, and a replacement + :ref:`timezone expression `:: + + >>> arrow.get(datetime(2013, 5, 5), 'US/Pacific') + + + **Two** arguments, a naive ``date``, and a replacement + :ref:`timezone expression `:: + + >>> arrow.get(date(2013, 5, 5), 'US/Pacific') + + + **Two** arguments, both ``str``, to parse the first according to the format of the second:: + + >>> arrow.get('2013-05-05 12:30:45 America/Chicago', 'YYYY-MM-DD HH:mm:ss ZZZ') + + + **Two** arguments, first a ``str`` to parse and second a ``list`` of formats to try:: + + >>> arrow.get('2013-05-05 12:30:45', ['MM/DD/YYYY', 'YYYY-MM-DD HH:mm:ss']) + + + **Three or more** arguments, as for the constructor of a ``datetime``:: + + >>> arrow.get(2013, 5, 5, 12, 30, 45) + + + """ + + arg_count = len(args) + locale = kwargs.pop("locale", "en_us") + tz = kwargs.get("tzinfo", None) + normalize_whitespace = kwargs.pop("normalize_whitespace", False) + + # if kwargs given, send to constructor unless only tzinfo provided + if len(kwargs) > 1: + arg_count = 3 + + # tzinfo kwarg is not provided + if len(kwargs) == 1 and tz is None: + arg_count = 3 + + # () -> now, @ utc. + if arg_count == 0: + if isstr(tz): + tz = parser.TzinfoParser.parse(tz) + return self.type.now(tz) + + if isinstance(tz, dt_tzinfo): + return self.type.now(tz) + + return self.type.utcnow() + + if arg_count == 1: + arg = args[0] + + # (None) -> now, @ utc. + if arg is None: + return self.type.utcnow() + + # try (int, float) -> from timestamp with tz + elif not isstr(arg) and is_timestamp(arg): + if tz is None: + # set to UTC by default + tz = dateutil_tz.tzutc() + return self.type.fromtimestamp(arg, tzinfo=tz) + + # (Arrow) -> from the object's datetime. + elif isinstance(arg, Arrow): + return self.type.fromdatetime(arg.datetime) + + # (datetime) -> from datetime. + elif isinstance(arg, datetime): + return self.type.fromdatetime(arg) + + # (date) -> from date. + elif isinstance(arg, date): + return self.type.fromdate(arg) + + # (tzinfo) -> now, @ tzinfo. + elif isinstance(arg, dt_tzinfo): + return self.type.now(arg) + + # (str) -> parse. + elif isstr(arg): + dt = parser.DateTimeParser(locale).parse_iso(arg, normalize_whitespace) + return self.type.fromdatetime(dt, tz) + + # (struct_time) -> from struct_time + elif isinstance(arg, struct_time): + return self.type.utcfromtimestamp(calendar.timegm(arg)) + + # (iso calendar) -> convert then from date + elif isinstance(arg, tuple) and len(arg) == 3: + dt = iso_to_gregorian(*arg) + return self.type.fromdate(dt) + + else: + raise TypeError( + "Can't parse single argument of type '{}'".format(type(arg)) + ) + + elif arg_count == 2: + + arg_1, arg_2 = args[0], args[1] + + if isinstance(arg_1, datetime): + + # (datetime, tzinfo/str) -> fromdatetime replace tzinfo. + if isinstance(arg_2, dt_tzinfo) or isstr(arg_2): + return self.type.fromdatetime(arg_1, arg_2) + else: + raise TypeError( + "Can't parse two arguments of types 'datetime', '{}'".format( + type(arg_2) + ) + ) + + elif isinstance(arg_1, date): + + # (date, tzinfo/str) -> fromdate replace tzinfo. + if isinstance(arg_2, dt_tzinfo) or isstr(arg_2): + return self.type.fromdate(arg_1, tzinfo=arg_2) + else: + raise TypeError( + "Can't parse two arguments of types 'date', '{}'".format( + type(arg_2) + ) + ) + + # (str, format) -> parse. + elif isstr(arg_1) and (isstr(arg_2) or isinstance(arg_2, list)): + dt = parser.DateTimeParser(locale).parse( + args[0], args[1], normalize_whitespace + ) + return self.type.fromdatetime(dt, tzinfo=tz) + + else: + raise TypeError( + "Can't parse two arguments of types '{}' and '{}'".format( + type(arg_1), type(arg_2) + ) + ) + + # 3+ args -> datetime-like via constructor. + else: + return self.type(*args, **kwargs) + + def utcnow(self): + """Returns an :class:`Arrow ` object, representing "now" in UTC time. + + Usage:: + + >>> import arrow + >>> arrow.utcnow() + + """ + + return self.type.utcnow() + + def now(self, tz=None): + """Returns an :class:`Arrow ` object, representing "now" in the given + timezone. + + :param tz: (optional) A :ref:`timezone expression `. Defaults to local time. + + Usage:: + + >>> import arrow + >>> arrow.now() + + + >>> arrow.now('US/Pacific') + + + >>> arrow.now('+02:00') + + + >>> arrow.now('local') + + """ + + if tz is None: + tz = dateutil_tz.tzlocal() + elif not isinstance(tz, dt_tzinfo): + tz = parser.TzinfoParser.parse(tz) + + return self.type.now(tz) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/formatter.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/formatter.py new file mode 100644 index 0000000000..9f9d7a44da --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/formatter.py @@ -0,0 +1,139 @@ +# -*- coding: utf-8 -*- +from __future__ import absolute_import, division + +import calendar +import re + +from dateutil import tz as dateutil_tz + +from arrow import locales, util + +FORMAT_ATOM = "YYYY-MM-DD HH:mm:ssZZ" +FORMAT_COOKIE = "dddd, DD-MMM-YYYY HH:mm:ss ZZZ" +FORMAT_RFC822 = "ddd, DD MMM YY HH:mm:ss Z" +FORMAT_RFC850 = "dddd, DD-MMM-YY HH:mm:ss ZZZ" +FORMAT_RFC1036 = "ddd, DD MMM YY HH:mm:ss Z" +FORMAT_RFC1123 = "ddd, DD MMM YYYY HH:mm:ss Z" +FORMAT_RFC2822 = "ddd, DD MMM YYYY HH:mm:ss Z" +FORMAT_RFC3339 = "YYYY-MM-DD HH:mm:ssZZ" +FORMAT_RSS = "ddd, DD MMM YYYY HH:mm:ss Z" +FORMAT_W3C = "YYYY-MM-DD HH:mm:ssZZ" + + +class DateTimeFormatter(object): + + # This pattern matches characters enclosed in square brackets are matched as + # an atomic group. For more info on atomic groups and how to they are + # emulated in Python's re library, see https://stackoverflow.com/a/13577411/2701578 + + _FORMAT_RE = re.compile( + r"(\[(?:(?=(?P[^]]))(?P=literal))*\]|YYY?Y?|MM?M?M?|Do|DD?D?D?|d?dd?d?|HH?|hh?|mm?|ss?|SS?S?S?S?S?|ZZ?Z?|a|A|X|x|W)" + ) + + def __init__(self, locale="en_us"): + + self.locale = locales.get_locale(locale) + + def format(cls, dt, fmt): + + return cls._FORMAT_RE.sub(lambda m: cls._format_token(dt, m.group(0)), fmt) + + def _format_token(self, dt, token): + + if token and token.startswith("[") and token.endswith("]"): + return token[1:-1] + + if token == "YYYY": + return self.locale.year_full(dt.year) + if token == "YY": + return self.locale.year_abbreviation(dt.year) + + if token == "MMMM": + return self.locale.month_name(dt.month) + if token == "MMM": + return self.locale.month_abbreviation(dt.month) + if token == "MM": + return "{:02d}".format(dt.month) + if token == "M": + return str(dt.month) + + if token == "DDDD": + return "{:03d}".format(dt.timetuple().tm_yday) + if token == "DDD": + return str(dt.timetuple().tm_yday) + if token == "DD": + return "{:02d}".format(dt.day) + if token == "D": + return str(dt.day) + + if token == "Do": + return self.locale.ordinal_number(dt.day) + + if token == "dddd": + return self.locale.day_name(dt.isoweekday()) + if token == "ddd": + return self.locale.day_abbreviation(dt.isoweekday()) + if token == "d": + return str(dt.isoweekday()) + + if token == "HH": + return "{:02d}".format(dt.hour) + if token == "H": + return str(dt.hour) + if token == "hh": + return "{:02d}".format(dt.hour if 0 < dt.hour < 13 else abs(dt.hour - 12)) + if token == "h": + return str(dt.hour if 0 < dt.hour < 13 else abs(dt.hour - 12)) + + if token == "mm": + return "{:02d}".format(dt.minute) + if token == "m": + return str(dt.minute) + + if token == "ss": + return "{:02d}".format(dt.second) + if token == "s": + return str(dt.second) + + if token == "SSSSSS": + return str("{:06d}".format(int(dt.microsecond))) + if token == "SSSSS": + return str("{:05d}".format(int(dt.microsecond / 10))) + if token == "SSSS": + return str("{:04d}".format(int(dt.microsecond / 100))) + if token == "SSS": + return str("{:03d}".format(int(dt.microsecond / 1000))) + if token == "SS": + return str("{:02d}".format(int(dt.microsecond / 10000))) + if token == "S": + return str(int(dt.microsecond / 100000)) + + if token == "X": + # TODO: replace with a call to dt.timestamp() when we drop Python 2.7 + return str(calendar.timegm(dt.utctimetuple())) + + if token == "x": + # TODO: replace with a call to dt.timestamp() when we drop Python 2.7 + ts = calendar.timegm(dt.utctimetuple()) + (dt.microsecond / 1000000) + return str(int(ts * 1000000)) + + if token == "ZZZ": + return dt.tzname() + + if token in ["ZZ", "Z"]: + separator = ":" if token == "ZZ" else "" + tz = dateutil_tz.tzutc() if dt.tzinfo is None else dt.tzinfo + total_minutes = int(util.total_seconds(tz.utcoffset(dt)) / 60) + + sign = "+" if total_minutes >= 0 else "-" + total_minutes = abs(total_minutes) + hour, minute = divmod(total_minutes, 60) + + return "{}{:02d}{}{:02d}".format(sign, hour, separator, minute) + + if token in ("a", "A"): + return self.locale.meridian(dt.hour, token) + + if token == "W": + year, week, day = dt.isocalendar() + return "{}-W{:02d}-{}".format(year, week, day) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/locales.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/locales.py new file mode 100644 index 0000000000..6833da5a78 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/locales.py @@ -0,0 +1,4267 @@ +# -*- coding: utf-8 -*- +from __future__ import absolute_import, unicode_literals + +import inspect +import sys +from math import trunc + + +def get_locale(name): + """Returns an appropriate :class:`Locale ` + corresponding to an inpute locale name. + + :param name: the name of the locale. + + """ + + locale_cls = _locales.get(name.lower()) + + if locale_cls is None: + raise ValueError("Unsupported locale '{}'".format(name)) + + return locale_cls() + + +def get_locale_by_class_name(name): + """Returns an appropriate :class:`Locale ` + corresponding to an locale class name. + + :param name: the name of the locale class. + + """ + locale_cls = globals().get(name) + + if locale_cls is None: + raise ValueError("Unsupported locale '{}'".format(name)) + + return locale_cls() + + +# base locale type. + + +class Locale(object): + """ Represents locale-specific data and functionality. """ + + names = [] + + timeframes = { + "now": "", + "second": "", + "seconds": "", + "minute": "", + "minutes": "", + "hour": "", + "hours": "", + "day": "", + "days": "", + "week": "", + "weeks": "", + "month": "", + "months": "", + "year": "", + "years": "", + } + + meridians = {"am": "", "pm": "", "AM": "", "PM": ""} + + past = None + future = None + and_word = None + + month_names = [] + month_abbreviations = [] + + day_names = [] + day_abbreviations = [] + + ordinal_day_re = r"(\d+)" + + def __init__(self): + + self._month_name_to_ordinal = None + + def describe(self, timeframe, delta=0, only_distance=False): + """Describes a delta within a timeframe in plain language. + + :param timeframe: a string representing a timeframe. + :param delta: a quantity representing a delta in a timeframe. + :param only_distance: return only distance eg: "11 seconds" without "in" or "ago" keywords + """ + + humanized = self._format_timeframe(timeframe, delta) + if not only_distance: + humanized = self._format_relative(humanized, timeframe, delta) + + return humanized + + def describe_multi(self, timeframes, only_distance=False): + """Describes a delta within multiple timeframes in plain language. + + :param timeframes: a list of string, quantity pairs each representing a timeframe and delta. + :param only_distance: return only distance eg: "2 hours and 11 seconds" without "in" or "ago" keywords + """ + + humanized = "" + for index, (timeframe, delta) in enumerate(timeframes): + humanized += self._format_timeframe(timeframe, delta) + if index == len(timeframes) - 2 and self.and_word: + humanized += " " + self.and_word + " " + elif index < len(timeframes) - 1: + humanized += " " + + if not only_distance: + humanized = self._format_relative(humanized, timeframe, delta) + + return humanized + + def day_name(self, day): + """Returns the day name for a specified day of the week. + + :param day: the ``int`` day of the week (1-7). + + """ + + return self.day_names[day] + + def day_abbreviation(self, day): + """Returns the day abbreviation for a specified day of the week. + + :param day: the ``int`` day of the week (1-7). + + """ + + return self.day_abbreviations[day] + + def month_name(self, month): + """Returns the month name for a specified month of the year. + + :param month: the ``int`` month of the year (1-12). + + """ + + return self.month_names[month] + + def month_abbreviation(self, month): + """Returns the month abbreviation for a specified month of the year. + + :param month: the ``int`` month of the year (1-12). + + """ + + return self.month_abbreviations[month] + + def month_number(self, name): + """Returns the month number for a month specified by name or abbreviation. + + :param name: the month name or abbreviation. + + """ + + if self._month_name_to_ordinal is None: + self._month_name_to_ordinal = self._name_to_ordinal(self.month_names) + self._month_name_to_ordinal.update( + self._name_to_ordinal(self.month_abbreviations) + ) + + return self._month_name_to_ordinal.get(name) + + def year_full(self, year): + """Returns the year for specific locale if available + + :param name: the ``int`` year (4-digit) + """ + return "{:04d}".format(year) + + def year_abbreviation(self, year): + """Returns the year for specific locale if available + + :param name: the ``int`` year (4-digit) + """ + return "{:04d}".format(year)[2:] + + def meridian(self, hour, token): + """Returns the meridian indicator for a specified hour and format token. + + :param hour: the ``int`` hour of the day. + :param token: the format token. + """ + + if token == "a": + return self.meridians["am"] if hour < 12 else self.meridians["pm"] + if token == "A": + return self.meridians["AM"] if hour < 12 else self.meridians["PM"] + + def ordinal_number(self, n): + """Returns the ordinal format of a given integer + + :param n: an integer + """ + return self._ordinal_number(n) + + def _ordinal_number(self, n): + return "{}".format(n) + + def _name_to_ordinal(self, lst): + return dict(map(lambda i: (i[1].lower(), i[0] + 1), enumerate(lst[1:]))) + + def _format_timeframe(self, timeframe, delta): + return self.timeframes[timeframe].format(trunc(abs(delta))) + + def _format_relative(self, humanized, timeframe, delta): + + if timeframe == "now": + return humanized + + direction = self.past if delta < 0 else self.future + + return direction.format(humanized) + + +# base locale type implementations. + + +class EnglishLocale(Locale): + + names = [ + "en", + "en_us", + "en_gb", + "en_au", + "en_be", + "en_jp", + "en_za", + "en_ca", + "en_ph", + ] + + past = "{0} ago" + future = "in {0}" + and_word = "and" + + timeframes = { + "now": "just now", + "second": "a second", + "seconds": "{0} seconds", + "minute": "a minute", + "minutes": "{0} minutes", + "hour": "an hour", + "hours": "{0} hours", + "day": "a day", + "days": "{0} days", + "week": "a week", + "weeks": "{0} weeks", + "month": "a month", + "months": "{0} months", + "year": "a year", + "years": "{0} years", + } + + meridians = {"am": "am", "pm": "pm", "AM": "AM", "PM": "PM"} + + month_names = [ + "", + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December", + ] + month_abbreviations = [ + "", + "Jan", + "Feb", + "Mar", + "Apr", + "May", + "Jun", + "Jul", + "Aug", + "Sep", + "Oct", + "Nov", + "Dec", + ] + + day_names = [ + "", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday", + ] + day_abbreviations = ["", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"] + + ordinal_day_re = r"((?P[2-3]?1(?=st)|[2-3]?2(?=nd)|[2-3]?3(?=rd)|[1-3]?[04-9](?=th)|1[1-3](?=th))(st|nd|rd|th))" + + def _ordinal_number(self, n): + if n % 100 not in (11, 12, 13): + remainder = abs(n) % 10 + if remainder == 1: + return "{}st".format(n) + elif remainder == 2: + return "{}nd".format(n) + elif remainder == 3: + return "{}rd".format(n) + return "{}th".format(n) + + def describe(self, timeframe, delta=0, only_distance=False): + """Describes a delta within a timeframe in plain language. + + :param timeframe: a string representing a timeframe. + :param delta: a quantity representing a delta in a timeframe. + :param only_distance: return only distance eg: "11 seconds" without "in" or "ago" keywords + """ + + humanized = super(EnglishLocale, self).describe(timeframe, delta, only_distance) + if only_distance and timeframe == "now": + humanized = "instantly" + + return humanized + + +class ItalianLocale(Locale): + names = ["it", "it_it"] + past = "{0} fa" + future = "tra {0}" + and_word = "e" + + timeframes = { + "now": "adesso", + "second": "un secondo", + "seconds": "{0} qualche secondo", + "minute": "un minuto", + "minutes": "{0} minuti", + "hour": "un'ora", + "hours": "{0} ore", + "day": "un giorno", + "days": "{0} giorni", + "week": "una settimana,", + "weeks": "{0} settimane", + "month": "un mese", + "months": "{0} mesi", + "year": "un anno", + "years": "{0} anni", + } + + month_names = [ + "", + "gennaio", + "febbraio", + "marzo", + "aprile", + "maggio", + "giugno", + "luglio", + "agosto", + "settembre", + "ottobre", + "novembre", + "dicembre", + ] + month_abbreviations = [ + "", + "gen", + "feb", + "mar", + "apr", + "mag", + "giu", + "lug", + "ago", + "set", + "ott", + "nov", + "dic", + ] + + day_names = [ + "", + "lunedì", + "martedì", + "mercoledì", + "giovedì", + "venerdì", + "sabato", + "domenica", + ] + day_abbreviations = ["", "lun", "mar", "mer", "gio", "ven", "sab", "dom"] + + ordinal_day_re = r"((?P[1-3]?[0-9](?=[ºª]))[ºª])" + + def _ordinal_number(self, n): + return "{}º".format(n) + + +class SpanishLocale(Locale): + names = ["es", "es_es"] + past = "hace {0}" + future = "en {0}" + and_word = "y" + + timeframes = { + "now": "ahora", + "second": "un segundo", + "seconds": "{0} segundos", + "minute": "un minuto", + "minutes": "{0} minutos", + "hour": "una hora", + "hours": "{0} horas", + "day": "un día", + "days": "{0} días", + "week": "una semana", + "weeks": "{0} semanas", + "month": "un mes", + "months": "{0} meses", + "year": "un año", + "years": "{0} años", + } + + meridians = {"am": "am", "pm": "pm", "AM": "AM", "PM": "PM"} + + month_names = [ + "", + "enero", + "febrero", + "marzo", + "abril", + "mayo", + "junio", + "julio", + "agosto", + "septiembre", + "octubre", + "noviembre", + "diciembre", + ] + month_abbreviations = [ + "", + "ene", + "feb", + "mar", + "abr", + "may", + "jun", + "jul", + "ago", + "sep", + "oct", + "nov", + "dic", + ] + + day_names = [ + "", + "lunes", + "martes", + "miércoles", + "jueves", + "viernes", + "sábado", + "domingo", + ] + day_abbreviations = ["", "lun", "mar", "mie", "jue", "vie", "sab", "dom"] + + ordinal_day_re = r"((?P[1-3]?[0-9](?=[ºª]))[ºª])" + + def _ordinal_number(self, n): + return "{}º".format(n) + + +class FrenchBaseLocale(Locale): + + past = "il y a {0}" + future = "dans {0}" + and_word = "et" + + timeframes = { + "now": "maintenant", + "second": "une seconde", + "seconds": "{0} quelques secondes", + "minute": "une minute", + "minutes": "{0} minutes", + "hour": "une heure", + "hours": "{0} heures", + "day": "un jour", + "days": "{0} jours", + "week": "une semaine", + "weeks": "{0} semaines", + "month": "un mois", + "months": "{0} mois", + "year": "un an", + "years": "{0} ans", + } + + month_names = [ + "", + "janvier", + "février", + "mars", + "avril", + "mai", + "juin", + "juillet", + "août", + "septembre", + "octobre", + "novembre", + "décembre", + ] + + day_names = [ + "", + "lundi", + "mardi", + "mercredi", + "jeudi", + "vendredi", + "samedi", + "dimanche", + ] + day_abbreviations = ["", "lun", "mar", "mer", "jeu", "ven", "sam", "dim"] + + ordinal_day_re = ( + r"((?P\b1(?=er\b)|[1-3]?[02-9](?=e\b)|[1-3]1(?=e\b))(er|e)\b)" + ) + + def _ordinal_number(self, n): + if abs(n) == 1: + return "{}er".format(n) + return "{}e".format(n) + + +class FrenchLocale(FrenchBaseLocale, Locale): + + names = ["fr", "fr_fr"] + + month_abbreviations = [ + "", + "janv", + "févr", + "mars", + "avr", + "mai", + "juin", + "juil", + "août", + "sept", + "oct", + "nov", + "déc", + ] + + +class FrenchCanadianLocale(FrenchBaseLocale, Locale): + + names = ["fr_ca"] + + month_abbreviations = [ + "", + "janv", + "févr", + "mars", + "avr", + "mai", + "juin", + "juill", + "août", + "sept", + "oct", + "nov", + "déc", + ] + + +class GreekLocale(Locale): + + names = ["el", "el_gr"] + + past = "{0} πριν" + future = "σε {0}" + and_word = "και" + + timeframes = { + "now": "τώρα", + "second": "ένα δεύτερο", + "seconds": "{0} δευτερόλεπτα", + "minute": "ένα λεπτό", + "minutes": "{0} λεπτά", + "hour": "μία ώρα", + "hours": "{0} ώρες", + "day": "μία μέρα", + "days": "{0} μέρες", + "month": "ένα μήνα", + "months": "{0} μήνες", + "year": "ένα χρόνο", + "years": "{0} χρόνια", + } + + month_names = [ + "", + "Ιανουαρίου", + "Φεβρουαρίου", + "Μαρτίου", + "Απριλίου", + "Μαΐου", + "Ιουνίου", + "Ιουλίου", + "Αυγούστου", + "Σεπτεμβρίου", + "Οκτωβρίου", + "Νοεμβρίου", + "Δεκεμβρίου", + ] + month_abbreviations = [ + "", + "Ιαν", + "Φεβ", + "Μαρ", + "Απρ", + "Μαϊ", + "Ιον", + "Ιολ", + "Αυγ", + "Σεπ", + "Οκτ", + "Νοε", + "Δεκ", + ] + + day_names = [ + "", + "Δευτέρα", + "Τρίτη", + "Τετάρτη", + "Πέμπτη", + "Παρασκευή", + "Σάββατο", + "Κυριακή", + ] + day_abbreviations = ["", "Δευ", "Τρι", "Τετ", "Πεμ", "Παρ", "Σαβ", "Κυρ"] + + +class JapaneseLocale(Locale): + + names = ["ja", "ja_jp"] + + past = "{0}前" + future = "{0}後" + + timeframes = { + "now": "現在", + "second": "二番目の", + "seconds": "{0}数秒", + "minute": "1分", + "minutes": "{0}分", + "hour": "1時間", + "hours": "{0}時間", + "day": "1日", + "days": "{0}日", + "week": "1週間", + "weeks": "{0}週間", + "month": "1ヶ月", + "months": "{0}ヶ月", + "year": "1年", + "years": "{0}年", + } + + month_names = [ + "", + "1月", + "2月", + "3月", + "4月", + "5月", + "6月", + "7月", + "8月", + "9月", + "10月", + "11月", + "12月", + ] + month_abbreviations = [ + "", + " 1", + " 2", + " 3", + " 4", + " 5", + " 6", + " 7", + " 8", + " 9", + "10", + "11", + "12", + ] + + day_names = ["", "月曜日", "火曜日", "水曜日", "木曜日", "金曜日", "土曜日", "日曜日"] + day_abbreviations = ["", "月", "火", "水", "木", "金", "土", "日"] + + +class SwedishLocale(Locale): + + names = ["sv", "sv_se"] + + past = "för {0} sen" + future = "om {0}" + and_word = "och" + + timeframes = { + "now": "just nu", + "second": "en sekund", + "seconds": "{0} några sekunder", + "minute": "en minut", + "minutes": "{0} minuter", + "hour": "en timme", + "hours": "{0} timmar", + "day": "en dag", + "days": "{0} dagar", + "week": "en vecka", + "weeks": "{0} veckor", + "month": "en månad", + "months": "{0} månader", + "year": "ett år", + "years": "{0} år", + } + + month_names = [ + "", + "januari", + "februari", + "mars", + "april", + "maj", + "juni", + "juli", + "augusti", + "september", + "oktober", + "november", + "december", + ] + month_abbreviations = [ + "", + "jan", + "feb", + "mar", + "apr", + "maj", + "jun", + "jul", + "aug", + "sep", + "okt", + "nov", + "dec", + ] + + day_names = [ + "", + "måndag", + "tisdag", + "onsdag", + "torsdag", + "fredag", + "lördag", + "söndag", + ] + day_abbreviations = ["", "mån", "tis", "ons", "tor", "fre", "lör", "sön"] + + +class FinnishLocale(Locale): + + names = ["fi", "fi_fi"] + + # The finnish grammar is very complex, and its hard to convert + # 1-to-1 to something like English. + + past = "{0} sitten" + future = "{0} kuluttua" + + timeframes = { + "now": ["juuri nyt", "juuri nyt"], + "second": ["sekunti", "sekunti"], + "seconds": ["{0} muutama sekunti", "{0} muutaman sekunnin"], + "minute": ["minuutti", "minuutin"], + "minutes": ["{0} minuuttia", "{0} minuutin"], + "hour": ["tunti", "tunnin"], + "hours": ["{0} tuntia", "{0} tunnin"], + "day": ["päivä", "päivä"], + "days": ["{0} päivää", "{0} päivän"], + "month": ["kuukausi", "kuukauden"], + "months": ["{0} kuukautta", "{0} kuukauden"], + "year": ["vuosi", "vuoden"], + "years": ["{0} vuotta", "{0} vuoden"], + } + + # Months and days are lowercase in Finnish + month_names = [ + "", + "tammikuu", + "helmikuu", + "maaliskuu", + "huhtikuu", + "toukokuu", + "kesäkuu", + "heinäkuu", + "elokuu", + "syyskuu", + "lokakuu", + "marraskuu", + "joulukuu", + ] + + month_abbreviations = [ + "", + "tammi", + "helmi", + "maalis", + "huhti", + "touko", + "kesä", + "heinä", + "elo", + "syys", + "loka", + "marras", + "joulu", + ] + + day_names = [ + "", + "maanantai", + "tiistai", + "keskiviikko", + "torstai", + "perjantai", + "lauantai", + "sunnuntai", + ] + + day_abbreviations = ["", "ma", "ti", "ke", "to", "pe", "la", "su"] + + def _format_timeframe(self, timeframe, delta): + return ( + self.timeframes[timeframe][0].format(abs(delta)), + self.timeframes[timeframe][1].format(abs(delta)), + ) + + def _format_relative(self, humanized, timeframe, delta): + if timeframe == "now": + return humanized[0] + + direction = self.past if delta < 0 else self.future + which = 0 if delta < 0 else 1 + + return direction.format(humanized[which]) + + def _ordinal_number(self, n): + return "{}.".format(n) + + +class ChineseCNLocale(Locale): + + names = ["zh", "zh_cn"] + + past = "{0}前" + future = "{0}后" + + timeframes = { + "now": "刚才", + "second": "一秒", + "seconds": "{0}秒", + "minute": "1分钟", + "minutes": "{0}分钟", + "hour": "1小时", + "hours": "{0}小时", + "day": "1天", + "days": "{0}天", + "week": "一周", + "weeks": "{0}周", + "month": "1个月", + "months": "{0}个月", + "year": "1年", + "years": "{0}年", + } + + month_names = [ + "", + "一月", + "二月", + "三月", + "四月", + "五月", + "六月", + "七月", + "八月", + "九月", + "十月", + "十一月", + "十二月", + ] + month_abbreviations = [ + "", + " 1", + " 2", + " 3", + " 4", + " 5", + " 6", + " 7", + " 8", + " 9", + "10", + "11", + "12", + ] + + day_names = ["", "星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期日"] + day_abbreviations = ["", "一", "二", "三", "四", "五", "六", "日"] + + +class ChineseTWLocale(Locale): + + names = ["zh_tw"] + + past = "{0}前" + future = "{0}後" + and_word = "和" + + timeframes = { + "now": "剛才", + "second": "1秒", + "seconds": "{0}秒", + "minute": "1分鐘", + "minutes": "{0}分鐘", + "hour": "1小時", + "hours": "{0}小時", + "day": "1天", + "days": "{0}天", + "week": "1週", + "weeks": "{0}週", + "month": "1個月", + "months": "{0}個月", + "year": "1年", + "years": "{0}年", + } + + month_names = [ + "", + "1月", + "2月", + "3月", + "4月", + "5月", + "6月", + "7月", + "8月", + "9月", + "10月", + "11月", + "12月", + ] + month_abbreviations = [ + "", + " 1", + " 2", + " 3", + " 4", + " 5", + " 6", + " 7", + " 8", + " 9", + "10", + "11", + "12", + ] + + day_names = ["", "週一", "週二", "週三", "週四", "週五", "週六", "週日"] + day_abbreviations = ["", "一", "二", "三", "四", "五", "六", "日"] + + +class HongKongLocale(Locale): + + names = ["zh_hk"] + + past = "{0}前" + future = "{0}後" + + timeframes = { + "now": "剛才", + "second": "1秒", + "seconds": "{0}秒", + "minute": "1分鐘", + "minutes": "{0}分鐘", + "hour": "1小時", + "hours": "{0}小時", + "day": "1天", + "days": "{0}天", + "week": "1星期", + "weeks": "{0}星期", + "month": "1個月", + "months": "{0}個月", + "year": "1年", + "years": "{0}年", + } + + month_names = [ + "", + "1月", + "2月", + "3月", + "4月", + "5月", + "6月", + "7月", + "8月", + "9月", + "10月", + "11月", + "12月", + ] + month_abbreviations = [ + "", + " 1", + " 2", + " 3", + " 4", + " 5", + " 6", + " 7", + " 8", + " 9", + "10", + "11", + "12", + ] + + day_names = ["", "星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期日"] + day_abbreviations = ["", "一", "二", "三", "四", "五", "六", "日"] + + +class KoreanLocale(Locale): + + names = ["ko", "ko_kr"] + + past = "{0} 전" + future = "{0} 후" + + timeframes = { + "now": "지금", + "second": "1초", + "seconds": "{0}초", + "minute": "1분", + "minutes": "{0}분", + "hour": "한시간", + "hours": "{0}시간", + "day": "하루", + "days": "{0}일", + "week": "1주", + "weeks": "{0}주", + "month": "한달", + "months": "{0}개월", + "year": "1년", + "years": "{0}년", + } + + special_dayframes = { + -3: "그끄제", + -2: "그제", + -1: "어제", + 1: "내일", + 2: "모레", + 3: "글피", + 4: "그글피", + } + + special_yearframes = {-2: "제작년", -1: "작년", 1: "내년", 2: "내후년"} + + month_names = [ + "", + "1월", + "2월", + "3월", + "4월", + "5월", + "6월", + "7월", + "8월", + "9월", + "10월", + "11월", + "12월", + ] + month_abbreviations = [ + "", + " 1", + " 2", + " 3", + " 4", + " 5", + " 6", + " 7", + " 8", + " 9", + "10", + "11", + "12", + ] + + day_names = ["", "월요일", "화요일", "수요일", "목요일", "금요일", "토요일", "일요일"] + day_abbreviations = ["", "월", "화", "수", "목", "금", "토", "일"] + + def _ordinal_number(self, n): + ordinals = ["0", "첫", "두", "세", "네", "다섯", "여섯", "일곱", "여덟", "아홉", "열"] + if n < len(ordinals): + return "{}번째".format(ordinals[n]) + return "{}번째".format(n) + + def _format_relative(self, humanized, timeframe, delta): + if timeframe in ("day", "days"): + special = self.special_dayframes.get(delta) + if special: + return special + elif timeframe in ("year", "years"): + special = self.special_yearframes.get(delta) + if special: + return special + + return super(KoreanLocale, self)._format_relative(humanized, timeframe, delta) + + +# derived locale types & implementations. +class DutchLocale(Locale): + + names = ["nl", "nl_nl"] + + past = "{0} geleden" + future = "over {0}" + + timeframes = { + "now": "nu", + "second": "een seconde", + "seconds": "{0} seconden", + "minute": "een minuut", + "minutes": "{0} minuten", + "hour": "een uur", + "hours": "{0} uur", + "day": "een dag", + "days": "{0} dagen", + "week": "een week", + "weeks": "{0} weken", + "month": "een maand", + "months": "{0} maanden", + "year": "een jaar", + "years": "{0} jaar", + } + + # In Dutch names of months and days are not starting with a capital letter + # like in the English language. + month_names = [ + "", + "januari", + "februari", + "maart", + "april", + "mei", + "juni", + "juli", + "augustus", + "september", + "oktober", + "november", + "december", + ] + month_abbreviations = [ + "", + "jan", + "feb", + "mrt", + "apr", + "mei", + "jun", + "jul", + "aug", + "sep", + "okt", + "nov", + "dec", + ] + + day_names = [ + "", + "maandag", + "dinsdag", + "woensdag", + "donderdag", + "vrijdag", + "zaterdag", + "zondag", + ] + day_abbreviations = ["", "ma", "di", "wo", "do", "vr", "za", "zo"] + + +class SlavicBaseLocale(Locale): + def _format_timeframe(self, timeframe, delta): + + form = self.timeframes[timeframe] + delta = abs(delta) + + if isinstance(form, list): + + if delta % 10 == 1 and delta % 100 != 11: + form = form[0] + elif 2 <= delta % 10 <= 4 and (delta % 100 < 10 or delta % 100 >= 20): + form = form[1] + else: + form = form[2] + + return form.format(delta) + + +class BelarusianLocale(SlavicBaseLocale): + + names = ["be", "be_by"] + + past = "{0} таму" + future = "праз {0}" + + timeframes = { + "now": "зараз", + "second": "секунду", + "seconds": "{0} некалькі секунд", + "minute": "хвіліну", + "minutes": ["{0} хвіліну", "{0} хвіліны", "{0} хвілін"], + "hour": "гадзіну", + "hours": ["{0} гадзіну", "{0} гадзіны", "{0} гадзін"], + "day": "дзень", + "days": ["{0} дзень", "{0} дні", "{0} дзён"], + "month": "месяц", + "months": ["{0} месяц", "{0} месяцы", "{0} месяцаў"], + "year": "год", + "years": ["{0} год", "{0} гады", "{0} гадоў"], + } + + month_names = [ + "", + "студзеня", + "лютага", + "сакавіка", + "красавіка", + "траўня", + "чэрвеня", + "ліпеня", + "жніўня", + "верасня", + "кастрычніка", + "лістапада", + "снежня", + ] + month_abbreviations = [ + "", + "студ", + "лют", + "сак", + "крас", + "трав", + "чэрв", + "ліп", + "жнів", + "вер", + "каст", + "ліст", + "снеж", + ] + + day_names = [ + "", + "панядзелак", + "аўторак", + "серада", + "чацвер", + "пятніца", + "субота", + "нядзеля", + ] + day_abbreviations = ["", "пн", "ат", "ср", "чц", "пт", "сб", "нд"] + + +class PolishLocale(SlavicBaseLocale): + + names = ["pl", "pl_pl"] + + past = "{0} temu" + future = "za {0}" + + # The nouns should be in genitive case (Polish: "dopełniacz") + # in order to correctly form `past` & `future` expressions. + timeframes = { + "now": "teraz", + "second": "sekundę", + "seconds": ["{0} sekund", "{0} sekundy", "{0} sekund"], + "minute": "minutę", + "minutes": ["{0} minut", "{0} minuty", "{0} minut"], + "hour": "godzinę", + "hours": ["{0} godzin", "{0} godziny", "{0} godzin"], + "day": "dzień", + "days": "{0} dni", + "week": "tydzień", + "weeks": ["{0} tygodni", "{0} tygodnie", "{0} tygodni"], + "month": "miesiąc", + "months": ["{0} miesięcy", "{0} miesiące", "{0} miesięcy"], + "year": "rok", + "years": ["{0} lat", "{0} lata", "{0} lat"], + } + + month_names = [ + "", + "styczeń", + "luty", + "marzec", + "kwiecień", + "maj", + "czerwiec", + "lipiec", + "sierpień", + "wrzesień", + "październik", + "listopad", + "grudzień", + ] + month_abbreviations = [ + "", + "sty", + "lut", + "mar", + "kwi", + "maj", + "cze", + "lip", + "sie", + "wrz", + "paź", + "lis", + "gru", + ] + + day_names = [ + "", + "poniedziałek", + "wtorek", + "środa", + "czwartek", + "piątek", + "sobota", + "niedziela", + ] + day_abbreviations = ["", "Pn", "Wt", "Śr", "Czw", "Pt", "So", "Nd"] + + +class RussianLocale(SlavicBaseLocale): + + names = ["ru", "ru_ru"] + + past = "{0} назад" + future = "через {0}" + + timeframes = { + "now": "сейчас", + "second": "Второй", + "seconds": "{0} несколько секунд", + "minute": "минуту", + "minutes": ["{0} минуту", "{0} минуты", "{0} минут"], + "hour": "час", + "hours": ["{0} час", "{0} часа", "{0} часов"], + "day": "день", + "days": ["{0} день", "{0} дня", "{0} дней"], + "week": "неделю", + "weeks": ["{0} неделю", "{0} недели", "{0} недель"], + "month": "месяц", + "months": ["{0} месяц", "{0} месяца", "{0} месяцев"], + "year": "год", + "years": ["{0} год", "{0} года", "{0} лет"], + } + + month_names = [ + "", + "января", + "февраля", + "марта", + "апреля", + "мая", + "июня", + "июля", + "августа", + "сентября", + "октября", + "ноября", + "декабря", + ] + month_abbreviations = [ + "", + "янв", + "фев", + "мар", + "апр", + "май", + "июн", + "июл", + "авг", + "сен", + "окт", + "ноя", + "дек", + ] + + day_names = [ + "", + "понедельник", + "вторник", + "среда", + "четверг", + "пятница", + "суббота", + "воскресенье", + ] + day_abbreviations = ["", "пн", "вт", "ср", "чт", "пт", "сб", "вс"] + + +class AfrikaansLocale(Locale): + + names = ["af", "af_nl"] + + past = "{0} gelede" + future = "in {0}" + + timeframes = { + "now": "nou", + "second": "n sekonde", + "seconds": "{0} sekondes", + "minute": "minuut", + "minutes": "{0} minute", + "hour": "uur", + "hours": "{0} ure", + "day": "een dag", + "days": "{0} dae", + "month": "een maand", + "months": "{0} maande", + "year": "een jaar", + "years": "{0} jaar", + } + + month_names = [ + "", + "Januarie", + "Februarie", + "Maart", + "April", + "Mei", + "Junie", + "Julie", + "Augustus", + "September", + "Oktober", + "November", + "Desember", + ] + month_abbreviations = [ + "", + "Jan", + "Feb", + "Mrt", + "Apr", + "Mei", + "Jun", + "Jul", + "Aug", + "Sep", + "Okt", + "Nov", + "Des", + ] + + day_names = [ + "", + "Maandag", + "Dinsdag", + "Woensdag", + "Donderdag", + "Vrydag", + "Saterdag", + "Sondag", + ] + day_abbreviations = ["", "Ma", "Di", "Wo", "Do", "Vr", "Za", "So"] + + +class BulgarianLocale(SlavicBaseLocale): + + names = ["bg", "bg_BG"] + + past = "{0} назад" + future = "напред {0}" + + timeframes = { + "now": "сега", + "second": "секунда", + "seconds": "{0} няколко секунди", + "minute": "минута", + "minutes": ["{0} минута", "{0} минути", "{0} минути"], + "hour": "час", + "hours": ["{0} час", "{0} часа", "{0} часа"], + "day": "ден", + "days": ["{0} ден", "{0} дни", "{0} дни"], + "month": "месец", + "months": ["{0} месец", "{0} месеца", "{0} месеца"], + "year": "година", + "years": ["{0} година", "{0} години", "{0} години"], + } + + month_names = [ + "", + "януари", + "февруари", + "март", + "април", + "май", + "юни", + "юли", + "август", + "септември", + "октомври", + "ноември", + "декември", + ] + month_abbreviations = [ + "", + "ян", + "февр", + "март", + "апр", + "май", + "юни", + "юли", + "авг", + "септ", + "окт", + "ноем", + "дек", + ] + + day_names = [ + "", + "понеделник", + "вторник", + "сряда", + "четвъртък", + "петък", + "събота", + "неделя", + ] + day_abbreviations = ["", "пон", "вт", "ср", "четв", "пет", "съб", "нед"] + + +class UkrainianLocale(SlavicBaseLocale): + + names = ["ua", "uk_ua"] + + past = "{0} тому" + future = "за {0}" + + timeframes = { + "now": "зараз", + "second": "секунда", + "seconds": "{0} кілька секунд", + "minute": "хвилину", + "minutes": ["{0} хвилину", "{0} хвилини", "{0} хвилин"], + "hour": "годину", + "hours": ["{0} годину", "{0} години", "{0} годин"], + "day": "день", + "days": ["{0} день", "{0} дні", "{0} днів"], + "month": "місяць", + "months": ["{0} місяць", "{0} місяці", "{0} місяців"], + "year": "рік", + "years": ["{0} рік", "{0} роки", "{0} років"], + } + + month_names = [ + "", + "січня", + "лютого", + "березня", + "квітня", + "травня", + "червня", + "липня", + "серпня", + "вересня", + "жовтня", + "листопада", + "грудня", + ] + month_abbreviations = [ + "", + "січ", + "лют", + "бер", + "квіт", + "трав", + "черв", + "лип", + "серп", + "вер", + "жовт", + "лист", + "груд", + ] + + day_names = [ + "", + "понеділок", + "вівторок", + "середа", + "четвер", + "п’ятниця", + "субота", + "неділя", + ] + day_abbreviations = ["", "пн", "вт", "ср", "чт", "пт", "сб", "нд"] + + +class MacedonianLocale(SlavicBaseLocale): + names = ["mk", "mk_mk"] + + past = "пред {0}" + future = "за {0}" + + timeframes = { + "now": "сега", + "second": "една секунда", + "seconds": ["{0} секунда", "{0} секунди", "{0} секунди"], + "minute": "една минута", + "minutes": ["{0} минута", "{0} минути", "{0} минути"], + "hour": "еден саат", + "hours": ["{0} саат", "{0} саати", "{0} саати"], + "day": "еден ден", + "days": ["{0} ден", "{0} дена", "{0} дена"], + "week": "една недела", + "weeks": ["{0} недела", "{0} недели", "{0} недели"], + "month": "еден месец", + "months": ["{0} месец", "{0} месеци", "{0} месеци"], + "year": "една година", + "years": ["{0} година", "{0} години", "{0} години"], + } + + meridians = {"am": "дп", "pm": "пп", "AM": "претпладне", "PM": "попладне"} + + month_names = [ + "", + "Јануари", + "Февруари", + "Март", + "Април", + "Мај", + "Јуни", + "Јули", + "Август", + "Септември", + "Октомври", + "Ноември", + "Декември", + ] + month_abbreviations = [ + "", + "Јан", + "Фев", + "Мар", + "Апр", + "Мај", + "Јун", + "Јул", + "Авг", + "Септ", + "Окт", + "Ноем", + "Декем", + ] + + day_names = [ + "", + "Понеделник", + "Вторник", + "Среда", + "Четврток", + "Петок", + "Сабота", + "Недела", + ] + day_abbreviations = [ + "", + "Пон", + "Вт", + "Сре", + "Чет", + "Пет", + "Саб", + "Нед", + ] + + +class GermanBaseLocale(Locale): + + past = "vor {0}" + future = "in {0}" + and_word = "und" + + timeframes = { + "now": "gerade eben", + "second": "eine Sekunde", + "seconds": "{0} Sekunden", + "minute": "einer Minute", + "minutes": "{0} Minuten", + "hour": "einer Stunde", + "hours": "{0} Stunden", + "day": "einem Tag", + "days": "{0} Tagen", + "week": "einer Woche", + "weeks": "{0} Wochen", + "month": "einem Monat", + "months": "{0} Monaten", + "year": "einem Jahr", + "years": "{0} Jahren", + } + + timeframes_only_distance = timeframes.copy() + timeframes_only_distance["minute"] = "eine Minute" + timeframes_only_distance["hour"] = "eine Stunde" + timeframes_only_distance["day"] = "ein Tag" + timeframes_only_distance["week"] = "eine Woche" + timeframes_only_distance["month"] = "ein Monat" + timeframes_only_distance["year"] = "ein Jahr" + + month_names = [ + "", + "Januar", + "Februar", + "März", + "April", + "Mai", + "Juni", + "Juli", + "August", + "September", + "Oktober", + "November", + "Dezember", + ] + + month_abbreviations = [ + "", + "Jan", + "Feb", + "Mär", + "Apr", + "Mai", + "Jun", + "Jul", + "Aug", + "Sep", + "Okt", + "Nov", + "Dez", + ] + + day_names = [ + "", + "Montag", + "Dienstag", + "Mittwoch", + "Donnerstag", + "Freitag", + "Samstag", + "Sonntag", + ] + + day_abbreviations = ["", "Mo", "Di", "Mi", "Do", "Fr", "Sa", "So"] + + def _ordinal_number(self, n): + return "{}.".format(n) + + def describe(self, timeframe, delta=0, only_distance=False): + """Describes a delta within a timeframe in plain language. + + :param timeframe: a string representing a timeframe. + :param delta: a quantity representing a delta in a timeframe. + :param only_distance: return only distance eg: "11 seconds" without "in" or "ago" keywords + """ + + if not only_distance: + return super(GermanBaseLocale, self).describe( + timeframe, delta, only_distance + ) + + # German uses a different case without 'in' or 'ago' + humanized = self.timeframes_only_distance[timeframe].format(trunc(abs(delta))) + + return humanized + + +class GermanLocale(GermanBaseLocale, Locale): + + names = ["de", "de_de"] + + +class SwissLocale(GermanBaseLocale, Locale): + + names = ["de_ch"] + + +class AustrianLocale(GermanBaseLocale, Locale): + + names = ["de_at"] + + month_names = [ + "", + "Jänner", + "Februar", + "März", + "April", + "Mai", + "Juni", + "Juli", + "August", + "September", + "Oktober", + "November", + "Dezember", + ] + + +class NorwegianLocale(Locale): + + names = ["nb", "nb_no"] + + past = "for {0} siden" + future = "om {0}" + + timeframes = { + "now": "nå nettopp", + "second": "et sekund", + "seconds": "{0} noen sekunder", + "minute": "ett minutt", + "minutes": "{0} minutter", + "hour": "en time", + "hours": "{0} timer", + "day": "en dag", + "days": "{0} dager", + "month": "en måned", + "months": "{0} måneder", + "year": "ett år", + "years": "{0} år", + } + + month_names = [ + "", + "januar", + "februar", + "mars", + "april", + "mai", + "juni", + "juli", + "august", + "september", + "oktober", + "november", + "desember", + ] + month_abbreviations = [ + "", + "jan", + "feb", + "mar", + "apr", + "mai", + "jun", + "jul", + "aug", + "sep", + "okt", + "nov", + "des", + ] + + day_names = [ + "", + "mandag", + "tirsdag", + "onsdag", + "torsdag", + "fredag", + "lørdag", + "søndag", + ] + day_abbreviations = ["", "ma", "ti", "on", "to", "fr", "lø", "sø"] + + +class NewNorwegianLocale(Locale): + + names = ["nn", "nn_no"] + + past = "for {0} sidan" + future = "om {0}" + + timeframes = { + "now": "no nettopp", + "second": "et sekund", + "seconds": "{0} nokre sekund", + "minute": "ett minutt", + "minutes": "{0} minutt", + "hour": "ein time", + "hours": "{0} timar", + "day": "ein dag", + "days": "{0} dagar", + "month": "en månad", + "months": "{0} månader", + "year": "eit år", + "years": "{0} år", + } + + month_names = [ + "", + "januar", + "februar", + "mars", + "april", + "mai", + "juni", + "juli", + "august", + "september", + "oktober", + "november", + "desember", + ] + month_abbreviations = [ + "", + "jan", + "feb", + "mar", + "apr", + "mai", + "jun", + "jul", + "aug", + "sep", + "okt", + "nov", + "des", + ] + + day_names = [ + "", + "måndag", + "tysdag", + "onsdag", + "torsdag", + "fredag", + "laurdag", + "sundag", + ] + day_abbreviations = ["", "må", "ty", "on", "to", "fr", "la", "su"] + + +class PortugueseLocale(Locale): + names = ["pt", "pt_pt"] + + past = "há {0}" + future = "em {0}" + and_word = "e" + + timeframes = { + "now": "agora", + "second": "um segundo", + "seconds": "{0} segundos", + "minute": "um minuto", + "minutes": "{0} minutos", + "hour": "uma hora", + "hours": "{0} horas", + "day": "um dia", + "days": "{0} dias", + "week": "uma semana", + "weeks": "{0} semanas", + "month": "um mês", + "months": "{0} meses", + "year": "um ano", + "years": "{0} anos", + } + + month_names = [ + "", + "Janeiro", + "Fevereiro", + "Março", + "Abril", + "Maio", + "Junho", + "Julho", + "Agosto", + "Setembro", + "Outubro", + "Novembro", + "Dezembro", + ] + month_abbreviations = [ + "", + "Jan", + "Fev", + "Mar", + "Abr", + "Mai", + "Jun", + "Jul", + "Ago", + "Set", + "Out", + "Nov", + "Dez", + ] + + day_names = [ + "", + "Segunda-feira", + "Terça-feira", + "Quarta-feira", + "Quinta-feira", + "Sexta-feira", + "Sábado", + "Domingo", + ] + day_abbreviations = ["", "Seg", "Ter", "Qua", "Qui", "Sex", "Sab", "Dom"] + + +class BrazilianPortugueseLocale(PortugueseLocale): + names = ["pt_br"] + + past = "faz {0}" + + +class TagalogLocale(Locale): + + names = ["tl", "tl_ph"] + + past = "nakaraang {0}" + future = "{0} mula ngayon" + + timeframes = { + "now": "ngayon lang", + "second": "isang segundo", + "seconds": "{0} segundo", + "minute": "isang minuto", + "minutes": "{0} minuto", + "hour": "isang oras", + "hours": "{0} oras", + "day": "isang araw", + "days": "{0} araw", + "week": "isang linggo", + "weeks": "{0} linggo", + "month": "isang buwan", + "months": "{0} buwan", + "year": "isang taon", + "years": "{0} taon", + } + + month_names = [ + "", + "Enero", + "Pebrero", + "Marso", + "Abril", + "Mayo", + "Hunyo", + "Hulyo", + "Agosto", + "Setyembre", + "Oktubre", + "Nobyembre", + "Disyembre", + ] + month_abbreviations = [ + "", + "Ene", + "Peb", + "Mar", + "Abr", + "May", + "Hun", + "Hul", + "Ago", + "Set", + "Okt", + "Nob", + "Dis", + ] + + day_names = [ + "", + "Lunes", + "Martes", + "Miyerkules", + "Huwebes", + "Biyernes", + "Sabado", + "Linggo", + ] + day_abbreviations = ["", "Lun", "Mar", "Miy", "Huw", "Biy", "Sab", "Lin"] + + meridians = {"am": "nu", "pm": "nh", "AM": "ng umaga", "PM": "ng hapon"} + + def _ordinal_number(self, n): + return "ika-{}".format(n) + + +class VietnameseLocale(Locale): + + names = ["vi", "vi_vn"] + + past = "{0} trước" + future = "{0} nữa" + + timeframes = { + "now": "hiện tại", + "second": "một giây", + "seconds": "{0} giây", + "minute": "một phút", + "minutes": "{0} phút", + "hour": "một giờ", + "hours": "{0} giờ", + "day": "một ngày", + "days": "{0} ngày", + "week": "một tuần", + "weeks": "{0} tuần", + "month": "một tháng", + "months": "{0} tháng", + "year": "một năm", + "years": "{0} năm", + } + + month_names = [ + "", + "Tháng Một", + "Tháng Hai", + "Tháng Ba", + "Tháng Tư", + "Tháng Năm", + "Tháng Sáu", + "Tháng Bảy", + "Tháng Tám", + "Tháng Chín", + "Tháng Mười", + "Tháng Mười Một", + "Tháng Mười Hai", + ] + month_abbreviations = [ + "", + "Tháng 1", + "Tháng 2", + "Tháng 3", + "Tháng 4", + "Tháng 5", + "Tháng 6", + "Tháng 7", + "Tháng 8", + "Tháng 9", + "Tháng 10", + "Tháng 11", + "Tháng 12", + ] + + day_names = [ + "", + "Thứ Hai", + "Thứ Ba", + "Thứ Tư", + "Thứ Năm", + "Thứ Sáu", + "Thứ Bảy", + "Chủ Nhật", + ] + day_abbreviations = ["", "Thứ 2", "Thứ 3", "Thứ 4", "Thứ 5", "Thứ 6", "Thứ 7", "CN"] + + +class TurkishLocale(Locale): + + names = ["tr", "tr_tr"] + + past = "{0} önce" + future = "{0} sonra" + + timeframes = { + "now": "şimdi", + "second": "bir saniye", + "seconds": "{0} saniye", + "minute": "bir dakika", + "minutes": "{0} dakika", + "hour": "bir saat", + "hours": "{0} saat", + "day": "bir gün", + "days": "{0} gün", + "month": "bir ay", + "months": "{0} ay", + "year": "yıl", + "years": "{0} yıl", + } + + month_names = [ + "", + "Ocak", + "Şubat", + "Mart", + "Nisan", + "Mayıs", + "Haziran", + "Temmuz", + "Ağustos", + "Eylül", + "Ekim", + "Kasım", + "Aralık", + ] + month_abbreviations = [ + "", + "Oca", + "Şub", + "Mar", + "Nis", + "May", + "Haz", + "Tem", + "Ağu", + "Eyl", + "Eki", + "Kas", + "Ara", + ] + + day_names = [ + "", + "Pazartesi", + "Salı", + "Çarşamba", + "Perşembe", + "Cuma", + "Cumartesi", + "Pazar", + ] + day_abbreviations = ["", "Pzt", "Sal", "Çar", "Per", "Cum", "Cmt", "Paz"] + + +class AzerbaijaniLocale(Locale): + + names = ["az", "az_az"] + + past = "{0} əvvəl" + future = "{0} sonra" + + timeframes = { + "now": "indi", + "second": "saniyə", + "seconds": "{0} saniyə", + "minute": "bir dəqiqə", + "minutes": "{0} dəqiqə", + "hour": "bir saat", + "hours": "{0} saat", + "day": "bir gün", + "days": "{0} gün", + "month": "bir ay", + "months": "{0} ay", + "year": "il", + "years": "{0} il", + } + + month_names = [ + "", + "Yanvar", + "Fevral", + "Mart", + "Aprel", + "May", + "İyun", + "İyul", + "Avqust", + "Sentyabr", + "Oktyabr", + "Noyabr", + "Dekabr", + ] + month_abbreviations = [ + "", + "Yan", + "Fev", + "Mar", + "Apr", + "May", + "İyn", + "İyl", + "Avq", + "Sen", + "Okt", + "Noy", + "Dek", + ] + + day_names = [ + "", + "Bazar ertəsi", + "Çərşənbə axşamı", + "Çərşənbə", + "Cümə axşamı", + "Cümə", + "Şənbə", + "Bazar", + ] + day_abbreviations = ["", "Ber", "Çax", "Çər", "Cax", "Cüm", "Şnb", "Bzr"] + + +class ArabicLocale(Locale): + names = [ + "ar", + "ar_ae", + "ar_bh", + "ar_dj", + "ar_eg", + "ar_eh", + "ar_er", + "ar_km", + "ar_kw", + "ar_ly", + "ar_om", + "ar_qa", + "ar_sa", + "ar_sd", + "ar_so", + "ar_ss", + "ar_td", + "ar_ye", + ] + + past = "منذ {0}" + future = "خلال {0}" + + timeframes = { + "now": "الآن", + "second": "ثانية", + "seconds": {"double": "ثانيتين", "ten": "{0} ثوان", "higher": "{0} ثانية"}, + "minute": "دقيقة", + "minutes": {"double": "دقيقتين", "ten": "{0} دقائق", "higher": "{0} دقيقة"}, + "hour": "ساعة", + "hours": {"double": "ساعتين", "ten": "{0} ساعات", "higher": "{0} ساعة"}, + "day": "يوم", + "days": {"double": "يومين", "ten": "{0} أيام", "higher": "{0} يوم"}, + "month": "شهر", + "months": {"double": "شهرين", "ten": "{0} أشهر", "higher": "{0} شهر"}, + "year": "سنة", + "years": {"double": "سنتين", "ten": "{0} سنوات", "higher": "{0} سنة"}, + } + + month_names = [ + "", + "يناير", + "فبراير", + "مارس", + "أبريل", + "مايو", + "يونيو", + "يوليو", + "أغسطس", + "سبتمبر", + "أكتوبر", + "نوفمبر", + "ديسمبر", + ] + month_abbreviations = [ + "", + "يناير", + "فبراير", + "مارس", + "أبريل", + "مايو", + "يونيو", + "يوليو", + "أغسطس", + "سبتمبر", + "أكتوبر", + "نوفمبر", + "ديسمبر", + ] + + day_names = [ + "", + "الإثنين", + "الثلاثاء", + "الأربعاء", + "الخميس", + "الجمعة", + "السبت", + "الأحد", + ] + day_abbreviations = ["", "إثنين", "ثلاثاء", "أربعاء", "خميس", "جمعة", "سبت", "أحد"] + + def _format_timeframe(self, timeframe, delta): + form = self.timeframes[timeframe] + delta = abs(delta) + if isinstance(form, dict): + if delta == 2: + form = form["double"] + elif delta > 2 and delta <= 10: + form = form["ten"] + else: + form = form["higher"] + + return form.format(delta) + + +class LevantArabicLocale(ArabicLocale): + names = ["ar_iq", "ar_jo", "ar_lb", "ar_ps", "ar_sy"] + month_names = [ + "", + "كانون الثاني", + "شباط", + "آذار", + "نيسان", + "أيار", + "حزيران", + "تموز", + "آب", + "أيلول", + "تشرين الأول", + "تشرين الثاني", + "كانون الأول", + ] + month_abbreviations = [ + "", + "كانون الثاني", + "شباط", + "آذار", + "نيسان", + "أيار", + "حزيران", + "تموز", + "آب", + "أيلول", + "تشرين الأول", + "تشرين الثاني", + "كانون الأول", + ] + + +class AlgeriaTunisiaArabicLocale(ArabicLocale): + names = ["ar_tn", "ar_dz"] + month_names = [ + "", + "جانفي", + "فيفري", + "مارس", + "أفريل", + "ماي", + "جوان", + "جويلية", + "أوت", + "سبتمبر", + "أكتوبر", + "نوفمبر", + "ديسمبر", + ] + month_abbreviations = [ + "", + "جانفي", + "فيفري", + "مارس", + "أفريل", + "ماي", + "جوان", + "جويلية", + "أوت", + "سبتمبر", + "أكتوبر", + "نوفمبر", + "ديسمبر", + ] + + +class MauritaniaArabicLocale(ArabicLocale): + names = ["ar_mr"] + month_names = [ + "", + "يناير", + "فبراير", + "مارس", + "إبريل", + "مايو", + "يونيو", + "يوليو", + "أغشت", + "شتمبر", + "أكتوبر", + "نوفمبر", + "دجمبر", + ] + month_abbreviations = [ + "", + "يناير", + "فبراير", + "مارس", + "إبريل", + "مايو", + "يونيو", + "يوليو", + "أغشت", + "شتمبر", + "أكتوبر", + "نوفمبر", + "دجمبر", + ] + + +class MoroccoArabicLocale(ArabicLocale): + names = ["ar_ma"] + month_names = [ + "", + "يناير", + "فبراير", + "مارس", + "أبريل", + "ماي", + "يونيو", + "يوليوز", + "غشت", + "شتنبر", + "أكتوبر", + "نونبر", + "دجنبر", + ] + month_abbreviations = [ + "", + "يناير", + "فبراير", + "مارس", + "أبريل", + "ماي", + "يونيو", + "يوليوز", + "غشت", + "شتنبر", + "أكتوبر", + "نونبر", + "دجنبر", + ] + + +class IcelandicLocale(Locale): + def _format_timeframe(self, timeframe, delta): + + timeframe = self.timeframes[timeframe] + if delta < 0: + timeframe = timeframe[0] + elif delta > 0: + timeframe = timeframe[1] + + return timeframe.format(abs(delta)) + + names = ["is", "is_is"] + + past = "fyrir {0} síðan" + future = "eftir {0}" + + timeframes = { + "now": "rétt í þessu", + "second": ("sekúndu", "sekúndu"), + "seconds": ("{0} nokkrum sekúndum", "nokkrar sekúndur"), + "minute": ("einni mínútu", "eina mínútu"), + "minutes": ("{0} mínútum", "{0} mínútur"), + "hour": ("einum tíma", "einn tíma"), + "hours": ("{0} tímum", "{0} tíma"), + "day": ("einum degi", "einn dag"), + "days": ("{0} dögum", "{0} daga"), + "month": ("einum mánuði", "einn mánuð"), + "months": ("{0} mánuðum", "{0} mánuði"), + "year": ("einu ári", "eitt ár"), + "years": ("{0} árum", "{0} ár"), + } + + meridians = {"am": "f.h.", "pm": "e.h.", "AM": "f.h.", "PM": "e.h."} + + month_names = [ + "", + "janúar", + "febrúar", + "mars", + "apríl", + "maí", + "júní", + "júlí", + "ágúst", + "september", + "október", + "nóvember", + "desember", + ] + month_abbreviations = [ + "", + "jan", + "feb", + "mar", + "apr", + "maí", + "jún", + "júl", + "ágú", + "sep", + "okt", + "nóv", + "des", + ] + + day_names = [ + "", + "mánudagur", + "þriðjudagur", + "miðvikudagur", + "fimmtudagur", + "föstudagur", + "laugardagur", + "sunnudagur", + ] + day_abbreviations = ["", "mán", "þri", "mið", "fim", "fös", "lau", "sun"] + + +class DanishLocale(Locale): + + names = ["da", "da_dk"] + + past = "for {0} siden" + future = "efter {0}" + and_word = "og" + + timeframes = { + "now": "lige nu", + "second": "et sekund", + "seconds": "{0} et par sekunder", + "minute": "et minut", + "minutes": "{0} minutter", + "hour": "en time", + "hours": "{0} timer", + "day": "en dag", + "days": "{0} dage", + "month": "en måned", + "months": "{0} måneder", + "year": "et år", + "years": "{0} år", + } + + month_names = [ + "", + "januar", + "februar", + "marts", + "april", + "maj", + "juni", + "juli", + "august", + "september", + "oktober", + "november", + "december", + ] + month_abbreviations = [ + "", + "jan", + "feb", + "mar", + "apr", + "maj", + "jun", + "jul", + "aug", + "sep", + "okt", + "nov", + "dec", + ] + + day_names = [ + "", + "mandag", + "tirsdag", + "onsdag", + "torsdag", + "fredag", + "lørdag", + "søndag", + ] + day_abbreviations = ["", "man", "tir", "ons", "tor", "fre", "lør", "søn"] + + +class MalayalamLocale(Locale): + + names = ["ml"] + + past = "{0} മുമ്പ്" + future = "{0} ശേഷം" + + timeframes = { + "now": "ഇപ്പോൾ", + "second": "ഒരു നിമിഷം", + "seconds": "{0} സെക്കന്റ്‌", + "minute": "ഒരു മിനിറ്റ്", + "minutes": "{0} മിനിറ്റ്", + "hour": "ഒരു മണിക്കൂർ", + "hours": "{0} മണിക്കൂർ", + "day": "ഒരു ദിവസം ", + "days": "{0} ദിവസം ", + "month": "ഒരു മാസം ", + "months": "{0} മാസം ", + "year": "ഒരു വർഷം ", + "years": "{0} വർഷം ", + } + + meridians = { + "am": "രാവിലെ", + "pm": "ഉച്ചക്ക് ശേഷം", + "AM": "രാവിലെ", + "PM": "ഉച്ചക്ക് ശേഷം", + } + + month_names = [ + "", + "ജനുവരി", + "ഫെബ്രുവരി", + "മാർച്ച്‌", + "ഏപ്രിൽ ", + "മെയ്‌ ", + "ജൂണ്‍", + "ജൂലൈ", + "ഓഗസ്റ്റ്‌", + "സെപ്റ്റംബർ", + "ഒക്ടോബർ", + "നവംബർ", + "ഡിസംബർ", + ] + month_abbreviations = [ + "", + "ജനു", + "ഫെബ് ", + "മാർ", + "ഏപ്രിൽ", + "മേയ്", + "ജൂണ്‍", + "ജൂലൈ", + "ഓഗസ്റ", + "സെപ്റ്റ", + "ഒക്ടോ", + "നവം", + "ഡിസം", + ] + + day_names = ["", "തിങ്കള്‍", "ചൊവ്വ", "ബുധന്‍", "വ്യാഴം", "വെള്ളി", "ശനി", "ഞായര്‍"] + day_abbreviations = [ + "", + "തിങ്കള്‍", + "ചൊവ്വ", + "ബുധന്‍", + "വ്യാഴം", + "വെള്ളി", + "ശനി", + "ഞായര്‍", + ] + + +class HindiLocale(Locale): + + names = ["hi"] + + past = "{0} पहले" + future = "{0} बाद" + + timeframes = { + "now": "अभी", + "second": "एक पल", + "seconds": "{0} सेकंड्", + "minute": "एक मिनट ", + "minutes": "{0} मिनट ", + "hour": "एक घंटा", + "hours": "{0} घंटे", + "day": "एक दिन", + "days": "{0} दिन", + "month": "एक माह ", + "months": "{0} महीने ", + "year": "एक वर्ष ", + "years": "{0} साल ", + } + + meridians = {"am": "सुबह", "pm": "शाम", "AM": "सुबह", "PM": "शाम"} + + month_names = [ + "", + "जनवरी", + "फरवरी", + "मार्च", + "अप्रैल ", + "मई", + "जून", + "जुलाई", + "अगस्त", + "सितंबर", + "अक्टूबर", + "नवंबर", + "दिसंबर", + ] + month_abbreviations = [ + "", + "जन", + "फ़र", + "मार्च", + "अप्रै", + "मई", + "जून", + "जुलाई", + "आग", + "सित", + "अकत", + "नवे", + "दिस", + ] + + day_names = [ + "", + "सोमवार", + "मंगलवार", + "बुधवार", + "गुरुवार", + "शुक्रवार", + "शनिवार", + "रविवार", + ] + day_abbreviations = ["", "सोम", "मंगल", "बुध", "गुरुवार", "शुक्र", "शनि", "रवि"] + + +class CzechLocale(Locale): + names = ["cs", "cs_cz"] + + timeframes = { + "now": "Teď", + "second": {"past": "vteřina", "future": "vteřina", "zero": "vteřina"}, + "seconds": {"past": "{0} sekundami", "future": ["{0} sekundy", "{0} sekund"]}, + "minute": {"past": "minutou", "future": "minutu", "zero": "{0} minut"}, + "minutes": {"past": "{0} minutami", "future": ["{0} minuty", "{0} minut"]}, + "hour": {"past": "hodinou", "future": "hodinu", "zero": "{0} hodin"}, + "hours": {"past": "{0} hodinami", "future": ["{0} hodiny", "{0} hodin"]}, + "day": {"past": "dnem", "future": "den", "zero": "{0} dnů"}, + "days": {"past": "{0} dny", "future": ["{0} dny", "{0} dnů"]}, + "week": {"past": "týdnem", "future": "týden", "zero": "{0} týdnů"}, + "weeks": {"past": "{0} týdny", "future": ["{0} týdny", "{0} týdnů"]}, + "month": {"past": "měsícem", "future": "měsíc", "zero": "{0} měsíců"}, + "months": {"past": "{0} měsíci", "future": ["{0} měsíce", "{0} měsíců"]}, + "year": {"past": "rokem", "future": "rok", "zero": "{0} let"}, + "years": {"past": "{0} lety", "future": ["{0} roky", "{0} let"]}, + } + + past = "Před {0}" + future = "Za {0}" + + month_names = [ + "", + "leden", + "únor", + "březen", + "duben", + "květen", + "červen", + "červenec", + "srpen", + "září", + "říjen", + "listopad", + "prosinec", + ] + month_abbreviations = [ + "", + "led", + "úno", + "bře", + "dub", + "kvě", + "čvn", + "čvc", + "srp", + "zář", + "říj", + "lis", + "pro", + ] + + day_names = [ + "", + "pondělí", + "úterý", + "středa", + "čtvrtek", + "pátek", + "sobota", + "neděle", + ] + day_abbreviations = ["", "po", "út", "st", "čt", "pá", "so", "ne"] + + def _format_timeframe(self, timeframe, delta): + """Czech aware time frame format function, takes into account + the differences between past and future forms.""" + form = self.timeframes[timeframe] + if isinstance(form, dict): + if delta == 0: + form = form["zero"] # And *never* use 0 in the singular! + elif delta > 0: + form = form["future"] + else: + form = form["past"] + delta = abs(delta) + + if isinstance(form, list): + if 2 <= delta % 10 <= 4 and (delta % 100 < 10 or delta % 100 >= 20): + form = form[0] + else: + form = form[1] + + return form.format(delta) + + +class SlovakLocale(Locale): + names = ["sk", "sk_sk"] + + timeframes = { + "now": "Teraz", + "second": {"past": "sekundou", "future": "sekundu", "zero": "{0} sekúnd"}, + "seconds": {"past": "{0} sekundami", "future": ["{0} sekundy", "{0} sekúnd"]}, + "minute": {"past": "minútou", "future": "minútu", "zero": "{0} minút"}, + "minutes": {"past": "{0} minútami", "future": ["{0} minúty", "{0} minút"]}, + "hour": {"past": "hodinou", "future": "hodinu", "zero": "{0} hodín"}, + "hours": {"past": "{0} hodinami", "future": ["{0} hodiny", "{0} hodín"]}, + "day": {"past": "dňom", "future": "deň", "zero": "{0} dní"}, + "days": {"past": "{0} dňami", "future": ["{0} dni", "{0} dní"]}, + "week": {"past": "týždňom", "future": "týždeň", "zero": "{0} týždňov"}, + "weeks": {"past": "{0} týždňami", "future": ["{0} týždne", "{0} týždňov"]}, + "month": {"past": "mesiacom", "future": "mesiac", "zero": "{0} mesiacov"}, + "months": {"past": "{0} mesiacmi", "future": ["{0} mesiace", "{0} mesiacov"]}, + "year": {"past": "rokom", "future": "rok", "zero": "{0} rokov"}, + "years": {"past": "{0} rokmi", "future": ["{0} roky", "{0} rokov"]}, + } + + past = "Pred {0}" + future = "O {0}" + and_word = "a" + + month_names = [ + "", + "január", + "február", + "marec", + "apríl", + "máj", + "jún", + "júl", + "august", + "september", + "október", + "november", + "december", + ] + month_abbreviations = [ + "", + "jan", + "feb", + "mar", + "apr", + "máj", + "jún", + "júl", + "aug", + "sep", + "okt", + "nov", + "dec", + ] + + day_names = [ + "", + "pondelok", + "utorok", + "streda", + "štvrtok", + "piatok", + "sobota", + "nedeľa", + ] + day_abbreviations = ["", "po", "ut", "st", "št", "pi", "so", "ne"] + + def _format_timeframe(self, timeframe, delta): + """Slovak aware time frame format function, takes into account + the differences between past and future forms.""" + form = self.timeframes[timeframe] + if isinstance(form, dict): + if delta == 0: + form = form["zero"] # And *never* use 0 in the singular! + elif delta > 0: + form = form["future"] + else: + form = form["past"] + delta = abs(delta) + + if isinstance(form, list): + if 2 <= delta % 10 <= 4 and (delta % 100 < 10 or delta % 100 >= 20): + form = form[0] + else: + form = form[1] + + return form.format(delta) + + +class FarsiLocale(Locale): + + names = ["fa", "fa_ir"] + + past = "{0} قبل" + future = "در {0}" + + timeframes = { + "now": "اکنون", + "second": "یک لحظه", + "seconds": "{0} ثانیه", + "minute": "یک دقیقه", + "minutes": "{0} دقیقه", + "hour": "یک ساعت", + "hours": "{0} ساعت", + "day": "یک روز", + "days": "{0} روز", + "month": "یک ماه", + "months": "{0} ماه", + "year": "یک سال", + "years": "{0} سال", + } + + meridians = { + "am": "قبل از ظهر", + "pm": "بعد از ظهر", + "AM": "قبل از ظهر", + "PM": "بعد از ظهر", + } + + month_names = [ + "", + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December", + ] + month_abbreviations = [ + "", + "Jan", + "Feb", + "Mar", + "Apr", + "May", + "Jun", + "Jul", + "Aug", + "Sep", + "Oct", + "Nov", + "Dec", + ] + + day_names = [ + "", + "دو شنبه", + "سه شنبه", + "چهارشنبه", + "پنجشنبه", + "جمعه", + "شنبه", + "یکشنبه", + ] + day_abbreviations = ["", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"] + + +class HebrewLocale(Locale): + + names = ["he", "he_IL"] + + past = "לפני {0}" + future = "בעוד {0}" + and_word = "ו" + + timeframes = { + "now": "הרגע", + "second": "שנייה", + "seconds": "{0} שניות", + "minute": "דקה", + "minutes": "{0} דקות", + "hour": "שעה", + "hours": "{0} שעות", + "2-hours": "שעתיים", + "day": "יום", + "days": "{0} ימים", + "2-days": "יומיים", + "week": "שבוע", + "weeks": "{0} שבועות", + "2-weeks": "שבועיים", + "month": "חודש", + "months": "{0} חודשים", + "2-months": "חודשיים", + "year": "שנה", + "years": "{0} שנים", + "2-years": "שנתיים", + } + + meridians = { + "am": 'לפנ"צ', + "pm": 'אחר"צ', + "AM": "לפני הצהריים", + "PM": "אחרי הצהריים", + } + + month_names = [ + "", + "ינואר", + "פברואר", + "מרץ", + "אפריל", + "מאי", + "יוני", + "יולי", + "אוגוסט", + "ספטמבר", + "אוקטובר", + "נובמבר", + "דצמבר", + ] + month_abbreviations = [ + "", + "ינו׳", + "פבר׳", + "מרץ", + "אפר׳", + "מאי", + "יוני", + "יולי", + "אוג׳", + "ספט׳", + "אוק׳", + "נוב׳", + "דצמ׳", + ] + + day_names = ["", "שני", "שלישי", "רביעי", "חמישי", "שישי", "שבת", "ראשון"] + day_abbreviations = ["", "ב׳", "ג׳", "ד׳", "ה׳", "ו׳", "ש׳", "א׳"] + + def _format_timeframe(self, timeframe, delta): + """Hebrew couple of aware""" + couple = "2-{}".format(timeframe) + single = timeframe.rstrip("s") + if abs(delta) == 2 and couple in self.timeframes: + key = couple + elif abs(delta) == 1 and single in self.timeframes: + key = single + else: + key = timeframe + + return self.timeframes[key].format(trunc(abs(delta))) + + def describe_multi(self, timeframes, only_distance=False): + """Describes a delta within multiple timeframes in plain language. + In Hebrew, the and word behaves a bit differently. + + :param timeframes: a list of string, quantity pairs each representing a timeframe and delta. + :param only_distance: return only distance eg: "2 hours and 11 seconds" without "in" or "ago" keywords + """ + + humanized = "" + for index, (timeframe, delta) in enumerate(timeframes): + last_humanized = self._format_timeframe(timeframe, delta) + if index == 0: + humanized = last_humanized + elif index == len(timeframes) - 1: # Must have at least 2 items + humanized += " " + self.and_word + if last_humanized[0].isdecimal(): + humanized += "־" + humanized += last_humanized + else: # Don't add for the last one + humanized += ", " + last_humanized + + if not only_distance: + humanized = self._format_relative(humanized, timeframe, delta) + + return humanized + + +class MarathiLocale(Locale): + + names = ["mr"] + + past = "{0} आधी" + future = "{0} नंतर" + + timeframes = { + "now": "सद्य", + "second": "एक सेकंद", + "seconds": "{0} सेकंद", + "minute": "एक मिनिट ", + "minutes": "{0} मिनिट ", + "hour": "एक तास", + "hours": "{0} तास", + "day": "एक दिवस", + "days": "{0} दिवस", + "month": "एक महिना ", + "months": "{0} महिने ", + "year": "एक वर्ष ", + "years": "{0} वर्ष ", + } + + meridians = {"am": "सकाळ", "pm": "संध्याकाळ", "AM": "सकाळ", "PM": "संध्याकाळ"} + + month_names = [ + "", + "जानेवारी", + "फेब्रुवारी", + "मार्च", + "एप्रिल", + "मे", + "जून", + "जुलै", + "अॉगस्ट", + "सप्टेंबर", + "अॉक्टोबर", + "नोव्हेंबर", + "डिसेंबर", + ] + month_abbreviations = [ + "", + "जान", + "फेब्रु", + "मार्च", + "एप्रि", + "मे", + "जून", + "जुलै", + "अॉग", + "सप्टें", + "अॉक्टो", + "नोव्हें", + "डिसें", + ] + + day_names = [ + "", + "सोमवार", + "मंगळवार", + "बुधवार", + "गुरुवार", + "शुक्रवार", + "शनिवार", + "रविवार", + ] + day_abbreviations = ["", "सोम", "मंगळ", "बुध", "गुरु", "शुक्र", "शनि", "रवि"] + + +def _map_locales(): + + locales = {} + + for _, cls in inspect.getmembers(sys.modules[__name__], inspect.isclass): + if issubclass(cls, Locale): # pragma: no branch + for name in cls.names: + locales[name.lower()] = cls + + return locales + + +class CatalanLocale(Locale): + names = ["ca", "ca_es", "ca_ad", "ca_fr", "ca_it"] + past = "Fa {0}" + future = "En {0}" + and_word = "i" + + timeframes = { + "now": "Ara mateix", + "second": "un segon", + "seconds": "{0} segons", + "minute": "1 minut", + "minutes": "{0} minuts", + "hour": "una hora", + "hours": "{0} hores", + "day": "un dia", + "days": "{0} dies", + "month": "un mes", + "months": "{0} mesos", + "year": "un any", + "years": "{0} anys", + } + + month_names = [ + "", + "gener", + "febrer", + "març", + "abril", + "maig", + "juny", + "juliol", + "agost", + "setembre", + "octubre", + "novembre", + "desembre", + ] + month_abbreviations = [ + "", + "gen.", + "febr.", + "març", + "abr.", + "maig", + "juny", + "jul.", + "ag.", + "set.", + "oct.", + "nov.", + "des.", + ] + day_names = [ + "", + "dilluns", + "dimarts", + "dimecres", + "dijous", + "divendres", + "dissabte", + "diumenge", + ] + day_abbreviations = [ + "", + "dl.", + "dt.", + "dc.", + "dj.", + "dv.", + "ds.", + "dg.", + ] + + +class BasqueLocale(Locale): + names = ["eu", "eu_eu"] + past = "duela {0}" + future = "{0}" # I don't know what's the right phrase in Basque for the future. + + timeframes = { + "now": "Orain", + "second": "segundo bat", + "seconds": "{0} segundu", + "minute": "minutu bat", + "minutes": "{0} minutu", + "hour": "ordu bat", + "hours": "{0} ordu", + "day": "egun bat", + "days": "{0} egun", + "month": "hilabete bat", + "months": "{0} hilabet", + "year": "urte bat", + "years": "{0} urte", + } + + month_names = [ + "", + "urtarrilak", + "otsailak", + "martxoak", + "apirilak", + "maiatzak", + "ekainak", + "uztailak", + "abuztuak", + "irailak", + "urriak", + "azaroak", + "abenduak", + ] + month_abbreviations = [ + "", + "urt", + "ots", + "mar", + "api", + "mai", + "eka", + "uzt", + "abu", + "ira", + "urr", + "aza", + "abe", + ] + day_names = [ + "", + "astelehena", + "asteartea", + "asteazkena", + "osteguna", + "ostirala", + "larunbata", + "igandea", + ] + day_abbreviations = ["", "al", "ar", "az", "og", "ol", "lr", "ig"] + + +class HungarianLocale(Locale): + + names = ["hu", "hu_hu"] + + past = "{0} ezelőtt" + future = "{0} múlva" + + timeframes = { + "now": "éppen most", + "second": {"past": "egy második", "future": "egy második"}, + "seconds": {"past": "{0} másodpercekkel", "future": "{0} pár másodperc"}, + "minute": {"past": "egy perccel", "future": "egy perc"}, + "minutes": {"past": "{0} perccel", "future": "{0} perc"}, + "hour": {"past": "egy órával", "future": "egy óra"}, + "hours": {"past": "{0} órával", "future": "{0} óra"}, + "day": {"past": "egy nappal", "future": "egy nap"}, + "days": {"past": "{0} nappal", "future": "{0} nap"}, + "month": {"past": "egy hónappal", "future": "egy hónap"}, + "months": {"past": "{0} hónappal", "future": "{0} hónap"}, + "year": {"past": "egy évvel", "future": "egy év"}, + "years": {"past": "{0} évvel", "future": "{0} év"}, + } + + month_names = [ + "", + "január", + "február", + "március", + "április", + "május", + "június", + "július", + "augusztus", + "szeptember", + "október", + "november", + "december", + ] + month_abbreviations = [ + "", + "jan", + "febr", + "márc", + "ápr", + "máj", + "jún", + "júl", + "aug", + "szept", + "okt", + "nov", + "dec", + ] + + day_names = [ + "", + "hétfő", + "kedd", + "szerda", + "csütörtök", + "péntek", + "szombat", + "vasárnap", + ] + day_abbreviations = ["", "hét", "kedd", "szer", "csüt", "pént", "szom", "vas"] + + meridians = {"am": "de", "pm": "du", "AM": "DE", "PM": "DU"} + + def _format_timeframe(self, timeframe, delta): + form = self.timeframes[timeframe] + + if isinstance(form, dict): + if delta > 0: + form = form["future"] + else: + form = form["past"] + + return form.format(abs(delta)) + + +class EsperantoLocale(Locale): + names = ["eo", "eo_xx"] + past = "antaŭ {0}" + future = "post {0}" + + timeframes = { + "now": "nun", + "second": "sekundo", + "seconds": "{0} kelkaj sekundoj", + "minute": "unu minuto", + "minutes": "{0} minutoj", + "hour": "un horo", + "hours": "{0} horoj", + "day": "unu tago", + "days": "{0} tagoj", + "month": "unu monato", + "months": "{0} monatoj", + "year": "unu jaro", + "years": "{0} jaroj", + } + + month_names = [ + "", + "januaro", + "februaro", + "marto", + "aprilo", + "majo", + "junio", + "julio", + "aŭgusto", + "septembro", + "oktobro", + "novembro", + "decembro", + ] + month_abbreviations = [ + "", + "jan", + "feb", + "mar", + "apr", + "maj", + "jun", + "jul", + "aŭg", + "sep", + "okt", + "nov", + "dec", + ] + + day_names = [ + "", + "lundo", + "mardo", + "merkredo", + "ĵaŭdo", + "vendredo", + "sabato", + "dimanĉo", + ] + day_abbreviations = ["", "lun", "mar", "mer", "ĵaŭ", "ven", "sab", "dim"] + + meridians = {"am": "atm", "pm": "ptm", "AM": "ATM", "PM": "PTM"} + + ordinal_day_re = r"((?P[1-3]?[0-9](?=a))a)" + + def _ordinal_number(self, n): + return "{}a".format(n) + + +class ThaiLocale(Locale): + + names = ["th", "th_th"] + + past = "{0}{1}ที่ผ่านมา" + future = "ในอีก{1}{0}" + + timeframes = { + "now": "ขณะนี้", + "second": "วินาที", + "seconds": "{0} ไม่กี่วินาที", + "minute": "1 นาที", + "minutes": "{0} นาที", + "hour": "1 ชั่วโมง", + "hours": "{0} ชั่วโมง", + "day": "1 วัน", + "days": "{0} วัน", + "month": "1 เดือน", + "months": "{0} เดือน", + "year": "1 ปี", + "years": "{0} ปี", + } + + month_names = [ + "", + "มกราคม", + "กุมภาพันธ์", + "มีนาคม", + "เมษายน", + "พฤษภาคม", + "มิถุนายน", + "กรกฎาคม", + "สิงหาคม", + "กันยายน", + "ตุลาคม", + "พฤศจิกายน", + "ธันวาคม", + ] + month_abbreviations = [ + "", + "ม.ค.", + "ก.พ.", + "มี.ค.", + "เม.ย.", + "พ.ค.", + "มิ.ย.", + "ก.ค.", + "ส.ค.", + "ก.ย.", + "ต.ค.", + "พ.ย.", + "ธ.ค.", + ] + + day_names = ["", "จันทร์", "อังคาร", "พุธ", "พฤหัสบดี", "ศุกร์", "เสาร์", "อาทิตย์"] + day_abbreviations = ["", "จ", "อ", "พ", "พฤ", "ศ", "ส", "อา"] + + meridians = {"am": "am", "pm": "pm", "AM": "AM", "PM": "PM"} + + BE_OFFSET = 543 + + def year_full(self, year): + """Thai always use Buddhist Era (BE) which is CE + 543""" + year += self.BE_OFFSET + return "{:04d}".format(year) + + def year_abbreviation(self, year): + """Thai always use Buddhist Era (BE) which is CE + 543""" + year += self.BE_OFFSET + return "{:04d}".format(year)[2:] + + def _format_relative(self, humanized, timeframe, delta): + """Thai normally doesn't have any space between words""" + if timeframe == "now": + return humanized + space = "" if timeframe == "seconds" else " " + direction = self.past if delta < 0 else self.future + + return direction.format(humanized, space) + + +class BengaliLocale(Locale): + + names = ["bn", "bn_bd", "bn_in"] + + past = "{0} আগে" + future = "{0} পরে" + + timeframes = { + "now": "এখন", + "second": "একটি দ্বিতীয়", + "seconds": "{0} সেকেন্ড", + "minute": "এক মিনিট", + "minutes": "{0} মিনিট", + "hour": "এক ঘণ্টা", + "hours": "{0} ঘণ্টা", + "day": "এক দিন", + "days": "{0} দিন", + "month": "এক মাস", + "months": "{0} মাস ", + "year": "এক বছর", + "years": "{0} বছর", + } + + meridians = {"am": "সকাল", "pm": "বিকাল", "AM": "সকাল", "PM": "বিকাল"} + + month_names = [ + "", + "জানুয়ারি", + "ফেব্রুয়ারি", + "মার্চ", + "এপ্রিল", + "মে", + "জুন", + "জুলাই", + "আগস্ট", + "সেপ্টেম্বর", + "অক্টোবর", + "নভেম্বর", + "ডিসেম্বর", + ] + month_abbreviations = [ + "", + "জানু", + "ফেব", + "মার্চ", + "এপ্রি", + "মে", + "জুন", + "জুল", + "অগা", + "সেপ্ট", + "অক্টো", + "নভে", + "ডিসে", + ] + + day_names = [ + "", + "সোমবার", + "মঙ্গলবার", + "বুধবার", + "বৃহস্পতিবার", + "শুক্রবার", + "শনিবার", + "রবিবার", + ] + day_abbreviations = ["", "সোম", "মঙ্গল", "বুধ", "বৃহঃ", "শুক্র", "শনি", "রবি"] + + def _ordinal_number(self, n): + if n > 10 or n == 0: + return "{}তম".format(n) + if n in [1, 5, 7, 8, 9, 10]: + return "{}ম".format(n) + if n in [2, 3]: + return "{}য়".format(n) + if n == 4: + return "{}র্থ".format(n) + if n == 6: + return "{}ষ্ঠ".format(n) + + +class RomanshLocale(Locale): + + names = ["rm", "rm_ch"] + + past = "avant {0}" + future = "en {0}" + + timeframes = { + "now": "en quest mument", + "second": "in secunda", + "seconds": "{0} secundas", + "minute": "ina minuta", + "minutes": "{0} minutas", + "hour": "in'ura", + "hours": "{0} ura", + "day": "in di", + "days": "{0} dis", + "month": "in mais", + "months": "{0} mais", + "year": "in onn", + "years": "{0} onns", + } + + month_names = [ + "", + "schaner", + "favrer", + "mars", + "avrigl", + "matg", + "zercladur", + "fanadur", + "avust", + "settember", + "october", + "november", + "december", + ] + + month_abbreviations = [ + "", + "schan", + "fav", + "mars", + "avr", + "matg", + "zer", + "fan", + "avu", + "set", + "oct", + "nov", + "dec", + ] + + day_names = [ + "", + "glindesdi", + "mardi", + "mesemna", + "gievgia", + "venderdi", + "sonda", + "dumengia", + ] + + day_abbreviations = ["", "gli", "ma", "me", "gie", "ve", "so", "du"] + + +class RomanianLocale(Locale): + names = ["ro", "ro_ro"] + + past = "{0} în urmă" + future = "peste {0}" + and_word = "și" + + timeframes = { + "now": "acum", + "second": "o secunda", + "seconds": "{0} câteva secunde", + "minute": "un minut", + "minutes": "{0} minute", + "hour": "o oră", + "hours": "{0} ore", + "day": "o zi", + "days": "{0} zile", + "month": "o lună", + "months": "{0} luni", + "year": "un an", + "years": "{0} ani", + } + + month_names = [ + "", + "ianuarie", + "februarie", + "martie", + "aprilie", + "mai", + "iunie", + "iulie", + "august", + "septembrie", + "octombrie", + "noiembrie", + "decembrie", + ] + month_abbreviations = [ + "", + "ian", + "febr", + "mart", + "apr", + "mai", + "iun", + "iul", + "aug", + "sept", + "oct", + "nov", + "dec", + ] + + day_names = [ + "", + "luni", + "marți", + "miercuri", + "joi", + "vineri", + "sâmbătă", + "duminică", + ] + day_abbreviations = ["", "Lun", "Mar", "Mie", "Joi", "Vin", "Sâm", "Dum"] + + +class SlovenianLocale(Locale): + names = ["sl", "sl_si"] + + past = "pred {0}" + future = "čez {0}" + and_word = "in" + + timeframes = { + "now": "zdaj", + "second": "sekundo", + "seconds": "{0} sekund", + "minute": "minuta", + "minutes": "{0} minutami", + "hour": "uro", + "hours": "{0} ur", + "day": "dan", + "days": "{0} dni", + "month": "mesec", + "months": "{0} mesecev", + "year": "leto", + "years": "{0} let", + } + + meridians = {"am": "", "pm": "", "AM": "", "PM": ""} + + month_names = [ + "", + "Januar", + "Februar", + "Marec", + "April", + "Maj", + "Junij", + "Julij", + "Avgust", + "September", + "Oktober", + "November", + "December", + ] + + month_abbreviations = [ + "", + "Jan", + "Feb", + "Mar", + "Apr", + "Maj", + "Jun", + "Jul", + "Avg", + "Sep", + "Okt", + "Nov", + "Dec", + ] + + day_names = [ + "", + "Ponedeljek", + "Torek", + "Sreda", + "Četrtek", + "Petek", + "Sobota", + "Nedelja", + ] + + day_abbreviations = ["", "Pon", "Tor", "Sre", "Čet", "Pet", "Sob", "Ned"] + + +class IndonesianLocale(Locale): + + names = ["id", "id_id"] + + past = "{0} yang lalu" + future = "dalam {0}" + and_word = "dan" + + timeframes = { + "now": "baru saja", + "second": "1 sebentar", + "seconds": "{0} detik", + "minute": "1 menit", + "minutes": "{0} menit", + "hour": "1 jam", + "hours": "{0} jam", + "day": "1 hari", + "days": "{0} hari", + "month": "1 bulan", + "months": "{0} bulan", + "year": "1 tahun", + "years": "{0} tahun", + } + + meridians = {"am": "", "pm": "", "AM": "", "PM": ""} + + month_names = [ + "", + "Januari", + "Februari", + "Maret", + "April", + "Mei", + "Juni", + "Juli", + "Agustus", + "September", + "Oktober", + "November", + "Desember", + ] + + month_abbreviations = [ + "", + "Jan", + "Feb", + "Mar", + "Apr", + "Mei", + "Jun", + "Jul", + "Ags", + "Sept", + "Okt", + "Nov", + "Des", + ] + + day_names = ["", "Senin", "Selasa", "Rabu", "Kamis", "Jumat", "Sabtu", "Minggu"] + + day_abbreviations = [ + "", + "Senin", + "Selasa", + "Rabu", + "Kamis", + "Jumat", + "Sabtu", + "Minggu", + ] + + +class NepaliLocale(Locale): + names = ["ne", "ne_np"] + + past = "{0} पहिले" + future = "{0} पछी" + + timeframes = { + "now": "अहिले", + "second": "एक सेकेन्ड", + "seconds": "{0} सेकण्ड", + "minute": "मिनेट", + "minutes": "{0} मिनेट", + "hour": "एक घण्टा", + "hours": "{0} घण्टा", + "day": "एक दिन", + "days": "{0} दिन", + "month": "एक महिना", + "months": "{0} महिना", + "year": "एक बर्ष", + "years": "बर्ष", + } + + meridians = {"am": "पूर्वाह्न", "pm": "अपरान्ह", "AM": "पूर्वाह्न", "PM": "अपरान्ह"} + + month_names = [ + "", + "जनवरी", + "फेब्रुअरी", + "मार्च", + "एप्रील", + "मे", + "जुन", + "जुलाई", + "अगष्ट", + "सेप्टेम्बर", + "अक्टोबर", + "नोवेम्बर", + "डिसेम्बर", + ] + month_abbreviations = [ + "", + "जन", + "फेब", + "मार्च", + "एप्रील", + "मे", + "जुन", + "जुलाई", + "अग", + "सेप", + "अक्ट", + "नोव", + "डिस", + ] + + day_names = [ + "", + "सोमवार", + "मंगलवार", + "बुधवार", + "बिहिवार", + "शुक्रवार", + "शनिवार", + "आइतवार", + ] + + day_abbreviations = ["", "सोम", "मंगल", "बुध", "बिहि", "शुक्र", "शनि", "आइत"] + + +class EstonianLocale(Locale): + names = ["ee", "et"] + + past = "{0} tagasi" + future = "{0} pärast" + and_word = "ja" + + timeframes = { + "now": {"past": "just nüüd", "future": "just nüüd"}, + "second": {"past": "üks sekund", "future": "ühe sekundi"}, + "seconds": {"past": "{0} sekundit", "future": "{0} sekundi"}, + "minute": {"past": "üks minut", "future": "ühe minuti"}, + "minutes": {"past": "{0} minutit", "future": "{0} minuti"}, + "hour": {"past": "tund aega", "future": "tunni aja"}, + "hours": {"past": "{0} tundi", "future": "{0} tunni"}, + "day": {"past": "üks päev", "future": "ühe päeva"}, + "days": {"past": "{0} päeva", "future": "{0} päeva"}, + "month": {"past": "üks kuu", "future": "ühe kuu"}, + "months": {"past": "{0} kuud", "future": "{0} kuu"}, + "year": {"past": "üks aasta", "future": "ühe aasta"}, + "years": {"past": "{0} aastat", "future": "{0} aasta"}, + } + + month_names = [ + "", + "Jaanuar", + "Veebruar", + "Märts", + "Aprill", + "Mai", + "Juuni", + "Juuli", + "August", + "September", + "Oktoober", + "November", + "Detsember", + ] + month_abbreviations = [ + "", + "Jan", + "Veb", + "Mär", + "Apr", + "Mai", + "Jun", + "Jul", + "Aug", + "Sep", + "Okt", + "Nov", + "Dets", + ] + + day_names = [ + "", + "Esmaspäev", + "Teisipäev", + "Kolmapäev", + "Neljapäev", + "Reede", + "Laupäev", + "Pühapäev", + ] + day_abbreviations = ["", "Esm", "Teis", "Kolm", "Nelj", "Re", "Lau", "Püh"] + + def _format_timeframe(self, timeframe, delta): + form = self.timeframes[timeframe] + if delta > 0: + form = form["future"] + else: + form = form["past"] + return form.format(abs(delta)) + + +class SwahiliLocale(Locale): + + names = [ + "sw", + "sw_ke", + "sw_tz", + ] + + past = "{0} iliyopita" + future = "muda wa {0}" + and_word = "na" + + timeframes = { + "now": "sasa hivi", + "second": "sekunde", + "seconds": "sekunde {0}", + "minute": "dakika moja", + "minutes": "dakika {0}", + "hour": "saa moja", + "hours": "saa {0}", + "day": "siku moja", + "days": "siku {0}", + "week": "wiki moja", + "weeks": "wiki {0}", + "month": "mwezi moja", + "months": "miezi {0}", + "year": "mwaka moja", + "years": "miaka {0}", + } + + meridians = {"am": "asu", "pm": "mch", "AM": "ASU", "PM": "MCH"} + + month_names = [ + "", + "Januari", + "Februari", + "Machi", + "Aprili", + "Mei", + "Juni", + "Julai", + "Agosti", + "Septemba", + "Oktoba", + "Novemba", + "Desemba", + ] + month_abbreviations = [ + "", + "Jan", + "Feb", + "Mac", + "Apr", + "Mei", + "Jun", + "Jul", + "Ago", + "Sep", + "Okt", + "Nov", + "Des", + ] + + day_names = [ + "", + "Jumatatu", + "Jumanne", + "Jumatano", + "Alhamisi", + "Ijumaa", + "Jumamosi", + "Jumapili", + ] + day_abbreviations = [ + "", + "Jumatatu", + "Jumanne", + "Jumatano", + "Alhamisi", + "Ijumaa", + "Jumamosi", + "Jumapili", + ] + + +_locales = _map_locales() diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/parser.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/parser.py new file mode 100644 index 0000000000..243fd1721c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/parser.py @@ -0,0 +1,596 @@ +# -*- coding: utf-8 -*- +from __future__ import absolute_import, unicode_literals + +import re +from datetime import datetime, timedelta + +from dateutil import tz + +from arrow import locales +from arrow.util import iso_to_gregorian, next_weekday, normalize_timestamp + +try: + from functools import lru_cache +except ImportError: # pragma: no cover + from backports.functools_lru_cache import lru_cache # pragma: no cover + + +class ParserError(ValueError): + pass + + +# Allows for ParserErrors to be propagated from _build_datetime() +# when day_of_year errors occur. +# Before this, the ParserErrors were caught by the try/except in +# _parse_multiformat() and the appropriate error message was not +# transmitted to the user. +class ParserMatchError(ParserError): + pass + + +class DateTimeParser(object): + + _FORMAT_RE = re.compile( + r"(YYY?Y?|MM?M?M?|Do|DD?D?D?|d?d?d?d|HH?|hh?|mm?|ss?|S+|ZZ?Z?|a|A|x|X|W)" + ) + _ESCAPE_RE = re.compile(r"\[[^\[\]]*\]") + + _ONE_OR_TWO_DIGIT_RE = re.compile(r"\d{1,2}") + _ONE_OR_TWO_OR_THREE_DIGIT_RE = re.compile(r"\d{1,3}") + _ONE_OR_MORE_DIGIT_RE = re.compile(r"\d+") + _TWO_DIGIT_RE = re.compile(r"\d{2}") + _THREE_DIGIT_RE = re.compile(r"\d{3}") + _FOUR_DIGIT_RE = re.compile(r"\d{4}") + _TZ_Z_RE = re.compile(r"([\+\-])(\d{2})(?:(\d{2}))?|Z") + _TZ_ZZ_RE = re.compile(r"([\+\-])(\d{2})(?:\:(\d{2}))?|Z") + _TZ_NAME_RE = re.compile(r"\w[\w+\-/]+") + # NOTE: timestamps cannot be parsed from natural language strings (by removing the ^...$) because it will + # break cases like "15 Jul 2000" and a format list (see issue #447) + _TIMESTAMP_RE = re.compile(r"^\-?\d+\.?\d+$") + _TIMESTAMP_EXPANDED_RE = re.compile(r"^\-?\d+$") + _TIME_RE = re.compile(r"^(\d{2})(?:\:?(\d{2}))?(?:\:?(\d{2}))?(?:([\.\,])(\d+))?$") + _WEEK_DATE_RE = re.compile(r"(?P\d{4})[\-]?W(?P\d{2})[\-]?(?P\d)?") + + _BASE_INPUT_RE_MAP = { + "YYYY": _FOUR_DIGIT_RE, + "YY": _TWO_DIGIT_RE, + "MM": _TWO_DIGIT_RE, + "M": _ONE_OR_TWO_DIGIT_RE, + "DDDD": _THREE_DIGIT_RE, + "DDD": _ONE_OR_TWO_OR_THREE_DIGIT_RE, + "DD": _TWO_DIGIT_RE, + "D": _ONE_OR_TWO_DIGIT_RE, + "HH": _TWO_DIGIT_RE, + "H": _ONE_OR_TWO_DIGIT_RE, + "hh": _TWO_DIGIT_RE, + "h": _ONE_OR_TWO_DIGIT_RE, + "mm": _TWO_DIGIT_RE, + "m": _ONE_OR_TWO_DIGIT_RE, + "ss": _TWO_DIGIT_RE, + "s": _ONE_OR_TWO_DIGIT_RE, + "X": _TIMESTAMP_RE, + "x": _TIMESTAMP_EXPANDED_RE, + "ZZZ": _TZ_NAME_RE, + "ZZ": _TZ_ZZ_RE, + "Z": _TZ_Z_RE, + "S": _ONE_OR_MORE_DIGIT_RE, + "W": _WEEK_DATE_RE, + } + + SEPARATORS = ["-", "/", "."] + + def __init__(self, locale="en_us", cache_size=0): + + self.locale = locales.get_locale(locale) + self._input_re_map = self._BASE_INPUT_RE_MAP.copy() + self._input_re_map.update( + { + "MMMM": self._generate_choice_re( + self.locale.month_names[1:], re.IGNORECASE + ), + "MMM": self._generate_choice_re( + self.locale.month_abbreviations[1:], re.IGNORECASE + ), + "Do": re.compile(self.locale.ordinal_day_re), + "dddd": self._generate_choice_re( + self.locale.day_names[1:], re.IGNORECASE + ), + "ddd": self._generate_choice_re( + self.locale.day_abbreviations[1:], re.IGNORECASE + ), + "d": re.compile(r"[1-7]"), + "a": self._generate_choice_re( + (self.locale.meridians["am"], self.locale.meridians["pm"]) + ), + # note: 'A' token accepts both 'am/pm' and 'AM/PM' formats to + # ensure backwards compatibility of this token + "A": self._generate_choice_re(self.locale.meridians.values()), + } + ) + if cache_size > 0: + self._generate_pattern_re = lru_cache(maxsize=cache_size)( + self._generate_pattern_re + ) + + # TODO: since we support more than ISO 8601, we should rename this function + # IDEA: break into multiple functions + def parse_iso(self, datetime_string, normalize_whitespace=False): + + if normalize_whitespace: + datetime_string = re.sub(r"\s+", " ", datetime_string.strip()) + + has_space_divider = " " in datetime_string + has_t_divider = "T" in datetime_string + + num_spaces = datetime_string.count(" ") + if has_space_divider and num_spaces != 1 or has_t_divider and num_spaces > 0: + raise ParserError( + "Expected an ISO 8601-like string, but was given '{}'. Try passing in a format string to resolve this.".format( + datetime_string + ) + ) + + has_time = has_space_divider or has_t_divider + has_tz = False + + # date formats (ISO 8601 and others) to test against + # NOTE: YYYYMM is omitted to avoid confusion with YYMMDD (no longer part of ISO 8601, but is still often used) + formats = [ + "YYYY-MM-DD", + "YYYY-M-DD", + "YYYY-M-D", + "YYYY/MM/DD", + "YYYY/M/DD", + "YYYY/M/D", + "YYYY.MM.DD", + "YYYY.M.DD", + "YYYY.M.D", + "YYYYMMDD", + "YYYY-DDDD", + "YYYYDDDD", + "YYYY-MM", + "YYYY/MM", + "YYYY.MM", + "YYYY", + "W", + ] + + if has_time: + + if has_space_divider: + date_string, time_string = datetime_string.split(" ", 1) + else: + date_string, time_string = datetime_string.split("T", 1) + + time_parts = re.split(r"[\+\-Z]", time_string, 1, re.IGNORECASE) + + time_components = self._TIME_RE.match(time_parts[0]) + + if time_components is None: + raise ParserError( + "Invalid time component provided. Please specify a format or provide a valid time component in the basic or extended ISO 8601 time format." + ) + + ( + hours, + minutes, + seconds, + subseconds_sep, + subseconds, + ) = time_components.groups() + + has_tz = len(time_parts) == 2 + has_minutes = minutes is not None + has_seconds = seconds is not None + has_subseconds = subseconds is not None + + is_basic_time_format = ":" not in time_parts[0] + tz_format = "Z" + + # use 'ZZ' token instead since tz offset is present in non-basic format + if has_tz and ":" in time_parts[1]: + tz_format = "ZZ" + + time_sep = "" if is_basic_time_format else ":" + + if has_subseconds: + time_string = "HH{time_sep}mm{time_sep}ss{subseconds_sep}S".format( + time_sep=time_sep, subseconds_sep=subseconds_sep + ) + elif has_seconds: + time_string = "HH{time_sep}mm{time_sep}ss".format(time_sep=time_sep) + elif has_minutes: + time_string = "HH{time_sep}mm".format(time_sep=time_sep) + else: + time_string = "HH" + + if has_space_divider: + formats = ["{} {}".format(f, time_string) for f in formats] + else: + formats = ["{}T{}".format(f, time_string) for f in formats] + + if has_time and has_tz: + # Add "Z" or "ZZ" to the format strings to indicate to + # _parse_token() that a timezone needs to be parsed + formats = ["{}{}".format(f, tz_format) for f in formats] + + return self._parse_multiformat(datetime_string, formats) + + def parse(self, datetime_string, fmt, normalize_whitespace=False): + + if normalize_whitespace: + datetime_string = re.sub(r"\s+", " ", datetime_string) + + if isinstance(fmt, list): + return self._parse_multiformat(datetime_string, fmt) + + fmt_tokens, fmt_pattern_re = self._generate_pattern_re(fmt) + + match = fmt_pattern_re.search(datetime_string) + + if match is None: + raise ParserMatchError( + "Failed to match '{}' when parsing '{}'".format(fmt, datetime_string) + ) + + parts = {} + for token in fmt_tokens: + if token == "Do": + value = match.group("value") + elif token == "W": + value = (match.group("year"), match.group("week"), match.group("day")) + else: + value = match.group(token) + self._parse_token(token, value, parts) + + return self._build_datetime(parts) + + def _generate_pattern_re(self, fmt): + + # fmt is a string of tokens like 'YYYY-MM-DD' + # we construct a new string by replacing each + # token by its pattern: + # 'YYYY-MM-DD' -> '(?P\d{4})-(?P\d{2})-(?P
\d{2})' + tokens = [] + offset = 0 + + # Escape all special RegEx chars + escaped_fmt = re.escape(fmt) + + # Extract the bracketed expressions to be reinserted later. + escaped_fmt = re.sub(self._ESCAPE_RE, "#", escaped_fmt) + + # Any number of S is the same as one. + # TODO: allow users to specify the number of digits to parse + escaped_fmt = re.sub(r"S+", "S", escaped_fmt) + + escaped_data = re.findall(self._ESCAPE_RE, fmt) + + fmt_pattern = escaped_fmt + + for m in self._FORMAT_RE.finditer(escaped_fmt): + token = m.group(0) + try: + input_re = self._input_re_map[token] + except KeyError: + raise ParserError("Unrecognized token '{}'".format(token)) + input_pattern = "(?P<{}>{})".format(token, input_re.pattern) + tokens.append(token) + # a pattern doesn't have the same length as the token + # it replaces! We keep the difference in the offset variable. + # This works because the string is scanned left-to-right and matches + # are returned in the order found by finditer. + fmt_pattern = ( + fmt_pattern[: m.start() + offset] + + input_pattern + + fmt_pattern[m.end() + offset :] + ) + offset += len(input_pattern) - (m.end() - m.start()) + + final_fmt_pattern = "" + split_fmt = fmt_pattern.split(r"\#") + + # Due to the way Python splits, 'split_fmt' will always be longer + for i in range(len(split_fmt)): + final_fmt_pattern += split_fmt[i] + if i < len(escaped_data): + final_fmt_pattern += escaped_data[i][1:-1] + + # Wrap final_fmt_pattern in a custom word boundary to strictly + # match the formatting pattern and filter out date and time formats + # that include junk such as: blah1998-09-12 blah, blah 1998-09-12blah, + # blah1998-09-12blah. The custom word boundary matches every character + # that is not a whitespace character to allow for searching for a date + # and time string in a natural language sentence. Therefore, searching + # for a string of the form YYYY-MM-DD in "blah 1998-09-12 blah" will + # work properly. + # Certain punctuation before or after the target pattern such as + # "1998-09-12," is permitted. For the full list of valid punctuation, + # see the documentation. + + starting_word_boundary = ( + r"(?\s])" # This is the list of punctuation that is ok before the pattern (i.e. "It can't not be these characters before the pattern") + r"(\b|^)" # The \b is to block cases like 1201912 but allow 201912 for pattern YYYYMM. The ^ was necessary to allow a negative number through i.e. before epoch numbers + ) + ending_word_boundary = ( + r"(?=[\,\.\;\:\?\!\"\'\`\[\]\{\}\(\)\<\>]?" # Positive lookahead stating that these punctuation marks can appear after the pattern at most 1 time + r"(?!\S))" # Don't allow any non-whitespace character after the punctuation + ) + bounded_fmt_pattern = r"{}{}{}".format( + starting_word_boundary, final_fmt_pattern, ending_word_boundary + ) + + return tokens, re.compile(bounded_fmt_pattern, flags=re.IGNORECASE) + + def _parse_token(self, token, value, parts): + + if token == "YYYY": + parts["year"] = int(value) + + elif token == "YY": + value = int(value) + parts["year"] = 1900 + value if value > 68 else 2000 + value + + elif token in ["MMMM", "MMM"]: + parts["month"] = self.locale.month_number(value.lower()) + + elif token in ["MM", "M"]: + parts["month"] = int(value) + + elif token in ["DDDD", "DDD"]: + parts["day_of_year"] = int(value) + + elif token in ["DD", "D"]: + parts["day"] = int(value) + + elif token == "Do": + parts["day"] = int(value) + + elif token == "dddd": + # locale day names are 1-indexed + day_of_week = [x.lower() for x in self.locale.day_names].index( + value.lower() + ) + parts["day_of_week"] = day_of_week - 1 + + elif token == "ddd": + # locale day abbreviations are 1-indexed + day_of_week = [x.lower() for x in self.locale.day_abbreviations].index( + value.lower() + ) + parts["day_of_week"] = day_of_week - 1 + + elif token.upper() in ["HH", "H"]: + parts["hour"] = int(value) + + elif token in ["mm", "m"]: + parts["minute"] = int(value) + + elif token in ["ss", "s"]: + parts["second"] = int(value) + + elif token == "S": + # We have the *most significant* digits of an arbitrary-precision integer. + # We want the six most significant digits as an integer, rounded. + # IDEA: add nanosecond support somehow? Need datetime support for it first. + value = value.ljust(7, str("0")) + + # floating-point (IEEE-754) defaults to half-to-even rounding + seventh_digit = int(value[6]) + if seventh_digit == 5: + rounding = int(value[5]) % 2 + elif seventh_digit > 5: + rounding = 1 + else: + rounding = 0 + + parts["microsecond"] = int(value[:6]) + rounding + + elif token == "X": + parts["timestamp"] = float(value) + + elif token == "x": + parts["expanded_timestamp"] = int(value) + + elif token in ["ZZZ", "ZZ", "Z"]: + parts["tzinfo"] = TzinfoParser.parse(value) + + elif token in ["a", "A"]: + if value in (self.locale.meridians["am"], self.locale.meridians["AM"]): + parts["am_pm"] = "am" + elif value in (self.locale.meridians["pm"], self.locale.meridians["PM"]): + parts["am_pm"] = "pm" + + elif token == "W": + parts["weekdate"] = value + + @staticmethod + def _build_datetime(parts): + + weekdate = parts.get("weekdate") + + if weekdate is not None: + # we can use strptime (%G, %V, %u) in python 3.6 but these tokens aren't available before that + year, week = int(weekdate[0]), int(weekdate[1]) + + if weekdate[2] is not None: + day = int(weekdate[2]) + else: + # day not given, default to 1 + day = 1 + + dt = iso_to_gregorian(year, week, day) + parts["year"] = dt.year + parts["month"] = dt.month + parts["day"] = dt.day + + timestamp = parts.get("timestamp") + + if timestamp is not None: + return datetime.fromtimestamp(timestamp, tz=tz.tzutc()) + + expanded_timestamp = parts.get("expanded_timestamp") + + if expanded_timestamp is not None: + return datetime.fromtimestamp( + normalize_timestamp(expanded_timestamp), + tz=tz.tzutc(), + ) + + day_of_year = parts.get("day_of_year") + + if day_of_year is not None: + year = parts.get("year") + month = parts.get("month") + if year is None: + raise ParserError( + "Year component is required with the DDD and DDDD tokens." + ) + + if month is not None: + raise ParserError( + "Month component is not allowed with the DDD and DDDD tokens." + ) + + date_string = "{}-{}".format(year, day_of_year) + try: + dt = datetime.strptime(date_string, "%Y-%j") + except ValueError: + raise ParserError( + "The provided day of year '{}' is invalid.".format(day_of_year) + ) + + parts["year"] = dt.year + parts["month"] = dt.month + parts["day"] = dt.day + + day_of_week = parts.get("day_of_week") + day = parts.get("day") + + # If day is passed, ignore day of week + if day_of_week is not None and day is None: + year = parts.get("year", 1970) + month = parts.get("month", 1) + day = 1 + + # dddd => first day of week after epoch + # dddd YYYY => first day of week in specified year + # dddd MM YYYY => first day of week in specified year and month + # dddd MM => first day after epoch in specified month + next_weekday_dt = next_weekday(datetime(year, month, day), day_of_week) + parts["year"] = next_weekday_dt.year + parts["month"] = next_weekday_dt.month + parts["day"] = next_weekday_dt.day + + am_pm = parts.get("am_pm") + hour = parts.get("hour", 0) + + if am_pm == "pm" and hour < 12: + hour += 12 + elif am_pm == "am" and hour == 12: + hour = 0 + + # Support for midnight at the end of day + if hour == 24: + if parts.get("minute", 0) != 0: + raise ParserError("Midnight at the end of day must not contain minutes") + if parts.get("second", 0) != 0: + raise ParserError("Midnight at the end of day must not contain seconds") + if parts.get("microsecond", 0) != 0: + raise ParserError( + "Midnight at the end of day must not contain microseconds" + ) + hour = 0 + day_increment = 1 + else: + day_increment = 0 + + # account for rounding up to 1000000 + microsecond = parts.get("microsecond", 0) + if microsecond == 1000000: + microsecond = 0 + second_increment = 1 + else: + second_increment = 0 + + increment = timedelta(days=day_increment, seconds=second_increment) + + return ( + datetime( + year=parts.get("year", 1), + month=parts.get("month", 1), + day=parts.get("day", 1), + hour=hour, + minute=parts.get("minute", 0), + second=parts.get("second", 0), + microsecond=microsecond, + tzinfo=parts.get("tzinfo"), + ) + + increment + ) + + def _parse_multiformat(self, string, formats): + + _datetime = None + + for fmt in formats: + try: + _datetime = self.parse(string, fmt) + break + except ParserMatchError: + pass + + if _datetime is None: + raise ParserError( + "Could not match input '{}' to any of the following formats: {}".format( + string, ", ".join(formats) + ) + ) + + return _datetime + + # generates a capture group of choices separated by an OR operator + @staticmethod + def _generate_choice_re(choices, flags=0): + return re.compile(r"({})".format("|".join(choices)), flags=flags) + + +class TzinfoParser(object): + _TZINFO_RE = re.compile(r"^([\+\-])?(\d{2})(?:\:?(\d{2}))?$") + + @classmethod + def parse(cls, tzinfo_string): + + tzinfo = None + + if tzinfo_string == "local": + tzinfo = tz.tzlocal() + + elif tzinfo_string in ["utc", "UTC", "Z"]: + tzinfo = tz.tzutc() + + else: + + iso_match = cls._TZINFO_RE.match(tzinfo_string) + + if iso_match: + sign, hours, minutes = iso_match.groups() + if minutes is None: + minutes = 0 + seconds = int(hours) * 3600 + int(minutes) * 60 + + if sign == "-": + seconds *= -1 + + tzinfo = tz.tzoffset(None, seconds) + + else: + tzinfo = tz.gettz(tzinfo_string) + + if tzinfo is None: + raise ParserError( + 'Could not parse timezone expression "{}"'.format(tzinfo_string) + ) + + return tzinfo diff --git a/openpype/modules/ftrack/python2_vendor/arrow/arrow/util.py b/openpype/modules/ftrack/python2_vendor/arrow/arrow/util.py new file mode 100644 index 0000000000..acce8878df --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/arrow/util.py @@ -0,0 +1,115 @@ +# -*- coding: utf-8 -*- +from __future__ import absolute_import + +import datetime +import numbers + +from dateutil.rrule import WEEKLY, rrule + +from arrow.constants import MAX_TIMESTAMP, MAX_TIMESTAMP_MS, MAX_TIMESTAMP_US + + +def next_weekday(start_date, weekday): + """Get next weekday from the specified start date. + + :param start_date: Datetime object representing the start date. + :param weekday: Next weekday to obtain. Can be a value between 0 (Monday) and 6 (Sunday). + :return: Datetime object corresponding to the next weekday after start_date. + + Usage:: + + # Get first Monday after epoch + >>> next_weekday(datetime(1970, 1, 1), 0) + 1970-01-05 00:00:00 + + # Get first Thursday after epoch + >>> next_weekday(datetime(1970, 1, 1), 3) + 1970-01-01 00:00:00 + + # Get first Sunday after epoch + >>> next_weekday(datetime(1970, 1, 1), 6) + 1970-01-04 00:00:00 + """ + if weekday < 0 or weekday > 6: + raise ValueError("Weekday must be between 0 (Monday) and 6 (Sunday).") + return rrule(freq=WEEKLY, dtstart=start_date, byweekday=weekday, count=1)[0] + + +def total_seconds(td): + """Get total seconds for timedelta.""" + return td.total_seconds() + + +def is_timestamp(value): + """Check if value is a valid timestamp.""" + if isinstance(value, bool): + return False + if not ( + isinstance(value, numbers.Integral) + or isinstance(value, float) + or isinstance(value, str) + ): + return False + try: + float(value) + return True + except ValueError: + return False + + +def normalize_timestamp(timestamp): + """Normalize millisecond and microsecond timestamps into normal timestamps.""" + if timestamp > MAX_TIMESTAMP: + if timestamp < MAX_TIMESTAMP_MS: + timestamp /= 1e3 + elif timestamp < MAX_TIMESTAMP_US: + timestamp /= 1e6 + else: + raise ValueError( + "The specified timestamp '{}' is too large.".format(timestamp) + ) + return timestamp + + +# Credit to https://stackoverflow.com/a/1700069 +def iso_to_gregorian(iso_year, iso_week, iso_day): + """Converts an ISO week date tuple into a datetime object.""" + + if not 1 <= iso_week <= 53: + raise ValueError("ISO Calendar week value must be between 1-53.") + + if not 1 <= iso_day <= 7: + raise ValueError("ISO Calendar day value must be between 1-7") + + # The first week of the year always contains 4 Jan. + fourth_jan = datetime.date(iso_year, 1, 4) + delta = datetime.timedelta(fourth_jan.isoweekday() - 1) + year_start = fourth_jan - delta + gregorian = year_start + datetime.timedelta(days=iso_day - 1, weeks=iso_week - 1) + + return gregorian + + +def validate_bounds(bounds): + if bounds != "()" and bounds != "(]" and bounds != "[)" and bounds != "[]": + raise ValueError( + 'Invalid bounds. Please select between "()", "(]", "[)", or "[]".' + ) + + +# Python 2.7 / 3.0+ definitions for isstr function. + +try: # pragma: no cover + basestring + + def isstr(s): + return isinstance(s, basestring) # noqa: F821 + + +except NameError: # pragma: no cover + + def isstr(s): + return isinstance(s, str) + + +__all__ = ["next_weekday", "total_seconds", "is_timestamp", "isstr", "iso_to_gregorian"] diff --git a/openpype/modules/ftrack/python2_vendor/arrow/docs/Makefile b/openpype/modules/ftrack/python2_vendor/arrow/docs/Makefile new file mode 100644 index 0000000000..d4bb2cbb9e --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/docs/conf.py b/openpype/modules/ftrack/python2_vendor/arrow/docs/conf.py new file mode 100644 index 0000000000..aaf3c50822 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/docs/conf.py @@ -0,0 +1,62 @@ +# -*- coding: utf-8 -*- + +# -- Path setup -------------------------------------------------------------- + +import io +import os +import sys + +sys.path.insert(0, os.path.abspath("..")) + +about = {} +with io.open("../arrow/_version.py", "r", encoding="utf-8") as f: + exec(f.read(), about) + +# -- Project information ----------------------------------------------------- + +project = u"Arrow 🏹" +copyright = "2020, Chris Smith" +author = "Chris Smith" + +release = about["__version__"] + +# -- General configuration --------------------------------------------------- + +extensions = ["sphinx.ext.autodoc"] + +templates_path = [] + +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + +master_doc = "index" +source_suffix = ".rst" +pygments_style = "sphinx" + +language = None + +# -- Options for HTML output ------------------------------------------------- + +html_theme = "alabaster" +html_theme_path = [] +html_static_path = [] + +html_show_sourcelink = False +html_show_sphinx = False +html_show_copyright = True + +# https://alabaster.readthedocs.io/en/latest/customization.html +html_theme_options = { + "description": "Arrow is a sensible and human-friendly approach to dates, times and timestamps.", + "github_user": "arrow-py", + "github_repo": "arrow", + "github_banner": True, + "show_related": False, + "show_powered_by": False, + "github_button": True, + "github_type": "star", + "github_count": "true", # must be a string +} + +html_sidebars = { + "**": ["about.html", "localtoc.html", "relations.html", "searchbox.html"] +} diff --git a/openpype/modules/ftrack/python2_vendor/arrow/docs/index.rst b/openpype/modules/ftrack/python2_vendor/arrow/docs/index.rst new file mode 100644 index 0000000000..e2830b04f3 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/docs/index.rst @@ -0,0 +1,566 @@ +Arrow: Better dates & times for Python +====================================== + +Release v\ |release| (`Installation`_) (`Changelog `_) + +.. include:: ../README.rst + :start-after: start-inclusion-marker-do-not-remove + :end-before: end-inclusion-marker-do-not-remove + +User's Guide +------------ + +Creation +~~~~~~~~ + +Get 'now' easily: + +.. code-block:: python + + >>> arrow.utcnow() + + + >>> arrow.now() + + + >>> arrow.now('US/Pacific') + + +Create from timestamps (:code:`int` or :code:`float`): + +.. code-block:: python + + >>> arrow.get(1367900664) + + + >>> arrow.get(1367900664.152325) + + +Use a naive or timezone-aware datetime, or flexibly specify a timezone: + +.. code-block:: python + + >>> arrow.get(datetime.utcnow()) + + + >>> arrow.get(datetime(2013, 5, 5), 'US/Pacific') + + + >>> from dateutil import tz + >>> arrow.get(datetime(2013, 5, 5), tz.gettz('US/Pacific')) + + + >>> arrow.get(datetime.now(tz.gettz('US/Pacific'))) + + +Parse from a string: + +.. code-block:: python + + >>> arrow.get('2013-05-05 12:30:45', 'YYYY-MM-DD HH:mm:ss') + + +Search a date in a string: + +.. code-block:: python + + >>> arrow.get('June was born in May 1980', 'MMMM YYYY') + + +Some ISO 8601 compliant strings are recognized and parsed without a format string: + + >>> arrow.get('2013-09-30T15:34:00.000-07:00') + + +Arrow objects can be instantiated directly too, with the same arguments as a datetime: + +.. code-block:: python + + >>> arrow.get(2013, 5, 5) + + + >>> arrow.Arrow(2013, 5, 5) + + +Properties +~~~~~~~~~~ + +Get a datetime or timestamp representation: + +.. code-block:: python + + >>> a = arrow.utcnow() + >>> a.datetime + datetime.datetime(2013, 5, 7, 4, 38, 15, 447644, tzinfo=tzutc()) + + >>> a.timestamp + 1367901495 + +Get a naive datetime, and tzinfo: + +.. code-block:: python + + >>> a.naive + datetime.datetime(2013, 5, 7, 4, 38, 15, 447644) + + >>> a.tzinfo + tzutc() + +Get any datetime value: + +.. code-block:: python + + >>> a.year + 2013 + +Call datetime functions that return properties: + +.. code-block:: python + + >>> a.date() + datetime.date(2013, 5, 7) + + >>> a.time() + datetime.time(4, 38, 15, 447644) + +Replace & Shift +~~~~~~~~~~~~~~~ + +Get a new :class:`Arrow ` object, with altered attributes, just as you would with a datetime: + +.. code-block:: python + + >>> arw = arrow.utcnow() + >>> arw + + + >>> arw.replace(hour=4, minute=40) + + +Or, get one with attributes shifted forward or backward: + +.. code-block:: python + + >>> arw.shift(weeks=+3) + + +Even replace the timezone without altering other attributes: + +.. code-block:: python + + >>> arw.replace(tzinfo='US/Pacific') + + +Move between the earlier and later moments of an ambiguous time: + +.. code-block:: python + + >>> paris_transition = arrow.Arrow(2019, 10, 27, 2, tzinfo="Europe/Paris", fold=0) + >>> paris_transition + + >>> paris_transition.ambiguous + True + >>> paris_transition.replace(fold=1) + + +Format +~~~~~~ + +.. code-block:: python + + >>> arrow.utcnow().format('YYYY-MM-DD HH:mm:ss ZZ') + '2013-05-07 05:23:16 -00:00' + +Convert +~~~~~~~ + +Convert from UTC to other timezones by name or tzinfo: + +.. code-block:: python + + >>> utc = arrow.utcnow() + >>> utc + + + >>> utc.to('US/Pacific') + + + >>> utc.to(tz.gettz('US/Pacific')) + + +Or using shorthand: + +.. code-block:: python + + >>> utc.to('local') + + + >>> utc.to('local').to('utc') + + + +Humanize +~~~~~~~~ + +Humanize relative to now: + +.. code-block:: python + + >>> past = arrow.utcnow().shift(hours=-1) + >>> past.humanize() + 'an hour ago' + +Or another Arrow, or datetime: + +.. code-block:: python + + >>> present = arrow.utcnow() + >>> future = present.shift(hours=2) + >>> future.humanize(present) + 'in 2 hours' + +Indicate time as relative or include only the distance + +.. code-block:: python + + >>> present = arrow.utcnow() + >>> future = present.shift(hours=2) + >>> future.humanize(present) + 'in 2 hours' + >>> future.humanize(present, only_distance=True) + '2 hours' + + +Indicate a specific time granularity (or multiple): + +.. code-block:: python + + >>> present = arrow.utcnow() + >>> future = present.shift(minutes=66) + >>> future.humanize(present, granularity="minute") + 'in 66 minutes' + >>> future.humanize(present, granularity=["hour", "minute"]) + 'in an hour and 6 minutes' + >>> present.humanize(future, granularity=["hour", "minute"]) + 'an hour and 6 minutes ago' + >>> future.humanize(present, only_distance=True, granularity=["hour", "minute"]) + 'an hour and 6 minutes' + +Support for a growing number of locales (see ``locales.py`` for supported languages): + +.. code-block:: python + + + >>> future = arrow.utcnow().shift(hours=1) + >>> future.humanize(a, locale='ru') + 'через 2 час(а,ов)' + + +Ranges & Spans +~~~~~~~~~~~~~~ + +Get the time span of any unit: + +.. code-block:: python + + >>> arrow.utcnow().span('hour') + (, ) + +Or just get the floor and ceiling: + +.. code-block:: python + + >>> arrow.utcnow().floor('hour') + + + >>> arrow.utcnow().ceil('hour') + + +You can also get a range of time spans: + +.. code-block:: python + + >>> start = datetime(2013, 5, 5, 12, 30) + >>> end = datetime(2013, 5, 5, 17, 15) + >>> for r in arrow.Arrow.span_range('hour', start, end): + ... print r + ... + (, ) + (, ) + (, ) + (, ) + (, ) + +Or just iterate over a range of time: + +.. code-block:: python + + >>> start = datetime(2013, 5, 5, 12, 30) + >>> end = datetime(2013, 5, 5, 17, 15) + >>> for r in arrow.Arrow.range('hour', start, end): + ... print repr(r) + ... + + + + + + +.. toctree:: + :maxdepth: 2 + +Factories +~~~~~~~~~ + +Use factories to harness Arrow's module API for a custom Arrow-derived type. First, derive your type: + +.. code-block:: python + + >>> class CustomArrow(arrow.Arrow): + ... + ... def days_till_xmas(self): + ... + ... xmas = arrow.Arrow(self.year, 12, 25) + ... + ... if self > xmas: + ... xmas = xmas.shift(years=1) + ... + ... return (xmas - self).days + + +Then get and use a factory for it: + +.. code-block:: python + + >>> factory = arrow.ArrowFactory(CustomArrow) + >>> custom = factory.utcnow() + >>> custom + >>> + + >>> custom.days_till_xmas() + >>> 211 + +Supported Tokens +~~~~~~~~~~~~~~~~ + +Use the following tokens for parsing and formatting. Note that they are **not** the same as the tokens for `strptime `_: + ++--------------------------------+--------------+-------------------------------------------+ +| |Token |Output | ++================================+==============+===========================================+ +|**Year** |YYYY |2000, 2001, 2002 ... 2012, 2013 | ++--------------------------------+--------------+-------------------------------------------+ +| |YY |00, 01, 02 ... 12, 13 | ++--------------------------------+--------------+-------------------------------------------+ +|**Month** |MMMM |January, February, March ... [#t1]_ | ++--------------------------------+--------------+-------------------------------------------+ +| |MMM |Jan, Feb, Mar ... [#t1]_ | ++--------------------------------+--------------+-------------------------------------------+ +| |MM |01, 02, 03 ... 11, 12 | ++--------------------------------+--------------+-------------------------------------------+ +| |M |1, 2, 3 ... 11, 12 | ++--------------------------------+--------------+-------------------------------------------+ +|**Day of Year** |DDDD |001, 002, 003 ... 364, 365 | ++--------------------------------+--------------+-------------------------------------------+ +| |DDD |1, 2, 3 ... 364, 365 | ++--------------------------------+--------------+-------------------------------------------+ +|**Day of Month** |DD |01, 02, 03 ... 30, 31 | ++--------------------------------+--------------+-------------------------------------------+ +| |D |1, 2, 3 ... 30, 31 | ++--------------------------------+--------------+-------------------------------------------+ +| |Do |1st, 2nd, 3rd ... 30th, 31st | ++--------------------------------+--------------+-------------------------------------------+ +|**Day of Week** |dddd |Monday, Tuesday, Wednesday ... [#t2]_ | ++--------------------------------+--------------+-------------------------------------------+ +| |ddd |Mon, Tue, Wed ... [#t2]_ | ++--------------------------------+--------------+-------------------------------------------+ +| |d |1, 2, 3 ... 6, 7 | ++--------------------------------+--------------+-------------------------------------------+ +|**ISO week date** |W |2011-W05-4, 2019-W17 | ++--------------------------------+--------------+-------------------------------------------+ +|**Hour** |HH |00, 01, 02 ... 23, 24 | ++--------------------------------+--------------+-------------------------------------------+ +| |H |0, 1, 2 ... 23, 24 | ++--------------------------------+--------------+-------------------------------------------+ +| |hh |01, 02, 03 ... 11, 12 | ++--------------------------------+--------------+-------------------------------------------+ +| |h |1, 2, 3 ... 11, 12 | ++--------------------------------+--------------+-------------------------------------------+ +|**AM / PM** |A |AM, PM, am, pm [#t1]_ | ++--------------------------------+--------------+-------------------------------------------+ +| |a |am, pm [#t1]_ | ++--------------------------------+--------------+-------------------------------------------+ +|**Minute** |mm |00, 01, 02 ... 58, 59 | ++--------------------------------+--------------+-------------------------------------------+ +| |m |0, 1, 2 ... 58, 59 | ++--------------------------------+--------------+-------------------------------------------+ +|**Second** |ss |00, 01, 02 ... 58, 59 | ++--------------------------------+--------------+-------------------------------------------+ +| |s |0, 1, 2 ... 58, 59 | ++--------------------------------+--------------+-------------------------------------------+ +|**Sub-second** |S... |0, 02, 003, 000006, 123123123123... [#t3]_ | ++--------------------------------+--------------+-------------------------------------------+ +|**Timezone** |ZZZ |Asia/Baku, Europe/Warsaw, GMT ... [#t4]_ | ++--------------------------------+--------------+-------------------------------------------+ +| |ZZ |-07:00, -06:00 ... +06:00, +07:00, +08, Z | ++--------------------------------+--------------+-------------------------------------------+ +| |Z |-0700, -0600 ... +0600, +0700, +08, Z | ++--------------------------------+--------------+-------------------------------------------+ +|**Seconds Timestamp** |X |1381685817, 1381685817.915482 ... [#t5]_ | ++--------------------------------+--------------+-------------------------------------------+ +|**ms or µs Timestamp** |x |1569980330813, 1569980330813221 | ++--------------------------------+--------------+-------------------------------------------+ + +.. rubric:: Footnotes + +.. [#t1] localization support for parsing and formatting +.. [#t2] localization support only for formatting +.. [#t3] the result is truncated to microseconds, with `half-to-even rounding `_. +.. [#t4] timezone names from `tz database `_ provided via dateutil package, note that abbreviations such as MST, PDT, BRST are unlikely to parse due to ambiguity. Use the full IANA zone name instead (Asia/Shanghai, Europe/London, America/Chicago etc). +.. [#t5] this token cannot be used for parsing timestamps out of natural language strings due to compatibility reasons + +Built-in Formats +++++++++++++++++ + +There are several formatting standards that are provided as built-in tokens. + +.. code-block:: python + + >>> arw = arrow.utcnow() + >>> arw.format(arrow.FORMAT_ATOM) + '2020-05-27 10:30:35+00:00' + >>> arw.format(arrow.FORMAT_COOKIE) + 'Wednesday, 27-May-2020 10:30:35 UTC' + >>> arw.format(arrow.FORMAT_RSS) + 'Wed, 27 May 2020 10:30:35 +0000' + >>> arw.format(arrow.FORMAT_RFC822) + 'Wed, 27 May 20 10:30:35 +0000' + >>> arw.format(arrow.FORMAT_RFC850) + 'Wednesday, 27-May-20 10:30:35 UTC' + >>> arw.format(arrow.FORMAT_RFC1036) + 'Wed, 27 May 20 10:30:35 +0000' + >>> arw.format(arrow.FORMAT_RFC1123) + 'Wed, 27 May 2020 10:30:35 +0000' + >>> arw.format(arrow.FORMAT_RFC2822) + 'Wed, 27 May 2020 10:30:35 +0000' + >>> arw.format(arrow.FORMAT_RFC3339) + '2020-05-27 10:30:35+00:00' + >>> arw.format(arrow.FORMAT_W3C) + '2020-05-27 10:30:35+00:00' + +Escaping Formats +~~~~~~~~~~~~~~~~ + +Tokens, phrases, and regular expressions in a format string can be escaped when parsing and formatting by enclosing them within square brackets. + +Tokens & Phrases +++++++++++++++++ + +Any `token `_ or phrase can be escaped as follows: + +.. code-block:: python + + >>> fmt = "YYYY-MM-DD h [h] m" + >>> arw = arrow.get("2018-03-09 8 h 40", fmt) + + >>> arw.format(fmt) + '2018-03-09 8 h 40' + + >>> fmt = "YYYY-MM-DD h [hello] m" + >>> arw = arrow.get("2018-03-09 8 hello 40", fmt) + + >>> arw.format(fmt) + '2018-03-09 8 hello 40' + + >>> fmt = "YYYY-MM-DD h [hello world] m" + >>> arw = arrow.get("2018-03-09 8 hello world 40", fmt) + + >>> arw.format(fmt) + '2018-03-09 8 hello world 40' + +This can be useful for parsing dates in different locales such as French, in which it is common to format time strings as "8 h 40" rather than "8:40". + +Regular Expressions ++++++++++++++++++++ + +You can also escape regular expressions by enclosing them within square brackets. In the following example, we are using the regular expression :code:`\s+` to match any number of whitespace characters that separate the tokens. This is useful if you do not know the number of spaces between tokens ahead of time (e.g. in log files). + +.. code-block:: python + + >>> fmt = r"ddd[\s+]MMM[\s+]DD[\s+]HH:mm:ss[\s+]YYYY" + >>> arrow.get("Mon Sep 08 16:41:45 2014", fmt) + + + >>> arrow.get("Mon \tSep 08 16:41:45 2014", fmt) + + + >>> arrow.get("Mon Sep 08 16:41:45 2014", fmt) + + +Punctuation +~~~~~~~~~~~ + +Date and time formats may be fenced on either side by one punctuation character from the following list: ``, . ; : ? ! " \` ' [ ] { } ( ) < >`` + +.. code-block:: python + + >>> arrow.get("Cool date: 2019-10-31T09:12:45.123456+04:30.", "YYYY-MM-DDTHH:mm:ss.SZZ") + + + >>> arrow.get("Tomorrow (2019-10-31) is Halloween!", "YYYY-MM-DD") + + + >>> arrow.get("Halloween is on 2019.10.31.", "YYYY.MM.DD") + + + >>> arrow.get("It's Halloween tomorrow (2019-10-31)!", "YYYY-MM-DD") + # Raises exception because there are multiple punctuation marks following the date + +Redundant Whitespace +~~~~~~~~~~~~~~~~~~~~ + +Redundant whitespace characters (spaces, tabs, and newlines) can be normalized automatically by passing in the ``normalize_whitespace`` flag to ``arrow.get``: + +.. code-block:: python + + >>> arrow.get('\t \n 2013-05-05T12:30:45.123456 \t \n', normalize_whitespace=True) + + + >>> arrow.get('2013-05-05 T \n 12:30:45\t123456', 'YYYY-MM-DD T HH:mm:ss S', normalize_whitespace=True) + + +API Guide +--------- + +arrow.arrow +~~~~~~~~~~~ + +.. automodule:: arrow.arrow + :members: + +arrow.factory +~~~~~~~~~~~~~ + +.. automodule:: arrow.factory + :members: + +arrow.api +~~~~~~~~~ + +.. automodule:: arrow.api + :members: + +arrow.locale +~~~~~~~~~~~~ + +.. automodule:: arrow.locales + :members: + :undoc-members: + +Release History +--------------- + +.. toctree:: + :maxdepth: 2 + + releases diff --git a/openpype/modules/ftrack/python2_vendor/arrow/docs/make.bat b/openpype/modules/ftrack/python2_vendor/arrow/docs/make.bat new file mode 100644 index 0000000000..922152e96a --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/openpype/modules/ftrack/python2_vendor/arrow/docs/releases.rst b/openpype/modules/ftrack/python2_vendor/arrow/docs/releases.rst new file mode 100644 index 0000000000..22e1e59c8c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/docs/releases.rst @@ -0,0 +1,3 @@ +.. _releases: + +.. include:: ../CHANGELOG.rst diff --git a/openpype/modules/ftrack/python2_vendor/arrow/requirements.txt b/openpype/modules/ftrack/python2_vendor/arrow/requirements.txt new file mode 100644 index 0000000000..df565d8384 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/requirements.txt @@ -0,0 +1,14 @@ +backports.functools_lru_cache==1.6.1; python_version == "2.7" +dateparser==0.7.* +pre-commit==1.21.*; python_version <= "3.5" +pre-commit==2.6.*; python_version >= "3.6" +pytest==4.6.*; python_version == "2.7" +pytest==6.0.*; python_version >= "3.5" +pytest-cov==2.10.* +pytest-mock==2.0.*; python_version == "2.7" +pytest-mock==3.2.*; python_version >= "3.5" +python-dateutil==2.8.* +pytz==2019.* +simplejson==3.17.* +sphinx==1.8.*; python_version == "2.7" +sphinx==3.2.*; python_version >= "3.5" diff --git a/openpype/modules/ftrack/python2_vendor/arrow/setup.cfg b/openpype/modules/ftrack/python2_vendor/arrow/setup.cfg new file mode 100644 index 0000000000..2a9acf13da --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/setup.cfg @@ -0,0 +1,2 @@ +[bdist_wheel] +universal = 1 diff --git a/openpype/modules/ftrack/python2_vendor/arrow/setup.py b/openpype/modules/ftrack/python2_vendor/arrow/setup.py new file mode 100644 index 0000000000..dc4f0e77d5 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/setup.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +import io + +from setuptools import setup + +with io.open("README.rst", "r", encoding="utf-8") as f: + readme = f.read() + +about = {} +with io.open("arrow/_version.py", "r", encoding="utf-8") as f: + exec(f.read(), about) + +setup( + name="arrow", + version=about["__version__"], + description="Better dates & times for Python", + long_description=readme, + long_description_content_type="text/x-rst", + url="https://arrow.readthedocs.io", + author="Chris Smith", + author_email="crsmithdev@gmail.com", + license="Apache 2.0", + packages=["arrow"], + zip_safe=False, + python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", + install_requires=[ + "python-dateutil>=2.7.0", + "backports.functools_lru_cache>=1.2.1;python_version=='2.7'", + ], + classifiers=[ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Topic :: Software Development :: Libraries :: Python Modules", + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 2.7", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.5", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + ], + keywords="arrow date time datetime timestamp timezone humanize", + project_urls={ + "Repository": "https://github.com/arrow-py/arrow", + "Bug Reports": "https://github.com/arrow-py/arrow/issues", + "Documentation": "https://arrow.readthedocs.io", + }, +) diff --git a/openpype/modules/default_modules/sync_server/providers/__init__.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/__init__.py similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/__init__.py rename to openpype/modules/ftrack/python2_vendor/arrow/tests/__init__.py diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/conftest.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/conftest.py new file mode 100644 index 0000000000..5bc8a4af2e --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/conftest.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +from datetime import datetime + +import pytest +from dateutil import tz as dateutil_tz + +from arrow import arrow, factory, formatter, locales, parser + + +@pytest.fixture(scope="class") +def time_utcnow(request): + request.cls.arrow = arrow.Arrow.utcnow() + + +@pytest.fixture(scope="class") +def time_2013_01_01(request): + request.cls.now = arrow.Arrow.utcnow() + request.cls.arrow = arrow.Arrow(2013, 1, 1) + request.cls.datetime = datetime(2013, 1, 1) + + +@pytest.fixture(scope="class") +def time_2013_02_03(request): + request.cls.arrow = arrow.Arrow(2013, 2, 3, 12, 30, 45, 1) + + +@pytest.fixture(scope="class") +def time_2013_02_15(request): + request.cls.datetime = datetime(2013, 2, 15, 3, 41, 22, 8923) + request.cls.arrow = arrow.Arrow.fromdatetime(request.cls.datetime) + + +@pytest.fixture(scope="class") +def time_1975_12_25(request): + request.cls.datetime = datetime( + 1975, 12, 25, 14, 15, 16, tzinfo=dateutil_tz.gettz("America/New_York") + ) + request.cls.arrow = arrow.Arrow.fromdatetime(request.cls.datetime) + + +@pytest.fixture(scope="class") +def arrow_formatter(request): + request.cls.formatter = formatter.DateTimeFormatter() + + +@pytest.fixture(scope="class") +def arrow_factory(request): + request.cls.factory = factory.ArrowFactory() + + +@pytest.fixture(scope="class") +def lang_locales(request): + request.cls.locales = locales._locales + + +@pytest.fixture(scope="class") +def lang_locale(request): + # As locale test classes are prefixed with Test, we are dynamically getting the locale by the test class name. + # TestEnglishLocale -> EnglishLocale + name = request.cls.__name__[4:] + request.cls.locale = locales.get_locale_by_class_name(name) + + +@pytest.fixture(scope="class") +def dt_parser(request): + request.cls.parser = parser.DateTimeParser() + + +@pytest.fixture(scope="class") +def dt_parser_regex(request): + request.cls.format_regex = parser.DateTimeParser._FORMAT_RE + + +@pytest.fixture(scope="class") +def tzinfo_parser(request): + request.cls.parser = parser.TzinfoParser() diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/test_api.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_api.py new file mode 100644 index 0000000000..9b19a27cd9 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_api.py @@ -0,0 +1,28 @@ +# -*- coding: utf-8 -*- +import arrow + + +class TestModule: + def test_get(self, mocker): + mocker.patch("arrow.api._factory.get", return_value="result") + + assert arrow.api.get() == "result" + + def test_utcnow(self, mocker): + mocker.patch("arrow.api._factory.utcnow", return_value="utcnow") + + assert arrow.api.utcnow() == "utcnow" + + def test_now(self, mocker): + mocker.patch("arrow.api._factory.now", tz="tz", return_value="now") + + assert arrow.api.now("tz") == "now" + + def test_factory(self): + class MockCustomArrowClass(arrow.Arrow): + pass + + result = arrow.api.factory(MockCustomArrowClass) + + assert isinstance(result, arrow.factory.ArrowFactory) + assert isinstance(result.utcnow(), MockCustomArrowClass) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/test_arrow.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_arrow.py new file mode 100644 index 0000000000..b0bd20a5e3 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_arrow.py @@ -0,0 +1,2150 @@ +# -*- coding: utf-8 -*- +from __future__ import absolute_import, unicode_literals + +import calendar +import pickle +import sys +import time +from datetime import date, datetime, timedelta + +import dateutil +import pytest +import pytz +import simplejson as json +from dateutil import tz +from dateutil.relativedelta import FR, MO, SA, SU, TH, TU, WE + +from arrow import arrow + +from .utils import assert_datetime_equality + + +class TestTestArrowInit: + def test_init_bad_input(self): + + with pytest.raises(TypeError): + arrow.Arrow(2013) + + with pytest.raises(TypeError): + arrow.Arrow(2013, 2) + + with pytest.raises(ValueError): + arrow.Arrow(2013, 2, 2, 12, 30, 45, 9999999) + + def test_init(self): + + result = arrow.Arrow(2013, 2, 2) + self.expected = datetime(2013, 2, 2, tzinfo=tz.tzutc()) + assert result._datetime == self.expected + + result = arrow.Arrow(2013, 2, 2, 12) + self.expected = datetime(2013, 2, 2, 12, tzinfo=tz.tzutc()) + assert result._datetime == self.expected + + result = arrow.Arrow(2013, 2, 2, 12, 30) + self.expected = datetime(2013, 2, 2, 12, 30, tzinfo=tz.tzutc()) + assert result._datetime == self.expected + + result = arrow.Arrow(2013, 2, 2, 12, 30, 45) + self.expected = datetime(2013, 2, 2, 12, 30, 45, tzinfo=tz.tzutc()) + assert result._datetime == self.expected + + result = arrow.Arrow(2013, 2, 2, 12, 30, 45, 999999) + self.expected = datetime(2013, 2, 2, 12, 30, 45, 999999, tzinfo=tz.tzutc()) + assert result._datetime == self.expected + + result = arrow.Arrow( + 2013, 2, 2, 12, 30, 45, 999999, tzinfo=tz.gettz("Europe/Paris") + ) + self.expected = datetime( + 2013, 2, 2, 12, 30, 45, 999999, tzinfo=tz.gettz("Europe/Paris") + ) + assert result._datetime == self.expected + + # regression tests for issue #626 + def test_init_pytz_timezone(self): + + result = arrow.Arrow( + 2013, 2, 2, 12, 30, 45, 999999, tzinfo=pytz.timezone("Europe/Paris") + ) + self.expected = datetime( + 2013, 2, 2, 12, 30, 45, 999999, tzinfo=tz.gettz("Europe/Paris") + ) + assert result._datetime == self.expected + assert_datetime_equality(result._datetime, self.expected, 1) + + def test_init_with_fold(self): + before = arrow.Arrow(2017, 10, 29, 2, 0, tzinfo="Europe/Stockholm") + after = arrow.Arrow(2017, 10, 29, 2, 0, tzinfo="Europe/Stockholm", fold=1) + + assert hasattr(before, "fold") + assert hasattr(after, "fold") + + # PEP-495 requires the comparisons below to be true + assert before == after + assert before.utcoffset() != after.utcoffset() + + +class TestTestArrowFactory: + def test_now(self): + + result = arrow.Arrow.now() + + assert_datetime_equality( + result._datetime, datetime.now().replace(tzinfo=tz.tzlocal()) + ) + + def test_utcnow(self): + + result = arrow.Arrow.utcnow() + + assert_datetime_equality( + result._datetime, datetime.utcnow().replace(tzinfo=tz.tzutc()) + ) + + assert result.fold == 0 + + def test_fromtimestamp(self): + + timestamp = time.time() + + result = arrow.Arrow.fromtimestamp(timestamp) + assert_datetime_equality( + result._datetime, datetime.now().replace(tzinfo=tz.tzlocal()) + ) + + result = arrow.Arrow.fromtimestamp(timestamp, tzinfo=tz.gettz("Europe/Paris")) + assert_datetime_equality( + result._datetime, + datetime.fromtimestamp(timestamp, tz.gettz("Europe/Paris")), + ) + + result = arrow.Arrow.fromtimestamp(timestamp, tzinfo="Europe/Paris") + assert_datetime_equality( + result._datetime, + datetime.fromtimestamp(timestamp, tz.gettz("Europe/Paris")), + ) + + with pytest.raises(ValueError): + arrow.Arrow.fromtimestamp("invalid timestamp") + + def test_utcfromtimestamp(self): + + timestamp = time.time() + + result = arrow.Arrow.utcfromtimestamp(timestamp) + assert_datetime_equality( + result._datetime, datetime.utcnow().replace(tzinfo=tz.tzutc()) + ) + + with pytest.raises(ValueError): + arrow.Arrow.utcfromtimestamp("invalid timestamp") + + def test_fromdatetime(self): + + dt = datetime(2013, 2, 3, 12, 30, 45, 1) + + result = arrow.Arrow.fromdatetime(dt) + + assert result._datetime == dt.replace(tzinfo=tz.tzutc()) + + def test_fromdatetime_dt_tzinfo(self): + + dt = datetime(2013, 2, 3, 12, 30, 45, 1, tzinfo=tz.gettz("US/Pacific")) + + result = arrow.Arrow.fromdatetime(dt) + + assert result._datetime == dt.replace(tzinfo=tz.gettz("US/Pacific")) + + def test_fromdatetime_tzinfo_arg(self): + + dt = datetime(2013, 2, 3, 12, 30, 45, 1) + + result = arrow.Arrow.fromdatetime(dt, tz.gettz("US/Pacific")) + + assert result._datetime == dt.replace(tzinfo=tz.gettz("US/Pacific")) + + def test_fromdate(self): + + dt = date(2013, 2, 3) + + result = arrow.Arrow.fromdate(dt, tz.gettz("US/Pacific")) + + assert result._datetime == datetime(2013, 2, 3, tzinfo=tz.gettz("US/Pacific")) + + def test_strptime(self): + + formatted = datetime(2013, 2, 3, 12, 30, 45).strftime("%Y-%m-%d %H:%M:%S") + + result = arrow.Arrow.strptime(formatted, "%Y-%m-%d %H:%M:%S") + assert result._datetime == datetime(2013, 2, 3, 12, 30, 45, tzinfo=tz.tzutc()) + + result = arrow.Arrow.strptime( + formatted, "%Y-%m-%d %H:%M:%S", tzinfo=tz.gettz("Europe/Paris") + ) + assert result._datetime == datetime( + 2013, 2, 3, 12, 30, 45, tzinfo=tz.gettz("Europe/Paris") + ) + + +@pytest.mark.usefixtures("time_2013_02_03") +class TestTestArrowRepresentation: + def test_repr(self): + + result = self.arrow.__repr__() + + assert result == "".format(self.arrow._datetime.isoformat()) + + def test_str(self): + + result = self.arrow.__str__() + + assert result == self.arrow._datetime.isoformat() + + def test_hash(self): + + result = self.arrow.__hash__() + + assert result == self.arrow._datetime.__hash__() + + def test_format(self): + + result = "{:YYYY-MM-DD}".format(self.arrow) + + assert result == "2013-02-03" + + def test_bare_format(self): + + result = self.arrow.format() + + assert result == "2013-02-03 12:30:45+00:00" + + def test_format_no_format_string(self): + + result = "{}".format(self.arrow) + + assert result == str(self.arrow) + + def test_clone(self): + + result = self.arrow.clone() + + assert result is not self.arrow + assert result._datetime == self.arrow._datetime + + +@pytest.mark.usefixtures("time_2013_01_01") +class TestArrowAttribute: + def test_getattr_base(self): + + with pytest.raises(AttributeError): + self.arrow.prop + + def test_getattr_week(self): + + assert self.arrow.week == 1 + + def test_getattr_quarter(self): + # start dates + q1 = arrow.Arrow(2013, 1, 1) + q2 = arrow.Arrow(2013, 4, 1) + q3 = arrow.Arrow(2013, 8, 1) + q4 = arrow.Arrow(2013, 10, 1) + assert q1.quarter == 1 + assert q2.quarter == 2 + assert q3.quarter == 3 + assert q4.quarter == 4 + + # end dates + q1 = arrow.Arrow(2013, 3, 31) + q2 = arrow.Arrow(2013, 6, 30) + q3 = arrow.Arrow(2013, 9, 30) + q4 = arrow.Arrow(2013, 12, 31) + assert q1.quarter == 1 + assert q2.quarter == 2 + assert q3.quarter == 3 + assert q4.quarter == 4 + + def test_getattr_dt_value(self): + + assert self.arrow.year == 2013 + + def test_tzinfo(self): + + self.arrow.tzinfo = tz.gettz("PST") + assert self.arrow.tzinfo == tz.gettz("PST") + + def test_naive(self): + + assert self.arrow.naive == self.arrow._datetime.replace(tzinfo=None) + + def test_timestamp(self): + + assert self.arrow.timestamp == calendar.timegm( + self.arrow._datetime.utctimetuple() + ) + + with pytest.warns(DeprecationWarning): + self.arrow.timestamp + + def test_int_timestamp(self): + + assert self.arrow.int_timestamp == calendar.timegm( + self.arrow._datetime.utctimetuple() + ) + + def test_float_timestamp(self): + + result = self.arrow.float_timestamp - self.arrow.timestamp + + assert result == self.arrow.microsecond + + def test_getattr_fold(self): + + # UTC is always unambiguous + assert self.now.fold == 0 + + ambiguous_dt = arrow.Arrow( + 2017, 10, 29, 2, 0, tzinfo="Europe/Stockholm", fold=1 + ) + assert ambiguous_dt.fold == 1 + + with pytest.raises(AttributeError): + ambiguous_dt.fold = 0 + + def test_getattr_ambiguous(self): + + assert not self.now.ambiguous + + ambiguous_dt = arrow.Arrow(2017, 10, 29, 2, 0, tzinfo="Europe/Stockholm") + + assert ambiguous_dt.ambiguous + + def test_getattr_imaginary(self): + + assert not self.now.imaginary + + imaginary_dt = arrow.Arrow(2013, 3, 31, 2, 30, tzinfo="Europe/Paris") + + assert imaginary_dt.imaginary + + +@pytest.mark.usefixtures("time_utcnow") +class TestArrowComparison: + def test_eq(self): + + assert self.arrow == self.arrow + assert self.arrow == self.arrow.datetime + assert not (self.arrow == "abc") + + def test_ne(self): + + assert not (self.arrow != self.arrow) + assert not (self.arrow != self.arrow.datetime) + assert self.arrow != "abc" + + def test_gt(self): + + arrow_cmp = self.arrow.shift(minutes=1) + + assert not (self.arrow > self.arrow) + assert not (self.arrow > self.arrow.datetime) + + with pytest.raises(TypeError): + self.arrow > "abc" + + assert self.arrow < arrow_cmp + assert self.arrow < arrow_cmp.datetime + + def test_ge(self): + + with pytest.raises(TypeError): + self.arrow >= "abc" + + assert self.arrow >= self.arrow + assert self.arrow >= self.arrow.datetime + + def test_lt(self): + + arrow_cmp = self.arrow.shift(minutes=1) + + assert not (self.arrow < self.arrow) + assert not (self.arrow < self.arrow.datetime) + + with pytest.raises(TypeError): + self.arrow < "abc" + + assert self.arrow < arrow_cmp + assert self.arrow < arrow_cmp.datetime + + def test_le(self): + + with pytest.raises(TypeError): + self.arrow <= "abc" + + assert self.arrow <= self.arrow + assert self.arrow <= self.arrow.datetime + + +@pytest.mark.usefixtures("time_2013_01_01") +class TestArrowMath: + def test_add_timedelta(self): + + result = self.arrow.__add__(timedelta(days=1)) + + assert result._datetime == datetime(2013, 1, 2, tzinfo=tz.tzutc()) + + def test_add_other(self): + + with pytest.raises(TypeError): + self.arrow + 1 + + def test_radd(self): + + result = self.arrow.__radd__(timedelta(days=1)) + + assert result._datetime == datetime(2013, 1, 2, tzinfo=tz.tzutc()) + + def test_sub_timedelta(self): + + result = self.arrow.__sub__(timedelta(days=1)) + + assert result._datetime == datetime(2012, 12, 31, tzinfo=tz.tzutc()) + + def test_sub_datetime(self): + + result = self.arrow.__sub__(datetime(2012, 12, 21, tzinfo=tz.tzutc())) + + assert result == timedelta(days=11) + + def test_sub_arrow(self): + + result = self.arrow.__sub__(arrow.Arrow(2012, 12, 21, tzinfo=tz.tzutc())) + + assert result == timedelta(days=11) + + def test_sub_other(self): + + with pytest.raises(TypeError): + self.arrow - object() + + def test_rsub_datetime(self): + + result = self.arrow.__rsub__(datetime(2012, 12, 21, tzinfo=tz.tzutc())) + + assert result == timedelta(days=-11) + + def test_rsub_other(self): + + with pytest.raises(TypeError): + timedelta(days=1) - self.arrow + + +@pytest.mark.usefixtures("time_utcnow") +class TestArrowDatetimeInterface: + def test_date(self): + + result = self.arrow.date() + + assert result == self.arrow._datetime.date() + + def test_time(self): + + result = self.arrow.time() + + assert result == self.arrow._datetime.time() + + def test_timetz(self): + + result = self.arrow.timetz() + + assert result == self.arrow._datetime.timetz() + + def test_astimezone(self): + + other_tz = tz.gettz("US/Pacific") + + result = self.arrow.astimezone(other_tz) + + assert result == self.arrow._datetime.astimezone(other_tz) + + def test_utcoffset(self): + + result = self.arrow.utcoffset() + + assert result == self.arrow._datetime.utcoffset() + + def test_dst(self): + + result = self.arrow.dst() + + assert result == self.arrow._datetime.dst() + + def test_timetuple(self): + + result = self.arrow.timetuple() + + assert result == self.arrow._datetime.timetuple() + + def test_utctimetuple(self): + + result = self.arrow.utctimetuple() + + assert result == self.arrow._datetime.utctimetuple() + + def test_toordinal(self): + + result = self.arrow.toordinal() + + assert result == self.arrow._datetime.toordinal() + + def test_weekday(self): + + result = self.arrow.weekday() + + assert result == self.arrow._datetime.weekday() + + def test_isoweekday(self): + + result = self.arrow.isoweekday() + + assert result == self.arrow._datetime.isoweekday() + + def test_isocalendar(self): + + result = self.arrow.isocalendar() + + assert result == self.arrow._datetime.isocalendar() + + def test_isoformat(self): + + result = self.arrow.isoformat() + + assert result == self.arrow._datetime.isoformat() + + def test_simplejson(self): + + result = json.dumps({"v": self.arrow.for_json()}, for_json=True) + + assert json.loads(result)["v"] == self.arrow._datetime.isoformat() + + def test_ctime(self): + + result = self.arrow.ctime() + + assert result == self.arrow._datetime.ctime() + + def test_strftime(self): + + result = self.arrow.strftime("%Y") + + assert result == self.arrow._datetime.strftime("%Y") + + +class TestArrowFalsePositiveDst: + """These tests relate to issues #376 and #551. + The key points in both issues are that arrow will assign a UTC timezone if none is provided and + .to() will change other attributes to be correct whereas .replace() only changes the specified attribute. + + Issue 376 + >>> arrow.get('2016-11-06').to('America/New_York').ceil('day') + < Arrow [2016-11-05T23:59:59.999999-04:00] > + + Issue 551 + >>> just_before = arrow.get('2018-11-04T01:59:59.999999') + >>> just_before + 2018-11-04T01:59:59.999999+00:00 + >>> just_after = just_before.shift(microseconds=1) + >>> just_after + 2018-11-04T02:00:00+00:00 + >>> just_before_eastern = just_before.replace(tzinfo='US/Eastern') + >>> just_before_eastern + 2018-11-04T01:59:59.999999-04:00 + >>> just_after_eastern = just_after.replace(tzinfo='US/Eastern') + >>> just_after_eastern + 2018-11-04T02:00:00-05:00 + """ + + def test_dst(self): + self.before_1 = arrow.Arrow( + 2016, 11, 6, 3, 59, tzinfo=tz.gettz("America/New_York") + ) + self.before_2 = arrow.Arrow(2016, 11, 6, tzinfo=tz.gettz("America/New_York")) + self.after_1 = arrow.Arrow(2016, 11, 6, 4, tzinfo=tz.gettz("America/New_York")) + self.after_2 = arrow.Arrow( + 2016, 11, 6, 23, 59, tzinfo=tz.gettz("America/New_York") + ) + self.before_3 = arrow.Arrow( + 2018, 11, 4, 3, 59, tzinfo=tz.gettz("America/New_York") + ) + self.before_4 = arrow.Arrow(2018, 11, 4, tzinfo=tz.gettz("America/New_York")) + self.after_3 = arrow.Arrow(2018, 11, 4, 4, tzinfo=tz.gettz("America/New_York")) + self.after_4 = arrow.Arrow( + 2018, 11, 4, 23, 59, tzinfo=tz.gettz("America/New_York") + ) + assert self.before_1.day == self.before_2.day + assert self.after_1.day == self.after_2.day + assert self.before_3.day == self.before_4.day + assert self.after_3.day == self.after_4.day + + +class TestArrowConversion: + def test_to(self): + + dt_from = datetime.now() + arrow_from = arrow.Arrow.fromdatetime(dt_from, tz.gettz("US/Pacific")) + + self.expected = dt_from.replace(tzinfo=tz.gettz("US/Pacific")).astimezone( + tz.tzutc() + ) + + assert arrow_from.to("UTC").datetime == self.expected + assert arrow_from.to(tz.tzutc()).datetime == self.expected + + # issue #368 + def test_to_pacific_then_utc(self): + result = arrow.Arrow(2018, 11, 4, 1, tzinfo="-08:00").to("US/Pacific").to("UTC") + assert result == arrow.Arrow(2018, 11, 4, 9) + + # issue #368 + def test_to_amsterdam_then_utc(self): + result = arrow.Arrow(2016, 10, 30).to("Europe/Amsterdam") + assert result.utcoffset() == timedelta(seconds=7200) + + # regression test for #690 + def test_to_israel_same_offset(self): + + result = arrow.Arrow(2019, 10, 27, 2, 21, 1, tzinfo="+03:00").to("Israel") + expected = arrow.Arrow(2019, 10, 27, 1, 21, 1, tzinfo="Israel") + + assert result == expected + assert result.utcoffset() != expected.utcoffset() + + # issue 315 + def test_anchorage_dst(self): + before = arrow.Arrow(2016, 3, 13, 1, 59, tzinfo="America/Anchorage") + after = arrow.Arrow(2016, 3, 13, 2, 1, tzinfo="America/Anchorage") + + assert before.utcoffset() != after.utcoffset() + + # issue 476 + def test_chicago_fall(self): + + result = arrow.Arrow(2017, 11, 5, 2, 1, tzinfo="-05:00").to("America/Chicago") + expected = arrow.Arrow(2017, 11, 5, 1, 1, tzinfo="America/Chicago") + + assert result == expected + assert result.utcoffset() != expected.utcoffset() + + def test_toronto_gap(self): + + before = arrow.Arrow(2011, 3, 13, 6, 30, tzinfo="UTC").to("America/Toronto") + after = arrow.Arrow(2011, 3, 13, 7, 30, tzinfo="UTC").to("America/Toronto") + + assert before.datetime.replace(tzinfo=None) == datetime(2011, 3, 13, 1, 30) + assert after.datetime.replace(tzinfo=None) == datetime(2011, 3, 13, 3, 30) + + assert before.utcoffset() != after.utcoffset() + + def test_sydney_gap(self): + + before = arrow.Arrow(2012, 10, 6, 15, 30, tzinfo="UTC").to("Australia/Sydney") + after = arrow.Arrow(2012, 10, 6, 16, 30, tzinfo="UTC").to("Australia/Sydney") + + assert before.datetime.replace(tzinfo=None) == datetime(2012, 10, 7, 1, 30) + assert after.datetime.replace(tzinfo=None) == datetime(2012, 10, 7, 3, 30) + + assert before.utcoffset() != after.utcoffset() + + +class TestArrowPickling: + def test_pickle_and_unpickle(self): + + dt = arrow.Arrow.utcnow() + + pickled = pickle.dumps(dt) + + unpickled = pickle.loads(pickled) + + assert unpickled == dt + + +class TestArrowReplace: + def test_not_attr(self): + + with pytest.raises(AttributeError): + arrow.Arrow.utcnow().replace(abc=1) + + def test_replace(self): + + arw = arrow.Arrow(2013, 5, 5, 12, 30, 45) + + assert arw.replace(year=2012) == arrow.Arrow(2012, 5, 5, 12, 30, 45) + assert arw.replace(month=1) == arrow.Arrow(2013, 1, 5, 12, 30, 45) + assert arw.replace(day=1) == arrow.Arrow(2013, 5, 1, 12, 30, 45) + assert arw.replace(hour=1) == arrow.Arrow(2013, 5, 5, 1, 30, 45) + assert arw.replace(minute=1) == arrow.Arrow(2013, 5, 5, 12, 1, 45) + assert arw.replace(second=1) == arrow.Arrow(2013, 5, 5, 12, 30, 1) + + def test_replace_tzinfo(self): + + arw = arrow.Arrow.utcnow().to("US/Eastern") + + result = arw.replace(tzinfo=tz.gettz("US/Pacific")) + + assert result == arw.datetime.replace(tzinfo=tz.gettz("US/Pacific")) + + def test_replace_fold(self): + + before = arrow.Arrow(2017, 11, 5, 1, tzinfo="America/New_York") + after = before.replace(fold=1) + + assert before.fold == 0 + assert after.fold == 1 + assert before == after + assert before.utcoffset() != after.utcoffset() + + def test_replace_fold_and_other(self): + + arw = arrow.Arrow(2013, 5, 5, 12, 30, 45) + + assert arw.replace(fold=1, minute=50) == arrow.Arrow(2013, 5, 5, 12, 50, 45) + assert arw.replace(minute=50, fold=1) == arrow.Arrow(2013, 5, 5, 12, 50, 45) + + def test_replace_week(self): + + with pytest.raises(AttributeError): + arrow.Arrow.utcnow().replace(week=1) + + def test_replace_quarter(self): + + with pytest.raises(AttributeError): + arrow.Arrow.utcnow().replace(quarter=1) + + def test_replace_quarter_and_fold(self): + with pytest.raises(AttributeError): + arrow.utcnow().replace(fold=1, quarter=1) + + with pytest.raises(AttributeError): + arrow.utcnow().replace(quarter=1, fold=1) + + def test_replace_other_kwargs(self): + + with pytest.raises(AttributeError): + arrow.utcnow().replace(abc="def") + + +class TestArrowShift: + def test_not_attr(self): + + now = arrow.Arrow.utcnow() + + with pytest.raises(AttributeError): + now.shift(abc=1) + + with pytest.raises(AttributeError): + now.shift(week=1) + + def test_shift(self): + + arw = arrow.Arrow(2013, 5, 5, 12, 30, 45) + + assert arw.shift(years=1) == arrow.Arrow(2014, 5, 5, 12, 30, 45) + assert arw.shift(quarters=1) == arrow.Arrow(2013, 8, 5, 12, 30, 45) + assert arw.shift(quarters=1, months=1) == arrow.Arrow(2013, 9, 5, 12, 30, 45) + assert arw.shift(months=1) == arrow.Arrow(2013, 6, 5, 12, 30, 45) + assert arw.shift(weeks=1) == arrow.Arrow(2013, 5, 12, 12, 30, 45) + assert arw.shift(days=1) == arrow.Arrow(2013, 5, 6, 12, 30, 45) + assert arw.shift(hours=1) == arrow.Arrow(2013, 5, 5, 13, 30, 45) + assert arw.shift(minutes=1) == arrow.Arrow(2013, 5, 5, 12, 31, 45) + assert arw.shift(seconds=1) == arrow.Arrow(2013, 5, 5, 12, 30, 46) + assert arw.shift(microseconds=1) == arrow.Arrow(2013, 5, 5, 12, 30, 45, 1) + + # Remember: Python's weekday 0 is Monday + assert arw.shift(weekday=0) == arrow.Arrow(2013, 5, 6, 12, 30, 45) + assert arw.shift(weekday=1) == arrow.Arrow(2013, 5, 7, 12, 30, 45) + assert arw.shift(weekday=2) == arrow.Arrow(2013, 5, 8, 12, 30, 45) + assert arw.shift(weekday=3) == arrow.Arrow(2013, 5, 9, 12, 30, 45) + assert arw.shift(weekday=4) == arrow.Arrow(2013, 5, 10, 12, 30, 45) + assert arw.shift(weekday=5) == arrow.Arrow(2013, 5, 11, 12, 30, 45) + assert arw.shift(weekday=6) == arw + + with pytest.raises(IndexError): + arw.shift(weekday=7) + + # Use dateutil.relativedelta's convenient day instances + assert arw.shift(weekday=MO) == arrow.Arrow(2013, 5, 6, 12, 30, 45) + assert arw.shift(weekday=MO(0)) == arrow.Arrow(2013, 5, 6, 12, 30, 45) + assert arw.shift(weekday=MO(1)) == arrow.Arrow(2013, 5, 6, 12, 30, 45) + assert arw.shift(weekday=MO(2)) == arrow.Arrow(2013, 5, 13, 12, 30, 45) + assert arw.shift(weekday=TU) == arrow.Arrow(2013, 5, 7, 12, 30, 45) + assert arw.shift(weekday=TU(0)) == arrow.Arrow(2013, 5, 7, 12, 30, 45) + assert arw.shift(weekday=TU(1)) == arrow.Arrow(2013, 5, 7, 12, 30, 45) + assert arw.shift(weekday=TU(2)) == arrow.Arrow(2013, 5, 14, 12, 30, 45) + assert arw.shift(weekday=WE) == arrow.Arrow(2013, 5, 8, 12, 30, 45) + assert arw.shift(weekday=WE(0)) == arrow.Arrow(2013, 5, 8, 12, 30, 45) + assert arw.shift(weekday=WE(1)) == arrow.Arrow(2013, 5, 8, 12, 30, 45) + assert arw.shift(weekday=WE(2)) == arrow.Arrow(2013, 5, 15, 12, 30, 45) + assert arw.shift(weekday=TH) == arrow.Arrow(2013, 5, 9, 12, 30, 45) + assert arw.shift(weekday=TH(0)) == arrow.Arrow(2013, 5, 9, 12, 30, 45) + assert arw.shift(weekday=TH(1)) == arrow.Arrow(2013, 5, 9, 12, 30, 45) + assert arw.shift(weekday=TH(2)) == arrow.Arrow(2013, 5, 16, 12, 30, 45) + assert arw.shift(weekday=FR) == arrow.Arrow(2013, 5, 10, 12, 30, 45) + assert arw.shift(weekday=FR(0)) == arrow.Arrow(2013, 5, 10, 12, 30, 45) + assert arw.shift(weekday=FR(1)) == arrow.Arrow(2013, 5, 10, 12, 30, 45) + assert arw.shift(weekday=FR(2)) == arrow.Arrow(2013, 5, 17, 12, 30, 45) + assert arw.shift(weekday=SA) == arrow.Arrow(2013, 5, 11, 12, 30, 45) + assert arw.shift(weekday=SA(0)) == arrow.Arrow(2013, 5, 11, 12, 30, 45) + assert arw.shift(weekday=SA(1)) == arrow.Arrow(2013, 5, 11, 12, 30, 45) + assert arw.shift(weekday=SA(2)) == arrow.Arrow(2013, 5, 18, 12, 30, 45) + assert arw.shift(weekday=SU) == arw + assert arw.shift(weekday=SU(0)) == arw + assert arw.shift(weekday=SU(1)) == arw + assert arw.shift(weekday=SU(2)) == arrow.Arrow(2013, 5, 12, 12, 30, 45) + + def test_shift_negative(self): + + arw = arrow.Arrow(2013, 5, 5, 12, 30, 45) + + assert arw.shift(years=-1) == arrow.Arrow(2012, 5, 5, 12, 30, 45) + assert arw.shift(quarters=-1) == arrow.Arrow(2013, 2, 5, 12, 30, 45) + assert arw.shift(quarters=-1, months=-1) == arrow.Arrow(2013, 1, 5, 12, 30, 45) + assert arw.shift(months=-1) == arrow.Arrow(2013, 4, 5, 12, 30, 45) + assert arw.shift(weeks=-1) == arrow.Arrow(2013, 4, 28, 12, 30, 45) + assert arw.shift(days=-1) == arrow.Arrow(2013, 5, 4, 12, 30, 45) + assert arw.shift(hours=-1) == arrow.Arrow(2013, 5, 5, 11, 30, 45) + assert arw.shift(minutes=-1) == arrow.Arrow(2013, 5, 5, 12, 29, 45) + assert arw.shift(seconds=-1) == arrow.Arrow(2013, 5, 5, 12, 30, 44) + assert arw.shift(microseconds=-1) == arrow.Arrow(2013, 5, 5, 12, 30, 44, 999999) + + # Not sure how practical these negative weekdays are + assert arw.shift(weekday=-1) == arw.shift(weekday=SU) + assert arw.shift(weekday=-2) == arw.shift(weekday=SA) + assert arw.shift(weekday=-3) == arw.shift(weekday=FR) + assert arw.shift(weekday=-4) == arw.shift(weekday=TH) + assert arw.shift(weekday=-5) == arw.shift(weekday=WE) + assert arw.shift(weekday=-6) == arw.shift(weekday=TU) + assert arw.shift(weekday=-7) == arw.shift(weekday=MO) + + with pytest.raises(IndexError): + arw.shift(weekday=-8) + + assert arw.shift(weekday=MO(-1)) == arrow.Arrow(2013, 4, 29, 12, 30, 45) + assert arw.shift(weekday=TU(-1)) == arrow.Arrow(2013, 4, 30, 12, 30, 45) + assert arw.shift(weekday=WE(-1)) == arrow.Arrow(2013, 5, 1, 12, 30, 45) + assert arw.shift(weekday=TH(-1)) == arrow.Arrow(2013, 5, 2, 12, 30, 45) + assert arw.shift(weekday=FR(-1)) == arrow.Arrow(2013, 5, 3, 12, 30, 45) + assert arw.shift(weekday=SA(-1)) == arrow.Arrow(2013, 5, 4, 12, 30, 45) + assert arw.shift(weekday=SU(-1)) == arw + assert arw.shift(weekday=SU(-2)) == arrow.Arrow(2013, 4, 28, 12, 30, 45) + + def test_shift_quarters_bug(self): + + arw = arrow.Arrow(2013, 5, 5, 12, 30, 45) + + # The value of the last-read argument was used instead of the ``quarters`` argument. + # Recall that the keyword argument dict, like all dicts, is unordered, so only certain + # combinations of arguments would exhibit this. + assert arw.shift(quarters=0, years=1) == arrow.Arrow(2014, 5, 5, 12, 30, 45) + assert arw.shift(quarters=0, months=1) == arrow.Arrow(2013, 6, 5, 12, 30, 45) + assert arw.shift(quarters=0, weeks=1) == arrow.Arrow(2013, 5, 12, 12, 30, 45) + assert arw.shift(quarters=0, days=1) == arrow.Arrow(2013, 5, 6, 12, 30, 45) + assert arw.shift(quarters=0, hours=1) == arrow.Arrow(2013, 5, 5, 13, 30, 45) + assert arw.shift(quarters=0, minutes=1) == arrow.Arrow(2013, 5, 5, 12, 31, 45) + assert arw.shift(quarters=0, seconds=1) == arrow.Arrow(2013, 5, 5, 12, 30, 46) + assert arw.shift(quarters=0, microseconds=1) == arrow.Arrow( + 2013, 5, 5, 12, 30, 45, 1 + ) + + def test_shift_positive_imaginary(self): + + # Avoid shifting into imaginary datetimes, take into account DST and other timezone changes. + + new_york = arrow.Arrow(2017, 3, 12, 1, 30, tzinfo="America/New_York") + assert new_york.shift(hours=+1) == arrow.Arrow( + 2017, 3, 12, 3, 30, tzinfo="America/New_York" + ) + + # pendulum example + paris = arrow.Arrow(2013, 3, 31, 1, 50, tzinfo="Europe/Paris") + assert paris.shift(minutes=+20) == arrow.Arrow( + 2013, 3, 31, 3, 10, tzinfo="Europe/Paris" + ) + + canberra = arrow.Arrow(2018, 10, 7, 1, 30, tzinfo="Australia/Canberra") + assert canberra.shift(hours=+1) == arrow.Arrow( + 2018, 10, 7, 3, 30, tzinfo="Australia/Canberra" + ) + + kiev = arrow.Arrow(2018, 3, 25, 2, 30, tzinfo="Europe/Kiev") + assert kiev.shift(hours=+1) == arrow.Arrow( + 2018, 3, 25, 4, 30, tzinfo="Europe/Kiev" + ) + + # Edge case, the entire day of 2011-12-30 is imaginary in this zone! + apia = arrow.Arrow(2011, 12, 29, 23, tzinfo="Pacific/Apia") + assert apia.shift(hours=+2) == arrow.Arrow( + 2011, 12, 31, 1, tzinfo="Pacific/Apia" + ) + + def test_shift_negative_imaginary(self): + + new_york = arrow.Arrow(2011, 3, 13, 3, 30, tzinfo="America/New_York") + assert new_york.shift(hours=-1) == arrow.Arrow( + 2011, 3, 13, 3, 30, tzinfo="America/New_York" + ) + assert new_york.shift(hours=-2) == arrow.Arrow( + 2011, 3, 13, 1, 30, tzinfo="America/New_York" + ) + + london = arrow.Arrow(2019, 3, 31, 2, tzinfo="Europe/London") + assert london.shift(hours=-1) == arrow.Arrow( + 2019, 3, 31, 2, tzinfo="Europe/London" + ) + assert london.shift(hours=-2) == arrow.Arrow( + 2019, 3, 31, 0, tzinfo="Europe/London" + ) + + # edge case, crossing the international dateline + apia = arrow.Arrow(2011, 12, 31, 1, tzinfo="Pacific/Apia") + assert apia.shift(hours=-2) == arrow.Arrow( + 2011, 12, 31, 23, tzinfo="Pacific/Apia" + ) + + @pytest.mark.skipif( + dateutil.__version__ < "2.7.1", reason="old tz database (2018d needed)" + ) + def test_shift_kiritimati(self): + # corrected 2018d tz database release, will fail in earlier versions + + kiritimati = arrow.Arrow(1994, 12, 30, 12, 30, tzinfo="Pacific/Kiritimati") + assert kiritimati.shift(days=+1) == arrow.Arrow( + 1995, 1, 1, 12, 30, tzinfo="Pacific/Kiritimati" + ) + + @pytest.mark.skipif( + sys.version_info < (3, 6), reason="unsupported before python 3.6" + ) + def shift_imaginary_seconds(self): + # offset has a seconds component + monrovia = arrow.Arrow(1972, 1, 6, 23, tzinfo="Africa/Monrovia") + assert monrovia.shift(hours=+1, minutes=+30) == arrow.Arrow( + 1972, 1, 7, 1, 14, 30, tzinfo="Africa/Monrovia" + ) + + +class TestArrowRange: + def test_year(self): + + result = list( + arrow.Arrow.range( + "year", datetime(2013, 1, 2, 3, 4, 5), datetime(2016, 4, 5, 6, 7, 8) + ) + ) + + assert result == [ + arrow.Arrow(2013, 1, 2, 3, 4, 5), + arrow.Arrow(2014, 1, 2, 3, 4, 5), + arrow.Arrow(2015, 1, 2, 3, 4, 5), + arrow.Arrow(2016, 1, 2, 3, 4, 5), + ] + + def test_quarter(self): + + result = list( + arrow.Arrow.range( + "quarter", datetime(2013, 2, 3, 4, 5, 6), datetime(2013, 5, 6, 7, 8, 9) + ) + ) + + assert result == [ + arrow.Arrow(2013, 2, 3, 4, 5, 6), + arrow.Arrow(2013, 5, 3, 4, 5, 6), + ] + + def test_month(self): + + result = list( + arrow.Arrow.range( + "month", datetime(2013, 2, 3, 4, 5, 6), datetime(2013, 5, 6, 7, 8, 9) + ) + ) + + assert result == [ + arrow.Arrow(2013, 2, 3, 4, 5, 6), + arrow.Arrow(2013, 3, 3, 4, 5, 6), + arrow.Arrow(2013, 4, 3, 4, 5, 6), + arrow.Arrow(2013, 5, 3, 4, 5, 6), + ] + + def test_week(self): + + result = list( + arrow.Arrow.range( + "week", datetime(2013, 9, 1, 2, 3, 4), datetime(2013, 10, 1, 2, 3, 4) + ) + ) + + assert result == [ + arrow.Arrow(2013, 9, 1, 2, 3, 4), + arrow.Arrow(2013, 9, 8, 2, 3, 4), + arrow.Arrow(2013, 9, 15, 2, 3, 4), + arrow.Arrow(2013, 9, 22, 2, 3, 4), + arrow.Arrow(2013, 9, 29, 2, 3, 4), + ] + + def test_day(self): + + result = list( + arrow.Arrow.range( + "day", datetime(2013, 1, 2, 3, 4, 5), datetime(2013, 1, 5, 6, 7, 8) + ) + ) + + assert result == [ + arrow.Arrow(2013, 1, 2, 3, 4, 5), + arrow.Arrow(2013, 1, 3, 3, 4, 5), + arrow.Arrow(2013, 1, 4, 3, 4, 5), + arrow.Arrow(2013, 1, 5, 3, 4, 5), + ] + + def test_hour(self): + + result = list( + arrow.Arrow.range( + "hour", datetime(2013, 1, 2, 3, 4, 5), datetime(2013, 1, 2, 6, 7, 8) + ) + ) + + assert result == [ + arrow.Arrow(2013, 1, 2, 3, 4, 5), + arrow.Arrow(2013, 1, 2, 4, 4, 5), + arrow.Arrow(2013, 1, 2, 5, 4, 5), + arrow.Arrow(2013, 1, 2, 6, 4, 5), + ] + + result = list( + arrow.Arrow.range( + "hour", datetime(2013, 1, 2, 3, 4, 5), datetime(2013, 1, 2, 3, 4, 5) + ) + ) + + assert result == [arrow.Arrow(2013, 1, 2, 3, 4, 5)] + + def test_minute(self): + + result = list( + arrow.Arrow.range( + "minute", datetime(2013, 1, 2, 3, 4, 5), datetime(2013, 1, 2, 3, 7, 8) + ) + ) + + assert result == [ + arrow.Arrow(2013, 1, 2, 3, 4, 5), + arrow.Arrow(2013, 1, 2, 3, 5, 5), + arrow.Arrow(2013, 1, 2, 3, 6, 5), + arrow.Arrow(2013, 1, 2, 3, 7, 5), + ] + + def test_second(self): + + result = list( + arrow.Arrow.range( + "second", datetime(2013, 1, 2, 3, 4, 5), datetime(2013, 1, 2, 3, 4, 8) + ) + ) + + assert result == [ + arrow.Arrow(2013, 1, 2, 3, 4, 5), + arrow.Arrow(2013, 1, 2, 3, 4, 6), + arrow.Arrow(2013, 1, 2, 3, 4, 7), + arrow.Arrow(2013, 1, 2, 3, 4, 8), + ] + + def test_arrow(self): + + result = list( + arrow.Arrow.range( + "day", + arrow.Arrow(2013, 1, 2, 3, 4, 5), + arrow.Arrow(2013, 1, 5, 6, 7, 8), + ) + ) + + assert result == [ + arrow.Arrow(2013, 1, 2, 3, 4, 5), + arrow.Arrow(2013, 1, 3, 3, 4, 5), + arrow.Arrow(2013, 1, 4, 3, 4, 5), + arrow.Arrow(2013, 1, 5, 3, 4, 5), + ] + + def test_naive_tz(self): + + result = arrow.Arrow.range( + "year", datetime(2013, 1, 2, 3), datetime(2016, 4, 5, 6), "US/Pacific" + ) + + for r in result: + assert r.tzinfo == tz.gettz("US/Pacific") + + def test_aware_same_tz(self): + + result = arrow.Arrow.range( + "day", + arrow.Arrow(2013, 1, 1, tzinfo=tz.gettz("US/Pacific")), + arrow.Arrow(2013, 1, 3, tzinfo=tz.gettz("US/Pacific")), + ) + + for r in result: + assert r.tzinfo == tz.gettz("US/Pacific") + + def test_aware_different_tz(self): + + result = arrow.Arrow.range( + "day", + datetime(2013, 1, 1, tzinfo=tz.gettz("US/Eastern")), + datetime(2013, 1, 3, tzinfo=tz.gettz("US/Pacific")), + ) + + for r in result: + assert r.tzinfo == tz.gettz("US/Eastern") + + def test_aware_tz(self): + + result = arrow.Arrow.range( + "day", + datetime(2013, 1, 1, tzinfo=tz.gettz("US/Eastern")), + datetime(2013, 1, 3, tzinfo=tz.gettz("US/Pacific")), + tz=tz.gettz("US/Central"), + ) + + for r in result: + assert r.tzinfo == tz.gettz("US/Central") + + def test_imaginary(self): + # issue #72, avoid duplication in utc column + + before = arrow.Arrow(2018, 3, 10, 23, tzinfo="US/Pacific") + after = arrow.Arrow(2018, 3, 11, 4, tzinfo="US/Pacific") + + pacific_range = [t for t in arrow.Arrow.range("hour", before, after)] + utc_range = [t.to("utc") for t in arrow.Arrow.range("hour", before, after)] + + assert len(pacific_range) == len(set(pacific_range)) + assert len(utc_range) == len(set(utc_range)) + + def test_unsupported(self): + + with pytest.raises(AttributeError): + next(arrow.Arrow.range("abc", datetime.utcnow(), datetime.utcnow())) + + def test_range_over_months_ending_on_different_days(self): + # regression test for issue #842 + result = list(arrow.Arrow.range("month", datetime(2015, 1, 31), limit=4)) + assert result == [ + arrow.Arrow(2015, 1, 31), + arrow.Arrow(2015, 2, 28), + arrow.Arrow(2015, 3, 31), + arrow.Arrow(2015, 4, 30), + ] + + result = list(arrow.Arrow.range("month", datetime(2015, 1, 30), limit=3)) + assert result == [ + arrow.Arrow(2015, 1, 30), + arrow.Arrow(2015, 2, 28), + arrow.Arrow(2015, 3, 30), + ] + + result = list(arrow.Arrow.range("month", datetime(2015, 2, 28), limit=3)) + assert result == [ + arrow.Arrow(2015, 2, 28), + arrow.Arrow(2015, 3, 28), + arrow.Arrow(2015, 4, 28), + ] + + result = list(arrow.Arrow.range("month", datetime(2015, 3, 31), limit=3)) + assert result == [ + arrow.Arrow(2015, 3, 31), + arrow.Arrow(2015, 4, 30), + arrow.Arrow(2015, 5, 31), + ] + + def test_range_over_quarter_months_ending_on_different_days(self): + result = list(arrow.Arrow.range("quarter", datetime(2014, 11, 30), limit=3)) + assert result == [ + arrow.Arrow(2014, 11, 30), + arrow.Arrow(2015, 2, 28), + arrow.Arrow(2015, 5, 30), + ] + + def test_range_over_year_maintains_end_date_across_leap_year(self): + result = list(arrow.Arrow.range("year", datetime(2012, 2, 29), limit=5)) + assert result == [ + arrow.Arrow(2012, 2, 29), + arrow.Arrow(2013, 2, 28), + arrow.Arrow(2014, 2, 28), + arrow.Arrow(2015, 2, 28), + arrow.Arrow(2016, 2, 29), + ] + + +class TestArrowSpanRange: + def test_year(self): + + result = list( + arrow.Arrow.span_range("year", datetime(2013, 2, 1), datetime(2016, 3, 31)) + ) + + assert result == [ + ( + arrow.Arrow(2013, 1, 1), + arrow.Arrow(2013, 12, 31, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2014, 1, 1), + arrow.Arrow(2014, 12, 31, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2015, 1, 1), + arrow.Arrow(2015, 12, 31, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2016, 1, 1), + arrow.Arrow(2016, 12, 31, 23, 59, 59, 999999), + ), + ] + + def test_quarter(self): + + result = list( + arrow.Arrow.span_range( + "quarter", datetime(2013, 2, 2), datetime(2013, 5, 15) + ) + ) + + assert result == [ + (arrow.Arrow(2013, 1, 1), arrow.Arrow(2013, 3, 31, 23, 59, 59, 999999)), + (arrow.Arrow(2013, 4, 1), arrow.Arrow(2013, 6, 30, 23, 59, 59, 999999)), + ] + + def test_month(self): + + result = list( + arrow.Arrow.span_range("month", datetime(2013, 1, 2), datetime(2013, 4, 15)) + ) + + assert result == [ + (arrow.Arrow(2013, 1, 1), arrow.Arrow(2013, 1, 31, 23, 59, 59, 999999)), + (arrow.Arrow(2013, 2, 1), arrow.Arrow(2013, 2, 28, 23, 59, 59, 999999)), + (arrow.Arrow(2013, 3, 1), arrow.Arrow(2013, 3, 31, 23, 59, 59, 999999)), + (arrow.Arrow(2013, 4, 1), arrow.Arrow(2013, 4, 30, 23, 59, 59, 999999)), + ] + + def test_week(self): + + result = list( + arrow.Arrow.span_range("week", datetime(2013, 2, 2), datetime(2013, 2, 28)) + ) + + assert result == [ + (arrow.Arrow(2013, 1, 28), arrow.Arrow(2013, 2, 3, 23, 59, 59, 999999)), + (arrow.Arrow(2013, 2, 4), arrow.Arrow(2013, 2, 10, 23, 59, 59, 999999)), + ( + arrow.Arrow(2013, 2, 11), + arrow.Arrow(2013, 2, 17, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 2, 18), + arrow.Arrow(2013, 2, 24, 23, 59, 59, 999999), + ), + (arrow.Arrow(2013, 2, 25), arrow.Arrow(2013, 3, 3, 23, 59, 59, 999999)), + ] + + def test_day(self): + + result = list( + arrow.Arrow.span_range( + "day", datetime(2013, 1, 1, 12), datetime(2013, 1, 4, 12) + ) + ) + + assert result == [ + ( + arrow.Arrow(2013, 1, 1, 0), + arrow.Arrow(2013, 1, 1, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 2, 0), + arrow.Arrow(2013, 1, 2, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 3, 0), + arrow.Arrow(2013, 1, 3, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 4, 0), + arrow.Arrow(2013, 1, 4, 23, 59, 59, 999999), + ), + ] + + def test_days(self): + + result = list( + arrow.Arrow.span_range( + "days", datetime(2013, 1, 1, 12), datetime(2013, 1, 4, 12) + ) + ) + + assert result == [ + ( + arrow.Arrow(2013, 1, 1, 0), + arrow.Arrow(2013, 1, 1, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 2, 0), + arrow.Arrow(2013, 1, 2, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 3, 0), + arrow.Arrow(2013, 1, 3, 23, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 4, 0), + arrow.Arrow(2013, 1, 4, 23, 59, 59, 999999), + ), + ] + + def test_hour(self): + + result = list( + arrow.Arrow.span_range( + "hour", datetime(2013, 1, 1, 0, 30), datetime(2013, 1, 1, 3, 30) + ) + ) + + assert result == [ + ( + arrow.Arrow(2013, 1, 1, 0), + arrow.Arrow(2013, 1, 1, 0, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 1), + arrow.Arrow(2013, 1, 1, 1, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 2), + arrow.Arrow(2013, 1, 1, 2, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 3), + arrow.Arrow(2013, 1, 1, 3, 59, 59, 999999), + ), + ] + + result = list( + arrow.Arrow.span_range( + "hour", datetime(2013, 1, 1, 3, 30), datetime(2013, 1, 1, 3, 30) + ) + ) + + assert result == [ + (arrow.Arrow(2013, 1, 1, 3), arrow.Arrow(2013, 1, 1, 3, 59, 59, 999999)) + ] + + def test_minute(self): + + result = list( + arrow.Arrow.span_range( + "minute", datetime(2013, 1, 1, 0, 0, 30), datetime(2013, 1, 1, 0, 3, 30) + ) + ) + + assert result == [ + ( + arrow.Arrow(2013, 1, 1, 0, 0), + arrow.Arrow(2013, 1, 1, 0, 0, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 0, 1), + arrow.Arrow(2013, 1, 1, 0, 1, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 0, 2), + arrow.Arrow(2013, 1, 1, 0, 2, 59, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 0, 3), + arrow.Arrow(2013, 1, 1, 0, 3, 59, 999999), + ), + ] + + def test_second(self): + + result = list( + arrow.Arrow.span_range( + "second", datetime(2013, 1, 1), datetime(2013, 1, 1, 0, 0, 3) + ) + ) + + assert result == [ + ( + arrow.Arrow(2013, 1, 1, 0, 0, 0), + arrow.Arrow(2013, 1, 1, 0, 0, 0, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 0, 0, 1), + arrow.Arrow(2013, 1, 1, 0, 0, 1, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 0, 0, 2), + arrow.Arrow(2013, 1, 1, 0, 0, 2, 999999), + ), + ( + arrow.Arrow(2013, 1, 1, 0, 0, 3), + arrow.Arrow(2013, 1, 1, 0, 0, 3, 999999), + ), + ] + + def test_naive_tz(self): + + tzinfo = tz.gettz("US/Pacific") + + result = arrow.Arrow.span_range( + "hour", datetime(2013, 1, 1, 0), datetime(2013, 1, 1, 3, 59), "US/Pacific" + ) + + for f, c in result: + assert f.tzinfo == tzinfo + assert c.tzinfo == tzinfo + + def test_aware_same_tz(self): + + tzinfo = tz.gettz("US/Pacific") + + result = arrow.Arrow.span_range( + "hour", + datetime(2013, 1, 1, 0, tzinfo=tzinfo), + datetime(2013, 1, 1, 2, 59, tzinfo=tzinfo), + ) + + for f, c in result: + assert f.tzinfo == tzinfo + assert c.tzinfo == tzinfo + + def test_aware_different_tz(self): + + tzinfo1 = tz.gettz("US/Pacific") + tzinfo2 = tz.gettz("US/Eastern") + + result = arrow.Arrow.span_range( + "hour", + datetime(2013, 1, 1, 0, tzinfo=tzinfo1), + datetime(2013, 1, 1, 2, 59, tzinfo=tzinfo2), + ) + + for f, c in result: + assert f.tzinfo == tzinfo1 + assert c.tzinfo == tzinfo1 + + def test_aware_tz(self): + + result = arrow.Arrow.span_range( + "hour", + datetime(2013, 1, 1, 0, tzinfo=tz.gettz("US/Eastern")), + datetime(2013, 1, 1, 2, 59, tzinfo=tz.gettz("US/Eastern")), + tz="US/Central", + ) + + for f, c in result: + assert f.tzinfo == tz.gettz("US/Central") + assert c.tzinfo == tz.gettz("US/Central") + + def test_bounds_param_is_passed(self): + + result = list( + arrow.Arrow.span_range( + "quarter", datetime(2013, 2, 2), datetime(2013, 5, 15), bounds="[]" + ) + ) + + assert result == [ + (arrow.Arrow(2013, 1, 1), arrow.Arrow(2013, 4, 1)), + (arrow.Arrow(2013, 4, 1), arrow.Arrow(2013, 7, 1)), + ] + + +class TestArrowInterval: + def test_incorrect_input(self): + with pytest.raises(ValueError): + list( + arrow.Arrow.interval( + "month", datetime(2013, 1, 2), datetime(2013, 4, 15), 0 + ) + ) + + def test_correct(self): + result = list( + arrow.Arrow.interval( + "hour", datetime(2013, 5, 5, 12, 30), datetime(2013, 5, 5, 17, 15), 2 + ) + ) + + assert result == [ + ( + arrow.Arrow(2013, 5, 5, 12), + arrow.Arrow(2013, 5, 5, 13, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 5, 5, 14), + arrow.Arrow(2013, 5, 5, 15, 59, 59, 999999), + ), + ( + arrow.Arrow(2013, 5, 5, 16), + arrow.Arrow(2013, 5, 5, 17, 59, 59, 999999), + ), + ] + + def test_bounds_param_is_passed(self): + result = list( + arrow.Arrow.interval( + "hour", + datetime(2013, 5, 5, 12, 30), + datetime(2013, 5, 5, 17, 15), + 2, + bounds="[]", + ) + ) + + assert result == [ + (arrow.Arrow(2013, 5, 5, 12), arrow.Arrow(2013, 5, 5, 14)), + (arrow.Arrow(2013, 5, 5, 14), arrow.Arrow(2013, 5, 5, 16)), + (arrow.Arrow(2013, 5, 5, 16), arrow.Arrow(2013, 5, 5, 18)), + ] + + +@pytest.mark.usefixtures("time_2013_02_15") +class TestArrowSpan: + def test_span_attribute(self): + + with pytest.raises(AttributeError): + self.arrow.span("span") + + def test_span_year(self): + + floor, ceil = self.arrow.span("year") + + assert floor == datetime(2013, 1, 1, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 12, 31, 23, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_quarter(self): + + floor, ceil = self.arrow.span("quarter") + + assert floor == datetime(2013, 1, 1, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 3, 31, 23, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_quarter_count(self): + + floor, ceil = self.arrow.span("quarter", 2) + + assert floor == datetime(2013, 1, 1, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 6, 30, 23, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_year_count(self): + + floor, ceil = self.arrow.span("year", 2) + + assert floor == datetime(2013, 1, 1, tzinfo=tz.tzutc()) + assert ceil == datetime(2014, 12, 31, 23, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_month(self): + + floor, ceil = self.arrow.span("month") + + assert floor == datetime(2013, 2, 1, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 28, 23, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_week(self): + + floor, ceil = self.arrow.span("week") + + assert floor == datetime(2013, 2, 11, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 17, 23, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_day(self): + + floor, ceil = self.arrow.span("day") + + assert floor == datetime(2013, 2, 15, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 15, 23, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_hour(self): + + floor, ceil = self.arrow.span("hour") + + assert floor == datetime(2013, 2, 15, 3, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 15, 3, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_minute(self): + + floor, ceil = self.arrow.span("minute") + + assert floor == datetime(2013, 2, 15, 3, 41, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 15, 3, 41, 59, 999999, tzinfo=tz.tzutc()) + + def test_span_second(self): + + floor, ceil = self.arrow.span("second") + + assert floor == datetime(2013, 2, 15, 3, 41, 22, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 15, 3, 41, 22, 999999, tzinfo=tz.tzutc()) + + def test_span_microsecond(self): + + floor, ceil = self.arrow.span("microsecond") + + assert floor == datetime(2013, 2, 15, 3, 41, 22, 8923, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 15, 3, 41, 22, 8923, tzinfo=tz.tzutc()) + + def test_floor(self): + + floor, ceil = self.arrow.span("month") + + assert floor == self.arrow.floor("month") + assert ceil == self.arrow.ceil("month") + + def test_span_inclusive_inclusive(self): + + floor, ceil = self.arrow.span("hour", bounds="[]") + + assert floor == datetime(2013, 2, 15, 3, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 15, 4, tzinfo=tz.tzutc()) + + def test_span_exclusive_inclusive(self): + + floor, ceil = self.arrow.span("hour", bounds="(]") + + assert floor == datetime(2013, 2, 15, 3, 0, 0, 1, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 15, 4, tzinfo=tz.tzutc()) + + def test_span_exclusive_exclusive(self): + + floor, ceil = self.arrow.span("hour", bounds="()") + + assert floor == datetime(2013, 2, 15, 3, 0, 0, 1, tzinfo=tz.tzutc()) + assert ceil == datetime(2013, 2, 15, 3, 59, 59, 999999, tzinfo=tz.tzutc()) + + def test_bounds_are_validated(self): + + with pytest.raises(ValueError): + floor, ceil = self.arrow.span("hour", bounds="][") + + +@pytest.mark.usefixtures("time_2013_01_01") +class TestArrowHumanize: + def test_granularity(self): + + assert self.now.humanize(granularity="second") == "just now" + + later1 = self.now.shift(seconds=1) + assert self.now.humanize(later1, granularity="second") == "just now" + assert later1.humanize(self.now, granularity="second") == "just now" + assert self.now.humanize(later1, granularity="minute") == "0 minutes ago" + assert later1.humanize(self.now, granularity="minute") == "in 0 minutes" + + later100 = self.now.shift(seconds=100) + assert self.now.humanize(later100, granularity="second") == "100 seconds ago" + assert later100.humanize(self.now, granularity="second") == "in 100 seconds" + assert self.now.humanize(later100, granularity="minute") == "a minute ago" + assert later100.humanize(self.now, granularity="minute") == "in a minute" + assert self.now.humanize(later100, granularity="hour") == "0 hours ago" + assert later100.humanize(self.now, granularity="hour") == "in 0 hours" + + later4000 = self.now.shift(seconds=4000) + assert self.now.humanize(later4000, granularity="minute") == "66 minutes ago" + assert later4000.humanize(self.now, granularity="minute") == "in 66 minutes" + assert self.now.humanize(later4000, granularity="hour") == "an hour ago" + assert later4000.humanize(self.now, granularity="hour") == "in an hour" + assert self.now.humanize(later4000, granularity="day") == "0 days ago" + assert later4000.humanize(self.now, granularity="day") == "in 0 days" + + later105 = self.now.shift(seconds=10 ** 5) + assert self.now.humanize(later105, granularity="hour") == "27 hours ago" + assert later105.humanize(self.now, granularity="hour") == "in 27 hours" + assert self.now.humanize(later105, granularity="day") == "a day ago" + assert later105.humanize(self.now, granularity="day") == "in a day" + assert self.now.humanize(later105, granularity="week") == "0 weeks ago" + assert later105.humanize(self.now, granularity="week") == "in 0 weeks" + assert self.now.humanize(later105, granularity="month") == "0 months ago" + assert later105.humanize(self.now, granularity="month") == "in 0 months" + assert self.now.humanize(later105, granularity=["month"]) == "0 months ago" + assert later105.humanize(self.now, granularity=["month"]) == "in 0 months" + + later106 = self.now.shift(seconds=3 * 10 ** 6) + assert self.now.humanize(later106, granularity="day") == "34 days ago" + assert later106.humanize(self.now, granularity="day") == "in 34 days" + assert self.now.humanize(later106, granularity="week") == "4 weeks ago" + assert later106.humanize(self.now, granularity="week") == "in 4 weeks" + assert self.now.humanize(later106, granularity="month") == "a month ago" + assert later106.humanize(self.now, granularity="month") == "in a month" + assert self.now.humanize(later106, granularity="year") == "0 years ago" + assert later106.humanize(self.now, granularity="year") == "in 0 years" + + later506 = self.now.shift(seconds=50 * 10 ** 6) + assert self.now.humanize(later506, granularity="week") == "82 weeks ago" + assert later506.humanize(self.now, granularity="week") == "in 82 weeks" + assert self.now.humanize(later506, granularity="month") == "18 months ago" + assert later506.humanize(self.now, granularity="month") == "in 18 months" + assert self.now.humanize(later506, granularity="year") == "a year ago" + assert later506.humanize(self.now, granularity="year") == "in a year" + + later108 = self.now.shift(seconds=10 ** 8) + assert self.now.humanize(later108, granularity="year") == "3 years ago" + assert later108.humanize(self.now, granularity="year") == "in 3 years" + + later108onlydistance = self.now.shift(seconds=10 ** 8) + assert ( + self.now.humanize( + later108onlydistance, only_distance=True, granularity="year" + ) + == "3 years" + ) + assert ( + later108onlydistance.humanize( + self.now, only_distance=True, granularity="year" + ) + == "3 years" + ) + + with pytest.raises(AttributeError): + self.now.humanize(later108, granularity="years") + + def test_multiple_granularity(self): + assert self.now.humanize(granularity="second") == "just now" + assert self.now.humanize(granularity=["second"]) == "just now" + assert ( + self.now.humanize(granularity=["year", "month", "day", "hour", "second"]) + == "in 0 years 0 months 0 days 0 hours and 0 seconds" + ) + + later4000 = self.now.shift(seconds=4000) + assert ( + later4000.humanize(self.now, granularity=["hour", "minute"]) + == "in an hour and 6 minutes" + ) + assert ( + self.now.humanize(later4000, granularity=["hour", "minute"]) + == "an hour and 6 minutes ago" + ) + assert ( + later4000.humanize( + self.now, granularity=["hour", "minute"], only_distance=True + ) + == "an hour and 6 minutes" + ) + assert ( + later4000.humanize(self.now, granularity=["day", "hour", "minute"]) + == "in 0 days an hour and 6 minutes" + ) + assert ( + self.now.humanize(later4000, granularity=["day", "hour", "minute"]) + == "0 days an hour and 6 minutes ago" + ) + + later105 = self.now.shift(seconds=10 ** 5) + assert ( + self.now.humanize(later105, granularity=["hour", "day", "minute"]) + == "a day 3 hours and 46 minutes ago" + ) + with pytest.raises(AttributeError): + self.now.humanize(later105, granularity=["error", "second"]) + + later108onlydistance = self.now.shift(seconds=10 ** 8) + assert ( + self.now.humanize( + later108onlydistance, only_distance=True, granularity=["year"] + ) + == "3 years" + ) + assert ( + self.now.humanize( + later108onlydistance, only_distance=True, granularity=["month", "week"] + ) + == "37 months and 4 weeks" + ) + assert ( + self.now.humanize( + later108onlydistance, only_distance=True, granularity=["year", "second"] + ) + == "3 years and 5327200 seconds" + ) + + one_min_one_sec_ago = self.now.shift(minutes=-1, seconds=-1) + assert ( + one_min_one_sec_ago.humanize(self.now, granularity=["minute", "second"]) + == "a minute and a second ago" + ) + + one_min_two_secs_ago = self.now.shift(minutes=-1, seconds=-2) + assert ( + one_min_two_secs_ago.humanize(self.now, granularity=["minute", "second"]) + == "a minute and 2 seconds ago" + ) + + def test_seconds(self): + + later = self.now.shift(seconds=10) + + # regression test for issue #727 + assert self.now.humanize(later) == "10 seconds ago" + assert later.humanize(self.now) == "in 10 seconds" + + assert self.now.humanize(later, only_distance=True) == "10 seconds" + assert later.humanize(self.now, only_distance=True) == "10 seconds" + + def test_minute(self): + + later = self.now.shift(minutes=1) + + assert self.now.humanize(later) == "a minute ago" + assert later.humanize(self.now) == "in a minute" + + assert self.now.humanize(later, only_distance=True) == "a minute" + assert later.humanize(self.now, only_distance=True) == "a minute" + + def test_minutes(self): + + later = self.now.shift(minutes=2) + + assert self.now.humanize(later) == "2 minutes ago" + assert later.humanize(self.now) == "in 2 minutes" + + assert self.now.humanize(later, only_distance=True) == "2 minutes" + assert later.humanize(self.now, only_distance=True) == "2 minutes" + + def test_hour(self): + + later = self.now.shift(hours=1) + + assert self.now.humanize(later) == "an hour ago" + assert later.humanize(self.now) == "in an hour" + + assert self.now.humanize(later, only_distance=True) == "an hour" + assert later.humanize(self.now, only_distance=True) == "an hour" + + def test_hours(self): + + later = self.now.shift(hours=2) + + assert self.now.humanize(later) == "2 hours ago" + assert later.humanize(self.now) == "in 2 hours" + + assert self.now.humanize(later, only_distance=True) == "2 hours" + assert later.humanize(self.now, only_distance=True) == "2 hours" + + def test_day(self): + + later = self.now.shift(days=1) + + assert self.now.humanize(later) == "a day ago" + assert later.humanize(self.now) == "in a day" + + # regression test for issue #697 + less_than_48_hours = self.now.shift( + days=1, hours=23, seconds=59, microseconds=999999 + ) + assert self.now.humanize(less_than_48_hours) == "a day ago" + assert less_than_48_hours.humanize(self.now) == "in a day" + + less_than_48_hours_date = less_than_48_hours._datetime.date() + with pytest.raises(TypeError): + # humanize other argument does not take raw datetime.date objects + self.now.humanize(less_than_48_hours_date) + + # convert from date to arrow object + less_than_48_hours_date = arrow.Arrow.fromdate(less_than_48_hours_date) + assert self.now.humanize(less_than_48_hours_date) == "a day ago" + assert less_than_48_hours_date.humanize(self.now) == "in a day" + + assert self.now.humanize(later, only_distance=True) == "a day" + assert later.humanize(self.now, only_distance=True) == "a day" + + def test_days(self): + + later = self.now.shift(days=2) + + assert self.now.humanize(later) == "2 days ago" + assert later.humanize(self.now) == "in 2 days" + + assert self.now.humanize(later, only_distance=True) == "2 days" + assert later.humanize(self.now, only_distance=True) == "2 days" + + # Regression tests for humanize bug referenced in issue 541 + later = self.now.shift(days=3) + assert later.humanize(self.now) == "in 3 days" + + later = self.now.shift(days=3, seconds=1) + assert later.humanize(self.now) == "in 3 days" + + later = self.now.shift(days=4) + assert later.humanize(self.now) == "in 4 days" + + def test_week(self): + + later = self.now.shift(weeks=1) + + assert self.now.humanize(later) == "a week ago" + assert later.humanize(self.now) == "in a week" + + assert self.now.humanize(later, only_distance=True) == "a week" + assert later.humanize(self.now, only_distance=True) == "a week" + + def test_weeks(self): + + later = self.now.shift(weeks=2) + + assert self.now.humanize(later) == "2 weeks ago" + assert later.humanize(self.now) == "in 2 weeks" + + assert self.now.humanize(later, only_distance=True) == "2 weeks" + assert later.humanize(self.now, only_distance=True) == "2 weeks" + + def test_month(self): + + later = self.now.shift(months=1) + + assert self.now.humanize(later) == "a month ago" + assert later.humanize(self.now) == "in a month" + + assert self.now.humanize(later, only_distance=True) == "a month" + assert later.humanize(self.now, only_distance=True) == "a month" + + def test_months(self): + + later = self.now.shift(months=2) + earlier = self.now.shift(months=-2) + + assert earlier.humanize(self.now) == "2 months ago" + assert later.humanize(self.now) == "in 2 months" + + assert self.now.humanize(later, only_distance=True) == "2 months" + assert later.humanize(self.now, only_distance=True) == "2 months" + + def test_year(self): + + later = self.now.shift(years=1) + + assert self.now.humanize(later) == "a year ago" + assert later.humanize(self.now) == "in a year" + + assert self.now.humanize(later, only_distance=True) == "a year" + assert later.humanize(self.now, only_distance=True) == "a year" + + def test_years(self): + + later = self.now.shift(years=2) + + assert self.now.humanize(later) == "2 years ago" + assert later.humanize(self.now) == "in 2 years" + + assert self.now.humanize(later, only_distance=True) == "2 years" + assert later.humanize(self.now, only_distance=True) == "2 years" + + arw = arrow.Arrow(2014, 7, 2) + + result = arw.humanize(self.datetime) + + assert result == "in 2 years" + + def test_arrow(self): + + arw = arrow.Arrow.fromdatetime(self.datetime) + + result = arw.humanize(arrow.Arrow.fromdatetime(self.datetime)) + + assert result == "just now" + + def test_datetime_tzinfo(self): + + arw = arrow.Arrow.fromdatetime(self.datetime) + + result = arw.humanize(self.datetime.replace(tzinfo=tz.tzutc())) + + assert result == "just now" + + def test_other(self): + + arw = arrow.Arrow.fromdatetime(self.datetime) + + with pytest.raises(TypeError): + arw.humanize(object()) + + def test_invalid_locale(self): + + arw = arrow.Arrow.fromdatetime(self.datetime) + + with pytest.raises(ValueError): + arw.humanize(locale="klingon") + + def test_none(self): + + arw = arrow.Arrow.utcnow() + + result = arw.humanize() + + assert result == "just now" + + result = arw.humanize(None) + + assert result == "just now" + + def test_untranslated_granularity(self, mocker): + + arw = arrow.Arrow.utcnow() + later = arw.shift(weeks=1) + + # simulate an untranslated timeframe key + mocker.patch.dict("arrow.locales.EnglishLocale.timeframes") + del arrow.locales.EnglishLocale.timeframes["week"] + with pytest.raises(ValueError): + arw.humanize(later, granularity="week") + + +@pytest.mark.usefixtures("time_2013_01_01") +class TestArrowHumanizeTestsWithLocale: + def test_now(self): + + arw = arrow.Arrow(2013, 1, 1, 0, 0, 0) + + result = arw.humanize(self.datetime, locale="ru") + + assert result == "сейчас" + + def test_seconds(self): + arw = arrow.Arrow(2013, 1, 1, 0, 0, 44) + + result = arw.humanize(self.datetime, locale="ru") + + assert result == "через 44 несколько секунд" + + def test_years(self): + + arw = arrow.Arrow(2011, 7, 2) + + result = arw.humanize(self.datetime, locale="ru") + + assert result == "2 года назад" + + +class TestArrowIsBetween: + def test_start_before_end(self): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + start = arrow.Arrow.fromdatetime(datetime(2013, 5, 8)) + end = arrow.Arrow.fromdatetime(datetime(2013, 5, 5)) + result = target.is_between(start, end) + assert not result + + def test_exclusive_exclusive_bounds(self): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 5, 12, 30, 27)) + start = arrow.Arrow.fromdatetime(datetime(2013, 5, 5, 12, 30, 10)) + end = arrow.Arrow.fromdatetime(datetime(2013, 5, 5, 12, 30, 36)) + result = target.is_between(start, end, "()") + assert result + result = target.is_between(start, end) + assert result + + def test_exclusive_exclusive_bounds_same_date(self): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + start = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + end = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + result = target.is_between(start, end, "()") + assert not result + + def test_inclusive_exclusive_bounds(self): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 6)) + start = arrow.Arrow.fromdatetime(datetime(2013, 5, 4)) + end = arrow.Arrow.fromdatetime(datetime(2013, 5, 6)) + result = target.is_between(start, end, "[)") + assert not result + + def test_exclusive_inclusive_bounds(self): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + start = arrow.Arrow.fromdatetime(datetime(2013, 5, 5)) + end = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + result = target.is_between(start, end, "(]") + assert result + + def test_inclusive_inclusive_bounds_same_date(self): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + start = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + end = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + result = target.is_between(start, end, "[]") + assert result + + def test_type_error_exception(self): + with pytest.raises(TypeError): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + start = datetime(2013, 5, 5) + end = arrow.Arrow.fromdatetime(datetime(2013, 5, 8)) + target.is_between(start, end) + + with pytest.raises(TypeError): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + start = arrow.Arrow.fromdatetime(datetime(2013, 5, 5)) + end = datetime(2013, 5, 8) + target.is_between(start, end) + + with pytest.raises(TypeError): + target.is_between(None, None) + + def test_value_error_exception(self): + target = arrow.Arrow.fromdatetime(datetime(2013, 5, 7)) + start = arrow.Arrow.fromdatetime(datetime(2013, 5, 5)) + end = arrow.Arrow.fromdatetime(datetime(2013, 5, 8)) + with pytest.raises(ValueError): + target.is_between(start, end, "][") + with pytest.raises(ValueError): + target.is_between(start, end, "") + with pytest.raises(ValueError): + target.is_between(start, end, "]") + with pytest.raises(ValueError): + target.is_between(start, end, "[") + with pytest.raises(ValueError): + target.is_between(start, end, "hello") + + +class TestArrowUtil: + def test_get_datetime(self): + + get_datetime = arrow.Arrow._get_datetime + + arw = arrow.Arrow.utcnow() + dt = datetime.utcnow() + timestamp = time.time() + + assert get_datetime(arw) == arw.datetime + assert get_datetime(dt) == dt + assert ( + get_datetime(timestamp) == arrow.Arrow.utcfromtimestamp(timestamp).datetime + ) + + with pytest.raises(ValueError) as raise_ctx: + get_datetime("abc") + assert "not recognized as a datetime or timestamp" in str(raise_ctx.value) + + def test_get_tzinfo(self): + + get_tzinfo = arrow.Arrow._get_tzinfo + + with pytest.raises(ValueError) as raise_ctx: + get_tzinfo("abc") + assert "not recognized as a timezone" in str(raise_ctx.value) + + def test_get_iteration_params(self): + + assert arrow.Arrow._get_iteration_params("end", None) == ("end", sys.maxsize) + assert arrow.Arrow._get_iteration_params(None, 100) == (arrow.Arrow.max, 100) + assert arrow.Arrow._get_iteration_params(100, 120) == (100, 120) + + with pytest.raises(ValueError): + arrow.Arrow._get_iteration_params(None, None) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/test_factory.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_factory.py new file mode 100644 index 0000000000..2b8df5168f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_factory.py @@ -0,0 +1,390 @@ +# -*- coding: utf-8 -*- +import time +from datetime import date, datetime + +import pytest +from dateutil import tz + +from arrow.parser import ParserError + +from .utils import assert_datetime_equality + + +@pytest.mark.usefixtures("arrow_factory") +class TestGet: + def test_no_args(self): + + assert_datetime_equality( + self.factory.get(), datetime.utcnow().replace(tzinfo=tz.tzutc()) + ) + + def test_timestamp_one_arg_no_arg(self): + + no_arg = self.factory.get(1406430900).timestamp + one_arg = self.factory.get("1406430900", "X").timestamp + + assert no_arg == one_arg + + def test_one_arg_none(self): + + assert_datetime_equality( + self.factory.get(None), datetime.utcnow().replace(tzinfo=tz.tzutc()) + ) + + def test_struct_time(self): + + assert_datetime_equality( + self.factory.get(time.gmtime()), + datetime.utcnow().replace(tzinfo=tz.tzutc()), + ) + + def test_one_arg_timestamp(self): + + int_timestamp = int(time.time()) + timestamp_dt = datetime.utcfromtimestamp(int_timestamp).replace( + tzinfo=tz.tzutc() + ) + + assert self.factory.get(int_timestamp) == timestamp_dt + + with pytest.raises(ParserError): + self.factory.get(str(int_timestamp)) + + float_timestamp = time.time() + timestamp_dt = datetime.utcfromtimestamp(float_timestamp).replace( + tzinfo=tz.tzutc() + ) + + assert self.factory.get(float_timestamp) == timestamp_dt + + with pytest.raises(ParserError): + self.factory.get(str(float_timestamp)) + + # Regression test for issue #216 + # Python 3 raises OverflowError, Python 2 raises ValueError + timestamp = 99999999999999999999999999.99999999999999999999999999 + with pytest.raises((OverflowError, ValueError)): + self.factory.get(timestamp) + + def test_one_arg_expanded_timestamp(self): + + millisecond_timestamp = 1591328104308 + microsecond_timestamp = 1591328104308505 + + # Regression test for issue #796 + assert self.factory.get(millisecond_timestamp) == datetime.utcfromtimestamp( + 1591328104.308 + ).replace(tzinfo=tz.tzutc()) + assert self.factory.get(microsecond_timestamp) == datetime.utcfromtimestamp( + 1591328104.308505 + ).replace(tzinfo=tz.tzutc()) + + def test_one_arg_timestamp_with_tzinfo(self): + + timestamp = time.time() + timestamp_dt = datetime.fromtimestamp(timestamp, tz=tz.tzutc()).astimezone( + tz.gettz("US/Pacific") + ) + timezone = tz.gettz("US/Pacific") + + assert_datetime_equality( + self.factory.get(timestamp, tzinfo=timezone), timestamp_dt + ) + + def test_one_arg_arrow(self): + + arw = self.factory.utcnow() + result = self.factory.get(arw) + + assert arw == result + + def test_one_arg_datetime(self): + + dt = datetime.utcnow().replace(tzinfo=tz.tzutc()) + + assert self.factory.get(dt) == dt + + def test_one_arg_date(self): + + d = date.today() + dt = datetime(d.year, d.month, d.day, tzinfo=tz.tzutc()) + + assert self.factory.get(d) == dt + + def test_one_arg_tzinfo(self): + + self.expected = ( + datetime.utcnow() + .replace(tzinfo=tz.tzutc()) + .astimezone(tz.gettz("US/Pacific")) + ) + + assert_datetime_equality( + self.factory.get(tz.gettz("US/Pacific")), self.expected + ) + + # regression test for issue #658 + def test_one_arg_dateparser_datetime(self): + dateparser = pytest.importorskip("dateparser") + expected = datetime(1990, 1, 1).replace(tzinfo=tz.tzutc()) + # dateparser outputs: datetime.datetime(1990, 1, 1, 0, 0, tzinfo=) + parsed_date = dateparser.parse("1990-01-01T00:00:00+00:00") + dt_output = self.factory.get(parsed_date)._datetime.replace(tzinfo=tz.tzutc()) + assert dt_output == expected + + def test_kwarg_tzinfo(self): + + self.expected = ( + datetime.utcnow() + .replace(tzinfo=tz.tzutc()) + .astimezone(tz.gettz("US/Pacific")) + ) + + assert_datetime_equality( + self.factory.get(tzinfo=tz.gettz("US/Pacific")), self.expected + ) + + def test_kwarg_tzinfo_string(self): + + self.expected = ( + datetime.utcnow() + .replace(tzinfo=tz.tzutc()) + .astimezone(tz.gettz("US/Pacific")) + ) + + assert_datetime_equality(self.factory.get(tzinfo="US/Pacific"), self.expected) + + with pytest.raises(ParserError): + self.factory.get(tzinfo="US/PacificInvalidTzinfo") + + def test_kwarg_normalize_whitespace(self): + result = self.factory.get( + "Jun 1 2005 1:33PM", + "MMM D YYYY H:mmA", + tzinfo=tz.tzutc(), + normalize_whitespace=True, + ) + assert result._datetime == datetime(2005, 6, 1, 13, 33, tzinfo=tz.tzutc()) + + result = self.factory.get( + "\t 2013-05-05T12:30:45.123456 \t \n", + tzinfo=tz.tzutc(), + normalize_whitespace=True, + ) + assert result._datetime == datetime( + 2013, 5, 5, 12, 30, 45, 123456, tzinfo=tz.tzutc() + ) + + def test_one_arg_iso_str(self): + + dt = datetime.utcnow() + + assert_datetime_equality( + self.factory.get(dt.isoformat()), dt.replace(tzinfo=tz.tzutc()) + ) + + def test_one_arg_iso_calendar(self): + + pairs = [ + (datetime(2004, 1, 4), (2004, 1, 7)), + (datetime(2008, 12, 30), (2009, 1, 2)), + (datetime(2010, 1, 2), (2009, 53, 6)), + (datetime(2000, 2, 29), (2000, 9, 2)), + (datetime(2005, 1, 1), (2004, 53, 6)), + (datetime(2010, 1, 4), (2010, 1, 1)), + (datetime(2010, 1, 3), (2009, 53, 7)), + (datetime(2003, 12, 29), (2004, 1, 1)), + ] + + for pair in pairs: + dt, iso = pair + assert self.factory.get(iso) == self.factory.get(dt) + + with pytest.raises(TypeError): + self.factory.get((2014, 7, 1, 4)) + + with pytest.raises(TypeError): + self.factory.get((2014, 7)) + + with pytest.raises(ValueError): + self.factory.get((2014, 70, 1)) + + with pytest.raises(ValueError): + self.factory.get((2014, 7, 10)) + + def test_one_arg_other(self): + + with pytest.raises(TypeError): + self.factory.get(object()) + + def test_one_arg_bool(self): + + with pytest.raises(TypeError): + self.factory.get(False) + + with pytest.raises(TypeError): + self.factory.get(True) + + def test_two_args_datetime_tzinfo(self): + + result = self.factory.get(datetime(2013, 1, 1), tz.gettz("US/Pacific")) + + assert result._datetime == datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific")) + + def test_two_args_datetime_tz_str(self): + + result = self.factory.get(datetime(2013, 1, 1), "US/Pacific") + + assert result._datetime == datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific")) + + def test_two_args_date_tzinfo(self): + + result = self.factory.get(date(2013, 1, 1), tz.gettz("US/Pacific")) + + assert result._datetime == datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific")) + + def test_two_args_date_tz_str(self): + + result = self.factory.get(date(2013, 1, 1), "US/Pacific") + + assert result._datetime == datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific")) + + def test_two_args_datetime_other(self): + + with pytest.raises(TypeError): + self.factory.get(datetime.utcnow(), object()) + + def test_two_args_date_other(self): + + with pytest.raises(TypeError): + self.factory.get(date.today(), object()) + + def test_two_args_str_str(self): + + result = self.factory.get("2013-01-01", "YYYY-MM-DD") + + assert result._datetime == datetime(2013, 1, 1, tzinfo=tz.tzutc()) + + def test_two_args_str_tzinfo(self): + + result = self.factory.get("2013-01-01", tzinfo=tz.gettz("US/Pacific")) + + assert_datetime_equality( + result._datetime, datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific")) + ) + + def test_two_args_twitter_format(self): + + # format returned by twitter API for created_at: + twitter_date = "Fri Apr 08 21:08:54 +0000 2016" + result = self.factory.get(twitter_date, "ddd MMM DD HH:mm:ss Z YYYY") + + assert result._datetime == datetime(2016, 4, 8, 21, 8, 54, tzinfo=tz.tzutc()) + + def test_two_args_str_list(self): + + result = self.factory.get("2013-01-01", ["MM/DD/YYYY", "YYYY-MM-DD"]) + + assert result._datetime == datetime(2013, 1, 1, tzinfo=tz.tzutc()) + + def test_two_args_unicode_unicode(self): + + result = self.factory.get(u"2013-01-01", u"YYYY-MM-DD") + + assert result._datetime == datetime(2013, 1, 1, tzinfo=tz.tzutc()) + + def test_two_args_other(self): + + with pytest.raises(TypeError): + self.factory.get(object(), object()) + + def test_three_args_with_tzinfo(self): + + timefmt = "YYYYMMDD" + d = "20150514" + + assert self.factory.get(d, timefmt, tzinfo=tz.tzlocal()) == datetime( + 2015, 5, 14, tzinfo=tz.tzlocal() + ) + + def test_three_args(self): + + assert self.factory.get(2013, 1, 1) == datetime(2013, 1, 1, tzinfo=tz.tzutc()) + + def test_full_kwargs(self): + + assert ( + self.factory.get( + year=2016, + month=7, + day=14, + hour=7, + minute=16, + second=45, + microsecond=631092, + ) + == datetime(2016, 7, 14, 7, 16, 45, 631092, tzinfo=tz.tzutc()) + ) + + def test_three_kwargs(self): + + assert self.factory.get(year=2016, month=7, day=14) == datetime( + 2016, 7, 14, 0, 0, tzinfo=tz.tzutc() + ) + + def test_tzinfo_string_kwargs(self): + result = self.factory.get("2019072807", "YYYYMMDDHH", tzinfo="UTC") + assert result._datetime == datetime(2019, 7, 28, 7, 0, 0, 0, tzinfo=tz.tzutc()) + + def test_insufficient_kwargs(self): + + with pytest.raises(TypeError): + self.factory.get(year=2016) + + with pytest.raises(TypeError): + self.factory.get(year=2016, month=7) + + def test_locale(self): + result = self.factory.get("2010", "YYYY", locale="ja") + assert result._datetime == datetime(2010, 1, 1, 0, 0, 0, 0, tzinfo=tz.tzutc()) + + # regression test for issue #701 + result = self.factory.get( + "Montag, 9. September 2019, 16:15-20:00", "dddd, D. MMMM YYYY", locale="de" + ) + assert result._datetime == datetime(2019, 9, 9, 0, 0, 0, 0, tzinfo=tz.tzutc()) + + def test_locale_kwarg_only(self): + res = self.factory.get(locale="ja") + assert res.tzinfo == tz.tzutc() + + def test_locale_with_tzinfo(self): + res = self.factory.get(locale="ja", tzinfo=tz.gettz("Asia/Tokyo")) + assert res.tzinfo == tz.gettz("Asia/Tokyo") + + +@pytest.mark.usefixtures("arrow_factory") +class TestUtcNow: + def test_utcnow(self): + + assert_datetime_equality( + self.factory.utcnow()._datetime, + datetime.utcnow().replace(tzinfo=tz.tzutc()), + ) + + +@pytest.mark.usefixtures("arrow_factory") +class TestNow: + def test_no_tz(self): + + assert_datetime_equality(self.factory.now(), datetime.now(tz.tzlocal())) + + def test_tzinfo(self): + + assert_datetime_equality( + self.factory.now(tz.gettz("EST")), datetime.now(tz.gettz("EST")) + ) + + def test_tz_str(self): + + assert_datetime_equality(self.factory.now("EST"), datetime.now(tz.gettz("EST"))) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/test_formatter.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_formatter.py new file mode 100644 index 0000000000..e97aeb5dcc --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_formatter.py @@ -0,0 +1,282 @@ +# -*- coding: utf-8 -*- +from datetime import datetime + +import pytest +import pytz +from dateutil import tz as dateutil_tz + +from arrow import ( + FORMAT_ATOM, + FORMAT_COOKIE, + FORMAT_RFC822, + FORMAT_RFC850, + FORMAT_RFC1036, + FORMAT_RFC1123, + FORMAT_RFC2822, + FORMAT_RFC3339, + FORMAT_RSS, + FORMAT_W3C, +) + +from .utils import make_full_tz_list + + +@pytest.mark.usefixtures("arrow_formatter") +class TestFormatterFormatToken: + def test_format(self): + + dt = datetime(2013, 2, 5, 12, 32, 51) + + result = self.formatter.format(dt, "MM-DD-YYYY hh:mm:ss a") + + assert result == "02-05-2013 12:32:51 pm" + + def test_year(self): + + dt = datetime(2013, 1, 1) + assert self.formatter._format_token(dt, "YYYY") == "2013" + assert self.formatter._format_token(dt, "YY") == "13" + + def test_month(self): + + dt = datetime(2013, 1, 1) + assert self.formatter._format_token(dt, "MMMM") == "January" + assert self.formatter._format_token(dt, "MMM") == "Jan" + assert self.formatter._format_token(dt, "MM") == "01" + assert self.formatter._format_token(dt, "M") == "1" + + def test_day(self): + + dt = datetime(2013, 2, 1) + assert self.formatter._format_token(dt, "DDDD") == "032" + assert self.formatter._format_token(dt, "DDD") == "32" + assert self.formatter._format_token(dt, "DD") == "01" + assert self.formatter._format_token(dt, "D") == "1" + assert self.formatter._format_token(dt, "Do") == "1st" + + assert self.formatter._format_token(dt, "dddd") == "Friday" + assert self.formatter._format_token(dt, "ddd") == "Fri" + assert self.formatter._format_token(dt, "d") == "5" + + def test_hour(self): + + dt = datetime(2013, 1, 1, 2) + assert self.formatter._format_token(dt, "HH") == "02" + assert self.formatter._format_token(dt, "H") == "2" + + dt = datetime(2013, 1, 1, 13) + assert self.formatter._format_token(dt, "HH") == "13" + assert self.formatter._format_token(dt, "H") == "13" + + dt = datetime(2013, 1, 1, 2) + assert self.formatter._format_token(dt, "hh") == "02" + assert self.formatter._format_token(dt, "h") == "2" + + dt = datetime(2013, 1, 1, 13) + assert self.formatter._format_token(dt, "hh") == "01" + assert self.formatter._format_token(dt, "h") == "1" + + # test that 12-hour time converts to '12' at midnight + dt = datetime(2013, 1, 1, 0) + assert self.formatter._format_token(dt, "hh") == "12" + assert self.formatter._format_token(dt, "h") == "12" + + def test_minute(self): + + dt = datetime(2013, 1, 1, 0, 1) + assert self.formatter._format_token(dt, "mm") == "01" + assert self.formatter._format_token(dt, "m") == "1" + + def test_second(self): + + dt = datetime(2013, 1, 1, 0, 0, 1) + assert self.formatter._format_token(dt, "ss") == "01" + assert self.formatter._format_token(dt, "s") == "1" + + def test_sub_second(self): + + dt = datetime(2013, 1, 1, 0, 0, 0, 123456) + assert self.formatter._format_token(dt, "SSSSSS") == "123456" + assert self.formatter._format_token(dt, "SSSSS") == "12345" + assert self.formatter._format_token(dt, "SSSS") == "1234" + assert self.formatter._format_token(dt, "SSS") == "123" + assert self.formatter._format_token(dt, "SS") == "12" + assert self.formatter._format_token(dt, "S") == "1" + + dt = datetime(2013, 1, 1, 0, 0, 0, 2000) + assert self.formatter._format_token(dt, "SSSSSS") == "002000" + assert self.formatter._format_token(dt, "SSSSS") == "00200" + assert self.formatter._format_token(dt, "SSSS") == "0020" + assert self.formatter._format_token(dt, "SSS") == "002" + assert self.formatter._format_token(dt, "SS") == "00" + assert self.formatter._format_token(dt, "S") == "0" + + def test_timestamp(self): + + timestamp = 1588437009.8952794 + dt = datetime.utcfromtimestamp(timestamp) + expected = str(int(timestamp)) + assert self.formatter._format_token(dt, "X") == expected + + # Must round because time.time() may return a float with greater + # than 6 digits of precision + expected = str(int(timestamp * 1000000)) + assert self.formatter._format_token(dt, "x") == expected + + def test_timezone(self): + + dt = datetime.utcnow().replace(tzinfo=dateutil_tz.gettz("US/Pacific")) + + result = self.formatter._format_token(dt, "ZZ") + assert result == "-07:00" or result == "-08:00" + + result = self.formatter._format_token(dt, "Z") + assert result == "-0700" or result == "-0800" + + @pytest.mark.parametrize("full_tz_name", make_full_tz_list()) + def test_timezone_formatter(self, full_tz_name): + + # This test will fail if we use "now" as date as soon as we change from/to DST + dt = datetime(1986, 2, 14, tzinfo=pytz.timezone("UTC")).replace( + tzinfo=dateutil_tz.gettz(full_tz_name) + ) + abbreviation = dt.tzname() + + result = self.formatter._format_token(dt, "ZZZ") + assert result == abbreviation + + def test_am_pm(self): + + dt = datetime(2012, 1, 1, 11) + assert self.formatter._format_token(dt, "a") == "am" + assert self.formatter._format_token(dt, "A") == "AM" + + dt = datetime(2012, 1, 1, 13) + assert self.formatter._format_token(dt, "a") == "pm" + assert self.formatter._format_token(dt, "A") == "PM" + + def test_week(self): + dt = datetime(2017, 5, 19) + assert self.formatter._format_token(dt, "W") == "2017-W20-5" + + # make sure week is zero padded when needed + dt_early = datetime(2011, 1, 20) + assert self.formatter._format_token(dt_early, "W") == "2011-W03-4" + + def test_nonsense(self): + dt = datetime(2012, 1, 1, 11) + assert self.formatter._format_token(dt, None) is None + assert self.formatter._format_token(dt, "NONSENSE") is None + + def test_escape(self): + + assert ( + self.formatter.format( + datetime(2015, 12, 10, 17, 9), "MMMM D, YYYY [at] h:mma" + ) + == "December 10, 2015 at 5:09pm" + ) + + assert ( + self.formatter.format( + datetime(2015, 12, 10, 17, 9), "[MMMM] M D, YYYY [at] h:mma" + ) + == "MMMM 12 10, 2015 at 5:09pm" + ) + + assert ( + self.formatter.format( + datetime(1990, 11, 25), + "[It happened on] MMMM Do [in the year] YYYY [a long time ago]", + ) + == "It happened on November 25th in the year 1990 a long time ago" + ) + + assert ( + self.formatter.format( + datetime(1990, 11, 25), + "[It happened on] MMMM Do [in the][ year] YYYY [a long time ago]", + ) + == "It happened on November 25th in the year 1990 a long time ago" + ) + + assert ( + self.formatter.format( + datetime(1, 1, 1), "[I'm][ entirely][ escaped,][ weee!]" + ) + == "I'm entirely escaped, weee!" + ) + + # Special RegEx characters + assert ( + self.formatter.format( + datetime(2017, 12, 31, 2, 0), "MMM DD, YYYY |^${}().*+?<>-& h:mm A" + ) + == "Dec 31, 2017 |^${}().*+?<>-& 2:00 AM" + ) + + # Escaping is atomic: brackets inside brackets are treated literally + assert self.formatter.format(datetime(1, 1, 1), "[[[ ]]") == "[[ ]" + + +@pytest.mark.usefixtures("arrow_formatter", "time_1975_12_25") +class TestFormatterBuiltinFormats: + def test_atom(self): + assert ( + self.formatter.format(self.datetime, FORMAT_ATOM) + == "1975-12-25 14:15:16-05:00" + ) + + def test_cookie(self): + assert ( + self.formatter.format(self.datetime, FORMAT_COOKIE) + == "Thursday, 25-Dec-1975 14:15:16 EST" + ) + + def test_rfc_822(self): + assert ( + self.formatter.format(self.datetime, FORMAT_RFC822) + == "Thu, 25 Dec 75 14:15:16 -0500" + ) + + def test_rfc_850(self): + assert ( + self.formatter.format(self.datetime, FORMAT_RFC850) + == "Thursday, 25-Dec-75 14:15:16 EST" + ) + + def test_rfc_1036(self): + assert ( + self.formatter.format(self.datetime, FORMAT_RFC1036) + == "Thu, 25 Dec 75 14:15:16 -0500" + ) + + def test_rfc_1123(self): + assert ( + self.formatter.format(self.datetime, FORMAT_RFC1123) + == "Thu, 25 Dec 1975 14:15:16 -0500" + ) + + def test_rfc_2822(self): + assert ( + self.formatter.format(self.datetime, FORMAT_RFC2822) + == "Thu, 25 Dec 1975 14:15:16 -0500" + ) + + def test_rfc3339(self): + assert ( + self.formatter.format(self.datetime, FORMAT_RFC3339) + == "1975-12-25 14:15:16-05:00" + ) + + def test_rss(self): + assert ( + self.formatter.format(self.datetime, FORMAT_RSS) + == "Thu, 25 Dec 1975 14:15:16 -0500" + ) + + def test_w3c(self): + assert ( + self.formatter.format(self.datetime, FORMAT_W3C) + == "1975-12-25 14:15:16-05:00" + ) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/test_locales.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_locales.py new file mode 100644 index 0000000000..006ccdd5ba --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_locales.py @@ -0,0 +1,1352 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +import pytest + +from arrow import arrow, locales + + +@pytest.mark.usefixtures("lang_locales") +class TestLocaleValidation: + """Validate locales to ensure that translations are valid and complete""" + + def test_locale_validation(self): + + for _, locale_cls in self.locales.items(): + # 7 days + 1 spacer to allow for 1-indexing of months + assert len(locale_cls.day_names) == 8 + assert locale_cls.day_names[0] == "" + # ensure that all string from index 1 onward are valid (not blank or None) + assert all(locale_cls.day_names[1:]) + + assert len(locale_cls.day_abbreviations) == 8 + assert locale_cls.day_abbreviations[0] == "" + assert all(locale_cls.day_abbreviations[1:]) + + # 12 months + 1 spacer to allow for 1-indexing of months + assert len(locale_cls.month_names) == 13 + assert locale_cls.month_names[0] == "" + assert all(locale_cls.month_names[1:]) + + assert len(locale_cls.month_abbreviations) == 13 + assert locale_cls.month_abbreviations[0] == "" + assert all(locale_cls.month_abbreviations[1:]) + + assert len(locale_cls.names) > 0 + assert locale_cls.past is not None + assert locale_cls.future is not None + + +class TestModule: + def test_get_locale(self, mocker): + mock_locale = mocker.Mock() + mock_locale_cls = mocker.Mock() + mock_locale_cls.return_value = mock_locale + + with pytest.raises(ValueError): + arrow.locales.get_locale("locale_name") + + cls_dict = arrow.locales._locales + mocker.patch.dict(cls_dict, {"locale_name": mock_locale_cls}) + + result = arrow.locales.get_locale("locale_name") + + assert result == mock_locale + + def test_get_locale_by_class_name(self, mocker): + mock_locale_cls = mocker.Mock() + mock_locale_obj = mock_locale_cls.return_value = mocker.Mock() + + globals_fn = mocker.Mock() + globals_fn.return_value = {"NonExistentLocale": mock_locale_cls} + + with pytest.raises(ValueError): + arrow.locales.get_locale_by_class_name("NonExistentLocale") + + mocker.patch.object(locales, "globals", globals_fn) + result = arrow.locales.get_locale_by_class_name("NonExistentLocale") + + mock_locale_cls.assert_called_once_with() + assert result == mock_locale_obj + + def test_locales(self): + + assert len(locales._locales) > 0 + + +@pytest.mark.usefixtures("lang_locale") +class TestEnglishLocale: + def test_describe(self): + assert self.locale.describe("now", only_distance=True) == "instantly" + assert self.locale.describe("now", only_distance=False) == "just now" + + def test_format_timeframe(self): + + assert self.locale._format_timeframe("hours", 2) == "2 hours" + assert self.locale._format_timeframe("hour", 0) == "an hour" + + def test_format_relative_now(self): + + result = self.locale._format_relative("just now", "now", 0) + + assert result == "just now" + + def test_format_relative_past(self): + + result = self.locale._format_relative("an hour", "hour", 1) + + assert result == "in an hour" + + def test_format_relative_future(self): + + result = self.locale._format_relative("an hour", "hour", -1) + + assert result == "an hour ago" + + def test_ordinal_number(self): + assert self.locale.ordinal_number(0) == "0th" + assert self.locale.ordinal_number(1) == "1st" + assert self.locale.ordinal_number(2) == "2nd" + assert self.locale.ordinal_number(3) == "3rd" + assert self.locale.ordinal_number(4) == "4th" + assert self.locale.ordinal_number(10) == "10th" + assert self.locale.ordinal_number(11) == "11th" + assert self.locale.ordinal_number(12) == "12th" + assert self.locale.ordinal_number(13) == "13th" + assert self.locale.ordinal_number(14) == "14th" + assert self.locale.ordinal_number(21) == "21st" + assert self.locale.ordinal_number(22) == "22nd" + assert self.locale.ordinal_number(23) == "23rd" + assert self.locale.ordinal_number(24) == "24th" + + assert self.locale.ordinal_number(100) == "100th" + assert self.locale.ordinal_number(101) == "101st" + assert self.locale.ordinal_number(102) == "102nd" + assert self.locale.ordinal_number(103) == "103rd" + assert self.locale.ordinal_number(104) == "104th" + assert self.locale.ordinal_number(110) == "110th" + assert self.locale.ordinal_number(111) == "111th" + assert self.locale.ordinal_number(112) == "112th" + assert self.locale.ordinal_number(113) == "113th" + assert self.locale.ordinal_number(114) == "114th" + assert self.locale.ordinal_number(121) == "121st" + assert self.locale.ordinal_number(122) == "122nd" + assert self.locale.ordinal_number(123) == "123rd" + assert self.locale.ordinal_number(124) == "124th" + + def test_meridian_invalid_token(self): + assert self.locale.meridian(7, None) is None + assert self.locale.meridian(7, "B") is None + assert self.locale.meridian(7, "NONSENSE") is None + + +@pytest.mark.usefixtures("lang_locale") +class TestItalianLocale: + def test_ordinal_number(self): + assert self.locale.ordinal_number(1) == "1º" + + +@pytest.mark.usefixtures("lang_locale") +class TestSpanishLocale: + def test_ordinal_number(self): + assert self.locale.ordinal_number(1) == "1º" + + def test_format_timeframe(self): + assert self.locale._format_timeframe("now", 0) == "ahora" + assert self.locale._format_timeframe("seconds", 1) == "1 segundos" + assert self.locale._format_timeframe("seconds", 3) == "3 segundos" + assert self.locale._format_timeframe("seconds", 30) == "30 segundos" + assert self.locale._format_timeframe("minute", 1) == "un minuto" + assert self.locale._format_timeframe("minutes", 4) == "4 minutos" + assert self.locale._format_timeframe("minutes", 40) == "40 minutos" + assert self.locale._format_timeframe("hour", 1) == "una hora" + assert self.locale._format_timeframe("hours", 5) == "5 horas" + assert self.locale._format_timeframe("hours", 23) == "23 horas" + assert self.locale._format_timeframe("day", 1) == "un día" + assert self.locale._format_timeframe("days", 6) == "6 días" + assert self.locale._format_timeframe("days", 12) == "12 días" + assert self.locale._format_timeframe("week", 1) == "una semana" + assert self.locale._format_timeframe("weeks", 2) == "2 semanas" + assert self.locale._format_timeframe("weeks", 3) == "3 semanas" + assert self.locale._format_timeframe("month", 1) == "un mes" + assert self.locale._format_timeframe("months", 7) == "7 meses" + assert self.locale._format_timeframe("months", 11) == "11 meses" + assert self.locale._format_timeframe("year", 1) == "un año" + assert self.locale._format_timeframe("years", 8) == "8 años" + assert self.locale._format_timeframe("years", 12) == "12 años" + + assert self.locale._format_timeframe("now", 0) == "ahora" + assert self.locale._format_timeframe("seconds", -1) == "1 segundos" + assert self.locale._format_timeframe("seconds", -9) == "9 segundos" + assert self.locale._format_timeframe("seconds", -12) == "12 segundos" + assert self.locale._format_timeframe("minute", -1) == "un minuto" + assert self.locale._format_timeframe("minutes", -2) == "2 minutos" + assert self.locale._format_timeframe("minutes", -10) == "10 minutos" + assert self.locale._format_timeframe("hour", -1) == "una hora" + assert self.locale._format_timeframe("hours", -3) == "3 horas" + assert self.locale._format_timeframe("hours", -11) == "11 horas" + assert self.locale._format_timeframe("day", -1) == "un día" + assert self.locale._format_timeframe("days", -2) == "2 días" + assert self.locale._format_timeframe("days", -12) == "12 días" + assert self.locale._format_timeframe("week", -1) == "una semana" + assert self.locale._format_timeframe("weeks", -2) == "2 semanas" + assert self.locale._format_timeframe("weeks", -3) == "3 semanas" + assert self.locale._format_timeframe("month", -1) == "un mes" + assert self.locale._format_timeframe("months", -3) == "3 meses" + assert self.locale._format_timeframe("months", -13) == "13 meses" + assert self.locale._format_timeframe("year", -1) == "un año" + assert self.locale._format_timeframe("years", -4) == "4 años" + assert self.locale._format_timeframe("years", -14) == "14 años" + + +@pytest.mark.usefixtures("lang_locale") +class TestFrenchLocale: + def test_ordinal_number(self): + assert self.locale.ordinal_number(1) == "1er" + assert self.locale.ordinal_number(2) == "2e" + + def test_month_abbreviation(self): + assert "juil" in self.locale.month_abbreviations + + +@pytest.mark.usefixtures("lang_locale") +class TestFrenchCanadianLocale: + def test_month_abbreviation(self): + assert "juill" in self.locale.month_abbreviations + + +@pytest.mark.usefixtures("lang_locale") +class TestRussianLocale: + def test_plurals2(self): + assert self.locale._format_timeframe("hours", 0) == "0 часов" + assert self.locale._format_timeframe("hours", 1) == "1 час" + assert self.locale._format_timeframe("hours", 2) == "2 часа" + assert self.locale._format_timeframe("hours", 4) == "4 часа" + assert self.locale._format_timeframe("hours", 5) == "5 часов" + assert self.locale._format_timeframe("hours", 21) == "21 час" + assert self.locale._format_timeframe("hours", 22) == "22 часа" + assert self.locale._format_timeframe("hours", 25) == "25 часов" + + # feminine grammatical gender should be tested separately + assert self.locale._format_timeframe("minutes", 0) == "0 минут" + assert self.locale._format_timeframe("minutes", 1) == "1 минуту" + assert self.locale._format_timeframe("minutes", 2) == "2 минуты" + assert self.locale._format_timeframe("minutes", 4) == "4 минуты" + assert self.locale._format_timeframe("minutes", 5) == "5 минут" + assert self.locale._format_timeframe("minutes", 21) == "21 минуту" + assert self.locale._format_timeframe("minutes", 22) == "22 минуты" + assert self.locale._format_timeframe("minutes", 25) == "25 минут" + + +@pytest.mark.usefixtures("lang_locale") +class TestPolishLocale: + def test_plurals(self): + + assert self.locale._format_timeframe("seconds", 0) == "0 sekund" + assert self.locale._format_timeframe("second", 1) == "sekundę" + assert self.locale._format_timeframe("seconds", 2) == "2 sekundy" + assert self.locale._format_timeframe("seconds", 5) == "5 sekund" + assert self.locale._format_timeframe("seconds", 21) == "21 sekund" + assert self.locale._format_timeframe("seconds", 22) == "22 sekundy" + assert self.locale._format_timeframe("seconds", 25) == "25 sekund" + + assert self.locale._format_timeframe("minutes", 0) == "0 minut" + assert self.locale._format_timeframe("minute", 1) == "minutę" + assert self.locale._format_timeframe("minutes", 2) == "2 minuty" + assert self.locale._format_timeframe("minutes", 5) == "5 minut" + assert self.locale._format_timeframe("minutes", 21) == "21 minut" + assert self.locale._format_timeframe("minutes", 22) == "22 minuty" + assert self.locale._format_timeframe("minutes", 25) == "25 minut" + + assert self.locale._format_timeframe("hours", 0) == "0 godzin" + assert self.locale._format_timeframe("hour", 1) == "godzinę" + assert self.locale._format_timeframe("hours", 2) == "2 godziny" + assert self.locale._format_timeframe("hours", 5) == "5 godzin" + assert self.locale._format_timeframe("hours", 21) == "21 godzin" + assert self.locale._format_timeframe("hours", 22) == "22 godziny" + assert self.locale._format_timeframe("hours", 25) == "25 godzin" + + assert self.locale._format_timeframe("weeks", 0) == "0 tygodni" + assert self.locale._format_timeframe("week", 1) == "tydzień" + assert self.locale._format_timeframe("weeks", 2) == "2 tygodnie" + assert self.locale._format_timeframe("weeks", 5) == "5 tygodni" + assert self.locale._format_timeframe("weeks", 21) == "21 tygodni" + assert self.locale._format_timeframe("weeks", 22) == "22 tygodnie" + assert self.locale._format_timeframe("weeks", 25) == "25 tygodni" + + assert self.locale._format_timeframe("months", 0) == "0 miesięcy" + assert self.locale._format_timeframe("month", 1) == "miesiąc" + assert self.locale._format_timeframe("months", 2) == "2 miesiące" + assert self.locale._format_timeframe("months", 5) == "5 miesięcy" + assert self.locale._format_timeframe("months", 21) == "21 miesięcy" + assert self.locale._format_timeframe("months", 22) == "22 miesiące" + assert self.locale._format_timeframe("months", 25) == "25 miesięcy" + + assert self.locale._format_timeframe("years", 0) == "0 lat" + assert self.locale._format_timeframe("year", 1) == "rok" + assert self.locale._format_timeframe("years", 2) == "2 lata" + assert self.locale._format_timeframe("years", 5) == "5 lat" + assert self.locale._format_timeframe("years", 21) == "21 lat" + assert self.locale._format_timeframe("years", 22) == "22 lata" + assert self.locale._format_timeframe("years", 25) == "25 lat" + + +@pytest.mark.usefixtures("lang_locale") +class TestIcelandicLocale: + def test_format_timeframe(self): + + assert self.locale._format_timeframe("minute", -1) == "einni mínútu" + assert self.locale._format_timeframe("minute", 1) == "eina mínútu" + + assert self.locale._format_timeframe("hours", -2) == "2 tímum" + assert self.locale._format_timeframe("hours", 2) == "2 tíma" + assert self.locale._format_timeframe("now", 0) == "rétt í þessu" + + +@pytest.mark.usefixtures("lang_locale") +class TestMalayalamLocale: + def test_format_timeframe(self): + + assert self.locale._format_timeframe("hours", 2) == "2 മണിക്കൂർ" + assert self.locale._format_timeframe("hour", 0) == "ഒരു മണിക്കൂർ" + + def test_format_relative_now(self): + + result = self.locale._format_relative("ഇപ്പോൾ", "now", 0) + + assert result == "ഇപ്പോൾ" + + def test_format_relative_past(self): + + result = self.locale._format_relative("ഒരു മണിക്കൂർ", "hour", 1) + assert result == "ഒരു മണിക്കൂർ ശേഷം" + + def test_format_relative_future(self): + + result = self.locale._format_relative("ഒരു മണിക്കൂർ", "hour", -1) + assert result == "ഒരു മണിക്കൂർ മുമ്പ്" + + +@pytest.mark.usefixtures("lang_locale") +class TestHindiLocale: + def test_format_timeframe(self): + + assert self.locale._format_timeframe("hours", 2) == "2 घंटे" + assert self.locale._format_timeframe("hour", 0) == "एक घंटा" + + def test_format_relative_now(self): + + result = self.locale._format_relative("अभी", "now", 0) + assert result == "अभी" + + def test_format_relative_past(self): + + result = self.locale._format_relative("एक घंटा", "hour", 1) + assert result == "एक घंटा बाद" + + def test_format_relative_future(self): + + result = self.locale._format_relative("एक घंटा", "hour", -1) + assert result == "एक घंटा पहले" + + +@pytest.mark.usefixtures("lang_locale") +class TestCzechLocale: + def test_format_timeframe(self): + + assert self.locale._format_timeframe("hours", 2) == "2 hodiny" + assert self.locale._format_timeframe("hours", 5) == "5 hodin" + assert self.locale._format_timeframe("hour", 0) == "0 hodin" + assert self.locale._format_timeframe("hours", -2) == "2 hodinami" + assert self.locale._format_timeframe("hours", -5) == "5 hodinami" + assert self.locale._format_timeframe("now", 0) == "Teď" + + assert self.locale._format_timeframe("weeks", 2) == "2 týdny" + assert self.locale._format_timeframe("weeks", 5) == "5 týdnů" + assert self.locale._format_timeframe("week", 0) == "0 týdnů" + assert self.locale._format_timeframe("weeks", -2) == "2 týdny" + assert self.locale._format_timeframe("weeks", -5) == "5 týdny" + + def test_format_relative_now(self): + + result = self.locale._format_relative("Teď", "now", 0) + assert result == "Teď" + + def test_format_relative_future(self): + + result = self.locale._format_relative("hodinu", "hour", 1) + assert result == "Za hodinu" + + def test_format_relative_past(self): + + result = self.locale._format_relative("hodinou", "hour", -1) + assert result == "Před hodinou" + + +@pytest.mark.usefixtures("lang_locale") +class TestSlovakLocale: + def test_format_timeframe(self): + + assert self.locale._format_timeframe("seconds", -5) == "5 sekundami" + assert self.locale._format_timeframe("seconds", -2) == "2 sekundami" + assert self.locale._format_timeframe("second", -1) == "sekundou" + assert self.locale._format_timeframe("second", 0) == "0 sekúnd" + assert self.locale._format_timeframe("second", 1) == "sekundu" + assert self.locale._format_timeframe("seconds", 2) == "2 sekundy" + assert self.locale._format_timeframe("seconds", 5) == "5 sekúnd" + + assert self.locale._format_timeframe("minutes", -5) == "5 minútami" + assert self.locale._format_timeframe("minutes", -2) == "2 minútami" + assert self.locale._format_timeframe("minute", -1) == "minútou" + assert self.locale._format_timeframe("minute", 0) == "0 minút" + assert self.locale._format_timeframe("minute", 1) == "minútu" + assert self.locale._format_timeframe("minutes", 2) == "2 minúty" + assert self.locale._format_timeframe("minutes", 5) == "5 minút" + + assert self.locale._format_timeframe("hours", -5) == "5 hodinami" + assert self.locale._format_timeframe("hours", -2) == "2 hodinami" + assert self.locale._format_timeframe("hour", -1) == "hodinou" + assert self.locale._format_timeframe("hour", 0) == "0 hodín" + assert self.locale._format_timeframe("hour", 1) == "hodinu" + assert self.locale._format_timeframe("hours", 2) == "2 hodiny" + assert self.locale._format_timeframe("hours", 5) == "5 hodín" + + assert self.locale._format_timeframe("days", -5) == "5 dňami" + assert self.locale._format_timeframe("days", -2) == "2 dňami" + assert self.locale._format_timeframe("day", -1) == "dňom" + assert self.locale._format_timeframe("day", 0) == "0 dní" + assert self.locale._format_timeframe("day", 1) == "deň" + assert self.locale._format_timeframe("days", 2) == "2 dni" + assert self.locale._format_timeframe("days", 5) == "5 dní" + + assert self.locale._format_timeframe("weeks", -5) == "5 týždňami" + assert self.locale._format_timeframe("weeks", -2) == "2 týždňami" + assert self.locale._format_timeframe("week", -1) == "týždňom" + assert self.locale._format_timeframe("week", 0) == "0 týždňov" + assert self.locale._format_timeframe("week", 1) == "týždeň" + assert self.locale._format_timeframe("weeks", 2) == "2 týždne" + assert self.locale._format_timeframe("weeks", 5) == "5 týždňov" + + assert self.locale._format_timeframe("months", -5) == "5 mesiacmi" + assert self.locale._format_timeframe("months", -2) == "2 mesiacmi" + assert self.locale._format_timeframe("month", -1) == "mesiacom" + assert self.locale._format_timeframe("month", 0) == "0 mesiacov" + assert self.locale._format_timeframe("month", 1) == "mesiac" + assert self.locale._format_timeframe("months", 2) == "2 mesiace" + assert self.locale._format_timeframe("months", 5) == "5 mesiacov" + + assert self.locale._format_timeframe("years", -5) == "5 rokmi" + assert self.locale._format_timeframe("years", -2) == "2 rokmi" + assert self.locale._format_timeframe("year", -1) == "rokom" + assert self.locale._format_timeframe("year", 0) == "0 rokov" + assert self.locale._format_timeframe("year", 1) == "rok" + assert self.locale._format_timeframe("years", 2) == "2 roky" + assert self.locale._format_timeframe("years", 5) == "5 rokov" + + assert self.locale._format_timeframe("now", 0) == "Teraz" + + def test_format_relative_now(self): + + result = self.locale._format_relative("Teraz", "now", 0) + assert result == "Teraz" + + def test_format_relative_future(self): + + result = self.locale._format_relative("hodinu", "hour", 1) + assert result == "O hodinu" + + def test_format_relative_past(self): + + result = self.locale._format_relative("hodinou", "hour", -1) + assert result == "Pred hodinou" + + +@pytest.mark.usefixtures("lang_locale") +class TestBulgarianLocale: + def test_plurals2(self): + assert self.locale._format_timeframe("hours", 0) == "0 часа" + assert self.locale._format_timeframe("hours", 1) == "1 час" + assert self.locale._format_timeframe("hours", 2) == "2 часа" + assert self.locale._format_timeframe("hours", 4) == "4 часа" + assert self.locale._format_timeframe("hours", 5) == "5 часа" + assert self.locale._format_timeframe("hours", 21) == "21 час" + assert self.locale._format_timeframe("hours", 22) == "22 часа" + assert self.locale._format_timeframe("hours", 25) == "25 часа" + + # feminine grammatical gender should be tested separately + assert self.locale._format_timeframe("minutes", 0) == "0 минути" + assert self.locale._format_timeframe("minutes", 1) == "1 минута" + assert self.locale._format_timeframe("minutes", 2) == "2 минути" + assert self.locale._format_timeframe("minutes", 4) == "4 минути" + assert self.locale._format_timeframe("minutes", 5) == "5 минути" + assert self.locale._format_timeframe("minutes", 21) == "21 минута" + assert self.locale._format_timeframe("minutes", 22) == "22 минути" + assert self.locale._format_timeframe("minutes", 25) == "25 минути" + + +@pytest.mark.usefixtures("lang_locale") +class TestMacedonianLocale: + def test_singles_mk(self): + assert self.locale._format_timeframe("second", 1) == "една секунда" + assert self.locale._format_timeframe("minute", 1) == "една минута" + assert self.locale._format_timeframe("hour", 1) == "еден саат" + assert self.locale._format_timeframe("day", 1) == "еден ден" + assert self.locale._format_timeframe("week", 1) == "една недела" + assert self.locale._format_timeframe("month", 1) == "еден месец" + assert self.locale._format_timeframe("year", 1) == "една година" + + def test_meridians_mk(self): + assert self.locale.meridian(7, "A") == "претпладне" + assert self.locale.meridian(18, "A") == "попладне" + assert self.locale.meridian(10, "a") == "дп" + assert self.locale.meridian(22, "a") == "пп" + + def test_describe_mk(self): + assert self.locale.describe("second", only_distance=True) == "една секунда" + assert self.locale.describe("second", only_distance=False) == "за една секунда" + assert self.locale.describe("minute", only_distance=True) == "една минута" + assert self.locale.describe("minute", only_distance=False) == "за една минута" + assert self.locale.describe("hour", only_distance=True) == "еден саат" + assert self.locale.describe("hour", only_distance=False) == "за еден саат" + assert self.locale.describe("day", only_distance=True) == "еден ден" + assert self.locale.describe("day", only_distance=False) == "за еден ден" + assert self.locale.describe("week", only_distance=True) == "една недела" + assert self.locale.describe("week", only_distance=False) == "за една недела" + assert self.locale.describe("month", only_distance=True) == "еден месец" + assert self.locale.describe("month", only_distance=False) == "за еден месец" + assert self.locale.describe("year", only_distance=True) == "една година" + assert self.locale.describe("year", only_distance=False) == "за една година" + + def test_relative_mk(self): + # time + assert self.locale._format_relative("сега", "now", 0) == "сега" + assert self.locale._format_relative("1 секунда", "seconds", 1) == "за 1 секунда" + assert self.locale._format_relative("1 минута", "minutes", 1) == "за 1 минута" + assert self.locale._format_relative("1 саат", "hours", 1) == "за 1 саат" + assert self.locale._format_relative("1 ден", "days", 1) == "за 1 ден" + assert self.locale._format_relative("1 недела", "weeks", 1) == "за 1 недела" + assert self.locale._format_relative("1 месец", "months", 1) == "за 1 месец" + assert self.locale._format_relative("1 година", "years", 1) == "за 1 година" + assert ( + self.locale._format_relative("1 секунда", "seconds", -1) == "пред 1 секунда" + ) + assert ( + self.locale._format_relative("1 минута", "minutes", -1) == "пред 1 минута" + ) + assert self.locale._format_relative("1 саат", "hours", -1) == "пред 1 саат" + assert self.locale._format_relative("1 ден", "days", -1) == "пред 1 ден" + assert self.locale._format_relative("1 недела", "weeks", -1) == "пред 1 недела" + assert self.locale._format_relative("1 месец", "months", -1) == "пред 1 месец" + assert self.locale._format_relative("1 година", "years", -1) == "пред 1 година" + + def test_plurals_mk(self): + # Seconds + assert self.locale._format_timeframe("seconds", 0) == "0 секунди" + assert self.locale._format_timeframe("seconds", 1) == "1 секунда" + assert self.locale._format_timeframe("seconds", 2) == "2 секунди" + assert self.locale._format_timeframe("seconds", 4) == "4 секунди" + assert self.locale._format_timeframe("seconds", 5) == "5 секунди" + assert self.locale._format_timeframe("seconds", 21) == "21 секунда" + assert self.locale._format_timeframe("seconds", 22) == "22 секунди" + assert self.locale._format_timeframe("seconds", 25) == "25 секунди" + + # Minutes + assert self.locale._format_timeframe("minutes", 0) == "0 минути" + assert self.locale._format_timeframe("minutes", 1) == "1 минута" + assert self.locale._format_timeframe("minutes", 2) == "2 минути" + assert self.locale._format_timeframe("minutes", 4) == "4 минути" + assert self.locale._format_timeframe("minutes", 5) == "5 минути" + assert self.locale._format_timeframe("minutes", 21) == "21 минута" + assert self.locale._format_timeframe("minutes", 22) == "22 минути" + assert self.locale._format_timeframe("minutes", 25) == "25 минути" + + # Hours + assert self.locale._format_timeframe("hours", 0) == "0 саати" + assert self.locale._format_timeframe("hours", 1) == "1 саат" + assert self.locale._format_timeframe("hours", 2) == "2 саати" + assert self.locale._format_timeframe("hours", 4) == "4 саати" + assert self.locale._format_timeframe("hours", 5) == "5 саати" + assert self.locale._format_timeframe("hours", 21) == "21 саат" + assert self.locale._format_timeframe("hours", 22) == "22 саати" + assert self.locale._format_timeframe("hours", 25) == "25 саати" + + # Days + assert self.locale._format_timeframe("days", 0) == "0 дена" + assert self.locale._format_timeframe("days", 1) == "1 ден" + assert self.locale._format_timeframe("days", 2) == "2 дена" + assert self.locale._format_timeframe("days", 3) == "3 дена" + assert self.locale._format_timeframe("days", 21) == "21 ден" + + # Weeks + assert self.locale._format_timeframe("weeks", 0) == "0 недели" + assert self.locale._format_timeframe("weeks", 1) == "1 недела" + assert self.locale._format_timeframe("weeks", 2) == "2 недели" + assert self.locale._format_timeframe("weeks", 4) == "4 недели" + assert self.locale._format_timeframe("weeks", 5) == "5 недели" + assert self.locale._format_timeframe("weeks", 21) == "21 недела" + assert self.locale._format_timeframe("weeks", 22) == "22 недели" + assert self.locale._format_timeframe("weeks", 25) == "25 недели" + + # Months + assert self.locale._format_timeframe("months", 0) == "0 месеци" + assert self.locale._format_timeframe("months", 1) == "1 месец" + assert self.locale._format_timeframe("months", 2) == "2 месеци" + assert self.locale._format_timeframe("months", 4) == "4 месеци" + assert self.locale._format_timeframe("months", 5) == "5 месеци" + assert self.locale._format_timeframe("months", 21) == "21 месец" + assert self.locale._format_timeframe("months", 22) == "22 месеци" + assert self.locale._format_timeframe("months", 25) == "25 месеци" + + # Years + assert self.locale._format_timeframe("years", 1) == "1 година" + assert self.locale._format_timeframe("years", 2) == "2 години" + assert self.locale._format_timeframe("years", 5) == "5 години" + + def test_multi_describe_mk(self): + describe = self.locale.describe_multi + + fulltest = [("years", 5), ("weeks", 1), ("hours", 1), ("minutes", 6)] + assert describe(fulltest) == "за 5 години 1 недела 1 саат 6 минути" + seconds4000_0days = [("days", 0), ("hours", 1), ("minutes", 6)] + assert describe(seconds4000_0days) == "за 0 дена 1 саат 6 минути" + seconds4000 = [("hours", 1), ("minutes", 6)] + assert describe(seconds4000) == "за 1 саат 6 минути" + assert describe(seconds4000, only_distance=True) == "1 саат 6 минути" + seconds3700 = [("hours", 1), ("minutes", 1)] + assert describe(seconds3700) == "за 1 саат 1 минута" + seconds300_0hours = [("hours", 0), ("minutes", 5)] + assert describe(seconds300_0hours) == "за 0 саати 5 минути" + seconds300 = [("minutes", 5)] + assert describe(seconds300) == "за 5 минути" + seconds60 = [("minutes", 1)] + assert describe(seconds60) == "за 1 минута" + assert describe(seconds60, only_distance=True) == "1 минута" + seconds60 = [("seconds", 1)] + assert describe(seconds60) == "за 1 секунда" + assert describe(seconds60, only_distance=True) == "1 секунда" + + +@pytest.mark.usefixtures("time_2013_01_01") +@pytest.mark.usefixtures("lang_locale") +class TestHebrewLocale: + def test_couple_of_timeframe(self): + assert self.locale._format_timeframe("days", 1) == "יום" + assert self.locale._format_timeframe("days", 2) == "יומיים" + assert self.locale._format_timeframe("days", 3) == "3 ימים" + + assert self.locale._format_timeframe("hours", 1) == "שעה" + assert self.locale._format_timeframe("hours", 2) == "שעתיים" + assert self.locale._format_timeframe("hours", 3) == "3 שעות" + + assert self.locale._format_timeframe("week", 1) == "שבוע" + assert self.locale._format_timeframe("weeks", 2) == "שבועיים" + assert self.locale._format_timeframe("weeks", 3) == "3 שבועות" + + assert self.locale._format_timeframe("months", 1) == "חודש" + assert self.locale._format_timeframe("months", 2) == "חודשיים" + assert self.locale._format_timeframe("months", 4) == "4 חודשים" + + assert self.locale._format_timeframe("years", 1) == "שנה" + assert self.locale._format_timeframe("years", 2) == "שנתיים" + assert self.locale._format_timeframe("years", 5) == "5 שנים" + + def test_describe_multi(self): + describe = self.locale.describe_multi + + fulltest = [("years", 5), ("weeks", 1), ("hours", 1), ("minutes", 6)] + assert describe(fulltest) == "בעוד 5 שנים, שבוע, שעה ו־6 דקות" + seconds4000_0days = [("days", 0), ("hours", 1), ("minutes", 6)] + assert describe(seconds4000_0days) == "בעוד 0 ימים, שעה ו־6 דקות" + seconds4000 = [("hours", 1), ("minutes", 6)] + assert describe(seconds4000) == "בעוד שעה ו־6 דקות" + assert describe(seconds4000, only_distance=True) == "שעה ו־6 דקות" + seconds3700 = [("hours", 1), ("minutes", 1)] + assert describe(seconds3700) == "בעוד שעה ודקה" + seconds300_0hours = [("hours", 0), ("minutes", 5)] + assert describe(seconds300_0hours) == "בעוד 0 שעות ו־5 דקות" + seconds300 = [("minutes", 5)] + assert describe(seconds300) == "בעוד 5 דקות" + seconds60 = [("minutes", 1)] + assert describe(seconds60) == "בעוד דקה" + assert describe(seconds60, only_distance=True) == "דקה" + + +@pytest.mark.usefixtures("lang_locale") +class TestMarathiLocale: + def test_dateCoreFunctionality(self): + dt = arrow.Arrow(2015, 4, 11, 17, 30, 00) + assert self.locale.month_name(dt.month) == "एप्रिल" + assert self.locale.month_abbreviation(dt.month) == "एप्रि" + assert self.locale.day_name(dt.isoweekday()) == "शनिवार" + assert self.locale.day_abbreviation(dt.isoweekday()) == "शनि" + + def test_format_timeframe(self): + assert self.locale._format_timeframe("hours", 2) == "2 तास" + assert self.locale._format_timeframe("hour", 0) == "एक तास" + + def test_format_relative_now(self): + result = self.locale._format_relative("सद्य", "now", 0) + assert result == "सद्य" + + def test_format_relative_past(self): + result = self.locale._format_relative("एक तास", "hour", 1) + assert result == "एक तास नंतर" + + def test_format_relative_future(self): + result = self.locale._format_relative("एक तास", "hour", -1) + assert result == "एक तास आधी" + + # Not currently implemented + def test_ordinal_number(self): + assert self.locale.ordinal_number(1) == "1" + + +@pytest.mark.usefixtures("lang_locale") +class TestFinnishLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("hours", 2) == ("2 tuntia", "2 tunnin") + assert self.locale._format_timeframe("hour", 0) == ("tunti", "tunnin") + + def test_format_relative_now(self): + result = self.locale._format_relative(["juuri nyt", "juuri nyt"], "now", 0) + assert result == "juuri nyt" + + def test_format_relative_past(self): + result = self.locale._format_relative(["tunti", "tunnin"], "hour", 1) + assert result == "tunnin kuluttua" + + def test_format_relative_future(self): + result = self.locale._format_relative(["tunti", "tunnin"], "hour", -1) + assert result == "tunti sitten" + + def test_ordinal_number(self): + assert self.locale.ordinal_number(1) == "1." + + +@pytest.mark.usefixtures("lang_locale") +class TestGermanLocale: + def test_ordinal_number(self): + assert self.locale.ordinal_number(1) == "1." + + def test_define(self): + assert self.locale.describe("minute", only_distance=True) == "eine Minute" + assert self.locale.describe("minute", only_distance=False) == "in einer Minute" + assert self.locale.describe("hour", only_distance=True) == "eine Stunde" + assert self.locale.describe("hour", only_distance=False) == "in einer Stunde" + assert self.locale.describe("day", only_distance=True) == "ein Tag" + assert self.locale.describe("day", only_distance=False) == "in einem Tag" + assert self.locale.describe("week", only_distance=True) == "eine Woche" + assert self.locale.describe("week", only_distance=False) == "in einer Woche" + assert self.locale.describe("month", only_distance=True) == "ein Monat" + assert self.locale.describe("month", only_distance=False) == "in einem Monat" + assert self.locale.describe("year", only_distance=True) == "ein Jahr" + assert self.locale.describe("year", only_distance=False) == "in einem Jahr" + + def test_weekday(self): + dt = arrow.Arrow(2015, 4, 11, 17, 30, 00) + assert self.locale.day_name(dt.isoweekday()) == "Samstag" + assert self.locale.day_abbreviation(dt.isoweekday()) == "Sa" + + +@pytest.mark.usefixtures("lang_locale") +class TestHungarianLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("hours", 2) == "2 óra" + assert self.locale._format_timeframe("hour", 0) == "egy órával" + assert self.locale._format_timeframe("hours", -2) == "2 órával" + assert self.locale._format_timeframe("now", 0) == "éppen most" + + +@pytest.mark.usefixtures("lang_locale") +class TestEsperantoLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("hours", 2) == "2 horoj" + assert self.locale._format_timeframe("hour", 0) == "un horo" + assert self.locale._format_timeframe("hours", -2) == "2 horoj" + assert self.locale._format_timeframe("now", 0) == "nun" + + def test_ordinal_number(self): + assert self.locale.ordinal_number(1) == "1a" + + +@pytest.mark.usefixtures("lang_locale") +class TestThaiLocale: + def test_year_full(self): + assert self.locale.year_full(2015) == "2558" + + def test_year_abbreviation(self): + assert self.locale.year_abbreviation(2015) == "58" + + def test_format_relative_now(self): + result = self.locale._format_relative("ขณะนี้", "now", 0) + assert result == "ขณะนี้" + + def test_format_relative_past(self): + result = self.locale._format_relative("1 ชั่วโมง", "hour", 1) + assert result == "ในอีก 1 ชั่วโมง" + result = self.locale._format_relative("{0} ชั่วโมง", "hours", 2) + assert result == "ในอีก {0} ชั่วโมง" + result = self.locale._format_relative("ไม่กี่วินาที", "seconds", 42) + assert result == "ในอีกไม่กี่วินาที" + + def test_format_relative_future(self): + result = self.locale._format_relative("1 ชั่วโมง", "hour", -1) + assert result == "1 ชั่วโมง ที่ผ่านมา" + + +@pytest.mark.usefixtures("lang_locale") +class TestBengaliLocale: + def test_ordinal_number(self): + assert self.locale._ordinal_number(0) == "0তম" + assert self.locale._ordinal_number(1) == "1ম" + assert self.locale._ordinal_number(3) == "3য়" + assert self.locale._ordinal_number(4) == "4র্থ" + assert self.locale._ordinal_number(5) == "5ম" + assert self.locale._ordinal_number(6) == "6ষ্ঠ" + assert self.locale._ordinal_number(10) == "10ম" + assert self.locale._ordinal_number(11) == "11তম" + assert self.locale._ordinal_number(42) == "42তম" + assert self.locale._ordinal_number(-1) is None + + +@pytest.mark.usefixtures("lang_locale") +class TestRomanianLocale: + def test_timeframes(self): + + assert self.locale._format_timeframe("hours", 2) == "2 ore" + assert self.locale._format_timeframe("months", 2) == "2 luni" + + assert self.locale._format_timeframe("days", 2) == "2 zile" + assert self.locale._format_timeframe("years", 2) == "2 ani" + + assert self.locale._format_timeframe("hours", 3) == "3 ore" + assert self.locale._format_timeframe("months", 4) == "4 luni" + assert self.locale._format_timeframe("days", 3) == "3 zile" + assert self.locale._format_timeframe("years", 5) == "5 ani" + + def test_relative_timeframes(self): + assert self.locale._format_relative("acum", "now", 0) == "acum" + assert self.locale._format_relative("o oră", "hour", 1) == "peste o oră" + assert self.locale._format_relative("o oră", "hour", -1) == "o oră în urmă" + assert self.locale._format_relative("un minut", "minute", 1) == "peste un minut" + assert ( + self.locale._format_relative("un minut", "minute", -1) == "un minut în urmă" + ) + assert ( + self.locale._format_relative("câteva secunde", "seconds", -1) + == "câteva secunde în urmă" + ) + assert ( + self.locale._format_relative("câteva secunde", "seconds", 1) + == "peste câteva secunde" + ) + assert self.locale._format_relative("o zi", "day", -1) == "o zi în urmă" + assert self.locale._format_relative("o zi", "day", 1) == "peste o zi" + + +@pytest.mark.usefixtures("lang_locale") +class TestArabicLocale: + def test_timeframes(self): + + # single + assert self.locale._format_timeframe("minute", 1) == "دقيقة" + assert self.locale._format_timeframe("hour", 1) == "ساعة" + assert self.locale._format_timeframe("day", 1) == "يوم" + assert self.locale._format_timeframe("month", 1) == "شهر" + assert self.locale._format_timeframe("year", 1) == "سنة" + + # double + assert self.locale._format_timeframe("minutes", 2) == "دقيقتين" + assert self.locale._format_timeframe("hours", 2) == "ساعتين" + assert self.locale._format_timeframe("days", 2) == "يومين" + assert self.locale._format_timeframe("months", 2) == "شهرين" + assert self.locale._format_timeframe("years", 2) == "سنتين" + + # up to ten + assert self.locale._format_timeframe("minutes", 3) == "3 دقائق" + assert self.locale._format_timeframe("hours", 4) == "4 ساعات" + assert self.locale._format_timeframe("days", 5) == "5 أيام" + assert self.locale._format_timeframe("months", 6) == "6 أشهر" + assert self.locale._format_timeframe("years", 10) == "10 سنوات" + + # more than ten + assert self.locale._format_timeframe("minutes", 11) == "11 دقيقة" + assert self.locale._format_timeframe("hours", 19) == "19 ساعة" + assert self.locale._format_timeframe("months", 24) == "24 شهر" + assert self.locale._format_timeframe("days", 50) == "50 يوم" + assert self.locale._format_timeframe("years", 115) == "115 سنة" + + +@pytest.mark.usefixtures("lang_locale") +class TestNepaliLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("hours", 3) == "3 घण्टा" + assert self.locale._format_timeframe("hour", 0) == "एक घण्टा" + + def test_format_relative_now(self): + result = self.locale._format_relative("अहिले", "now", 0) + assert result == "अहिले" + + def test_format_relative_future(self): + result = self.locale._format_relative("एक घण्टा", "hour", 1) + assert result == "एक घण्टा पछी" + + def test_format_relative_past(self): + result = self.locale._format_relative("एक घण्टा", "hour", -1) + assert result == "एक घण्टा पहिले" + + +@pytest.mark.usefixtures("lang_locale") +class TestIndonesianLocale: + def test_timeframes(self): + assert self.locale._format_timeframe("hours", 2) == "2 jam" + assert self.locale._format_timeframe("months", 2) == "2 bulan" + + assert self.locale._format_timeframe("days", 2) == "2 hari" + assert self.locale._format_timeframe("years", 2) == "2 tahun" + + assert self.locale._format_timeframe("hours", 3) == "3 jam" + assert self.locale._format_timeframe("months", 4) == "4 bulan" + assert self.locale._format_timeframe("days", 3) == "3 hari" + assert self.locale._format_timeframe("years", 5) == "5 tahun" + + def test_format_relative_now(self): + assert self.locale._format_relative("baru saja", "now", 0) == "baru saja" + + def test_format_relative_past(self): + assert self.locale._format_relative("1 jam", "hour", 1) == "dalam 1 jam" + assert self.locale._format_relative("1 detik", "seconds", 1) == "dalam 1 detik" + + def test_format_relative_future(self): + assert self.locale._format_relative("1 jam", "hour", -1) == "1 jam yang lalu" + + +@pytest.mark.usefixtures("lang_locale") +class TestTagalogLocale: + def test_singles_tl(self): + assert self.locale._format_timeframe("second", 1) == "isang segundo" + assert self.locale._format_timeframe("minute", 1) == "isang minuto" + assert self.locale._format_timeframe("hour", 1) == "isang oras" + assert self.locale._format_timeframe("day", 1) == "isang araw" + assert self.locale._format_timeframe("week", 1) == "isang linggo" + assert self.locale._format_timeframe("month", 1) == "isang buwan" + assert self.locale._format_timeframe("year", 1) == "isang taon" + + def test_meridians_tl(self): + assert self.locale.meridian(7, "A") == "ng umaga" + assert self.locale.meridian(18, "A") == "ng hapon" + assert self.locale.meridian(10, "a") == "nu" + assert self.locale.meridian(22, "a") == "nh" + + def test_describe_tl(self): + assert self.locale.describe("second", only_distance=True) == "isang segundo" + assert ( + self.locale.describe("second", only_distance=False) + == "isang segundo mula ngayon" + ) + assert self.locale.describe("minute", only_distance=True) == "isang minuto" + assert ( + self.locale.describe("minute", only_distance=False) + == "isang minuto mula ngayon" + ) + assert self.locale.describe("hour", only_distance=True) == "isang oras" + assert ( + self.locale.describe("hour", only_distance=False) + == "isang oras mula ngayon" + ) + assert self.locale.describe("day", only_distance=True) == "isang araw" + assert ( + self.locale.describe("day", only_distance=False) == "isang araw mula ngayon" + ) + assert self.locale.describe("week", only_distance=True) == "isang linggo" + assert ( + self.locale.describe("week", only_distance=False) + == "isang linggo mula ngayon" + ) + assert self.locale.describe("month", only_distance=True) == "isang buwan" + assert ( + self.locale.describe("month", only_distance=False) + == "isang buwan mula ngayon" + ) + assert self.locale.describe("year", only_distance=True) == "isang taon" + assert ( + self.locale.describe("year", only_distance=False) + == "isang taon mula ngayon" + ) + + def test_relative_tl(self): + # time + assert self.locale._format_relative("ngayon", "now", 0) == "ngayon" + assert ( + self.locale._format_relative("1 segundo", "seconds", 1) + == "1 segundo mula ngayon" + ) + assert ( + self.locale._format_relative("1 minuto", "minutes", 1) + == "1 minuto mula ngayon" + ) + assert ( + self.locale._format_relative("1 oras", "hours", 1) == "1 oras mula ngayon" + ) + assert self.locale._format_relative("1 araw", "days", 1) == "1 araw mula ngayon" + assert ( + self.locale._format_relative("1 linggo", "weeks", 1) + == "1 linggo mula ngayon" + ) + assert ( + self.locale._format_relative("1 buwan", "months", 1) + == "1 buwan mula ngayon" + ) + assert ( + self.locale._format_relative("1 taon", "years", 1) == "1 taon mula ngayon" + ) + assert ( + self.locale._format_relative("1 segundo", "seconds", -1) + == "nakaraang 1 segundo" + ) + assert ( + self.locale._format_relative("1 minuto", "minutes", -1) + == "nakaraang 1 minuto" + ) + assert self.locale._format_relative("1 oras", "hours", -1) == "nakaraang 1 oras" + assert self.locale._format_relative("1 araw", "days", -1) == "nakaraang 1 araw" + assert ( + self.locale._format_relative("1 linggo", "weeks", -1) + == "nakaraang 1 linggo" + ) + assert ( + self.locale._format_relative("1 buwan", "months", -1) == "nakaraang 1 buwan" + ) + assert self.locale._format_relative("1 taon", "years", -1) == "nakaraang 1 taon" + + def test_plurals_tl(self): + # Seconds + assert self.locale._format_timeframe("seconds", 0) == "0 segundo" + assert self.locale._format_timeframe("seconds", 1) == "1 segundo" + assert self.locale._format_timeframe("seconds", 2) == "2 segundo" + assert self.locale._format_timeframe("seconds", 4) == "4 segundo" + assert self.locale._format_timeframe("seconds", 5) == "5 segundo" + assert self.locale._format_timeframe("seconds", 21) == "21 segundo" + assert self.locale._format_timeframe("seconds", 22) == "22 segundo" + assert self.locale._format_timeframe("seconds", 25) == "25 segundo" + + # Minutes + assert self.locale._format_timeframe("minutes", 0) == "0 minuto" + assert self.locale._format_timeframe("minutes", 1) == "1 minuto" + assert self.locale._format_timeframe("minutes", 2) == "2 minuto" + assert self.locale._format_timeframe("minutes", 4) == "4 minuto" + assert self.locale._format_timeframe("minutes", 5) == "5 minuto" + assert self.locale._format_timeframe("minutes", 21) == "21 minuto" + assert self.locale._format_timeframe("minutes", 22) == "22 minuto" + assert self.locale._format_timeframe("minutes", 25) == "25 minuto" + + # Hours + assert self.locale._format_timeframe("hours", 0) == "0 oras" + assert self.locale._format_timeframe("hours", 1) == "1 oras" + assert self.locale._format_timeframe("hours", 2) == "2 oras" + assert self.locale._format_timeframe("hours", 4) == "4 oras" + assert self.locale._format_timeframe("hours", 5) == "5 oras" + assert self.locale._format_timeframe("hours", 21) == "21 oras" + assert self.locale._format_timeframe("hours", 22) == "22 oras" + assert self.locale._format_timeframe("hours", 25) == "25 oras" + + # Days + assert self.locale._format_timeframe("days", 0) == "0 araw" + assert self.locale._format_timeframe("days", 1) == "1 araw" + assert self.locale._format_timeframe("days", 2) == "2 araw" + assert self.locale._format_timeframe("days", 3) == "3 araw" + assert self.locale._format_timeframe("days", 21) == "21 araw" + + # Weeks + assert self.locale._format_timeframe("weeks", 0) == "0 linggo" + assert self.locale._format_timeframe("weeks", 1) == "1 linggo" + assert self.locale._format_timeframe("weeks", 2) == "2 linggo" + assert self.locale._format_timeframe("weeks", 4) == "4 linggo" + assert self.locale._format_timeframe("weeks", 5) == "5 linggo" + assert self.locale._format_timeframe("weeks", 21) == "21 linggo" + assert self.locale._format_timeframe("weeks", 22) == "22 linggo" + assert self.locale._format_timeframe("weeks", 25) == "25 linggo" + + # Months + assert self.locale._format_timeframe("months", 0) == "0 buwan" + assert self.locale._format_timeframe("months", 1) == "1 buwan" + assert self.locale._format_timeframe("months", 2) == "2 buwan" + assert self.locale._format_timeframe("months", 4) == "4 buwan" + assert self.locale._format_timeframe("months", 5) == "5 buwan" + assert self.locale._format_timeframe("months", 21) == "21 buwan" + assert self.locale._format_timeframe("months", 22) == "22 buwan" + assert self.locale._format_timeframe("months", 25) == "25 buwan" + + # Years + assert self.locale._format_timeframe("years", 1) == "1 taon" + assert self.locale._format_timeframe("years", 2) == "2 taon" + assert self.locale._format_timeframe("years", 5) == "5 taon" + + def test_multi_describe_tl(self): + describe = self.locale.describe_multi + + fulltest = [("years", 5), ("weeks", 1), ("hours", 1), ("minutes", 6)] + assert describe(fulltest) == "5 taon 1 linggo 1 oras 6 minuto mula ngayon" + seconds4000_0days = [("days", 0), ("hours", 1), ("minutes", 6)] + assert describe(seconds4000_0days) == "0 araw 1 oras 6 minuto mula ngayon" + seconds4000 = [("hours", 1), ("minutes", 6)] + assert describe(seconds4000) == "1 oras 6 minuto mula ngayon" + assert describe(seconds4000, only_distance=True) == "1 oras 6 minuto" + seconds3700 = [("hours", 1), ("minutes", 1)] + assert describe(seconds3700) == "1 oras 1 minuto mula ngayon" + seconds300_0hours = [("hours", 0), ("minutes", 5)] + assert describe(seconds300_0hours) == "0 oras 5 minuto mula ngayon" + seconds300 = [("minutes", 5)] + assert describe(seconds300) == "5 minuto mula ngayon" + seconds60 = [("minutes", 1)] + assert describe(seconds60) == "1 minuto mula ngayon" + assert describe(seconds60, only_distance=True) == "1 minuto" + seconds60 = [("seconds", 1)] + assert describe(seconds60) == "1 segundo mula ngayon" + assert describe(seconds60, only_distance=True) == "1 segundo" + + def test_ordinal_number_tl(self): + assert self.locale.ordinal_number(0) == "ika-0" + assert self.locale.ordinal_number(1) == "ika-1" + assert self.locale.ordinal_number(2) == "ika-2" + assert self.locale.ordinal_number(3) == "ika-3" + assert self.locale.ordinal_number(10) == "ika-10" + assert self.locale.ordinal_number(23) == "ika-23" + assert self.locale.ordinal_number(100) == "ika-100" + assert self.locale.ordinal_number(103) == "ika-103" + assert self.locale.ordinal_number(114) == "ika-114" + + +@pytest.mark.usefixtures("lang_locale") +class TestEstonianLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("now", 0) == "just nüüd" + assert self.locale._format_timeframe("second", 1) == "ühe sekundi" + assert self.locale._format_timeframe("seconds", 3) == "3 sekundi" + assert self.locale._format_timeframe("seconds", 30) == "30 sekundi" + assert self.locale._format_timeframe("minute", 1) == "ühe minuti" + assert self.locale._format_timeframe("minutes", 4) == "4 minuti" + assert self.locale._format_timeframe("minutes", 40) == "40 minuti" + assert self.locale._format_timeframe("hour", 1) == "tunni aja" + assert self.locale._format_timeframe("hours", 5) == "5 tunni" + assert self.locale._format_timeframe("hours", 23) == "23 tunni" + assert self.locale._format_timeframe("day", 1) == "ühe päeva" + assert self.locale._format_timeframe("days", 6) == "6 päeva" + assert self.locale._format_timeframe("days", 12) == "12 päeva" + assert self.locale._format_timeframe("month", 1) == "ühe kuu" + assert self.locale._format_timeframe("months", 7) == "7 kuu" + assert self.locale._format_timeframe("months", 11) == "11 kuu" + assert self.locale._format_timeframe("year", 1) == "ühe aasta" + assert self.locale._format_timeframe("years", 8) == "8 aasta" + assert self.locale._format_timeframe("years", 12) == "12 aasta" + + assert self.locale._format_timeframe("now", 0) == "just nüüd" + assert self.locale._format_timeframe("second", -1) == "üks sekund" + assert self.locale._format_timeframe("seconds", -9) == "9 sekundit" + assert self.locale._format_timeframe("seconds", -12) == "12 sekundit" + assert self.locale._format_timeframe("minute", -1) == "üks minut" + assert self.locale._format_timeframe("minutes", -2) == "2 minutit" + assert self.locale._format_timeframe("minutes", -10) == "10 minutit" + assert self.locale._format_timeframe("hour", -1) == "tund aega" + assert self.locale._format_timeframe("hours", -3) == "3 tundi" + assert self.locale._format_timeframe("hours", -11) == "11 tundi" + assert self.locale._format_timeframe("day", -1) == "üks päev" + assert self.locale._format_timeframe("days", -2) == "2 päeva" + assert self.locale._format_timeframe("days", -12) == "12 päeva" + assert self.locale._format_timeframe("month", -1) == "üks kuu" + assert self.locale._format_timeframe("months", -3) == "3 kuud" + assert self.locale._format_timeframe("months", -13) == "13 kuud" + assert self.locale._format_timeframe("year", -1) == "üks aasta" + assert self.locale._format_timeframe("years", -4) == "4 aastat" + assert self.locale._format_timeframe("years", -14) == "14 aastat" + + +@pytest.mark.usefixtures("lang_locale") +class TestPortugueseLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("now", 0) == "agora" + assert self.locale._format_timeframe("second", 1) == "um segundo" + assert self.locale._format_timeframe("seconds", 30) == "30 segundos" + assert self.locale._format_timeframe("minute", 1) == "um minuto" + assert self.locale._format_timeframe("minutes", 40) == "40 minutos" + assert self.locale._format_timeframe("hour", 1) == "uma hora" + assert self.locale._format_timeframe("hours", 23) == "23 horas" + assert self.locale._format_timeframe("day", 1) == "um dia" + assert self.locale._format_timeframe("days", 12) == "12 dias" + assert self.locale._format_timeframe("month", 1) == "um mês" + assert self.locale._format_timeframe("months", 11) == "11 meses" + assert self.locale._format_timeframe("year", 1) == "um ano" + assert self.locale._format_timeframe("years", 12) == "12 anos" + + +@pytest.mark.usefixtures("lang_locale") +class TestBrazilianPortugueseLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("now", 0) == "agora" + assert self.locale._format_timeframe("second", 1) == "um segundo" + assert self.locale._format_timeframe("seconds", 30) == "30 segundos" + assert self.locale._format_timeframe("minute", 1) == "um minuto" + assert self.locale._format_timeframe("minutes", 40) == "40 minutos" + assert self.locale._format_timeframe("hour", 1) == "uma hora" + assert self.locale._format_timeframe("hours", 23) == "23 horas" + assert self.locale._format_timeframe("day", 1) == "um dia" + assert self.locale._format_timeframe("days", 12) == "12 dias" + assert self.locale._format_timeframe("month", 1) == "um mês" + assert self.locale._format_timeframe("months", 11) == "11 meses" + assert self.locale._format_timeframe("year", 1) == "um ano" + assert self.locale._format_timeframe("years", 12) == "12 anos" + assert self.locale._format_relative("uma hora", "hour", -1) == "faz uma hora" + + +@pytest.mark.usefixtures("lang_locale") +class TestHongKongLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("now", 0) == "剛才" + assert self.locale._format_timeframe("second", 1) == "1秒" + assert self.locale._format_timeframe("seconds", 30) == "30秒" + assert self.locale._format_timeframe("minute", 1) == "1分鐘" + assert self.locale._format_timeframe("minutes", 40) == "40分鐘" + assert self.locale._format_timeframe("hour", 1) == "1小時" + assert self.locale._format_timeframe("hours", 23) == "23小時" + assert self.locale._format_timeframe("day", 1) == "1天" + assert self.locale._format_timeframe("days", 12) == "12天" + assert self.locale._format_timeframe("week", 1) == "1星期" + assert self.locale._format_timeframe("weeks", 38) == "38星期" + assert self.locale._format_timeframe("month", 1) == "1個月" + assert self.locale._format_timeframe("months", 11) == "11個月" + assert self.locale._format_timeframe("year", 1) == "1年" + assert self.locale._format_timeframe("years", 12) == "12年" + + +@pytest.mark.usefixtures("lang_locale") +class TestChineseTWLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("now", 0) == "剛才" + assert self.locale._format_timeframe("second", 1) == "1秒" + assert self.locale._format_timeframe("seconds", 30) == "30秒" + assert self.locale._format_timeframe("minute", 1) == "1分鐘" + assert self.locale._format_timeframe("minutes", 40) == "40分鐘" + assert self.locale._format_timeframe("hour", 1) == "1小時" + assert self.locale._format_timeframe("hours", 23) == "23小時" + assert self.locale._format_timeframe("day", 1) == "1天" + assert self.locale._format_timeframe("days", 12) == "12天" + assert self.locale._format_timeframe("week", 1) == "1週" + assert self.locale._format_timeframe("weeks", 38) == "38週" + assert self.locale._format_timeframe("month", 1) == "1個月" + assert self.locale._format_timeframe("months", 11) == "11個月" + assert self.locale._format_timeframe("year", 1) == "1年" + assert self.locale._format_timeframe("years", 12) == "12年" + + +@pytest.mark.usefixtures("lang_locale") +class TestSwahiliLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("now", 0) == "sasa hivi" + assert self.locale._format_timeframe("second", 1) == "sekunde" + assert self.locale._format_timeframe("seconds", 3) == "sekunde 3" + assert self.locale._format_timeframe("seconds", 30) == "sekunde 30" + assert self.locale._format_timeframe("minute", 1) == "dakika moja" + assert self.locale._format_timeframe("minutes", 4) == "dakika 4" + assert self.locale._format_timeframe("minutes", 40) == "dakika 40" + assert self.locale._format_timeframe("hour", 1) == "saa moja" + assert self.locale._format_timeframe("hours", 5) == "saa 5" + assert self.locale._format_timeframe("hours", 23) == "saa 23" + assert self.locale._format_timeframe("day", 1) == "siku moja" + assert self.locale._format_timeframe("days", 6) == "siku 6" + assert self.locale._format_timeframe("days", 12) == "siku 12" + assert self.locale._format_timeframe("month", 1) == "mwezi moja" + assert self.locale._format_timeframe("months", 7) == "miezi 7" + assert self.locale._format_timeframe("week", 1) == "wiki moja" + assert self.locale._format_timeframe("weeks", 2) == "wiki 2" + assert self.locale._format_timeframe("months", 11) == "miezi 11" + assert self.locale._format_timeframe("year", 1) == "mwaka moja" + assert self.locale._format_timeframe("years", 8) == "miaka 8" + assert self.locale._format_timeframe("years", 12) == "miaka 12" + + def test_format_relative_now(self): + result = self.locale._format_relative("sasa hivi", "now", 0) + assert result == "sasa hivi" + + def test_format_relative_past(self): + result = self.locale._format_relative("saa moja", "hour", 1) + assert result == "muda wa saa moja" + + def test_format_relative_future(self): + result = self.locale._format_relative("saa moja", "hour", -1) + assert result == "saa moja iliyopita" + + +@pytest.mark.usefixtures("lang_locale") +class TestKoreanLocale: + def test_format_timeframe(self): + assert self.locale._format_timeframe("now", 0) == "지금" + assert self.locale._format_timeframe("second", 1) == "1초" + assert self.locale._format_timeframe("seconds", 2) == "2초" + assert self.locale._format_timeframe("minute", 1) == "1분" + assert self.locale._format_timeframe("minutes", 2) == "2분" + assert self.locale._format_timeframe("hour", 1) == "한시간" + assert self.locale._format_timeframe("hours", 2) == "2시간" + assert self.locale._format_timeframe("day", 1) == "하루" + assert self.locale._format_timeframe("days", 2) == "2일" + assert self.locale._format_timeframe("week", 1) == "1주" + assert self.locale._format_timeframe("weeks", 2) == "2주" + assert self.locale._format_timeframe("month", 1) == "한달" + assert self.locale._format_timeframe("months", 2) == "2개월" + assert self.locale._format_timeframe("year", 1) == "1년" + assert self.locale._format_timeframe("years", 2) == "2년" + + def test_format_relative(self): + assert self.locale._format_relative("지금", "now", 0) == "지금" + + assert self.locale._format_relative("1초", "second", 1) == "1초 후" + assert self.locale._format_relative("2초", "seconds", 2) == "2초 후" + assert self.locale._format_relative("1분", "minute", 1) == "1분 후" + assert self.locale._format_relative("2분", "minutes", 2) == "2분 후" + assert self.locale._format_relative("한시간", "hour", 1) == "한시간 후" + assert self.locale._format_relative("2시간", "hours", 2) == "2시간 후" + assert self.locale._format_relative("하루", "day", 1) == "내일" + assert self.locale._format_relative("2일", "days", 2) == "모레" + assert self.locale._format_relative("3일", "days", 3) == "글피" + assert self.locale._format_relative("4일", "days", 4) == "그글피" + assert self.locale._format_relative("5일", "days", 5) == "5일 후" + assert self.locale._format_relative("1주", "week", 1) == "1주 후" + assert self.locale._format_relative("2주", "weeks", 2) == "2주 후" + assert self.locale._format_relative("한달", "month", 1) == "한달 후" + assert self.locale._format_relative("2개월", "months", 2) == "2개월 후" + assert self.locale._format_relative("1년", "year", 1) == "내년" + assert self.locale._format_relative("2년", "years", 2) == "내후년" + assert self.locale._format_relative("3년", "years", 3) == "3년 후" + + assert self.locale._format_relative("1초", "second", -1) == "1초 전" + assert self.locale._format_relative("2초", "seconds", -2) == "2초 전" + assert self.locale._format_relative("1분", "minute", -1) == "1분 전" + assert self.locale._format_relative("2분", "minutes", -2) == "2분 전" + assert self.locale._format_relative("한시간", "hour", -1) == "한시간 전" + assert self.locale._format_relative("2시간", "hours", -2) == "2시간 전" + assert self.locale._format_relative("하루", "day", -1) == "어제" + assert self.locale._format_relative("2일", "days", -2) == "그제" + assert self.locale._format_relative("3일", "days", -3) == "그끄제" + assert self.locale._format_relative("4일", "days", -4) == "4일 전" + assert self.locale._format_relative("1주", "week", -1) == "1주 전" + assert self.locale._format_relative("2주", "weeks", -2) == "2주 전" + assert self.locale._format_relative("한달", "month", -1) == "한달 전" + assert self.locale._format_relative("2개월", "months", -2) == "2개월 전" + assert self.locale._format_relative("1년", "year", -1) == "작년" + assert self.locale._format_relative("2년", "years", -2) == "제작년" + assert self.locale._format_relative("3년", "years", -3) == "3년 전" + + def test_ordinal_number(self): + assert self.locale.ordinal_number(0) == "0번째" + assert self.locale.ordinal_number(1) == "첫번째" + assert self.locale.ordinal_number(2) == "두번째" + assert self.locale.ordinal_number(3) == "세번째" + assert self.locale.ordinal_number(4) == "네번째" + assert self.locale.ordinal_number(5) == "다섯번째" + assert self.locale.ordinal_number(6) == "여섯번째" + assert self.locale.ordinal_number(7) == "일곱번째" + assert self.locale.ordinal_number(8) == "여덟번째" + assert self.locale.ordinal_number(9) == "아홉번째" + assert self.locale.ordinal_number(10) == "열번째" + assert self.locale.ordinal_number(11) == "11번째" + assert self.locale.ordinal_number(12) == "12번째" + assert self.locale.ordinal_number(100) == "100번째" diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/test_parser.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_parser.py new file mode 100644 index 0000000000..9fb4e68f3c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_parser.py @@ -0,0 +1,1657 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +import calendar +import os +import time +from datetime import datetime + +import pytest +from dateutil import tz + +import arrow +from arrow import formatter, parser +from arrow.constants import MAX_TIMESTAMP_US +from arrow.parser import DateTimeParser, ParserError, ParserMatchError + +from .utils import make_full_tz_list + + +@pytest.mark.usefixtures("dt_parser") +class TestDateTimeParser: + def test_parse_multiformat(self, mocker): + mocker.patch( + "arrow.parser.DateTimeParser.parse", + string="str", + fmt="fmt_a", + side_effect=parser.ParserError, + ) + + with pytest.raises(parser.ParserError): + self.parser._parse_multiformat("str", ["fmt_a"]) + + mock_datetime = mocker.Mock() + mocker.patch( + "arrow.parser.DateTimeParser.parse", + string="str", + fmt="fmt_b", + return_value=mock_datetime, + ) + + result = self.parser._parse_multiformat("str", ["fmt_a", "fmt_b"]) + assert result == mock_datetime + + def test_parse_multiformat_all_fail(self, mocker): + mocker.patch( + "arrow.parser.DateTimeParser.parse", + string="str", + fmt="fmt_a", + side_effect=parser.ParserError, + ) + + mocker.patch( + "arrow.parser.DateTimeParser.parse", + string="str", + fmt="fmt_b", + side_effect=parser.ParserError, + ) + + with pytest.raises(parser.ParserError): + self.parser._parse_multiformat("str", ["fmt_a", "fmt_b"]) + + def test_parse_multiformat_unself_expected_fail(self, mocker): + class UnselfExpectedError(Exception): + pass + + mocker.patch( + "arrow.parser.DateTimeParser.parse", + string="str", + fmt="fmt_a", + side_effect=UnselfExpectedError, + ) + + with pytest.raises(UnselfExpectedError): + self.parser._parse_multiformat("str", ["fmt_a", "fmt_b"]) + + def test_parse_token_nonsense(self): + parts = {} + self.parser._parse_token("NONSENSE", "1900", parts) + assert parts == {} + + def test_parse_token_invalid_meridians(self): + parts = {} + self.parser._parse_token("A", "a..m", parts) + assert parts == {} + self.parser._parse_token("a", "p..m", parts) + assert parts == {} + + def test_parser_no_caching(self, mocker): + + mocked_parser = mocker.patch( + "arrow.parser.DateTimeParser._generate_pattern_re", fmt="fmt_a" + ) + self.parser = parser.DateTimeParser(cache_size=0) + for _ in range(100): + self.parser._generate_pattern_re("fmt_a") + assert mocked_parser.call_count == 100 + + def test_parser_1_line_caching(self, mocker): + mocked_parser = mocker.patch("arrow.parser.DateTimeParser._generate_pattern_re") + self.parser = parser.DateTimeParser(cache_size=1) + + for _ in range(100): + self.parser._generate_pattern_re(fmt="fmt_a") + assert mocked_parser.call_count == 1 + assert mocked_parser.call_args_list[0] == mocker.call(fmt="fmt_a") + + for _ in range(100): + self.parser._generate_pattern_re(fmt="fmt_b") + assert mocked_parser.call_count == 2 + assert mocked_parser.call_args_list[1] == mocker.call(fmt="fmt_b") + + for _ in range(100): + self.parser._generate_pattern_re(fmt="fmt_a") + assert mocked_parser.call_count == 3 + assert mocked_parser.call_args_list[2] == mocker.call(fmt="fmt_a") + + def test_parser_multiple_line_caching(self, mocker): + mocked_parser = mocker.patch("arrow.parser.DateTimeParser._generate_pattern_re") + self.parser = parser.DateTimeParser(cache_size=2) + + for _ in range(100): + self.parser._generate_pattern_re(fmt="fmt_a") + assert mocked_parser.call_count == 1 + assert mocked_parser.call_args_list[0] == mocker.call(fmt="fmt_a") + + for _ in range(100): + self.parser._generate_pattern_re(fmt="fmt_b") + assert mocked_parser.call_count == 2 + assert mocked_parser.call_args_list[1] == mocker.call(fmt="fmt_b") + + # fmt_a and fmt_b are in the cache, so no new calls should be made + for _ in range(100): + self.parser._generate_pattern_re(fmt="fmt_a") + for _ in range(100): + self.parser._generate_pattern_re(fmt="fmt_b") + assert mocked_parser.call_count == 2 + assert mocked_parser.call_args_list[0] == mocker.call(fmt="fmt_a") + assert mocked_parser.call_args_list[1] == mocker.call(fmt="fmt_b") + + def test_YY_and_YYYY_format_list(self): + + assert self.parser.parse("15/01/19", ["DD/MM/YY", "DD/MM/YYYY"]) == datetime( + 2019, 1, 15 + ) + + # Regression test for issue #580 + assert self.parser.parse("15/01/2019", ["DD/MM/YY", "DD/MM/YYYY"]) == datetime( + 2019, 1, 15 + ) + + assert ( + self.parser.parse( + "15/01/2019T04:05:06.789120Z", + ["D/M/YYThh:mm:ss.SZ", "D/M/YYYYThh:mm:ss.SZ"], + ) + == datetime(2019, 1, 15, 4, 5, 6, 789120, tzinfo=tz.tzutc()) + ) + + # regression test for issue #447 + def test_timestamp_format_list(self): + # should not match on the "X" token + assert ( + self.parser.parse( + "15 Jul 2000", + ["MM/DD/YYYY", "YYYY-MM-DD", "X", "DD-MMMM-YYYY", "D MMM YYYY"], + ) + == datetime(2000, 7, 15) + ) + + with pytest.raises(ParserError): + self.parser.parse("15 Jul", "X") + + +@pytest.mark.usefixtures("dt_parser") +class TestDateTimeParserParse: + def test_parse_list(self, mocker): + + mocker.patch( + "arrow.parser.DateTimeParser._parse_multiformat", + string="str", + formats=["fmt_a", "fmt_b"], + return_value="result", + ) + + result = self.parser.parse("str", ["fmt_a", "fmt_b"]) + assert result == "result" + + def test_parse_unrecognized_token(self, mocker): + + mocker.patch.dict("arrow.parser.DateTimeParser._BASE_INPUT_RE_MAP") + del arrow.parser.DateTimeParser._BASE_INPUT_RE_MAP["YYYY"] + + # need to make another local parser to apply patch changes + _parser = parser.DateTimeParser() + with pytest.raises(parser.ParserError): + _parser.parse("2013-01-01", "YYYY-MM-DD") + + def test_parse_parse_no_match(self): + + with pytest.raises(ParserError): + self.parser.parse("01-01", "YYYY-MM-DD") + + def test_parse_separators(self): + + with pytest.raises(ParserError): + self.parser.parse("1403549231", "YYYY-MM-DD") + + def test_parse_numbers(self): + + self.expected = datetime(2012, 1, 1, 12, 5, 10) + assert ( + self.parser.parse("2012-01-01 12:05:10", "YYYY-MM-DD HH:mm:ss") + == self.expected + ) + + def test_parse_year_two_digit(self): + + self.expected = datetime(1979, 1, 1, 12, 5, 10) + assert ( + self.parser.parse("79-01-01 12:05:10", "YY-MM-DD HH:mm:ss") == self.expected + ) + + def test_parse_timestamp(self): + + tz_utc = tz.tzutc() + int_timestamp = int(time.time()) + self.expected = datetime.fromtimestamp(int_timestamp, tz=tz_utc) + assert self.parser.parse("{:d}".format(int_timestamp), "X") == self.expected + + float_timestamp = time.time() + self.expected = datetime.fromtimestamp(float_timestamp, tz=tz_utc) + assert self.parser.parse("{:f}".format(float_timestamp), "X") == self.expected + + # test handling of ns timestamp (arrow will round to 6 digits regardless) + self.expected = datetime.fromtimestamp(float_timestamp, tz=tz_utc) + assert ( + self.parser.parse("{:f}123".format(float_timestamp), "X") == self.expected + ) + + # test ps timestamp (arrow will round to 6 digits regardless) + self.expected = datetime.fromtimestamp(float_timestamp, tz=tz_utc) + assert ( + self.parser.parse("{:f}123456".format(float_timestamp), "X") + == self.expected + ) + + # NOTE: negative timestamps cannot be handled by datetime on Window + # Must use timedelta to handle them. ref: https://stackoverflow.com/questions/36179914 + if os.name != "nt": + # regression test for issue #662 + negative_int_timestamp = -int_timestamp + self.expected = datetime.fromtimestamp(negative_int_timestamp, tz=tz_utc) + assert ( + self.parser.parse("{:d}".format(negative_int_timestamp), "X") + == self.expected + ) + + negative_float_timestamp = -float_timestamp + self.expected = datetime.fromtimestamp(negative_float_timestamp, tz=tz_utc) + assert ( + self.parser.parse("{:f}".format(negative_float_timestamp), "X") + == self.expected + ) + + # NOTE: timestamps cannot be parsed from natural language strings (by removing the ^...$) because it will + # break cases like "15 Jul 2000" and a format list (see issue #447) + with pytest.raises(ParserError): + natural_lang_string = "Meet me at {} at the restaurant.".format( + float_timestamp + ) + self.parser.parse(natural_lang_string, "X") + + with pytest.raises(ParserError): + self.parser.parse("1565982019.", "X") + + with pytest.raises(ParserError): + self.parser.parse(".1565982019", "X") + + def test_parse_expanded_timestamp(self): + # test expanded timestamps that include milliseconds + # and microseconds as multiples rather than decimals + # requested in issue #357 + + tz_utc = tz.tzutc() + timestamp = 1569982581.413132 + timestamp_milli = int(round(timestamp * 1000)) + timestamp_micro = int(round(timestamp * 1000000)) + + # "x" token should parse integer timestamps below MAX_TIMESTAMP normally + self.expected = datetime.fromtimestamp(int(timestamp), tz=tz_utc) + assert self.parser.parse("{:d}".format(int(timestamp)), "x") == self.expected + + self.expected = datetime.fromtimestamp(round(timestamp, 3), tz=tz_utc) + assert self.parser.parse("{:d}".format(timestamp_milli), "x") == self.expected + + self.expected = datetime.fromtimestamp(timestamp, tz=tz_utc) + assert self.parser.parse("{:d}".format(timestamp_micro), "x") == self.expected + + # anything above max µs timestamp should fail + with pytest.raises(ValueError): + self.parser.parse("{:d}".format(int(MAX_TIMESTAMP_US) + 1), "x") + + # floats are not allowed with the "x" token + with pytest.raises(ParserMatchError): + self.parser.parse("{:f}".format(timestamp), "x") + + def test_parse_names(self): + + self.expected = datetime(2012, 1, 1) + + assert self.parser.parse("January 1, 2012", "MMMM D, YYYY") == self.expected + assert self.parser.parse("Jan 1, 2012", "MMM D, YYYY") == self.expected + + def test_parse_pm(self): + + self.expected = datetime(1, 1, 1, 13, 0, 0) + assert self.parser.parse("1 pm", "H a") == self.expected + assert self.parser.parse("1 pm", "h a") == self.expected + + self.expected = datetime(1, 1, 1, 1, 0, 0) + assert self.parser.parse("1 am", "H A") == self.expected + assert self.parser.parse("1 am", "h A") == self.expected + + self.expected = datetime(1, 1, 1, 0, 0, 0) + assert self.parser.parse("12 am", "H A") == self.expected + assert self.parser.parse("12 am", "h A") == self.expected + + self.expected = datetime(1, 1, 1, 12, 0, 0) + assert self.parser.parse("12 pm", "H A") == self.expected + assert self.parser.parse("12 pm", "h A") == self.expected + + def test_parse_tz_hours_only(self): + + self.expected = datetime(2025, 10, 17, 5, 30, 10, tzinfo=tz.tzoffset(None, 0)) + parsed = self.parser.parse("2025-10-17 05:30:10+00", "YYYY-MM-DD HH:mm:ssZ") + assert parsed == self.expected + + def test_parse_tz_zz(self): + + self.expected = datetime(2013, 1, 1, tzinfo=tz.tzoffset(None, -7 * 3600)) + assert self.parser.parse("2013-01-01 -07:00", "YYYY-MM-DD ZZ") == self.expected + + @pytest.mark.parametrize("full_tz_name", make_full_tz_list()) + def test_parse_tz_name_zzz(self, full_tz_name): + + self.expected = datetime(2013, 1, 1, tzinfo=tz.gettz(full_tz_name)) + assert ( + self.parser.parse("2013-01-01 {}".format(full_tz_name), "YYYY-MM-DD ZZZ") + == self.expected + ) + + # note that offsets are not timezones + with pytest.raises(ParserError): + self.parser.parse("2013-01-01 12:30:45.9+1000", "YYYY-MM-DDZZZ") + + with pytest.raises(ParserError): + self.parser.parse("2013-01-01 12:30:45.9+10:00", "YYYY-MM-DDZZZ") + + with pytest.raises(ParserError): + self.parser.parse("2013-01-01 12:30:45.9-10", "YYYY-MM-DDZZZ") + + def test_parse_subsecond(self): + self.expected = datetime(2013, 1, 1, 12, 30, 45, 900000) + assert ( + self.parser.parse("2013-01-01 12:30:45.9", "YYYY-MM-DD HH:mm:ss.S") + == self.expected + ) + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 980000) + assert ( + self.parser.parse("2013-01-01 12:30:45.98", "YYYY-MM-DD HH:mm:ss.SS") + == self.expected + ) + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987000) + assert ( + self.parser.parse("2013-01-01 12:30:45.987", "YYYY-MM-DD HH:mm:ss.SSS") + == self.expected + ) + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987600) + assert ( + self.parser.parse("2013-01-01 12:30:45.9876", "YYYY-MM-DD HH:mm:ss.SSSS") + == self.expected + ) + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987650) + assert ( + self.parser.parse("2013-01-01 12:30:45.98765", "YYYY-MM-DD HH:mm:ss.SSSSS") + == self.expected + ) + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987654) + assert ( + self.parser.parse( + "2013-01-01 12:30:45.987654", "YYYY-MM-DD HH:mm:ss.SSSSSS" + ) + == self.expected + ) + + def test_parse_subsecond_rounding(self): + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987654) + datetime_format = "YYYY-MM-DD HH:mm:ss.S" + + # round up + string = "2013-01-01 12:30:45.9876539" + assert self.parser.parse(string, datetime_format) == self.expected + assert self.parser.parse_iso(string) == self.expected + + # round down + string = "2013-01-01 12:30:45.98765432" + assert self.parser.parse(string, datetime_format) == self.expected + assert self.parser.parse_iso(string) == self.expected + + # round half-up + string = "2013-01-01 12:30:45.987653521" + assert self.parser.parse(string, datetime_format) == self.expected + assert self.parser.parse_iso(string) == self.expected + + # round half-down + string = "2013-01-01 12:30:45.9876545210" + assert self.parser.parse(string, datetime_format) == self.expected + assert self.parser.parse_iso(string) == self.expected + + # overflow (zero out the subseconds and increment the seconds) + # regression tests for issue #636 + def test_parse_subsecond_rounding_overflow(self): + datetime_format = "YYYY-MM-DD HH:mm:ss.S" + + self.expected = datetime(2013, 1, 1, 12, 30, 46) + string = "2013-01-01 12:30:45.9999995" + assert self.parser.parse(string, datetime_format) == self.expected + assert self.parser.parse_iso(string) == self.expected + + self.expected = datetime(2013, 1, 1, 12, 31, 0) + string = "2013-01-01 12:30:59.9999999" + assert self.parser.parse(string, datetime_format) == self.expected + assert self.parser.parse_iso(string) == self.expected + + self.expected = datetime(2013, 1, 2, 0, 0, 0) + string = "2013-01-01 23:59:59.9999999" + assert self.parser.parse(string, datetime_format) == self.expected + assert self.parser.parse_iso(string) == self.expected + + # 6 digits should remain unrounded + self.expected = datetime(2013, 1, 1, 12, 30, 45, 999999) + string = "2013-01-01 12:30:45.999999" + assert self.parser.parse(string, datetime_format) == self.expected + assert self.parser.parse_iso(string) == self.expected + + # Regression tests for issue #560 + def test_parse_long_year(self): + with pytest.raises(ParserError): + self.parser.parse("09 January 123456789101112", "DD MMMM YYYY") + + with pytest.raises(ParserError): + self.parser.parse("123456789101112 09 January", "YYYY DD MMMM") + + with pytest.raises(ParserError): + self.parser.parse("68096653015/01/19", "YY/M/DD") + + def test_parse_with_extra_words_at_start_and_end_invalid(self): + input_format_pairs = [ + ("blah2016", "YYYY"), + ("blah2016blah", "YYYY"), + ("2016blah", "YYYY"), + ("2016-05blah", "YYYY-MM"), + ("2016-05-16blah", "YYYY-MM-DD"), + ("2016-05-16T04:05:06.789120blah", "YYYY-MM-DDThh:mm:ss.S"), + ("2016-05-16T04:05:06.789120ZblahZ", "YYYY-MM-DDThh:mm:ss.SZ"), + ("2016-05-16T04:05:06.789120Zblah", "YYYY-MM-DDThh:mm:ss.SZ"), + ("2016-05-16T04:05:06.789120blahZ", "YYYY-MM-DDThh:mm:ss.SZ"), + ] + + for pair in input_format_pairs: + with pytest.raises(ParserError): + self.parser.parse(pair[0], pair[1]) + + def test_parse_with_extra_words_at_start_and_end_valid(self): + # Spaces surrounding the parsable date are ok because we + # allow the parsing of natural language input. Additionally, a single + # character of specific punctuation before or after the date is okay. + # See docs for full list of valid punctuation. + + assert self.parser.parse("blah 2016 blah", "YYYY") == datetime(2016, 1, 1) + + assert self.parser.parse("blah 2016", "YYYY") == datetime(2016, 1, 1) + + assert self.parser.parse("2016 blah", "YYYY") == datetime(2016, 1, 1) + + # test one additional space along with space divider + assert self.parser.parse( + "blah 2016-05-16 04:05:06.789120", "YYYY-MM-DD hh:mm:ss.S" + ) == datetime(2016, 5, 16, 4, 5, 6, 789120) + + assert self.parser.parse( + "2016-05-16 04:05:06.789120 blah", "YYYY-MM-DD hh:mm:ss.S" + ) == datetime(2016, 5, 16, 4, 5, 6, 789120) + + # test one additional space along with T divider + assert self.parser.parse( + "blah 2016-05-16T04:05:06.789120", "YYYY-MM-DDThh:mm:ss.S" + ) == datetime(2016, 5, 16, 4, 5, 6, 789120) + + assert self.parser.parse( + "2016-05-16T04:05:06.789120 blah", "YYYY-MM-DDThh:mm:ss.S" + ) == datetime(2016, 5, 16, 4, 5, 6, 789120) + + assert ( + self.parser.parse( + "Meet me at 2016-05-16T04:05:06.789120 at the restaurant.", + "YYYY-MM-DDThh:mm:ss.S", + ) + == datetime(2016, 5, 16, 4, 5, 6, 789120) + ) + + assert ( + self.parser.parse( + "Meet me at 2016-05-16 04:05:06.789120 at the restaurant.", + "YYYY-MM-DD hh:mm:ss.S", + ) + == datetime(2016, 5, 16, 4, 5, 6, 789120) + ) + + # regression test for issue #701 + # tests cases of a partial match surrounded by punctuation + # for the list of valid punctuation, see documentation + def test_parse_with_punctuation_fences(self): + assert self.parser.parse( + "Meet me at my house on Halloween (2019-31-10)", "YYYY-DD-MM" + ) == datetime(2019, 10, 31) + + assert self.parser.parse( + "Monday, 9. September 2019, 16:15-20:00", "dddd, D. MMMM YYYY" + ) == datetime(2019, 9, 9) + + assert self.parser.parse("A date is 11.11.2011.", "DD.MM.YYYY") == datetime( + 2011, 11, 11 + ) + + with pytest.raises(ParserMatchError): + self.parser.parse("11.11.2011.1 is not a valid date.", "DD.MM.YYYY") + + with pytest.raises(ParserMatchError): + self.parser.parse( + "This date has too many punctuation marks following it (11.11.2011).", + "DD.MM.YYYY", + ) + + def test_parse_with_leading_and_trailing_whitespace(self): + assert self.parser.parse(" 2016", "YYYY") == datetime(2016, 1, 1) + + assert self.parser.parse("2016 ", "YYYY") == datetime(2016, 1, 1) + + assert self.parser.parse(" 2016 ", "YYYY") == datetime(2016, 1, 1) + + assert self.parser.parse( + " 2016-05-16 04:05:06.789120 ", "YYYY-MM-DD hh:mm:ss.S" + ) == datetime(2016, 5, 16, 4, 5, 6, 789120) + + assert self.parser.parse( + " 2016-05-16T04:05:06.789120 ", "YYYY-MM-DDThh:mm:ss.S" + ) == datetime(2016, 5, 16, 4, 5, 6, 789120) + + def test_parse_YYYY_DDDD(self): + assert self.parser.parse("1998-136", "YYYY-DDDD") == datetime(1998, 5, 16) + + assert self.parser.parse("1998-006", "YYYY-DDDD") == datetime(1998, 1, 6) + + with pytest.raises(ParserError): + self.parser.parse("1998-456", "YYYY-DDDD") + + def test_parse_YYYY_DDD(self): + assert self.parser.parse("1998-6", "YYYY-DDD") == datetime(1998, 1, 6) + + assert self.parser.parse("1998-136", "YYYY-DDD") == datetime(1998, 5, 16) + + with pytest.raises(ParserError): + self.parser.parse("1998-756", "YYYY-DDD") + + # month cannot be passed with DDD and DDDD tokens + def test_parse_YYYY_MM_DDDD(self): + with pytest.raises(ParserError): + self.parser.parse("2015-01-009", "YYYY-MM-DDDD") + + # year is required with the DDD and DDDD tokens + def test_parse_DDD_only(self): + with pytest.raises(ParserError): + self.parser.parse("5", "DDD") + + def test_parse_DDDD_only(self): + with pytest.raises(ParserError): + self.parser.parse("145", "DDDD") + + def test_parse_ddd_and_dddd(self): + fr_parser = parser.DateTimeParser("fr") + + # Day of week should be ignored when a day is passed + # 2019-10-17 is a Thursday, so we know day of week + # is ignored if the same date is outputted + expected = datetime(2019, 10, 17) + assert self.parser.parse("Tue 2019-10-17", "ddd YYYY-MM-DD") == expected + assert fr_parser.parse("mar 2019-10-17", "ddd YYYY-MM-DD") == expected + assert self.parser.parse("Tuesday 2019-10-17", "dddd YYYY-MM-DD") == expected + assert fr_parser.parse("mardi 2019-10-17", "dddd YYYY-MM-DD") == expected + + # Get first Tuesday after epoch + expected = datetime(1970, 1, 6) + assert self.parser.parse("Tue", "ddd") == expected + assert fr_parser.parse("mar", "ddd") == expected + assert self.parser.parse("Tuesday", "dddd") == expected + assert fr_parser.parse("mardi", "dddd") == expected + + # Get first Tuesday in 2020 + expected = datetime(2020, 1, 7) + assert self.parser.parse("Tue 2020", "ddd YYYY") == expected + assert fr_parser.parse("mar 2020", "ddd YYYY") == expected + assert self.parser.parse("Tuesday 2020", "dddd YYYY") == expected + assert fr_parser.parse("mardi 2020", "dddd YYYY") == expected + + # Get first Tuesday in February 2020 + expected = datetime(2020, 2, 4) + assert self.parser.parse("Tue 02 2020", "ddd MM YYYY") == expected + assert fr_parser.parse("mar 02 2020", "ddd MM YYYY") == expected + assert self.parser.parse("Tuesday 02 2020", "dddd MM YYYY") == expected + assert fr_parser.parse("mardi 02 2020", "dddd MM YYYY") == expected + + # Get first Tuesday in February after epoch + expected = datetime(1970, 2, 3) + assert self.parser.parse("Tue 02", "ddd MM") == expected + assert fr_parser.parse("mar 02", "ddd MM") == expected + assert self.parser.parse("Tuesday 02", "dddd MM") == expected + assert fr_parser.parse("mardi 02", "dddd MM") == expected + + # Times remain intact + expected = datetime(2020, 2, 4, 10, 25, 54, 123456, tz.tzoffset(None, -3600)) + assert ( + self.parser.parse( + "Tue 02 2020 10:25:54.123456-01:00", "ddd MM YYYY HH:mm:ss.SZZ" + ) + == expected + ) + assert ( + fr_parser.parse( + "mar 02 2020 10:25:54.123456-01:00", "ddd MM YYYY HH:mm:ss.SZZ" + ) + == expected + ) + assert ( + self.parser.parse( + "Tuesday 02 2020 10:25:54.123456-01:00", "dddd MM YYYY HH:mm:ss.SZZ" + ) + == expected + ) + assert ( + fr_parser.parse( + "mardi 02 2020 10:25:54.123456-01:00", "dddd MM YYYY HH:mm:ss.SZZ" + ) + == expected + ) + + def test_parse_ddd_and_dddd_ignore_case(self): + # Regression test for issue #851 + expected = datetime(2019, 6, 24) + assert ( + self.parser.parse("MONDAY, June 24, 2019", "dddd, MMMM DD, YYYY") + == expected + ) + + def test_parse_ddd_and_dddd_then_format(self): + # Regression test for issue #446 + arw_formatter = formatter.DateTimeFormatter() + assert arw_formatter.format(self.parser.parse("Mon", "ddd"), "ddd") == "Mon" + assert ( + arw_formatter.format(self.parser.parse("Monday", "dddd"), "dddd") + == "Monday" + ) + assert arw_formatter.format(self.parser.parse("Tue", "ddd"), "ddd") == "Tue" + assert ( + arw_formatter.format(self.parser.parse("Tuesday", "dddd"), "dddd") + == "Tuesday" + ) + assert arw_formatter.format(self.parser.parse("Wed", "ddd"), "ddd") == "Wed" + assert ( + arw_formatter.format(self.parser.parse("Wednesday", "dddd"), "dddd") + == "Wednesday" + ) + assert arw_formatter.format(self.parser.parse("Thu", "ddd"), "ddd") == "Thu" + assert ( + arw_formatter.format(self.parser.parse("Thursday", "dddd"), "dddd") + == "Thursday" + ) + assert arw_formatter.format(self.parser.parse("Fri", "ddd"), "ddd") == "Fri" + assert ( + arw_formatter.format(self.parser.parse("Friday", "dddd"), "dddd") + == "Friday" + ) + assert arw_formatter.format(self.parser.parse("Sat", "ddd"), "ddd") == "Sat" + assert ( + arw_formatter.format(self.parser.parse("Saturday", "dddd"), "dddd") + == "Saturday" + ) + assert arw_formatter.format(self.parser.parse("Sun", "ddd"), "ddd") == "Sun" + assert ( + arw_formatter.format(self.parser.parse("Sunday", "dddd"), "dddd") + == "Sunday" + ) + + def test_parse_HH_24(self): + assert self.parser.parse( + "2019-10-30T24:00:00", "YYYY-MM-DDTHH:mm:ss" + ) == datetime(2019, 10, 31, 0, 0, 0, 0) + assert self.parser.parse("2019-10-30T24:00", "YYYY-MM-DDTHH:mm") == datetime( + 2019, 10, 31, 0, 0, 0, 0 + ) + assert self.parser.parse("2019-10-30T24", "YYYY-MM-DDTHH") == datetime( + 2019, 10, 31, 0, 0, 0, 0 + ) + assert self.parser.parse( + "2019-10-30T24:00:00.0", "YYYY-MM-DDTHH:mm:ss.S" + ) == datetime(2019, 10, 31, 0, 0, 0, 0) + assert self.parser.parse( + "2019-10-31T24:00:00", "YYYY-MM-DDTHH:mm:ss" + ) == datetime(2019, 11, 1, 0, 0, 0, 0) + assert self.parser.parse( + "2019-12-31T24:00:00", "YYYY-MM-DDTHH:mm:ss" + ) == datetime(2020, 1, 1, 0, 0, 0, 0) + assert self.parser.parse( + "2019-12-31T23:59:59.9999999", "YYYY-MM-DDTHH:mm:ss.S" + ) == datetime(2020, 1, 1, 0, 0, 0, 0) + + with pytest.raises(ParserError): + self.parser.parse("2019-12-31T24:01:00", "YYYY-MM-DDTHH:mm:ss") + + with pytest.raises(ParserError): + self.parser.parse("2019-12-31T24:00:01", "YYYY-MM-DDTHH:mm:ss") + + with pytest.raises(ParserError): + self.parser.parse("2019-12-31T24:00:00.1", "YYYY-MM-DDTHH:mm:ss.S") + + with pytest.raises(ParserError): + self.parser.parse("2019-12-31T24:00:00.999999", "YYYY-MM-DDTHH:mm:ss.S") + + def test_parse_W(self): + + assert self.parser.parse("2011-W05-4", "W") == datetime(2011, 2, 3) + assert self.parser.parse("2011W054", "W") == datetime(2011, 2, 3) + assert self.parser.parse("2011-W05", "W") == datetime(2011, 1, 31) + assert self.parser.parse("2011W05", "W") == datetime(2011, 1, 31) + assert self.parser.parse("2011-W05-4T14:17:01", "WTHH:mm:ss") == datetime( + 2011, 2, 3, 14, 17, 1 + ) + assert self.parser.parse("2011W054T14:17:01", "WTHH:mm:ss") == datetime( + 2011, 2, 3, 14, 17, 1 + ) + assert self.parser.parse("2011-W05T14:17:01", "WTHH:mm:ss") == datetime( + 2011, 1, 31, 14, 17, 1 + ) + assert self.parser.parse("2011W05T141701", "WTHHmmss") == datetime( + 2011, 1, 31, 14, 17, 1 + ) + assert self.parser.parse("2011W054T141701", "WTHHmmss") == datetime( + 2011, 2, 3, 14, 17, 1 + ) + + bad_formats = [ + "201W22", + "1995-W1-4", + "2001-W34-90", + "2001--W34", + "2011-W03--3", + "thstrdjtrsrd676776r65", + "2002-W66-1T14:17:01", + "2002-W23-03T14:17:01", + ] + + for fmt in bad_formats: + with pytest.raises(ParserError): + self.parser.parse(fmt, "W") + + def test_parse_normalize_whitespace(self): + assert self.parser.parse( + "Jun 1 2005 1:33PM", "MMM D YYYY H:mmA", normalize_whitespace=True + ) == datetime(2005, 6, 1, 13, 33) + + with pytest.raises(ParserError): + self.parser.parse("Jun 1 2005 1:33PM", "MMM D YYYY H:mmA") + + assert ( + self.parser.parse( + "\t 2013-05-05 T \n 12:30:45\t123456 \t \n", + "YYYY-MM-DD T HH:mm:ss S", + normalize_whitespace=True, + ) + == datetime(2013, 5, 5, 12, 30, 45, 123456) + ) + + with pytest.raises(ParserError): + self.parser.parse( + "\t 2013-05-05 T \n 12:30:45\t123456 \t \n", + "YYYY-MM-DD T HH:mm:ss S", + ) + + assert self.parser.parse( + " \n Jun 1\t 2005\n ", "MMM D YYYY", normalize_whitespace=True + ) == datetime(2005, 6, 1) + + with pytest.raises(ParserError): + self.parser.parse(" \n Jun 1\t 2005\n ", "MMM D YYYY") + + +@pytest.mark.usefixtures("dt_parser_regex") +class TestDateTimeParserRegex: + def test_format_year(self): + + assert self.format_regex.findall("YYYY-YY") == ["YYYY", "YY"] + + def test_format_month(self): + + assert self.format_regex.findall("MMMM-MMM-MM-M") == ["MMMM", "MMM", "MM", "M"] + + def test_format_day(self): + + assert self.format_regex.findall("DDDD-DDD-DD-D") == ["DDDD", "DDD", "DD", "D"] + + def test_format_hour(self): + + assert self.format_regex.findall("HH-H-hh-h") == ["HH", "H", "hh", "h"] + + def test_format_minute(self): + + assert self.format_regex.findall("mm-m") == ["mm", "m"] + + def test_format_second(self): + + assert self.format_regex.findall("ss-s") == ["ss", "s"] + + def test_format_subsecond(self): + + assert self.format_regex.findall("SSSSSS-SSSSS-SSSS-SSS-SS-S") == [ + "SSSSSS", + "SSSSS", + "SSSS", + "SSS", + "SS", + "S", + ] + + def test_format_tz(self): + + assert self.format_regex.findall("ZZZ-ZZ-Z") == ["ZZZ", "ZZ", "Z"] + + def test_format_am_pm(self): + + assert self.format_regex.findall("A-a") == ["A", "a"] + + def test_format_timestamp(self): + + assert self.format_regex.findall("X") == ["X"] + + def test_format_timestamp_milli(self): + + assert self.format_regex.findall("x") == ["x"] + + def test_escape(self): + + escape_regex = parser.DateTimeParser._ESCAPE_RE + + assert escape_regex.findall("2018-03-09 8 [h] 40 [hello]") == ["[h]", "[hello]"] + + def test_month_names(self): + p = parser.DateTimeParser("en_us") + + text = "_".join(calendar.month_name[1:]) + + result = p._input_re_map["MMMM"].findall(text) + + assert result == calendar.month_name[1:] + + def test_month_abbreviations(self): + p = parser.DateTimeParser("en_us") + + text = "_".join(calendar.month_abbr[1:]) + + result = p._input_re_map["MMM"].findall(text) + + assert result == calendar.month_abbr[1:] + + def test_digits(self): + + assert parser.DateTimeParser._ONE_OR_TWO_DIGIT_RE.findall("4-56") == ["4", "56"] + assert parser.DateTimeParser._ONE_OR_TWO_OR_THREE_DIGIT_RE.findall( + "4-56-789" + ) == ["4", "56", "789"] + assert parser.DateTimeParser._ONE_OR_MORE_DIGIT_RE.findall( + "4-56-789-1234-12345" + ) == ["4", "56", "789", "1234", "12345"] + assert parser.DateTimeParser._TWO_DIGIT_RE.findall("12-3-45") == ["12", "45"] + assert parser.DateTimeParser._THREE_DIGIT_RE.findall("123-4-56") == ["123"] + assert parser.DateTimeParser._FOUR_DIGIT_RE.findall("1234-56") == ["1234"] + + def test_tz(self): + tz_z_re = parser.DateTimeParser._TZ_Z_RE + assert tz_z_re.findall("-0700") == [("-", "07", "00")] + assert tz_z_re.findall("+07") == [("+", "07", "")] + assert tz_z_re.search("15/01/2019T04:05:06.789120Z") is not None + assert tz_z_re.search("15/01/2019T04:05:06.789120") is None + + tz_zz_re = parser.DateTimeParser._TZ_ZZ_RE + assert tz_zz_re.findall("-07:00") == [("-", "07", "00")] + assert tz_zz_re.findall("+07") == [("+", "07", "")] + assert tz_zz_re.search("15/01/2019T04:05:06.789120Z") is not None + assert tz_zz_re.search("15/01/2019T04:05:06.789120") is None + + tz_name_re = parser.DateTimeParser._TZ_NAME_RE + assert tz_name_re.findall("Europe/Warsaw") == ["Europe/Warsaw"] + assert tz_name_re.findall("GMT") == ["GMT"] + + def test_timestamp(self): + timestamp_re = parser.DateTimeParser._TIMESTAMP_RE + assert timestamp_re.findall("1565707550.452729") == ["1565707550.452729"] + assert timestamp_re.findall("-1565707550.452729") == ["-1565707550.452729"] + assert timestamp_re.findall("-1565707550") == ["-1565707550"] + assert timestamp_re.findall("1565707550") == ["1565707550"] + assert timestamp_re.findall("1565707550.") == [] + assert timestamp_re.findall(".1565707550") == [] + + def test_timestamp_milli(self): + timestamp_expanded_re = parser.DateTimeParser._TIMESTAMP_EXPANDED_RE + assert timestamp_expanded_re.findall("-1565707550") == ["-1565707550"] + assert timestamp_expanded_re.findall("1565707550") == ["1565707550"] + assert timestamp_expanded_re.findall("1565707550.452729") == [] + assert timestamp_expanded_re.findall("1565707550.") == [] + assert timestamp_expanded_re.findall(".1565707550") == [] + + def test_time(self): + time_re = parser.DateTimeParser._TIME_RE + time_seperators = [":", ""] + + for sep in time_seperators: + assert time_re.findall("12") == [("12", "", "", "", "")] + assert time_re.findall("12{sep}35".format(sep=sep)) == [ + ("12", "35", "", "", "") + ] + assert time_re.findall("12{sep}35{sep}46".format(sep=sep)) == [ + ("12", "35", "46", "", "") + ] + assert time_re.findall("12{sep}35{sep}46.952313".format(sep=sep)) == [ + ("12", "35", "46", ".", "952313") + ] + assert time_re.findall("12{sep}35{sep}46,952313".format(sep=sep)) == [ + ("12", "35", "46", ",", "952313") + ] + + assert time_re.findall("12:") == [] + assert time_re.findall("12:35:46.") == [] + assert time_re.findall("12:35:46,") == [] + + +@pytest.mark.usefixtures("dt_parser") +class TestDateTimeParserISO: + def test_YYYY(self): + + assert self.parser.parse_iso("2013") == datetime(2013, 1, 1) + + def test_YYYY_DDDD(self): + assert self.parser.parse_iso("1998-136") == datetime(1998, 5, 16) + + assert self.parser.parse_iso("1998-006") == datetime(1998, 1, 6) + + with pytest.raises(ParserError): + self.parser.parse_iso("1998-456") + + # 2016 is a leap year, so Feb 29 exists (leap day) + assert self.parser.parse_iso("2016-059") == datetime(2016, 2, 28) + assert self.parser.parse_iso("2016-060") == datetime(2016, 2, 29) + assert self.parser.parse_iso("2016-061") == datetime(2016, 3, 1) + + # 2017 is not a leap year, so Feb 29 does not exist + assert self.parser.parse_iso("2017-059") == datetime(2017, 2, 28) + assert self.parser.parse_iso("2017-060") == datetime(2017, 3, 1) + assert self.parser.parse_iso("2017-061") == datetime(2017, 3, 2) + + # Since 2016 is a leap year, the 366th day falls in the same year + assert self.parser.parse_iso("2016-366") == datetime(2016, 12, 31) + + # Since 2017 is not a leap year, the 366th day falls in the next year + assert self.parser.parse_iso("2017-366") == datetime(2018, 1, 1) + + def test_YYYY_DDDD_HH_mm_ssZ(self): + + assert self.parser.parse_iso("2013-036 04:05:06+01:00") == datetime( + 2013, 2, 5, 4, 5, 6, tzinfo=tz.tzoffset(None, 3600) + ) + + assert self.parser.parse_iso("2013-036 04:05:06Z") == datetime( + 2013, 2, 5, 4, 5, 6, tzinfo=tz.tzutc() + ) + + def test_YYYY_MM_DDDD(self): + with pytest.raises(ParserError): + self.parser.parse_iso("2014-05-125") + + def test_YYYY_MM(self): + + for separator in DateTimeParser.SEPARATORS: + assert self.parser.parse_iso(separator.join(("2013", "02"))) == datetime( + 2013, 2, 1 + ) + + def test_YYYY_MM_DD(self): + + for separator in DateTimeParser.SEPARATORS: + assert self.parser.parse_iso( + separator.join(("2013", "02", "03")) + ) == datetime(2013, 2, 3) + + def test_YYYY_MM_DDTHH_mmZ(self): + + assert self.parser.parse_iso("2013-02-03T04:05+01:00") == datetime( + 2013, 2, 3, 4, 5, tzinfo=tz.tzoffset(None, 3600) + ) + + def test_YYYY_MM_DDTHH_mm(self): + + assert self.parser.parse_iso("2013-02-03T04:05") == datetime(2013, 2, 3, 4, 5) + + def test_YYYY_MM_DDTHH(self): + + assert self.parser.parse_iso("2013-02-03T04") == datetime(2013, 2, 3, 4) + + def test_YYYY_MM_DDTHHZ(self): + + assert self.parser.parse_iso("2013-02-03T04+01:00") == datetime( + 2013, 2, 3, 4, tzinfo=tz.tzoffset(None, 3600) + ) + + def test_YYYY_MM_DDTHH_mm_ssZ(self): + + assert self.parser.parse_iso("2013-02-03T04:05:06+01:00") == datetime( + 2013, 2, 3, 4, 5, 6, tzinfo=tz.tzoffset(None, 3600) + ) + + def test_YYYY_MM_DDTHH_mm_ss(self): + + assert self.parser.parse_iso("2013-02-03T04:05:06") == datetime( + 2013, 2, 3, 4, 5, 6 + ) + + def test_YYYY_MM_DD_HH_mmZ(self): + + assert self.parser.parse_iso("2013-02-03 04:05+01:00") == datetime( + 2013, 2, 3, 4, 5, tzinfo=tz.tzoffset(None, 3600) + ) + + def test_YYYY_MM_DD_HH_mm(self): + + assert self.parser.parse_iso("2013-02-03 04:05") == datetime(2013, 2, 3, 4, 5) + + def test_YYYY_MM_DD_HH(self): + + assert self.parser.parse_iso("2013-02-03 04") == datetime(2013, 2, 3, 4) + + def test_invalid_time(self): + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03T") + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03 044") + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03 04:05:06.") + + def test_YYYY_MM_DD_HH_mm_ssZ(self): + + assert self.parser.parse_iso("2013-02-03 04:05:06+01:00") == datetime( + 2013, 2, 3, 4, 5, 6, tzinfo=tz.tzoffset(None, 3600) + ) + + def test_YYYY_MM_DD_HH_mm_ss(self): + + assert self.parser.parse_iso("2013-02-03 04:05:06") == datetime( + 2013, 2, 3, 4, 5, 6 + ) + + def test_YYYY_MM_DDTHH_mm_ss_S(self): + + assert self.parser.parse_iso("2013-02-03T04:05:06.7") == datetime( + 2013, 2, 3, 4, 5, 6, 700000 + ) + + assert self.parser.parse_iso("2013-02-03T04:05:06.78") == datetime( + 2013, 2, 3, 4, 5, 6, 780000 + ) + + assert self.parser.parse_iso("2013-02-03T04:05:06.789") == datetime( + 2013, 2, 3, 4, 5, 6, 789000 + ) + + assert self.parser.parse_iso("2013-02-03T04:05:06.7891") == datetime( + 2013, 2, 3, 4, 5, 6, 789100 + ) + + assert self.parser.parse_iso("2013-02-03T04:05:06.78912") == datetime( + 2013, 2, 3, 4, 5, 6, 789120 + ) + + # ISO 8601:2004(E), ISO, 2004-12-01, 4.2.2.4 ... the decimal fraction + # shall be divided from the integer part by the decimal sign specified + # in ISO 31-0, i.e. the comma [,] or full stop [.]. Of these, the comma + # is the preferred sign. + assert self.parser.parse_iso("2013-02-03T04:05:06,789123678") == datetime( + 2013, 2, 3, 4, 5, 6, 789124 + ) + + # there is no limit on the number of decimal places + assert self.parser.parse_iso("2013-02-03T04:05:06.789123678") == datetime( + 2013, 2, 3, 4, 5, 6, 789124 + ) + + def test_YYYY_MM_DDTHH_mm_ss_SZ(self): + + assert self.parser.parse_iso("2013-02-03T04:05:06.7+01:00") == datetime( + 2013, 2, 3, 4, 5, 6, 700000, tzinfo=tz.tzoffset(None, 3600) + ) + + assert self.parser.parse_iso("2013-02-03T04:05:06.78+01:00") == datetime( + 2013, 2, 3, 4, 5, 6, 780000, tzinfo=tz.tzoffset(None, 3600) + ) + + assert self.parser.parse_iso("2013-02-03T04:05:06.789+01:00") == datetime( + 2013, 2, 3, 4, 5, 6, 789000, tzinfo=tz.tzoffset(None, 3600) + ) + + assert self.parser.parse_iso("2013-02-03T04:05:06.7891+01:00") == datetime( + 2013, 2, 3, 4, 5, 6, 789100, tzinfo=tz.tzoffset(None, 3600) + ) + + assert self.parser.parse_iso("2013-02-03T04:05:06.78912+01:00") == datetime( + 2013, 2, 3, 4, 5, 6, 789120, tzinfo=tz.tzoffset(None, 3600) + ) + + assert self.parser.parse_iso("2013-02-03 04:05:06.78912Z") == datetime( + 2013, 2, 3, 4, 5, 6, 789120, tzinfo=tz.tzutc() + ) + + def test_W(self): + + assert self.parser.parse_iso("2011-W05-4") == datetime(2011, 2, 3) + + assert self.parser.parse_iso("2011-W05-4T14:17:01") == datetime( + 2011, 2, 3, 14, 17, 1 + ) + + assert self.parser.parse_iso("2011W054") == datetime(2011, 2, 3) + + assert self.parser.parse_iso("2011W054T141701") == datetime( + 2011, 2, 3, 14, 17, 1 + ) + + def test_invalid_Z(self): + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03T04:05:06.78912z") + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03T04:05:06.78912zz") + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03T04:05:06.78912Zz") + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03T04:05:06.78912ZZ") + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03T04:05:06.78912+Z") + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03T04:05:06.78912-Z") + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-02-03T04:05:06.78912 Z") + + def test_parse_subsecond(self): + self.expected = datetime(2013, 1, 1, 12, 30, 45, 900000) + assert self.parser.parse_iso("2013-01-01 12:30:45.9") == self.expected + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 980000) + assert self.parser.parse_iso("2013-01-01 12:30:45.98") == self.expected + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987000) + assert self.parser.parse_iso("2013-01-01 12:30:45.987") == self.expected + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987600) + assert self.parser.parse_iso("2013-01-01 12:30:45.9876") == self.expected + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987650) + assert self.parser.parse_iso("2013-01-01 12:30:45.98765") == self.expected + + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987654) + assert self.parser.parse_iso("2013-01-01 12:30:45.987654") == self.expected + + # use comma as subsecond separator + self.expected = datetime(2013, 1, 1, 12, 30, 45, 987654) + assert self.parser.parse_iso("2013-01-01 12:30:45,987654") == self.expected + + def test_gnu_date(self): + """Regression tests for parsing output from GNU date.""" + # date -Ins + assert self.parser.parse_iso("2016-11-16T09:46:30,895636557-0800") == datetime( + 2016, 11, 16, 9, 46, 30, 895636, tzinfo=tz.tzoffset(None, -3600 * 8) + ) + + # date --rfc-3339=ns + assert self.parser.parse_iso("2016-11-16 09:51:14.682141526-08:00") == datetime( + 2016, 11, 16, 9, 51, 14, 682142, tzinfo=tz.tzoffset(None, -3600 * 8) + ) + + def test_isoformat(self): + + dt = datetime.utcnow() + + assert self.parser.parse_iso(dt.isoformat()) == dt + + def test_parse_iso_normalize_whitespace(self): + assert self.parser.parse_iso( + "2013-036 \t 04:05:06Z", normalize_whitespace=True + ) == datetime(2013, 2, 5, 4, 5, 6, tzinfo=tz.tzutc()) + + with pytest.raises(ParserError): + self.parser.parse_iso("2013-036 \t 04:05:06Z") + + assert self.parser.parse_iso( + "\t 2013-05-05T12:30:45.123456 \t \n", normalize_whitespace=True + ) == datetime(2013, 5, 5, 12, 30, 45, 123456) + + with pytest.raises(ParserError): + self.parser.parse_iso("\t 2013-05-05T12:30:45.123456 \t \n") + + def test_parse_iso_with_leading_and_trailing_whitespace(self): + datetime_string = " 2016-11-15T06:37:19.123456" + with pytest.raises(ParserError): + self.parser.parse_iso(datetime_string) + + datetime_string = " 2016-11-15T06:37:19.123456 " + with pytest.raises(ParserError): + self.parser.parse_iso(datetime_string) + + datetime_string = "2016-11-15T06:37:19.123456 " + with pytest.raises(ParserError): + self.parser.parse_iso(datetime_string) + + datetime_string = "2016-11-15T 06:37:19.123456" + with pytest.raises(ParserError): + self.parser.parse_iso(datetime_string) + + # leading whitespace + datetime_string = " 2016-11-15 06:37:19.123456" + with pytest.raises(ParserError): + self.parser.parse_iso(datetime_string) + + # trailing whitespace + datetime_string = "2016-11-15 06:37:19.123456 " + with pytest.raises(ParserError): + self.parser.parse_iso(datetime_string) + + datetime_string = " 2016-11-15 06:37:19.123456 " + with pytest.raises(ParserError): + self.parser.parse_iso(datetime_string) + + # two dividing spaces + datetime_string = "2016-11-15 06:37:19.123456" + with pytest.raises(ParserError): + self.parser.parse_iso(datetime_string) + + def test_parse_iso_with_extra_words_at_start_and_end_invalid(self): + test_inputs = [ + "blah2016", + "blah2016blah", + "blah 2016 blah", + "blah 2016", + "2016 blah", + "blah 2016-05-16 04:05:06.789120", + "2016-05-16 04:05:06.789120 blah", + "blah 2016-05-16T04:05:06.789120", + "2016-05-16T04:05:06.789120 blah", + "2016blah", + "2016-05blah", + "2016-05-16blah", + "2016-05-16T04:05:06.789120blah", + "2016-05-16T04:05:06.789120ZblahZ", + "2016-05-16T04:05:06.789120Zblah", + "2016-05-16T04:05:06.789120blahZ", + "Meet me at 2016-05-16T04:05:06.789120 at the restaurant.", + "Meet me at 2016-05-16 04:05:06.789120 at the restaurant.", + ] + + for ti in test_inputs: + with pytest.raises(ParserError): + self.parser.parse_iso(ti) + + def test_iso8601_basic_format(self): + assert self.parser.parse_iso("20180517") == datetime(2018, 5, 17) + + assert self.parser.parse_iso("20180517T10") == datetime(2018, 5, 17, 10) + + assert self.parser.parse_iso("20180517T105513.843456") == datetime( + 2018, 5, 17, 10, 55, 13, 843456 + ) + + assert self.parser.parse_iso("20180517T105513Z") == datetime( + 2018, 5, 17, 10, 55, 13, tzinfo=tz.tzutc() + ) + + assert self.parser.parse_iso("20180517T105513.843456-0700") == datetime( + 2018, 5, 17, 10, 55, 13, 843456, tzinfo=tz.tzoffset(None, -25200) + ) + + assert self.parser.parse_iso("20180517T105513-0700") == datetime( + 2018, 5, 17, 10, 55, 13, tzinfo=tz.tzoffset(None, -25200) + ) + + assert self.parser.parse_iso("20180517T105513-07") == datetime( + 2018, 5, 17, 10, 55, 13, tzinfo=tz.tzoffset(None, -25200) + ) + + # ordinal in basic format: YYYYDDDD + assert self.parser.parse_iso("1998136") == datetime(1998, 5, 16) + + # timezone requires +- seperator + with pytest.raises(ParserError): + self.parser.parse_iso("20180517T1055130700") + + with pytest.raises(ParserError): + self.parser.parse_iso("20180517T10551307") + + # too many digits in date + with pytest.raises(ParserError): + self.parser.parse_iso("201860517T105513Z") + + # too many digits in time + with pytest.raises(ParserError): + self.parser.parse_iso("20180517T1055213Z") + + def test_midnight_end_day(self): + assert self.parser.parse_iso("2019-10-30T24:00:00") == datetime( + 2019, 10, 31, 0, 0, 0, 0 + ) + assert self.parser.parse_iso("2019-10-30T24:00") == datetime( + 2019, 10, 31, 0, 0, 0, 0 + ) + assert self.parser.parse_iso("2019-10-30T24:00:00.0") == datetime( + 2019, 10, 31, 0, 0, 0, 0 + ) + assert self.parser.parse_iso("2019-10-31T24:00:00") == datetime( + 2019, 11, 1, 0, 0, 0, 0 + ) + assert self.parser.parse_iso("2019-12-31T24:00:00") == datetime( + 2020, 1, 1, 0, 0, 0, 0 + ) + assert self.parser.parse_iso("2019-12-31T23:59:59.9999999") == datetime( + 2020, 1, 1, 0, 0, 0, 0 + ) + + with pytest.raises(ParserError): + self.parser.parse_iso("2019-12-31T24:01:00") + + with pytest.raises(ParserError): + self.parser.parse_iso("2019-12-31T24:00:01") + + with pytest.raises(ParserError): + self.parser.parse_iso("2019-12-31T24:00:00.1") + + with pytest.raises(ParserError): + self.parser.parse_iso("2019-12-31T24:00:00.999999") + + +@pytest.mark.usefixtures("tzinfo_parser") +class TestTzinfoParser: + def test_parse_local(self): + + assert self.parser.parse("local") == tz.tzlocal() + + def test_parse_utc(self): + + assert self.parser.parse("utc") == tz.tzutc() + assert self.parser.parse("UTC") == tz.tzutc() + + def test_parse_iso(self): + + assert self.parser.parse("01:00") == tz.tzoffset(None, 3600) + assert self.parser.parse("11:35") == tz.tzoffset(None, 11 * 3600 + 2100) + assert self.parser.parse("+01:00") == tz.tzoffset(None, 3600) + assert self.parser.parse("-01:00") == tz.tzoffset(None, -3600) + + assert self.parser.parse("0100") == tz.tzoffset(None, 3600) + assert self.parser.parse("+0100") == tz.tzoffset(None, 3600) + assert self.parser.parse("-0100") == tz.tzoffset(None, -3600) + + assert self.parser.parse("01") == tz.tzoffset(None, 3600) + assert self.parser.parse("+01") == tz.tzoffset(None, 3600) + assert self.parser.parse("-01") == tz.tzoffset(None, -3600) + + def test_parse_str(self): + + assert self.parser.parse("US/Pacific") == tz.gettz("US/Pacific") + + def test_parse_fails(self): + + with pytest.raises(parser.ParserError): + self.parser.parse("fail") + + +@pytest.mark.usefixtures("dt_parser") +class TestDateTimeParserMonthName: + def test_shortmonth_capitalized(self): + + assert self.parser.parse("2013-Jan-01", "YYYY-MMM-DD") == datetime(2013, 1, 1) + + def test_shortmonth_allupper(self): + + assert self.parser.parse("2013-JAN-01", "YYYY-MMM-DD") == datetime(2013, 1, 1) + + def test_shortmonth_alllower(self): + + assert self.parser.parse("2013-jan-01", "YYYY-MMM-DD") == datetime(2013, 1, 1) + + def test_month_capitalized(self): + + assert self.parser.parse("2013-January-01", "YYYY-MMMM-DD") == datetime( + 2013, 1, 1 + ) + + def test_month_allupper(self): + + assert self.parser.parse("2013-JANUARY-01", "YYYY-MMMM-DD") == datetime( + 2013, 1, 1 + ) + + def test_month_alllower(self): + + assert self.parser.parse("2013-january-01", "YYYY-MMMM-DD") == datetime( + 2013, 1, 1 + ) + + def test_localized_month_name(self): + parser_ = parser.DateTimeParser("fr_fr") + + assert parser_.parse("2013-Janvier-01", "YYYY-MMMM-DD") == datetime(2013, 1, 1) + + def test_localized_month_abbreviation(self): + parser_ = parser.DateTimeParser("it_it") + + assert parser_.parse("2013-Gen-01", "YYYY-MMM-DD") == datetime(2013, 1, 1) + + +@pytest.mark.usefixtures("dt_parser") +class TestDateTimeParserMeridians: + def test_meridians_lowercase(self): + assert self.parser.parse("2013-01-01 5am", "YYYY-MM-DD ha") == datetime( + 2013, 1, 1, 5 + ) + + assert self.parser.parse("2013-01-01 5pm", "YYYY-MM-DD ha") == datetime( + 2013, 1, 1, 17 + ) + + def test_meridians_capitalized(self): + assert self.parser.parse("2013-01-01 5AM", "YYYY-MM-DD hA") == datetime( + 2013, 1, 1, 5 + ) + + assert self.parser.parse("2013-01-01 5PM", "YYYY-MM-DD hA") == datetime( + 2013, 1, 1, 17 + ) + + def test_localized_meridians_lowercase(self): + parser_ = parser.DateTimeParser("hu_hu") + assert parser_.parse("2013-01-01 5 de", "YYYY-MM-DD h a") == datetime( + 2013, 1, 1, 5 + ) + + assert parser_.parse("2013-01-01 5 du", "YYYY-MM-DD h a") == datetime( + 2013, 1, 1, 17 + ) + + def test_localized_meridians_capitalized(self): + parser_ = parser.DateTimeParser("hu_hu") + assert parser_.parse("2013-01-01 5 DE", "YYYY-MM-DD h A") == datetime( + 2013, 1, 1, 5 + ) + + assert parser_.parse("2013-01-01 5 DU", "YYYY-MM-DD h A") == datetime( + 2013, 1, 1, 17 + ) + + # regression test for issue #607 + def test_es_meridians(self): + parser_ = parser.DateTimeParser("es") + + assert parser_.parse( + "Junio 30, 2019 - 08:00 pm", "MMMM DD, YYYY - hh:mm a" + ) == datetime(2019, 6, 30, 20, 0) + + with pytest.raises(ParserError): + parser_.parse( + "Junio 30, 2019 - 08:00 pasdfasdfm", "MMMM DD, YYYY - hh:mm a" + ) + + def test_fr_meridians(self): + parser_ = parser.DateTimeParser("fr") + + # the French locale always uses a 24 hour clock, so it does not support meridians + with pytest.raises(ParserError): + parser_.parse("Janvier 30, 2019 - 08:00 pm", "MMMM DD, YYYY - hh:mm a") + + +@pytest.mark.usefixtures("dt_parser") +class TestDateTimeParserMonthOrdinalDay: + def test_english(self): + parser_ = parser.DateTimeParser("en_us") + + assert parser_.parse("January 1st, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 1 + ) + assert parser_.parse("January 2nd, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 2 + ) + assert parser_.parse("January 3rd, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 3 + ) + assert parser_.parse("January 4th, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 4 + ) + assert parser_.parse("January 11th, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 11 + ) + assert parser_.parse("January 12th, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 12 + ) + assert parser_.parse("January 13th, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 13 + ) + assert parser_.parse("January 21st, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 21 + ) + assert parser_.parse("January 31st, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 31 + ) + + with pytest.raises(ParserError): + parser_.parse("January 1th, 2013", "MMMM Do, YYYY") + + with pytest.raises(ParserError): + parser_.parse("January 11st, 2013", "MMMM Do, YYYY") + + def test_italian(self): + parser_ = parser.DateTimeParser("it_it") + + assert parser_.parse("Gennaio 1º, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 1 + ) + + def test_spanish(self): + parser_ = parser.DateTimeParser("es_es") + + assert parser_.parse("Enero 1º, 2013", "MMMM Do, YYYY") == datetime(2013, 1, 1) + + def test_french(self): + parser_ = parser.DateTimeParser("fr_fr") + + assert parser_.parse("Janvier 1er, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 1 + ) + + assert parser_.parse("Janvier 2e, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 2 + ) + + assert parser_.parse("Janvier 11e, 2013", "MMMM Do, YYYY") == datetime( + 2013, 1, 11 + ) + + +@pytest.mark.usefixtures("dt_parser") +class TestDateTimeParserSearchDate: + def test_parse_search(self): + + assert self.parser.parse( + "Today is 25 of September of 2003", "DD of MMMM of YYYY" + ) == datetime(2003, 9, 25) + + def test_parse_search_with_numbers(self): + + assert self.parser.parse( + "2000 people met the 2012-01-01 12:05:10", "YYYY-MM-DD HH:mm:ss" + ) == datetime(2012, 1, 1, 12, 5, 10) + + assert self.parser.parse( + "Call 01-02-03 on 79-01-01 12:05:10", "YY-MM-DD HH:mm:ss" + ) == datetime(1979, 1, 1, 12, 5, 10) + + def test_parse_search_with_names(self): + + assert self.parser.parse("June was born in May 1980", "MMMM YYYY") == datetime( + 1980, 5, 1 + ) + + def test_parse_search_locale_with_names(self): + p = parser.DateTimeParser("sv_se") + + assert p.parse("Jan föddes den 31 Dec 1980", "DD MMM YYYY") == datetime( + 1980, 12, 31 + ) + + assert p.parse("Jag föddes den 25 Augusti 1975", "DD MMMM YYYY") == datetime( + 1975, 8, 25 + ) + + def test_parse_search_fails(self): + + with pytest.raises(parser.ParserError): + self.parser.parse("Jag föddes den 25 Augusti 1975", "DD MMMM YYYY") + + def test_escape(self): + + format = "MMMM D, YYYY [at] h:mma" + assert self.parser.parse( + "Thursday, December 10, 2015 at 5:09pm", format + ) == datetime(2015, 12, 10, 17, 9) + + format = "[MMMM] M D, YYYY [at] h:mma" + assert self.parser.parse("MMMM 12 10, 2015 at 5:09pm", format) == datetime( + 2015, 12, 10, 17, 9 + ) + + format = "[It happened on] MMMM Do [in the year] YYYY [a long time ago]" + assert self.parser.parse( + "It happened on November 25th in the year 1990 a long time ago", format + ) == datetime(1990, 11, 25) + + format = "[It happened on] MMMM Do [in the][ year] YYYY [a long time ago]" + assert self.parser.parse( + "It happened on November 25th in the year 1990 a long time ago", format + ) == datetime(1990, 11, 25) + + format = "[I'm][ entirely][ escaped,][ weee!]" + assert self.parser.parse("I'm entirely escaped, weee!", format) == datetime( + 1, 1, 1 + ) + + # Special RegEx characters + format = "MMM DD, YYYY |^${}().*+?<>-& h:mm A" + assert self.parser.parse( + "Dec 31, 2017 |^${}().*+?<>-& 2:00 AM", format + ) == datetime(2017, 12, 31, 2, 0) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/test_util.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_util.py new file mode 100644 index 0000000000..e48b4de066 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/test_util.py @@ -0,0 +1,81 @@ +# -*- coding: utf-8 -*- +import time +from datetime import datetime + +import pytest + +from arrow import util + + +class TestUtil: + def test_next_weekday(self): + # Get first Monday after epoch + assert util.next_weekday(datetime(1970, 1, 1), 0) == datetime(1970, 1, 5) + + # Get first Tuesday after epoch + assert util.next_weekday(datetime(1970, 1, 1), 1) == datetime(1970, 1, 6) + + # Get first Wednesday after epoch + assert util.next_weekday(datetime(1970, 1, 1), 2) == datetime(1970, 1, 7) + + # Get first Thursday after epoch + assert util.next_weekday(datetime(1970, 1, 1), 3) == datetime(1970, 1, 1) + + # Get first Friday after epoch + assert util.next_weekday(datetime(1970, 1, 1), 4) == datetime(1970, 1, 2) + + # Get first Saturday after epoch + assert util.next_weekday(datetime(1970, 1, 1), 5) == datetime(1970, 1, 3) + + # Get first Sunday after epoch + assert util.next_weekday(datetime(1970, 1, 1), 6) == datetime(1970, 1, 4) + + # Weekdays are 0-indexed + with pytest.raises(ValueError): + util.next_weekday(datetime(1970, 1, 1), 7) + + with pytest.raises(ValueError): + util.next_weekday(datetime(1970, 1, 1), -1) + + def test_total_seconds(self): + td = datetime(2019, 1, 1) - datetime(2018, 1, 1) + assert util.total_seconds(td) == td.total_seconds() + + def test_is_timestamp(self): + timestamp_float = time.time() + timestamp_int = int(timestamp_float) + + assert util.is_timestamp(timestamp_int) + assert util.is_timestamp(timestamp_float) + assert util.is_timestamp(str(timestamp_int)) + assert util.is_timestamp(str(timestamp_float)) + + assert not util.is_timestamp(True) + assert not util.is_timestamp(False) + + class InvalidTimestamp: + pass + + assert not util.is_timestamp(InvalidTimestamp()) + + full_datetime = "2019-06-23T13:12:42" + assert not util.is_timestamp(full_datetime) + + def test_normalize_timestamp(self): + timestamp = 1591161115.194556 + millisecond_timestamp = 1591161115194 + microsecond_timestamp = 1591161115194556 + + assert util.normalize_timestamp(timestamp) == timestamp + assert util.normalize_timestamp(millisecond_timestamp) == 1591161115.194 + assert util.normalize_timestamp(microsecond_timestamp) == 1591161115.194556 + + with pytest.raises(ValueError): + util.normalize_timestamp(3e17) + + def test_iso_gregorian(self): + with pytest.raises(ValueError): + util.iso_to_gregorian(2013, 0, 5) + + with pytest.raises(ValueError): + util.iso_to_gregorian(2013, 8, 0) diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tests/utils.py b/openpype/modules/ftrack/python2_vendor/arrow/tests/utils.py new file mode 100644 index 0000000000..2a048feb3f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tests/utils.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +import pytz +from dateutil.zoneinfo import get_zonefile_instance + +from arrow import util + + +def make_full_tz_list(): + dateutil_zones = set(get_zonefile_instance().zones) + pytz_zones = set(pytz.all_timezones) + return dateutil_zones.union(pytz_zones) + + +def assert_datetime_equality(dt1, dt2, within=10): + assert dt1.tzinfo == dt2.tzinfo + assert abs(util.total_seconds(dt1 - dt2)) < within diff --git a/openpype/modules/ftrack/python2_vendor/arrow/tox.ini b/openpype/modules/ftrack/python2_vendor/arrow/tox.ini new file mode 100644 index 0000000000..46576b12e3 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/arrow/tox.ini @@ -0,0 +1,53 @@ +[tox] +minversion = 3.18.0 +envlist = py{py3,27,35,36,37,38,39},lint,docs +skip_missing_interpreters = true + +[gh-actions] +python = + pypy3: pypy3 + 2.7: py27 + 3.5: py35 + 3.6: py36 + 3.7: py37 + 3.8: py38 + 3.9: py39 + +[testenv] +deps = -rrequirements.txt +allowlist_externals = pytest +commands = pytest + +[testenv:lint] +basepython = python3 +skip_install = true +deps = pre-commit +commands = + pre-commit install + pre-commit run --all-files --show-diff-on-failure + +[testenv:docs] +basepython = python3 +skip_install = true +changedir = docs +deps = + doc8 + sphinx + python-dateutil +allowlist_externals = make +commands = + doc8 index.rst ../README.rst --extension .rst --ignore D001 + make html SPHINXOPTS="-W --keep-going" + +[pytest] +addopts = -v --cov-branch --cov=arrow --cov-fail-under=100 --cov-report=term-missing --cov-report=xml +testpaths = tests + +[isort] +line_length = 88 +multi_line_output = 3 +include_trailing_comma = true + +[flake8] +per-file-ignores = arrow/__init__.py:F401 +ignore = E203,E501,W503 diff --git a/openpype/modules/default_modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/__init__.py b/openpype/modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/__init__.py similarity index 100% rename from openpype/modules/default_modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/__init__.py rename to openpype/modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/__init__.py diff --git a/openpype/modules/default_modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/configparser/__init__.py b/openpype/modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/configparser/__init__.py similarity index 100% rename from openpype/modules/default_modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/configparser/__init__.py rename to openpype/modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/configparser/__init__.py diff --git a/openpype/modules/default_modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/configparser/helpers.py b/openpype/modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/configparser/helpers.py similarity index 100% rename from openpype/modules/default_modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/configparser/helpers.py rename to openpype/modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/configparser/helpers.py diff --git a/openpype/modules/default_modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/functools_lru_cache.py b/openpype/modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/functools_lru_cache.py similarity index 100% rename from openpype/modules/default_modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/functools_lru_cache.py rename to openpype/modules/ftrack/python2_vendor/backports.functools_lru_cache/backports/functools_lru_cache.py diff --git a/openpype/modules/default_modules/ftrack/python2_vendor/builtins/builtins/__init__.py b/openpype/modules/ftrack/python2_vendor/builtins/builtins/__init__.py similarity index 100% rename from openpype/modules/default_modules/ftrack/python2_vendor/builtins/builtins/__init__.py rename to openpype/modules/ftrack/python2_vendor/builtins/builtins/__init__.py diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/.gitignore b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/.gitignore new file mode 100644 index 0000000000..be621609ab --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/.gitignore @@ -0,0 +1,42 @@ +# General +*.py[cod] + +# Packages +*.egg +*.egg-info +dist +build +.eggs/ +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 +__pycache__ + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox + +# Caches +Thumbs.db + +# Development +.project +.pydevproject +.settings +.idea/ +.history/ +.vscode/ + +# Testing +.cache +test-reports/* +.pytest_cache/* \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/LICENSE.python b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/LICENSE.python new file mode 100644 index 0000000000..9dc010d803 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/LICENSE.python @@ -0,0 +1,254 @@ +A. HISTORY OF THE SOFTWARE +========================== + +Python was created in the early 1990s by Guido van Rossum at Stichting +Mathematisch Centrum (CWI, see http://www.cwi.nl) in the Netherlands +as a successor of a language called ABC. Guido remains Python's +principal author, although it includes many contributions from others. + +In 1995, Guido continued his work on Python at the Corporation for +National Research Initiatives (CNRI, see http://www.cnri.reston.va.us) +in Reston, Virginia where he released several versions of the +software. + +In May 2000, Guido and the Python core development team moved to +BeOpen.com to form the BeOpen PythonLabs team. In October of the same +year, the PythonLabs team moved to Digital Creations, which became +Zope Corporation. In 2001, the Python Software Foundation (PSF, see +https://www.python.org/psf/) was formed, a non-profit organization +created specifically to own Python-related Intellectual Property. +Zope Corporation was a sponsoring member of the PSF. + +All Python releases are Open Source (see http://www.opensource.org for +the Open Source Definition). Historically, most, but not all, Python +releases have also been GPL-compatible; the table below summarizes +the various releases. + + Release Derived Year Owner GPL- + from compatible? (1) + + 0.9.0 thru 1.2 1991-1995 CWI yes + 1.3 thru 1.5.2 1.2 1995-1999 CNRI yes + 1.6 1.5.2 2000 CNRI no + 2.0 1.6 2000 BeOpen.com no + 1.6.1 1.6 2001 CNRI yes (2) + 2.1 2.0+1.6.1 2001 PSF no + 2.0.1 2.0+1.6.1 2001 PSF yes + 2.1.1 2.1+2.0.1 2001 PSF yes + 2.1.2 2.1.1 2002 PSF yes + 2.1.3 2.1.2 2002 PSF yes + 2.2 and above 2.1.1 2001-now PSF yes + +Footnotes: + +(1) GPL-compatible doesn't mean that we're distributing Python under + the GPL. All Python licenses, unlike the GPL, let you distribute + a modified version without making your changes open source. The + GPL-compatible licenses make it possible to combine Python with + other software that is released under the GPL; the others don't. + +(2) According to Richard Stallman, 1.6.1 is not GPL-compatible, + because its license has a choice of law clause. According to + CNRI, however, Stallman's lawyer has told CNRI's lawyer that 1.6.1 + is "not incompatible" with the GPL. + +Thanks to the many outside volunteers who have worked under Guido's +direction to make these releases possible. + + +B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON +=============================================================== + +PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 +-------------------------------------------- + +1. This LICENSE AGREEMENT is between the Python Software Foundation +("PSF"), and the Individual or Organization ("Licensee") accessing and +otherwise using this software ("Python") in source or binary form and +its associated documentation. + +2. Subject to the terms and conditions of this License Agreement, PSF hereby +grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce, +analyze, test, perform and/or display publicly, prepare derivative works, +distribute, and otherwise use Python alone or in any derivative version, +provided, however, that PSF's License Agreement and PSF's notice of copyright, +i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, +2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Python Software Foundation; +All Rights Reserved" are retained in Python alone or in any derivative version +prepared by Licensee. + +3. In the event Licensee prepares a derivative work that is based on +or incorporates Python or any part thereof, and wants to make +the derivative work available to others as provided herein, then +Licensee hereby agrees to include in any such work a brief summary of +the changes made to Python. + +4. PSF is making Python available to Licensee on an "AS IS" +basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR +IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND +DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS +FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT +INFRINGE ANY THIRD PARTY RIGHTS. + +5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON +FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS +A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON, +OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + +6. This License Agreement will automatically terminate upon a material +breach of its terms and conditions. + +7. Nothing in this License Agreement shall be deemed to create any +relationship of agency, partnership, or joint venture between PSF and +Licensee. This License Agreement does not grant permission to use PSF +trademarks or trade name in a trademark sense to endorse or promote +products or services of Licensee, or any third party. + +8. By copying, installing or otherwise using Python, Licensee +agrees to be bound by the terms and conditions of this License +Agreement. + + +BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0 +------------------------------------------- + +BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1 + +1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an +office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the +Individual or Organization ("Licensee") accessing and otherwise using +this software in source or binary form and its associated +documentation ("the Software"). + +2. Subject to the terms and conditions of this BeOpen Python License +Agreement, BeOpen hereby grants Licensee a non-exclusive, +royalty-free, world-wide license to reproduce, analyze, test, perform +and/or display publicly, prepare derivative works, distribute, and +otherwise use the Software alone or in any derivative version, +provided, however, that the BeOpen Python License is retained in the +Software, alone or in any derivative version prepared by Licensee. + +3. BeOpen is making the Software available to Licensee on an "AS IS" +basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR +IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND +DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS +FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT +INFRINGE ANY THIRD PARTY RIGHTS. + +4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE +SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS +AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY +DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + +5. This License Agreement will automatically terminate upon a material +breach of its terms and conditions. + +6. This License Agreement shall be governed by and interpreted in all +respects by the law of the State of California, excluding conflict of +law provisions. Nothing in this License Agreement shall be deemed to +create any relationship of agency, partnership, or joint venture +between BeOpen and Licensee. This License Agreement does not grant +permission to use BeOpen trademarks or trade names in a trademark +sense to endorse or promote products or services of Licensee, or any +third party. As an exception, the "BeOpen Python" logos available at +http://www.pythonlabs.com/logos.html may be used according to the +permissions granted on that web page. + +7. By copying, installing or otherwise using the software, Licensee +agrees to be bound by the terms and conditions of this License +Agreement. + + +CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1 +--------------------------------------- + +1. This LICENSE AGREEMENT is between the Corporation for National +Research Initiatives, having an office at 1895 Preston White Drive, +Reston, VA 20191 ("CNRI"), and the Individual or Organization +("Licensee") accessing and otherwise using Python 1.6.1 software in +source or binary form and its associated documentation. + +2. Subject to the terms and conditions of this License Agreement, CNRI +hereby grants Licensee a nonexclusive, royalty-free, world-wide +license to reproduce, analyze, test, perform and/or display publicly, +prepare derivative works, distribute, and otherwise use Python 1.6.1 +alone or in any derivative version, provided, however, that CNRI's +License Agreement and CNRI's notice of copyright, i.e., "Copyright (c) +1995-2001 Corporation for National Research Initiatives; All Rights +Reserved" are retained in Python 1.6.1 alone or in any derivative +version prepared by Licensee. Alternately, in lieu of CNRI's License +Agreement, Licensee may substitute the following text (omitting the +quotes): "Python 1.6.1 is made available subject to the terms and +conditions in CNRI's License Agreement. This Agreement together with +Python 1.6.1 may be located on the Internet using the following +unique, persistent identifier (known as a handle): 1895.22/1013. This +Agreement may also be obtained from a proxy server on the Internet +using the following URL: http://hdl.handle.net/1895.22/1013". + +3. In the event Licensee prepares a derivative work that is based on +or incorporates Python 1.6.1 or any part thereof, and wants to make +the derivative work available to others as provided herein, then +Licensee hereby agrees to include in any such work a brief summary of +the changes made to Python 1.6.1. + +4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS" +basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR +IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND +DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS +FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT +INFRINGE ANY THIRD PARTY RIGHTS. + +5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON +1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS +A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1, +OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + +6. This License Agreement will automatically terminate upon a material +breach of its terms and conditions. + +7. This License Agreement shall be governed by the federal +intellectual property law of the United States, including without +limitation the federal copyright law, and, to the extent such +U.S. federal law does not apply, by the law of the Commonwealth of +Virginia, excluding Virginia's conflict of law provisions. +Notwithstanding the foregoing, with regard to derivative works based +on Python 1.6.1 that incorporate non-separable material that was +previously distributed under the GNU General Public License (GPL), the +law of the Commonwealth of Virginia shall govern this License +Agreement only as to issues arising under or with respect to +Paragraphs 4, 5, and 7 of this License Agreement. Nothing in this +License Agreement shall be deemed to create any relationship of +agency, partnership, or joint venture between CNRI and Licensee. This +License Agreement does not grant permission to use CNRI trademarks or +trade name in a trademark sense to endorse or promote products or +services of Licensee, or any third party. + +8. By clicking on the "ACCEPT" button where indicated, or by copying, +installing or otherwise using Python 1.6.1, Licensee agrees to be +bound by the terms and conditions of this License Agreement. + + ACCEPT + + +CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2 +-------------------------------------------------- + +Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, +The Netherlands. All rights reserved. + +Permission to use, copy, modify, and distribute this software and its +documentation for any purpose and without fee is hereby granted, +provided that the above copyright notice appear in all copies and that +both that copyright notice and this permission notice appear in +supporting documentation, and that the name of Stichting Mathematisch +Centrum or CWI not be used in advertising or publicity pertaining to +distribution of the software without specific, written prior +permission. + +STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO +THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE +FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/LICENSE.txt b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/LICENSE.txt new file mode 100644 index 0000000000..d9a10c0d8e --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/LICENSE.txt @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/MANIFEST.in b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/MANIFEST.in new file mode 100644 index 0000000000..3216ee548c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/MANIFEST.in @@ -0,0 +1,4 @@ +include LICENSE.txt +include README.rst +recursive-include resource *.py +recursive-include doc *.rst *.conf *.py *.png *.css diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/README.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/README.rst new file mode 100644 index 0000000000..074a35f97c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/README.rst @@ -0,0 +1,34 @@ +################# +ftrack Python API +################# + +Python API for ftrack. + +.. important:: + + This is the new Python client for the ftrack API. If you are migrating from + the old client then please read the dedicated `migration guide `_. + +************* +Documentation +************* + +Full documentation, including installation and setup guides, can be found at +http://ftrack-python-api.rtd.ftrack.com/en/stable/ + +********************* +Copyright and license +********************* + +Copyright (c) 2014 ftrack + +Licensed under the Apache License, Version 2.0 (the "License"); you may not use +this work except in compliance with the License. You may obtain a copy of the +License in the LICENSE.txt file, or at: + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software distributed +under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +CONDITIONS OF ANY KIND, either express or implied. See the License for the +specific language governing permissions and limitations under the License. \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/bitbucket-pipelines.yml b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/bitbucket-pipelines.yml new file mode 100644 index 0000000000..355f00f752 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/bitbucket-pipelines.yml @@ -0,0 +1,24 @@ +# Test configuration for bitbucket pipelines. +options: + max-time: 20 +definitions: + services: + ftrack: + image: + name: ftrackdocker/test-server:latest + username: $DOCKER_HUB_USERNAME + password: $DOCKER_HUB_PASSWORD + email: $DOCKER_HUB_EMAIL +pipelines: + default: + - parallel: + - step: + name: run tests against python 2.7.x + image: python:2.7 + caches: + - pip + services: + - ftrack + script: + - bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' $FTRACK_SERVER)" != "200" ]]; do sleep 1; done' + - python setup.py test \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/_static/ftrack.css b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/_static/ftrack.css new file mode 100644 index 0000000000..3456b0c3c5 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/_static/ftrack.css @@ -0,0 +1,16 @@ +@import "css/theme.css"; + +.domain-summary li { + float: left; + min-width: 12em; +} + +.domain-summary ul:before, ul:after { + content: ''; + clear: both; + display:block; +} + +.rst-content table.docutils td:last-child { + white-space: normal; +} diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/base.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/base.rst new file mode 100644 index 0000000000..4e165b0122 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/base.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +************************ +ftrack_api.accessor.base +************************ + +.. automodule:: ftrack_api.accessor.base diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/disk.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/disk.rst new file mode 100644 index 0000000000..f7d9dddf37 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/disk.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +************************ +ftrack_api.accessor.disk +************************ + +.. automodule:: ftrack_api.accessor.disk diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/index.rst new file mode 100644 index 0000000000..0adc23fe2d --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/index.rst @@ -0,0 +1,14 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +******************* +ftrack_api.accessor +******************* + +.. automodule:: ftrack_api.accessor + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/server.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/server.rst new file mode 100644 index 0000000000..62bd7f4165 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/accessor/server.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +************************ +ftrack_api.accessor.server +************************ + +.. automodule:: ftrack_api.accessor.server diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/attribute.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/attribute.rst new file mode 100644 index 0000000000..9fd8994eb1 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/attribute.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +******************** +ftrack_api.attribute +******************** + +.. automodule:: ftrack_api.attribute diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/cache.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/cache.rst new file mode 100644 index 0000000000..cbf9128a5a --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/cache.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +**************** +ftrack_api.cache +**************** + +.. automodule:: ftrack_api.cache diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/collection.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/collection.rst new file mode 100644 index 0000000000..607d574cb5 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/collection.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +********************* +ftrack_api.collection +********************* + +.. automodule:: ftrack_api.collection diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/asset_version.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/asset_version.rst new file mode 100644 index 0000000000..0bc4ce35f1 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/asset_version.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +******************************* +ftrack_api.entity.asset_version +******************************* + +.. automodule:: ftrack_api.entity.asset_version diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/base.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/base.rst new file mode 100644 index 0000000000..f4beedc9a4 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/base.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +********************** +ftrack_api.entity.base +********************** + +.. automodule:: ftrack_api.entity.base diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/component.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/component.rst new file mode 100644 index 0000000000..c9ce0a0cf1 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/component.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +*************************** +ftrack_api.entity.component +*************************** + +.. automodule:: ftrack_api.entity.component diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/factory.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/factory.rst new file mode 100644 index 0000000000..483c16641b --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/factory.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +************************* +ftrack_api.entity.factory +************************* + +.. automodule:: ftrack_api.entity.factory diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/index.rst new file mode 100644 index 0000000000..fce68c0e94 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/index.rst @@ -0,0 +1,14 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +***************** +ftrack_api.entity +***************** + +.. automodule:: ftrack_api.entity + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/job.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/job.rst new file mode 100644 index 0000000000..9d22a7c378 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/job.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +********************* +ftrack_api.entity.job +********************* + +.. automodule:: ftrack_api.entity.job diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/location.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/location.rst new file mode 100644 index 0000000000..60e006a10c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/location.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +************************** +ftrack_api.entity.location +************************** + +.. automodule:: ftrack_api.entity.location diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/note.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/note.rst new file mode 100644 index 0000000000..3588e48e5b --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/note.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +********************** +ftrack_api.entity.note +********************** + +.. automodule:: ftrack_api.entity.note diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/project_schema.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/project_schema.rst new file mode 100644 index 0000000000..5777ab0b40 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/project_schema.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +******************************** +ftrack_api.entity.project_schema +******************************** + +.. automodule:: ftrack_api.entity.project_schema diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/user.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/user.rst new file mode 100644 index 0000000000..0014498b9c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/entity/user.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +********************** +ftrack_api.entity.user +********************** + +.. automodule:: ftrack_api.entity.user diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/base.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/base.rst new file mode 100644 index 0000000000..2b0ca8d3ed --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/base.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +********************* +ftrack_api.event.base +********************* + +.. automodule:: ftrack_api.event.base diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/expression.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/expression.rst new file mode 100644 index 0000000000..f582717060 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/expression.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +*************************** +ftrack_api.event.expression +*************************** + +.. automodule:: ftrack_api.event.expression diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/hub.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/hub.rst new file mode 100644 index 0000000000..36d7a33163 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/hub.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +******************** +ftrack_api.event.hub +******************** + +.. automodule:: ftrack_api.event.hub diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/index.rst new file mode 100644 index 0000000000..0986e8e2f4 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/index.rst @@ -0,0 +1,14 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +**************** +ftrack_api.event +**************** + +.. automodule:: ftrack_api.event + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/subscriber.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/subscriber.rst new file mode 100644 index 0000000000..974f375817 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/subscriber.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +*************************** +ftrack_api.event.subscriber +*************************** + +.. automodule:: ftrack_api.event.subscriber diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/subscription.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/subscription.rst new file mode 100644 index 0000000000..94a20e3611 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/event/subscription.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +***************************** +ftrack_api.event.subscription +***************************** + +.. automodule:: ftrack_api.event.subscription diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/exception.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/exception.rst new file mode 100644 index 0000000000..64c3a699d7 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/exception.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +******************** +ftrack_api.exception +******************** + +.. automodule:: ftrack_api.exception diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/formatter.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/formatter.rst new file mode 100644 index 0000000000..9b8154bdc3 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/formatter.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +******************** +ftrack_api.formatter +******************** + +.. automodule:: ftrack_api.formatter diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/index.rst new file mode 100644 index 0000000000..ea3517ca68 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/index.rst @@ -0,0 +1,20 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _api_reference: + +************* +API Reference +************* + +ftrack_api +========== + +.. automodule:: ftrack_api + +.. toctree:: + :maxdepth: 1 + :glob: + + */index + * diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/inspection.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/inspection.rst new file mode 100644 index 0000000000..8223ee72f2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/inspection.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +********************* +ftrack_api.inspection +********************* + +.. automodule:: ftrack_api.inspection diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/logging.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/logging.rst new file mode 100644 index 0000000000..ecb883d385 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/logging.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2016 ftrack + +****************** +ftrack_api.logging +****************** + +.. automodule:: ftrack_api.logging diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/operation.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/operation.rst new file mode 100644 index 0000000000..b2dff9933d --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/operation.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +******************** +ftrack_api.operation +******************** + +.. automodule:: ftrack_api.operation diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/plugin.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/plugin.rst new file mode 100644 index 0000000000..a4993d94cf --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/plugin.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +***************** +ftrack_api.plugin +***************** + +.. automodule:: ftrack_api.plugin diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/query.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/query.rst new file mode 100644 index 0000000000..acbd8d237a --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/query.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +**************** +ftrack_api.query +**************** + +.. automodule:: ftrack_api.query diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/resource_identifier_transformer/base.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/resource_identifier_transformer/base.rst new file mode 100644 index 0000000000..09cdad8627 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/resource_identifier_transformer/base.rst @@ -0,0 +1,10 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _api_reference/resource_identifier_transformer.base: + +*********************************************** +ftrack_api.resource_identifier_transformer.base +*********************************************** + +.. automodule:: ftrack_api.resource_identifier_transformer.base diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/resource_identifier_transformer/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/resource_identifier_transformer/index.rst new file mode 100644 index 0000000000..755f052c9d --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/resource_identifier_transformer/index.rst @@ -0,0 +1,16 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _api_reference/resource_identifier_transformer: + +****************************************** +ftrack_api.resource_identifier_transformer +****************************************** + +.. automodule:: ftrack_api.resource_identifier_transformer + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/session.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/session.rst new file mode 100644 index 0000000000..dcce173d1f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/session.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +****************** +ftrack_api.session +****************** + +.. automodule:: ftrack_api.session diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/base.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/base.rst new file mode 100644 index 0000000000..55a1cc75d2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/base.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +************************* +ftrack_api.structure.base +************************* + +.. automodule:: ftrack_api.structure.base diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/id.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/id.rst new file mode 100644 index 0000000000..ade2c7ae88 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/id.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +*********************** +ftrack_api.structure.id +*********************** + +.. automodule:: ftrack_api.structure.id diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/index.rst new file mode 100644 index 0000000000..cbd4545cf7 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/index.rst @@ -0,0 +1,14 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +******************** +ftrack_api.structure +******************** + +.. automodule:: ftrack_api.structure + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/origin.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/origin.rst new file mode 100644 index 0000000000..403173e257 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/origin.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +*************************** +ftrack_api.structure.origin +*************************** + +.. automodule:: ftrack_api.structure.origin diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/standard.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/standard.rst new file mode 100644 index 0000000000..5c0d88026b --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/structure/standard.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +***************************** +ftrack_api.structure.standard +***************************** + +.. automodule:: ftrack_api.structure.standard diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/symbol.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/symbol.rst new file mode 100644 index 0000000000..55dc0125a8 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/api_reference/symbol.rst @@ -0,0 +1,8 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +***************** +ftrack_api.symbol +***************** + +.. automodule:: ftrack_api.symbol diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/caching.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/caching.rst new file mode 100644 index 0000000000..bfc5cef401 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/caching.rst @@ -0,0 +1,175 @@ +.. + :copyright: Copyright (c) 2015 ftrack + + +.. _caching: + +******* +Caching +******* + +The API makes use of caching in order to provide more efficient retrieval of +data by reducing the number of calls to the remote server:: + + # First call to retrieve user performs a request to the server. + user = session.get('User', 'some-user-id') + + # A later call in the same session to retrieve the same user just gets + # the existing instance from the cache without a request to the server. + user = session.get('User', 'some-user-id') + +It also seamlessly merges related data together regardless of how it was +retrieved:: + + >>> timelog = user['timelogs'][0] + >>> with session.auto_populating(False): + >>> print timelog['comment'] + NOT_SET + >>> session.query( + ... 'select comment from Timelog where id is "{0}"' + ... .format(timelog['id']) + ... ).all() + >>> with session.auto_populating(False): + >>> print timelog['comment'] + 'Some comment' + +By default, each :class:`~ftrack_api.session.Session` is configured with a +simple :class:`~ftrack_api.cache.MemoryCache()` and the cache is lost as soon as +the session expires. + +Configuring a session cache +=========================== + +It is possible to configure the cache that a session uses. An example would be a +persistent auto-populated cache that survives between sessions:: + + import os + import ftrack_api.cache + + # Specify where the file based cache should be stored. + cache_path = os.path.join(tempfile.gettempdir(), 'ftrack_session_cache.dbm') + + + # Define a cache maker that returns a file based cache. Note that a + # function is used because the file based cache should use the session's + # encode and decode methods to serialise the entity data to a format that + # can be written to disk (JSON). + def cache_maker(session): + '''Return cache to use for *session*.''' + return ftrack_api.cache.SerialisedCache( + ftrack_api.cache.FileCache(cache_path), + encode=session.encode, + decode=session.decode + ) + + # Create the session using the cache maker. + session = ftrack_api.Session(cache=cache_maker) + +.. note:: + + There can be a performance penalty when using a more complex cache setup. + For example, serialising data and also writing and reading from disk can be + relatively slow operations. + +Regardless of the cache specified, the session will always construct a +:class:`~ftrack_api.cache.LayeredCache` with a +:class:`~ftrack_api.cache.MemoryCache` at the top level and then your cache at +the second level. This is to ensure consistency of instances returned by the +session. + +You can check (or even modify) at any time what cache configuration a session is +using by accessing the `cache` attribute on a +:class:`~ftrack_api.session.Session`:: + + >>> print session.cache + + +Writing a new cache interface +============================= + +If you have a custom cache backend you should be able to integrate it into the +system by writing a cache interface that matches the one defined by +:class:`ftrack_api.cache.Cache`. This typically involves a subclass and +overriding the :meth:`~ftrack_api.cache.Cache.get`, +:meth:`~ftrack_api.cache.Cache.set` and :meth:`~ftrack_api.cache.Cache.remove` +methods. + + +Managing what gets cached +========================= + +The cache system is quite flexible when it comes to controlling what should be +cached. + +Consider you have a layered cache where the bottom layer cache should be +persisted between sessions. In this setup you probably don't want the persisted +cache to hold non-persisted values, such as modified entity values or newly +created entities not yet committed to the server. However, you might want the +top level memory cache to hold onto these values. + +Here is one way to set this up. First define a new proxy cache that is selective +about what it sets:: + + import ftrack_api.inspection + + + class SelectiveCache(ftrack_api.cache.ProxyCache): + '''Proxy cache that won't cache newly created entities.''' + + def set(self, key, value): + '''Set *value* for *key*.''' + if isinstance(value, ftrack_api.entity.base.Entity): + if ( + ftrack_api.inspection.state(value) + is ftrack_api.symbol.CREATED + ): + return + + super(SelectiveCache, self).set(key, value) + +Now use this custom cache to wrap the serialised cache in the setup above: + +.. code-block:: python + :emphasize-lines: 3, 9 + + def cache_maker(session): + '''Return cache to use for *session*.''' + return SelectiveCache( + ftrack_api.cache.SerialisedCache( + ftrack_api.cache.FileCache(cache_path), + encode=session.encode, + decode=session.decode + ) + ) + +Now to prevent modified attributes also being persisted, tweak the encode +settings for the file cache: + +.. code-block:: python + :emphasize-lines: 1, 9-12 + + import functools + + + def cache_maker(session): + '''Return cache to use for *session*.''' + return SelectiveCache( + ftrack_api.cache.SerialisedCache( + ftrack_api.cache.FileCache(cache_path), + encode=functools.partial( + session.encode, + entity_attribute_strategy='persisted_only' + ), + decode=session.decode + ) + ) + +And use the updated cache maker for your session:: + + session = ftrack_api.Session(cache=cache_maker) + +.. note:: + + For some type of attributes that are computed, long term caching is not + recommended and such values will not be encoded with the `persisted_only` + strategy. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/conf.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/conf.py new file mode 100644 index 0000000000..1154472155 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/conf.py @@ -0,0 +1,102 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +'''ftrack Python API documentation build configuration file.''' + +import os +import re + +# -- General ------------------------------------------------------------------ + +# Extensions. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.extlinks', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', + 'lowdown' +] + + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'ftrack Python API' +copyright = u'2014, ftrack' + +# Version +with open( + os.path.join( + os.path.dirname(__file__), '..', 'source', + 'ftrack_api', '_version.py' + ) +) as _version_file: + _version = re.match( + r'.*__version__ = \'(.*?)\'', _version_file.read(), re.DOTALL + ).group(1) + +version = _version +release = _version + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_template'] + +# A list of prefixes to ignore for module listings. +modindex_common_prefix = [ + 'ftrack_api.' +] + +# -- HTML output -------------------------------------------------------------- + +if not os.environ.get('READTHEDOCS', None) == 'True': + # Only import and set the theme if building locally. + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +html_static_path = ['_static'] +html_style = 'ftrack.css' + +# If True, copy source rst files to output for reference. +html_copy_source = True + + +# -- Autodoc ------------------------------------------------------------------ + +autodoc_default_flags = ['members', 'undoc-members', 'inherited-members'] +autodoc_member_order = 'bysource' + + +def autodoc_skip(app, what, name, obj, skip, options): + '''Don't skip __init__ method for autodoc.''' + if name == '__init__': + return False + + return skip + + +# -- Intersphinx -------------------------------------------------------------- + +intersphinx_mapping = { + 'python': ('http://docs.python.org/', None), + 'ftrack': ( + 'http://rtd.ftrack.com/docs/ftrack/en/stable/', None + ) +} + + +# -- Todos --------------------------------------------------------------------- + +todo_include_todos = os.environ.get('FTRACK_DOC_INCLUDE_TODOS', False) == 'True' + + +# -- Setup -------------------------------------------------------------------- + +def setup(app): + app.connect('autodoc-skip-member', autodoc_skip) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/docutils.conf b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/docutils.conf new file mode 100644 index 0000000000..3c927cc1ee --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/docutils.conf @@ -0,0 +1,2 @@ +[html4css1 writer] +field-name-limit:0 \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/environment_variables.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/environment_variables.rst new file mode 100644 index 0000000000..99019ee44f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/environment_variables.rst @@ -0,0 +1,56 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _environment_variables: + +********************* +Environment variables +********************* + +The following is a consolidated list of environment variables that this API +can reference: + +.. envvar:: FTRACK_SERVER + + The full url of the ftrack server to connect to. For example + "https://mycompany.ftrackapp.com" + +.. envvar:: FTRACK_API_USER + + The username of the ftrack user to act on behalf of when performing actions + in the system. + + .. note:: + + When this environment variable is not set, the API will typically also + check other standard operating system variables that hold the username + of the current logged in user. To do this it uses + :func:`getpass.getuser`. + +.. envvar:: FTRACK_API_KEY + + The API key to use when performing actions in the system. The API key is + used to determine the permissions that a script has in the system. + +.. envvar:: FTRACK_APIKEY + + For backwards compatibility. See :envvar:`FTRACK_API_KEY`. + +.. envvar:: FTRACK_EVENT_PLUGIN_PATH + + Paths to search recursively for plugins to load and use in a session. + Multiple paths can be specified by separating with the value of + :attr:`os.pathsep` (e.g. ':' or ';'). + +.. envvar:: FTRACK_API_SCHEMA_CACHE_PATH + + Path to a directory that will be used for storing and retrieving a cache of + the entity schemas fetched from the server. + +.. envvar:: http_proxy / https_proxy + + If you need to use a proxy to connect to ftrack you can use the + "standard" :envvar:`http_proxy` and :envvar:`https_proxy`. Please note that they + are lowercase. + + For example "export https_proxy=http://proxy.mycompany.com:8080" \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/event_list.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/event_list.rst new file mode 100644 index 0000000000..0c44a1b68c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/event_list.rst @@ -0,0 +1,137 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _event_list: + +********** +Event list +********** + +The following is a consolidated list of events published directly by this API. + +For some events, a template plugin file is also listed for download +(:guilabel:`Download template plugin`) to help get you started with writing your +own plugin for a particular event. + +.. seealso:: + + * :ref:`handling_events` + * :ref:`ftrack server event list ` + +.. _event_list/ftrack.api.session.construct-entity-type: + +ftrack.api.session.construct-entity-type +======================================== + +:download:`Download template plugin +` + +:ref:`Synchronous `. Published by +the session to retrieve constructed class for specified schema:: + + Event( + topic='ftrack.api.session.construct-entity-type', + data=dict( + schema=schema, + schemas=schemas + ) + ) + +Expects returned data to be:: + + A Python class. + +.. seealso:: :ref:`working_with_entities/entity_types`. + +.. _event_list/ftrack.api.session.configure-location: + +ftrack.api.session.configure-location +===================================== + +:download:`Download template plugin +` + +:ref:`Synchronous `. Published by +the session to allow configuring of location instances:: + + Event( + topic='ftrack.api.session.configure-location', + data=dict( + session=self + ) + ) + +.. seealso:: :ref:`Configuring locations `. + +.. _event_list/ftrack.location.component-added: + +ftrack.location.component-added +=============================== + +Published whenever a component is added to a location:: + + Event( + topic='ftrack.location.component-added', + data=dict( + component_id='e2dc0524-b576-11d3-9612-080027331d74', + location_id='07b82a97-8cf9-11e3-9383-20c9d081909b' + ) + ) + +.. _event_list/ftrack.location.component-removed: + +ftrack.location.component-removed +================================= + +Published whenever a component is removed from a location:: + + Event( + topic='ftrack.location.component-removed', + data=dict( + component_id='e2dc0524-b576-11d3-9612-080027331d74', + location_id='07b82a97-8cf9-11e3-9383-20c9d081909b' + ) + ) + +.. _event_list/ftrack.api.session.ready: + +ftrack.api.session.ready +======================== + +:ref:`Synchronous `. Published after +a :class:`~ftrack_api.session.Session` has been initialized and +is ready to be used:: + + Event( + topic='ftrack.api.session.ready', + data=dict( + session=, + ) + ) + +.. warning:: + + Since the event is synchronous and blocking, avoid doing any unnecessary + work as it will slow down session initialization. + +.. seealso:: + + Also see example usage in :download:`example_plugin_using_session.py + `. + + +.. _event_list/ftrack.api.session.reset: + +ftrack.api.session.reset +======================== + +:ref:`Synchronous `. Published after +a :class:`~ftrack_api.session.Session` has been reset and is ready to be used +again:: + + Event( + topic='ftrack.api.session.reset', + data=dict( + session=, + ) + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/assignments_and_allocations.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/assignments_and_allocations.rst new file mode 100644 index 0000000000..985eb9bb44 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/assignments_and_allocations.rst @@ -0,0 +1,82 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _example/assignments_and_allocations: + +**************************************** +Working with assignments and allocations +**************************************** + +.. currentmodule:: ftrack_api.session + +The API exposes `assignments` and `allocations` relationships on objects in +the project hierarchy. You can use these to retrieve the allocated or assigned +resources, which can be either groups or users. + +Allocations can be used to allocate users or groups to a project team, while +assignments are more explicit and is used to assign users to tasks. Both +assignment and allocations are modelled as `Appointment` objects, with a +`type` attribute indicating the type of the appoinment. + +The following example retrieves all users part of the project team:: + + # Retrieve a project + project = session.query('Project').first() + + # Set to hold all users part of the project team + project_team = set() + + # Add all allocated groups and users + for allocation in project['allocations']: + + # Resource may be either a group or a user + resource = allocation['resource'] + + # If the resource is a group, add its members + if isinstance(resource, session.types['Group']): + for membership in resource['memberships']: + user = membership['user'] + project_team.add(user) + + # The resource is a user, add it. + else: + user = resource + project_team.add(user) + +The next example shows how to assign the current user to a task:: + + # Retrieve a task and the current user + task = session.query('Task').first() + current_user = session.query( + u'User where username is {0}'.format(session.api_user) + ).one() + + # Create a new Appointment of type assignment. + session.create('Appointment', { + 'context': task, + 'resource': current_user, + 'type': 'assignment' + }) + + # Finally, persist the new assignment + session.commit() + +To list all users assigned to a task, see the following example:: + + task = session.query('Task').first() + users = session.query( + 'select first_name, last_name from User ' + 'where assignments any (context_id = "{0}")'.format(task['id']) + ) + for user in users: + print user['first_name'], user['last_name'] + +To list the current user's assigned tasks, see the example below:: + + assigned_tasks = session.query( + 'select link from Task ' + 'where assignments any (resource.username = "{0}")'.format(session.api_user) + ) + for task in assigned_tasks: + print u' / '.join(item['name'] for item in task['link']) + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/component.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/component.rst new file mode 100644 index 0000000000..6a39bb20d1 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/component.rst @@ -0,0 +1,23 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _example/component: + +*********************** +Working with components +*********************** + +.. currentmodule:: ftrack_api.session + +Components can be created manually or using the provide helper methods on a +:meth:`session ` or existing +:meth:`asset version +`:: + + component = version.create_component('/path/to/file_or_sequence.jpg') + session.commit() + +When a component is created using the helpers it is automatically added to a +location. + +.. seealso:: :ref:`Locations tutorial ` diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/custom_attribute.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/custom_attribute.rst new file mode 100644 index 0000000000..033942b442 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/custom_attribute.rst @@ -0,0 +1,94 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _example/custom_attribute: + +*********************** +Using custom attributes +*********************** + +.. currentmodule:: ftrack_api.session + +Custom attributes can be written and read from entities using the +``custom_attributes`` property. + +The ``custom_attributes`` property provides a similar interface to a dictionary. + +Keys can be printed using the keys method:: + + >>> task['custom_attributes'].keys() + [u'my_text_field'] + +or access keys and values as items:: + + >>> print task['custom_attributes'].items() + [(u'my_text_field', u'some text')] + +Read existing custom attribute values:: + + >>> print task['custom_attributes']['my_text_field'] + 'some text' + +Updating a custom attributes can also be done similar to a dictionary:: + + task['custom_attributes']['my_text_field'] = 'foo' + +To query for tasks with a custom attribute, ``my_text_field``, you can use the +key from the configuration:: + + for task in session.query( + 'Task where custom_attributes any ' + '(key is "my_text_field" and value is "bar")' + ): + print task['name'] + +Limitations +=========== + +Expression attributes +--------------------- + +Expression attributes are not yet supported and the reported value will +always be the non-evaluated expression. + +Hierarchical attributes +----------------------- + +Hierarchical attributes are not yet fully supported in the API. Hierarchical +attributes support both read and write, but when read they are not calculated +and instead the `raw` value is returned:: + + # The hierarchical attribute `my_attribute` is set on Shot but this will not + # be reflected on the children. Instead the raw value is returned. + print shot['custom_attributes']['my_attribute'] + 'foo' + print task['custom_attributes']['my_attribute'] + None + +To work around this limitation it is possible to use the legacy api for +hierarchical attributes or to manually query the parents for values and use the +first value that is set. + +Validation +========== + +Custom attributes are validated on the ftrack server before persisted. The +validation will check that the type of the data is correct for the custom +attribute. + + * number - :py:class:`int` or :py:class:`float` + * text - :py:class:`str` or :py:class:`unicode` + * enumerator - :py:class:`list` + * boolean - :py:class:`bool` + * date - :py:class:`datetime.datetime` or :py:class:`datetime.date` + +If the value set is not valid a :py:exc:`ftrack_api.exception.ServerError` is +raised with debug information:: + + shot['custom_attributes']['fstart'] = 'test' + + Traceback (most recent call last): + ... + ftrack_api.exception.ServerError: Server reported error: + ValidationError(Custom attribute value for "fstart" must be of type number. + Got "test" of type ) \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/encode_media.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/encode_media.rst new file mode 100644 index 0000000000..2be01ffe47 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/encode_media.rst @@ -0,0 +1,53 @@ +.. + :copyright: Copyright (c) 2016 ftrack + +.. currentmodule:: ftrack_api.session + +.. _example/encode_media: + +************** +Encoding media +************** + +Media such as images and video can be encoded by the ftrack server to allow +playing it in the ftrack web interface. Media can be encoded using +:meth:`ftrack_api.session.Session.encode_media` which accepts a path to a file +or an existing component in the ftrack.server location. + +Here is an example of how to encode a video and read the output:: + + job = session.encode_media('/PATH/TO/MEDIA') + job_data = json.loads(job['data']) + + print 'Source component id', job_data['source_component_id'] + print 'Keeping original component', job_data['keep_original'] + for output in job_data['output']: + print u'Output component - id: {0}, format: {1}'.format( + output['component_id'], output['format'] + ) + +You can also call the corresponding helper method on an :meth:`asset version +`, to have the +encoded components automatically associated with the version:: + + job = asset_version.encode_media('/PATH/TO/MEDIA') + +It is also possible to get the URL to an encoded component once the job has +finished:: + + job = session.encode_media('/PATH/TO/MEDIA') + + # Wait for job to finish. + + location = session.query('Location where name is "ftrack.server"').one() + for component in job['job_components']: + print location.get_url(component) + +Media can also be an existing component in another location. Before encoding it, +the component needs to be added to the ftrack.server location:: + + location = session.query('Location where name is "ftrack.server"').one() + location.add_component(component) + session.commit() + + job = session.encode_media(component) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/entity_links.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/entity_links.rst new file mode 100644 index 0000000000..43e31484f4 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/entity_links.rst @@ -0,0 +1,56 @@ +.. + :copyright: Copyright (c) 2016 ftrack + +.. _example/entity_links: + +****************** +Using entity links +****************** + +A link can be used to represent a dependency or another relation between +two entities in ftrack. + +There are two types of entities that can be linked: + +* Versions can be linked to other asset versions, where the link entity type + is `AssetVersionLink`. +* Objects like Task, Shot or Folder, where the link entity type is + `TypedContextLink`. + +Both `AssetVersion` and `TypedContext` objects have the same relations +`incoming_links` and `outgoing_links`. To list the incoming links to a Shot we +can use the relationship `incoming_links`:: + + for link in shot['incoming_links']: + print link['from'], link['to'] + +In the above example `link['to']` is the shot and `link['from']` could be an +asset build or something else that is linked to the shot. There is an equivalent +`outgoing_links` that can be used to access outgoing links on an object. + +To create a new link between objects or asset versions create a new +`TypedContextLink` or `AssetVersionLink` entity with the from and to properties +set. In this example we will link two asset versions:: + + session.create('AssetVersionLink', { + 'from': from_asset_version, + 'to': to_asset_version + }) + session.commit() + +Using asset version link shortcut +================================= + +Links on asset version can also be created by the use of the `uses_versions` and +`used_in_versions` relations:: + + rig_version['uses_versions'].append(model_version) + session.commit() + +This has the same result as creating the `AssetVersionLink` entity as in the +previous section. + +Which versions are using the model can be listed with:: + + for version in model_version['used_in_versions']: + print '{0} is using {1}'.format(version, model_version) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/index.rst new file mode 100644 index 0000000000..4fca37d754 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/index.rst @@ -0,0 +1,52 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. currentmodule:: ftrack_api.session + +.. _example: + +************** +Usage examples +************** + +The following examples show how to use the API to accomplish specific tasks +using the default configuration. + +.. note:: + + If you are using a server with a customised configuration you may need to + alter the examples slightly to make them work correctly. + +Most of the examples assume you have the *ftrack_api* package imported and have +already constructed a :class:`Session`:: + + import ftrack_api + + session = ftrack_api.Session() + + +.. toctree:: + + project + component + review_session + metadata + custom_attribute + manage_custom_attribute_configuration + link_attribute + scope + job + note + list + timer + assignments_and_allocations + thumbnail + encode_media + entity_links + web_review + publishing + security_roles + task_template + sync_ldap_users + invite_user + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/invite_user.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/invite_user.rst new file mode 100644 index 0000000000..342f0ef602 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/invite_user.rst @@ -0,0 +1,31 @@ +.. + :copyright: Copyright (c) 2017 ftrack + +.. _example/invite_user: + +********************* +Invite user +********************* + +Here we create a new user and send them a invitation through mail + + +Create a new user:: + + user_email = 'artist@mail.vfx-company.com' + + new_user = session.create( + 'User', { + 'username':user_email, + 'email':user_email, + 'is_active':True + } + ) + + session.commit() + + +Invite our new user:: + + new_user.send_invite() + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/job.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/job.rst new file mode 100644 index 0000000000..296a0f5e17 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/job.rst @@ -0,0 +1,97 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _example/job: + +************* +Managing jobs +************* + +.. currentmodule:: ftrack_api.session + +Jobs can be used to display feedback to users in the ftrack web interface when +performing long running tasks in the API. + +To create a job use :meth:`Session.create`:: + + user = # Get a user from ftrack. + + job = session.create('Job', { + 'user': user, + 'status': 'running' + }) + +The created job will appear as running in the :guilabel:`jobs` menu for the +specified user. To set a description on the job, add a dictionary containing +description as the `data` key: + +.. note:: + + In the current version of the API the dictionary needs to be JSON + serialised. + +.. code-block:: python + + import json + + job = session.create('Job', { + 'user': user, + 'status': 'running', + 'data': json.dumps({ + 'description': 'My custom job description.' + }) + }) + +When the long running task has finished simply set the job as completed and +continue with the next task. + +.. code-block:: python + + job['status'] = 'done' + session.commit() + +Attachments +=========== + +Job attachments are files that are attached to a job. In the ftrack web +interface these attachments can be downloaded by clicking on a job in the `Jobs` +menu. + +To get a job's attachments through the API you can use the `job_components` +relation and then use the ftrack server location to get the download URL:: + + server_location = session.query( + 'Location where name is "ftrack.server"' + ).one() + + for job_component in job['job_components']: + print 'Download URL: {0}'.format( + server_location.get_url(job_component['component']) + ) + +To add an attachment to a job you have to add it to the ftrack server location +and create a `jobComponent`:: + + server_location = session.query( + 'Location where name is "ftrack.server"' + ).one() + + # Create component and name it "My file". + component = session.create_component( + '/path/to/file', + data={'name': 'My file'}, + location=server_location + ) + + # Attach the component to the job. + session.create( + 'JobComponent', + {'component_id': component['id'], 'job_id': job['id']} + ) + + session.commit() + +.. note:: + + The ftrack web interface does only support downloading one attachment so + attaching more than one will have limited support in the web interface. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/link_attribute.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/link_attribute.rst new file mode 100644 index 0000000000..1dcea842cd --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/link_attribute.rst @@ -0,0 +1,55 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _example/link_attribute: + +********************* +Using link attributes +********************* + +The `link` attribute can be used to retreive the ids and names of the parents of +an object. It is particularly useful in cases where the path of an object must +be presented in a UI, but can also be used to speedup certain query patterns. + +You can use the `link` attribute on any entity inheriting from a +`Context` or `AssetVersion`. Here we use it on the `Task` entity:: + + task = session.query( + 'select link from Task where name is "myTask"' + ).first() + print task['link'] + +It can also be used create a list of parent entities, including the task +itself:: + + entities = [] + for item in task['link']: + entities.append(session.get(item['type'], item['id'])) + +The `link` attribute is an ordered list of dictionaries containting data +of the parents and the item itself. Each dictionary contains the following +entries: + + id + The id of the object and can be used to do a :meth:`Session.get`. + name + The name of the object. + type + The schema id of the object. + +A more advanced use-case is to get the parent names and ids of all timelogs for +a user:: + + for timelog in session.query( + 'select context.link, start, duration from Timelog ' + 'where user.username is "john.doe"' + ): + print timelog['context']['link'], timelog['start'], timelog['duration'] + +The attribute is also available from the `AssetVersion` asset relation:: + + for asset_version in session.query( + 'select link from AssetVersion ' + 'where user.username is "john.doe"' + ): + print asset_version['link'] diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/list.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/list.rst new file mode 100644 index 0000000000..155b25f9af --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/list.rst @@ -0,0 +1,46 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _example/list: + +*********** +Using lists +*********** + +.. currentmodule:: ftrack_api.session + +Lists can be used to create a collection of asset versions or objects such as +tasks. It could be a list of items that should be sent to client, be included in +todays review session or items that belong together in way that is different +from the project hierarchy. + +There are two types of lists, one for asset versions and one for other objects +such as tasks. + +To create a list use :meth:`Session.create`:: + + user = # Get a user from ftrack. + project = # Get a project from ftrack. + list_category = # Get a list category from ftrack. + + asset_version_list = session.create('AssetVersionList', { + 'owner': user, + 'project': project, + 'category': list_category + }) + + task_list = session.create('TypedContextList', { + 'owner': user, + 'project': project, + 'category': list_category + }) + +Then add items to the list like this:: + + asset_version_list['items'].append(asset_version) + task_list['items'].append(task) + +And remove items from the list like this:: + + asset_version_list['items'].remove(asset_version) + task_list['items'].remove(task) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/manage_custom_attribute_configuration.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/manage_custom_attribute_configuration.rst new file mode 100644 index 0000000000..e3d7c4062c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/manage_custom_attribute_configuration.rst @@ -0,0 +1,320 @@ +.. + :copyright: Copyright (c) 2017 ftrack + +.. _example/manage_custom_attribute_configuration: + +**************************************** +Managing custom attribute configurations +**************************************** + +From the API it is not only possible to +:ref:`read and update custom attributes for entities `, +but also managing custom attribute configurations. + +Existing custom attribute configurations can be queried as :: + + # Print all existing custom attribute configurations. + print session.query('CustomAttributeConfiguration').all() + +Use :meth:`Session.create` to create a new custom attribute configuration:: + + # Get the custom attribute type. + custom_attribute_type = session.query( + 'CustomAttributeType where name is "text"' + ).one() + + # Create a custom attribute configuration. + session.create('CustomAttributeConfiguration', { + 'entity_type': 'assetversion', + 'type': custom_attribute_type, + 'label': 'Asset version text attribute', + 'key': 'asset_version_text_attribute', + 'default': 'bar', + 'config': json.dumps({'markdown': False}) + }) + + # Persist it to the ftrack instance. + session.commit() + +.. tip:: + + The example above does not add security roles. This can be done either + from System Settings in the ftrack web application, or by following the + :ref:`example/manage_custom_attribute_configuration/security_roles` example. + +Global or project specific +========================== + +A custom attribute can be global or project specific depending on the +`project_id` attribute:: + + # Create a custom attribute configuration. + session.create('CustomAttributeConfiguration', { + # Set the `project_id` and the custom attribute will only be available + # on `my_project`. + 'project_id': my_project['id'], + 'entity_type': 'assetversion', + 'type': custom_attribute_type, + 'label': 'Asset version text attribute', + 'key': 'asset_version_text_attribute', + 'default': 'bar', + 'config': json.dumps({'markdown': False}) + }) + session.commit() + +A project specific custom attribute can be changed to a global:: + + custom_attribute_configuration['project_id'] = None + session.commit() + +Changing a global custom attribute configuration to a project specific is not +allowed. + +Entity types +============ + +Custom attribute configuration entity types are using a legacy notation. A +configuration can have one of the following as `entity_type`: + +:task: + Represents TypedContext (Folder, Shot, Sequence, Task, etc.) custom + attribute configurations. When setting this as entity_type the + object_type_id must be set as well. + + Creating a text custom attribute for Folder:: + + custom_attribute_type = session.query( + 'CustomAttributeType where name is "text"' + ).one() + object_type = session.query('ObjectType where name is "Folder"').one() + session.create('CustomAttributeConfiguration', { + 'entity_type': 'task', + 'object_type_id': object_type['id'], + 'type': custom_attribute_type, + 'label': 'Foo', + 'key': 'foo', + 'default': 'bar', + }) + session.commit() + + Can be associated with a `project_id`. + +:show: + Represents Projects custom attribute configurations. + + Can be associated with a `project_id`. + +:assetversion: + Represents AssetVersion custom attribute configurations. + + Can be associated with a `project_id`. + +:user: + Represents User custom attribute configurations. + + Must be `global` and cannot be associated with a `project_id`. + +:list: + Represents List custom attribute configurations. + + Can be associated with a `project_id`. + +:asset: + Represents Asset custom attribute configurations. + + .. note:: + + Asset custom attributes have limited support in the ftrack web + interface. + + Can be associated with a `project_id`. + +It is not possible to change type after a custom attribute configuration has +been created. + +Custom attribute configuration types +==================================== + +Custom attributes can be of different data types depending on what type is set +in the configuration. Some types requires an extra json encoded config to be +set: + +:text: + A sting type custom attribute. + + The `default` value must be either :py:class:`str` or :py:class:`unicode`. + + Can be either presented as raw text or markdown formatted in applicaitons + which support it. This is configured through a markwdown key:: + + # Get the custom attribute type. + custom_attribute_type = session.query( + 'CustomAttributeType where name is "text"' + ).one() + + # Create a custom attribute configuration. + session.create('CustomAttributeConfiguration', { + 'entity_type': 'assetversion', + 'type': custom_attribute_type, + 'label': 'Asset version text attribute', + 'key': 'asset_version_text_attribute', + 'default': 'bar', + 'config': json.dumps({'markdown': False}) + }) + + # Persist it to the ftrack instance. + session.commit() + +:boolean: + + A boolean type custom attribute. + + The `default` value must be a :py:class:`bool`. + + No config is required. + +:date: + A date type custom attribute. + + The `default` value must be an :term:`arrow` date - e.g. + arrow.Arrow(2017, 2, 8). + + No config is required. + +:enumerator: + An enumerator type custom attribute. + + The `default` value must be a list with either :py:class:`str` or + :py:class:`unicode`. + + The enumerator can either be single or multi select. The config must a json + dump of a dictionary containing `multiSelect` and `data`. Where + `multiSelect` is True or False and data is a list of options. Each option + should be a dictionary containing `value` and `menu`, where `menu` is meant + to be used as label in a user interface. + + Create a custom attribute enumerator:: + + custom_attribute_type = session.query( + 'CustomAttributeType where name is "enumerator"' + ).first() + session.create('CustomAttributeConfiguration', { + 'entity_type': 'assetversion', + 'type': custom_attribute_type, + 'label': 'Enumerator attribute', + 'key': 'enumerator_attribute', + 'default': ['bar'], + 'config': json.dumps({ + 'multiSelect': True, + 'data': json.dumps([ + {'menu': 'Foo', 'value': 'foo'}, + {'menu': 'Bar', 'value': 'bar'} + ]) + }) + }) + session.commit() + +:dynamic enumerator: + + An enumerator type where available options are fetched from remote. Created + in the same way as enumerator but without `data`. + +:number: + + A number custom attribute can be either decimal or integer for presentation. + + This can be configured through the `isdecimal` config option:: + + custom_attribute_type = session.query( + 'CustomAttributeType where name is "number"' + ).first() + session.create('CustomAttributeConfiguration', { + 'entity_type': 'assetversion', + 'type': custom_attribute_type, + 'label': 'Number attribute', + 'key': 'number_attribute', + 'default': 42, + 'config': json.dumps({ + 'isdecimal': True + }) + }) + session.commit() + +Changing default +================ + +It is possible to update the `default` value of a custom attribute +configuration. This will not change the value of any existing custom +attributes:: + + # Change the default value of custom attributes. This will only affect + # newly created entities. + custom_attribute_configuration['default'] = 43 + session.commit() + +.. _example/manage_custom_attribute_configuration/security_roles: + +Security roles +============== + +By default new custom attribute configurations and the entity values are not +readable or writable by any security role. + +This can be configured through the `read_security_roles` and `write_security_roles` +attributes:: + + # Pick random security role. + security_role = session.query('SecurityRole').first() + custom_attribute_type = session.query( + 'CustomAttributeType where name is "date"' + ).first() + session.create('CustomAttributeConfiguration', { + 'entity_type': 'assetversion', + 'type': custom_attribute_type, + 'label': 'Date attribute', + 'key': 'date_attribute', + 'default': arrow.Arrow(2017, 2, 8), + 'write_security_roles': [security_role], + 'read_security_roles': [security_role] + }) + session.commit() + +.. note:: + + Setting the correct security role is important and must be changed to + whatever security role is appropriate for your configuration and intended + purpose. + +Custom attribute groups +======================= + +A custom attribute configuration can be categorized using a +`CustomAttributeGroup`:: + + group = session.query('CustomAttributeGroup').first() + security_role = session.query('SecurityRole').first() + custom_attribute_type = session.query( + 'CustomAttributeType where name is "enumerator"' + ).first() + session.create('CustomAttributeConfiguration', { + 'entity_type': 'assetversion', + 'type': custom_attribute_type, + 'label': 'Enumerator attribute', + 'key': 'enumerator_attribute', + 'default': ['bar'], + 'config': json.dumps({ + 'multiSelect': True, + 'data': json.dumps([ + {'menu': 'Foo', 'value': 'foo'}, + {'menu': 'Bar', 'value': 'bar'} + ]) + }), + 'group': group, + 'write_security_roles': [security_role], + 'read_security_roles': [security_role] + }) + session.commit() + +.. seealso:: + + :ref:`example/custom_attribute` diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/metadata.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/metadata.rst new file mode 100644 index 0000000000..7b16881017 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/metadata.rst @@ -0,0 +1,43 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _example/metadata: + +************** +Using metadata +************** + +.. currentmodule:: ftrack_api.session + +Key/value metadata can be written to entities using the metadata property +and also used to query entities. + +The metadata property has a similar interface as a dictionary and keys can be +printed using the keys method:: + + >>> print new_sequence['metadata'].keys() + ['frame_padding', 'focal_length'] + +or items:: + + >>> print new_sequence['metadata'].items() + [('frame_padding': '4'), ('focal_length': '70')] + +Read existing metadata:: + + >>> print new_sequence['metadata']['frame_padding'] + '4' + +Setting metadata can be done in a few ways where that later one will replace +any existing metadata:: + + new_sequence['metadata']['frame_padding'] = '5' + new_sequence['metadata'] = { + 'frame_padding': '4' + } + +Entities can also be queried using metadata:: + + session.query( + 'Sequence where metadata any (key is "frame_padding" and value is "4")' + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/note.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/note.rst new file mode 100644 index 0000000000..8f8f1bb57d --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/note.rst @@ -0,0 +1,169 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. currentmodule:: ftrack_api.session + +.. _example/note: + +*********** +Using notes +*********** + +Notes can be written on almost all levels in ftrack. To retrieve notes on an +entity you can either query them or use the relation called `notes`:: + + task = session.query('Task').first() + + # Retrieve notes using notes property. + notes_on_task = task['notes'] + + # Or query them. + notes_on_task = session.query('Note where parent_id is "{}"'.format( + task['id'] + )) + +.. note:: + + It's currently not possible to use the `parent` property when querying + notes or to use the `parent` property on notes:: + + task = session.query('Task').first() + + # This won't work in the current version of the API. + session.query('Note where parent.id is "{}"'.format( + task['id'] + )) + + # Neither will this. + parent_of_note = note['parent'] + +To create new notes you can either use the helper method called +:meth:`~ftrack_api.entity.note.CreateNoteMixin.create_note` on any entity that +can have notes or use :meth:`Session.create` to create them manually:: + + user = session.query('User').first() + + # Create note using the helper method. + note = task.create_note('My new note', author=user) + + # Manually create a note + note = session.create('Note', { + 'content': 'My new note', + 'author': user + }) + + task['notes'].append(note) + +Replying to an existing note can also be done with a helper method or by +using :meth:`Session.create`:: + + # Create using helper method. + first_note_on_task = task['notes'][0] + first_note_on_task.create_reply('My new reply on note', author=user) + + # Create manually + reply = session.create('Note', { + 'content': 'My new note', + 'author': user + }) + + first_note_on_task.replies.append(reply) + +Notes can have labels. Use the label argument to set labels on the +note using the helper method:: + + label = session.query( + 'NoteLabel where name is "External Note"' + ).first() + + note = task.create_note( + 'New note with external category', author=user, labels=[label] + ) + +Or add labels to notes when creating a note manually:: + + label = session.query( + 'NoteLabel where name is "External Note"' + ).first() + + note = session.create('Note', { + 'content': 'New note with external category', + 'author': user + }) + + session.create('NoteLabelLink', { + 'note_id': note['id], + 'label_id': label['id'] + }) + + task['notes'].append(note) + +.. note:: + + Support for labels on notes was added in ftrack server version 4.3. For + older versions of the server, NoteCategory can be used instead. + +To specify a category when creating a note simply pass a `NoteCategory` instance +to the helper method:: + + category = session.query( + 'NoteCategory where name is "External Note"' + ).first() + + note = task.create_note( + 'New note with external category', author=user, category=category + ) + +When writing notes you might want to direct the note to someone. This is done +by adding users as recipients. If a user is added as a recipient the user will +receive notifications and the note will be displayed in their inbox. + +To add recipients pass a list of user or group instances to the helper method:: + + john = session.query('User where username is "john"').one() + animation_group = session.query('Group where name is "Animation"').first() + + note = task.create_note( + 'Note with recipients', author=user, recipients=[john, animation_group] + ) + +Attachments +=========== + +Note attachments are files that are attached to a note. In the ftrack web +interface these attachments appears next to the note and can be downloaded by +the user. + +To get a note's attachments through the API you can use the `note_components` +relation and then use the ftrack server location to get the download URL:: + + server_location = session.query( + 'Location where name is "ftrack.server"' + ).one() + + for note_component in note['note_components']: + print 'Download URL: {0}'.format( + server_location.get_url(note_component['component']) + ) + +To add an attachment to a note you have to add it to the ftrack server location +and create a `NoteComponent`:: + + server_location = session.query( + 'Location where name is "ftrack.server"' + ).one() + + # Create component and name it "My file". + component = session.create_component( + '/path/to/file', + data={'name': 'My file'}, + location=server_location + ) + + # Attach the component to the note. + session.create( + 'NoteComponent', + {'component_id': component['id'], 'note_id': note['id']} + ) + + session.commit() diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/project.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/project.rst new file mode 100644 index 0000000000..0b4c0879d6 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/project.rst @@ -0,0 +1,65 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _example/project: + +********************* +Working with projects +********************* + +.. currentmodule:: ftrack_api.session + +Creating a project +================== + +A project with sequences, shots and tasks can be created in one single +transaction. Tasks need to have a type and status set on creation based on the +project schema:: + + import uuid + + # Create a unique name for the project. + name = 'projectname_{0}'.format(uuid.uuid1().hex) + + # Naively pick the first project schema. For this example to work the + # schema must contain `Shot` and `Sequence` object types. + project_schema = session.query('ProjectSchema').first() + + # Create the project with the chosen schema. + project = session.create('Project', { + 'name': name, + 'full_name': name + '_full', + 'project_schema': project_schema + }) + + # Retrieve default types. + default_shot_status = project_schema.get_statuses('Shot')[0] + default_task_type = project_schema.get_types('Task')[0] + default_task_status = project_schema.get_statuses( + 'Task', default_task_type['id'] + )[0] + + # Create sequences, shots and tasks. + for sequence_number in range(1, 5): + sequence = session.create('Sequence', { + 'name': 'seq_{0}'.format(sequence_number), + 'parent': project + }) + + for shot_number in range(1, 5): + shot = session.create('Shot', { + 'name': '{0}0'.format(shot_number).zfill(3), + 'parent': sequence, + 'status': default_shot_status + }) + + for task_number in range(1, 5): + session.create('Task', { + 'name': 'task_{0}'.format(task_number), + 'parent': shot, + 'status': default_task_status, + 'type': default_task_type + }) + + # Commit all changes to the server. + session.commit() diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/publishing.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/publishing.rst new file mode 100644 index 0000000000..bf1da18ab9 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/publishing.rst @@ -0,0 +1,73 @@ +.. + :copyright: Copyright (c) 2016 ftrack + +.. currentmodule:: ftrack_api.session + +.. _example/publishing: + +******************* +Publishing versions +******************* + +To know more about publishing and the concepts around publishing, read the +`ftrack article `_ +about publishing. + +To publish an asset you first need to get the context where the asset should be +published:: + + # Get a task from a given id. + task = session.get('Task', '423ac382-e61d-4802-8914-dce20c92b740') + +And the parent of the task which will be used to publish the asset on:: + + asset_parent = task['parent'] + +Then we create an asset and a version on the asset:: + + asset_type = session.query('AssetType where name is "Geometry"').one() + asset = session.create('Asset', { + 'name': 'My asset', + 'type': asset_type, + 'parent': asset_parent + }) + asset_version = session.create('AssetVersion', { + 'asset': asset, + 'task': task + }) + +.. note:: + + The task is not used as the parent of the asset, instead the task is linked + directly to the AssetVersion. + +Then when we have a version where we can create the components:: + + asset_version.create_component( + '/path/to/a/file.mov', location='auto' + ) + asset_version.create_component( + '/path/to/a/another-file.mov', location='auto' + ) + + session.commit() + +This will automatically create a new component and add it to the location which +has been configured as the first in priority. + +Components can also be named and added to a custom location like this:: + + location = session.query('Location where name is "my-location"') + asset_version.create_component( + '/path/to/a/file.mov', + data={ + 'name': 'foobar' + }, + location=location + ) + +.. seealso:: + + * :ref:`example/component` + * :ref:`example/web_review` + * :ref:`example/thumbnail` diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/review_session.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/review_session.rst new file mode 100644 index 0000000000..68f7870d1c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/review_session.rst @@ -0,0 +1,87 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _example/review_session: + +********************* +Using review sessions +********************* + +.. currentmodule:: ftrack_api.session + +Client review sessions can either be queried manually or by using a project +instance. + +.. code-block:: python + + review_sessions = session.query( + 'ReviewSession where name is "Weekly review"' + ) + + project_review_sessions = project['review_sessions'] + +To create a new review session on a specific project use :meth:`Session.create`. + +.. code-block:: python + + review_session = session.create('ReviewSession', { + 'name': 'Weekly review', + 'description': 'See updates from last week.', + 'project': project + }) + +To add objects to a review session create them using +:meth:`Session.create` and reference a review session and an asset version. + +.. code-block:: python + + review_session = session.create('ReviewSessionObject', { + 'name': 'Compositing', + 'description': 'Fixed shadows.', + 'version': 'Version 3', + 'review_session': review_session, + 'asset_version': asset_version + }) + +To list all objects in a review session. + +.. code-block:: python + + review_session_objects = review_session['review_session_objects'] + +Listing and adding collaborators to review session can be done using +:meth:`Session.create` and the `review_session_invitees` relation on a +review session. + +.. code-block:: python + + invitee = session.create('ReviewSessionInvitee', { + 'name': 'John Doe', + 'email': 'john.doe@example.com', + 'review_session': review_session + }) + + session.commit() + + invitees = review_session['review_session_invitees'] + +To remove a collaborator simply delete the object using +:meth:`Session.delete`. + +.. code-block:: python + + session.delete(invitee) + +To send out an invite email to a signle collaborator use +:meth:`Session.send_review_session_invite`. + +.. code-block:: python + + session.send_review_session_invite(invitee) + +Multiple invitees can have emails sent to them in one batch using +:meth:`Session.send_review_session_invites`. + +.. code-block:: python + + session.send_review_session_invites(a_list_of_invitees) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/scope.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/scope.rst new file mode 100644 index 0000000000..3be42322ce --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/scope.rst @@ -0,0 +1,27 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _example/scope: + +************ +Using scopes +************ + +.. currentmodule:: ftrack_api.session + +Entities can be queried based on their scopes:: + + >>> tasks = session.query( + ... 'Task where scopes.name is "London"' + ... ) + +Scopes can be read and modified for entities:: + + >>> scope = session.query( + ... 'Scope where name is "London"' + ... )[0] + ... + ... if scope in task['scopes']: + ... task['scopes'].remove(scope) + ... else: + ... task['scopes'].append(scope) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/security_roles.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/security_roles.rst new file mode 100644 index 0000000000..4219e3d126 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/security_roles.rst @@ -0,0 +1,73 @@ +.. + :copyright: Copyright (c) 2017 ftrack + +.. _example/security_roles: + +********************************* +Working with user security roles +********************************* + +.. currentmodule:: ftrack_api.session + +The API exposes `SecurityRole` and `UserSecurityRole` that can be used to +specify who should have access to certain data on different projects. + +List all available security roles like this:: + + security_roles = session.query( + 'select name from SecurityRole where type is "PROJECT"' + ) + +.. note:: + + We only query for project roles since those are the ones we can add to a + user for certain projects. Other types include API and ASSIGNED. Type API + can only be added to global API keys, which is currently not supported via + the api and type ASSIGNED only applies to assigned tasks. + +To get all security roles from a user we can either use relations like this:: + + for user_security_role in user['user_security_roles']: + if user_security_role['is_all_projects']: + result_string = 'all projects' + else: + result_string = ', '.join( + [project['full_name'] for project in user_security_role['projects']] + ) + + print 'User has security role "{0}" which is valid on {1}.'.format( + user_security_role['security_role']['name'], + result_string + ) + +or query them directly like this:: + + user_security_roles = session.query( + 'UserSecurityRole where user.username is "{0}"'.format(session.api_user) + ).all() + +User security roles can also be added to a user for all projects like this:: + + project_manager_role = session.query( + 'SecurityRole where name is "Project Manager"' + ).one() + + session.create('UserSecurityRole', { + 'is_all_projects': True, + 'user': user, + 'security_role': project_manager_role + }) + session.commit() + +or for certain projects only like this:: + + projects = session.query( + 'Project where full_name is "project1" or full_name is "project2"' + ).all()[:] + + session.create('UserSecurityRole', { + 'user': user, + 'security_role': project_manager_role, + 'projects': projects + }) + session.commit() diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/sync_ldap_users.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/sync_ldap_users.rst new file mode 100644 index 0000000000..5ea0e47dc6 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/sync_ldap_users.rst @@ -0,0 +1,30 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _example/sync_with_ldap: + +******************** +Sync users with LDAP +******************** + +.. currentmodule:: ftrack_api.session + + +If ftrack is configured to connect to LDAP you may trigger a +synchronization through the api using the +:meth:`ftrack_api.session.Session.call`:: + + result = session.call([ + dict( + action='delayed_job', + job_type='SYNC_USERS_LDAP' + ) + ]) + job = result[0]['data] + +You will get a `ftrack_api.entity.job.Job` instance back which can be used +to check the success of the job:: + + if job.get('status') == 'failed': + # The job failed get the error. + logging.error(job.get('data')) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/task_template.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/task_template.rst new file mode 100644 index 0000000000..c6161e834a --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/task_template.rst @@ -0,0 +1,56 @@ +.. + :copyright: Copyright (c) 2017 ftrack + +.. _example/task_template: + +*************************** +Working with Task Templates +*************************** + +Task templates can help you organize your workflows by building a collection +of tasks to be applied for specific contexts. They can be applied to all `Context` +objects for example Project, Sequences, Shots, etc... + +Query task templates +======================= + +Retrive all task templates and there tasks for a project:: + + project = session.query('Project').first() + + for task_template in project['project_schema']['task_templates']: + print('\ntask template: {0}'.format( + task_template['name'] + )) + + for task_type in [t['task_type'] for t in task_template['items']]: + print('\ttask type: {0}'.format( + task_type['name'] + )) + + + +"Apply" a task template +======================= +Create all tasks in a random task template directly under the project:: + + + project = session.query('Project').first() + + task_template = random.choice( + project['project_schema']['task_templates'] + ) + + for task_type in [t['task_type'] for t in task_template['items']]: + session.create( + 'Task', { + 'name': task_type['name'], + 'type': task_type, + 'parent': project + } + ) + + session.commit() + + + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/thumbnail.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/thumbnail.rst new file mode 100644 index 0000000000..64199869a5 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/thumbnail.rst @@ -0,0 +1,71 @@ +.. + :copyright: Copyright (c) 2016 ftrack + +.. _example/thumbnail: + +*********************** +Working with thumbnails +*********************** + +Components can be used as thumbnails on various entities, including +`Project`, `Task`, `AssetVersion` and `User`. To create and set a thumbnail +you can use the helper method +:meth:`~ftrack_api.entity.component.CreateThumbnailMixin.create_thumbnail` on +any entity that can have a thumbnail:: + + task = session.get('Task', my_task_id) + thumbnail_component = task.create_thumbnail('/path/to/image.jpg') + +It is also possible to set an entity thumbnail by setting its `thumbnail` +relation or `thumbnail_id` attribute to a component you would +like to use as a thumbnail. For a component to be usable as a thumbnail, +it should + + 1. Be a FileComponent. + 2. Exist in the *ftrack.server* :term:`location`. + 3. Be of an appropriate resolution and valid file type. + +The following example creates a new component in the server location, and +uses that as a thumbnail for a task:: + + task = session.get('Task', my_task_id) + server_location = session.query( + 'Location where name is "ftrack.server"' + ).one() + + thumbnail_component = session.create_component( + '/path/to/image.jpg', + dict(name='thumbnail'), + location=server_location + ) + task['thumbnail'] = thumbnail_component + session.commit() + +The next example reuses a version's thumbnail for the asset parent thumbnail:: + + asset_version = session.get('AssetVersion', my_asset_version_id) + asset_parent = asset_version['asset']['parent'] + asset_parent['thumbnail_id'] = asset_version['thumbnail_id'] + session.commit() + +.. _example/thumbnail/url: + +Retrieving thumbnail URL +======================== + +To get an URL to a thumbnail, `thumbnail_component`, which can be used used +to download or display the image in an interface, use the following:: + + import ftrack_api.symbol + server_location = session.get('Location', ftrack_api.symbol.SERVER_LOCATION_ID) + thumbnail_url = server_location.get_thumbnail_url(thumbnail_component) + thumbnail_url_tiny = server_location.get_thumbnail_url( + thumbnail_component, size=100 + ) + thumbnail_url_large = server_location.get_thumbnail_url( + thumbnail_component, size=500 + ) + +.. seealso:: + + :ref:`example/component` diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/timer.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/timer.rst new file mode 100644 index 0000000000..eb86e2f897 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/timer.rst @@ -0,0 +1,37 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _example/timer: + +************ +Using timers +************ + +.. currentmodule:: ftrack_api.session + +Timers can be used to track how much time has been spend working on something. + +To start a timer for a user:: + + user = # Get a user from ftrack. + task = # Get a task from ftrack. + + user.start_timer(task) + +A timer has now been created for that user and should show up in the ftrack web +UI. + +To stop the currently running timer for a user and create a timelog from it:: + + user = # Get a user from ftrack. + + timelog = user.stop_timer() + +.. note:: + + Starting a timer when a timer is already running will raise in an exception. + Use the force parameter to automatically stop the running timer first. + + .. code-block:: python + + user.start_timer(task, force=True) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/web_review.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/web_review.rst new file mode 100644 index 0000000000..f1dede570f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/example/web_review.rst @@ -0,0 +1,78 @@ +.. + :copyright: Copyright (c) 2016 ftrack + +.. currentmodule:: ftrack_api.session + +.. _example/web_review: + +************************* +Publishing for web review +************************* + +Follow the :ref:`example/encode_media` example if you want to +upload and encode media using ftrack. + +If you already have a file encoded in the correct format and want to bypass +the built-in encoding in ftrack, you can create the component manually +and add it to the `ftrack.server` location:: + + # Retrieve or create version. + version = session.query('AssetVersion', 'SOME-ID') + + server_location = session.query('Location where name is "ftrack.server"').one() + filepath = '/path/to/local/file.mp4' + + component = version.create_component( + path=filepath, + data={ + 'name': 'ftrackreview-mp4' + }, + location=server_location + ) + + # Meta data needs to contain *frameIn*, *frameOut* and *frameRate*. + component['metadata']['ftr_meta'] = json.dumps({ + 'frameIn': 0, + 'frameOut': 150, + 'frameRate': 25 + }) + + component.session.commit() + +To publish an image for review the steps are similar:: + + # Retrieve or create version. + version = session.query('AssetVersion', 'SOME-ID') + + server_location = session.query('Location where name is "ftrack.server"').one() + filepath = '/path/to/image.jpg' + + component = version.create_component( + path=filepath, + data={ + 'name': 'ftrackreview-image' + }, + location=server_location + ) + + # Meta data needs to contain *format*. + component['metadata']['ftr_meta'] = json.dumps({ + 'format': 'image' + }) + + component.session.commit() + +Here is a list of components names and how they should be used: + +================== ===================================== +Component name Use +================== ===================================== +ftrackreview-image Images reviewable in the browser +ftrackreview-mp4 H.264/mp4 video reviewable in browser +ftrackreview-webm WebM video reviewable in browser +================== ===================================== + +.. note:: + + Make sure to use the pre-defined component names and set the `ftr_meta` on + the components or review will not work. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/glossary.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/glossary.rst new file mode 100644 index 0000000000..aa5cc77976 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/glossary.rst @@ -0,0 +1,76 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +******** +Glossary +******** + +.. glossary:: + + accessor + An implementation (typically a :term:`Python` plugin) for accessing + a particular type of storage using a specific protocol. + + .. seealso:: :ref:`locations/overview/accessors` + + action + Actions in ftrack provide a standardised way to integrate other tools, + either off-the-shelf or custom built, directly into your ftrack + workflow. + + .. seealso:: :ref:`ftrack:using/actions` + + api + Application programming interface. + + arrow + A Python library that offers a sensible, human-friendly approach to + creating, manipulating, formatting and converting dates, times, and + timestamps. Read more at http://crsmithdev.com/arrow/ + + asset + A container for :term:`asset versions `, typically + representing the output from an artist. For example, 'geometry' + from a modeling artist. Has an :term:`asset type` that categorises the + asset. + + asset type + Category for a particular asset. + + asset version + A specific version of data for an :term:`asset`. Can contain multiple + :term:`components `. + + component + A container to hold any type of data (such as a file or file sequence). + An :term:`asset version` can have any number of components, each with + a specific name. For example, a published version of geometry might + have two components containing the high and low resolution files, with + the component names as 'hires' and 'lowres' respectively. + + PEP-8 + Style guide for :term:`Python` code. Read the guide at + https://www.python.org/dev/peps/pep-0008/ + + plugin + :term:`Python` plugins are used by the API to extend it with new + functionality, such as :term:`locations ` or :term:`actions `. + + .. seealso:: :ref:`understanding_sessions/plugins` + + python + A programming language that lets you work more quickly and integrate + your systems more effectively. Often used in creative industries. Visit + the language website at http://www.python.org + + PyPi + :term:`Python` package index. The Python Package Index or PyPI is the + official third-party software repository for the Python programming + language. Visit the website at https://pypi.python.org/pypi + + resource identifier + A string that is stored in ftrack as a reference to a resource (such as + a file) in a specific location. Used by :term:`accessors ` to + determine how to access data. + + .. seealso:: :ref:`locations/overview/resource_identifiers` diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/handling_events.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/handling_events.rst new file mode 100644 index 0000000000..1d378473fa --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/handling_events.rst @@ -0,0 +1,315 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _handling_events: + +*************** +Handling events +*************** + +.. currentmodule:: ftrack_api.event + +Events are generated in ftrack when things happen such as a task being updated +or a new version being published. Each :class:`~ftrack_api.session.Session` +automatically connects to the event server and can be used to subscribe to +specific events and perform an action as a result. That action could be updating +another related entity based on a status change or generating folders when a new +shot is created for example. + +The :class:`~hub.EventHub` for each :class:`~ftrack_api.session.Session` is +accessible via :attr:`Session.event_hub +<~ftrack_api.session.Session.event_hub>`. + +.. _handling_events/subscribing: + +Subscribing to events +===================== + +To listen to events, you register a function against a subscription using +:meth:`Session.event_hub.subscribe `. The subscription +uses the :ref:`expression ` syntax and will filter +against each :class:`~base.Event` instance to determine if the registered +function should receive that event. If the subscription matches, the registered +function will be called with the :class:`~base.Event` instance as its sole +argument. The :class:`~base.Event` instance is a mapping like structure and can +be used like a normal dictionary. + +The following example subscribes a function to receive all 'ftrack.update' +events and then print out the entities that were updated:: + + import ftrack_api + + + def my_callback(event): + '''Event callback printing all new or updated entities.''' + for entity in event['data'].get('entities', []): + + # Print data for the entity. + print(entity) + + + # Subscribe to events with the update topic. + session = ftrack_api.Session() + session.event_hub.subscribe('topic=ftrack.update', my_callback) + +At this point, if you run this, your code would exit almost immediately. This +is because the event hub listens for events in a background thread. Typically, +you only want to stay connected whilst using the session, but in some cases you +will want to block and listen for events solely - a dedicated event processor. +To do this, use the :meth:`EventHub.wait ` method:: + + # Wait for events to be received and handled. + session.event_hub.wait() + +You cancel waiting for events by using a system interrupt (:kbd:`Ctrl-C`). +Alternatively, you can specify a *duration* to process events for:: + + # Only wait and process events for 5 seconds. + session.event_hub.wait(duration=5) + +.. note:: + + Events are continually received and queued for processing in the background + as soon as the connection to the server is established. As a result you may + see a flurry of activity as soon as you call + :meth:`~hub.EventHub.wait` for the first time. + +.. _handling_events/subscribing/subscriber_information: + +Subscriber information +---------------------- + +When subscribing, you can also specify additional information about your +subscriber. This contextual information can be useful when routing events, +particularly when :ref:`targeting events +`. By default, the +:class:`~hub.EventHub` will set some default information, but it can be +useful to enhance this. To do so, simply pass in *subscriber* as a dictionary of +data to the :meth:`~hub.EventHub.subscribe` method:: + + session.event_hub.subscribe( + 'topic=ftrack.update', + my_callback, + subscriber={ + 'id': 'my-unique-subscriber-id', + 'applicationId': 'maya' + } + ) + +.. _handling_events/subscribing/sending_replies: + +Sending replies +--------------- + +When handling an event it is sometimes useful to be able to send information +back to the source of the event. For example, +:ref:`ftrack:developing/events/list/ftrack.location.request-resolve` would +expect a resolved path to be sent back. + +You can craft a custom reply event if you want, but an easier way is just to +return the appropriate data from your handler. Any non *None* value will be +automatically sent as a reply:: + + def on_event(event): + # Send following data in automatic reply. + return {'success': True, 'message': 'Cool!'} + + session.event_hub.subscribe('topic=test-reply', on_event) + +.. seealso:: + + :ref:`handling_events/publishing/handling_replies` + +.. note:: + + Some events are published :ref:`synchronously + `. In this case, any returned data + is passed back to the publisher directly. + +.. _handling_events/subscribing/stopping_events: + +Stopping events +--------------- + +The *event* instance passed to each event handler also provides a method for +stopping the event, :meth:`Event.stop `. + +Once an event has been stopped, no further handlers for that specific event +will be called **locally**. Other handlers in other processes may still be +called. + +Combining this with setting appropriate priorities when subscribing to a topic +allows handlers to prevent lower priority handlers running when desired. + + >>> import ftrack_api + >>> import ftrack_api.event.base + >>> + >>> def callback_a(event): + ... '''Stop the event!''' + ... print('Callback A') + ... event.stop() + >>> + >>> def callback_b(event): + ... '''Never run.''' + ... print('Callback B') + >>> + >>> session = ftrack_api.Session() + >>> session.event_hub.subscribe( + ... 'topic=test-stop-event', callback_a, priority=10 + ... ) + >>> session.event_hub.subscribe( + ... 'topic=test-stop-event', callback_b, priority=20 + ... ) + >>> session.event_hub.publish( + ... ftrack_api.event.base.Event(topic='test-stop-event') + ... ) + >>> session.event_hub.wait(duration=5) + Callback A called. + +.. _handling_events/publishing: + +Publishing events +================= + +So far we have looked at listening to events coming from ftrack. However, you +are also free to publish your own events (or even publish relevant ftrack +events). + +To do this, simply construct an instance of :class:`ftrack_api.event.base.Event` +and pass it to :meth:`EventHub.publish ` via the session:: + + import ftrack_api.event.base + + event = ftrack_api.event.base.Event( + topic='my-company.some-topic', + data={'key': 'value'} + ) + session.event_hub.publish(event) + +The event hub will automatically add some information to your event before it +gets published, including the *source* of the event. By default the event source +is just the event hub, but you can customise this to provide more relevant +information if you want. For example, if you were publishing from within Maya:: + + session.event_hub.publish(ftrack_api.event.base.Event( + topic='my-company.some-topic', + data={'key': 'value'}, + source={ + 'applicationId': 'maya' + } + )) + +Remember that all supplied information can be used by subscribers to filter +events so the more accurate the information the better. + +.. _handling_events/publishing/synchronously: + +Publish synchronously +--------------------- + +It is also possible to call :meth:`~hub.EventHub.publish` synchronously by +passing `synchronous=True`. In synchronous mode, only local handlers will be +called. The result from each called handler is collected and all the results +returned together in a list:: + + >>> import ftrack_api + >>> import ftrack_api.event.base + >>> + >>> def callback_a(event): + ... return 'A' + >>> + >>> def callback_b(event): + ... return 'B' + >>> + >>> session = ftrack_api.Session() + >>> session.event_hub.subscribe( + ... 'topic=test-synchronous', callback_a, priority=10 + ... ) + >>> session.event_hub.subscribe( + ... 'topic=test-synchronous', callback_b, priority=20 + ... ) + >>> results = session.event_hub.publish( + ... ftrack_api.event.base.Event(topic='test-synchronous'), + ... synchronous=True + ... ) + >>> print results + ['A', 'B'] + +.. _handling_events/publishing/handling_replies: + +Handling replies +---------------- + +When publishing an event it is also possible to pass a callable that will be +called with any :ref:`reply event ` +received in response to the published event. + +To do so, simply pass in a callable as the *on_reply* parameter:: + + def handle_reply(event): + print 'Got reply', event + + session.event_hub.publish( + ftrack_api.event.base.Event(topic='test-reply'), + on_reply=handle_reply + ) + +.. _handling_events/publishing/targeting: + +Targeting events +---------------- + +In addition to subscribers filtering events to receive, it is also possible to +give an event a specific target to help route it to the right subscriber. + +To do this, set the *target* value on the event to an :ref:`expression +`. The expression will filter against registered +:ref:`subscriber information +`. + +For example, if you have many subscribers listening for a event, but only want +one of those subscribers to get the event, you can target the event to the +subscriber using its registered subscriber id:: + + session.event_hub.publish( + ftrack_api.event.base.Event( + topic='my-company.topic', + data={'key': 'value'}, + target='id=my-custom-subscriber-id' + ) + ) + +.. _handling_events/expressions: + +Expressions +=========== + +An expression is used to filter against a data structure, returning whether the +structure fulfils the expression requirements. Expressions are currently used +for subscriptions when :ref:`subscribing to events +` and for targets when :ref:`publishing targeted +events `. + +The form of the expression is loosely groupings of 'key=value' with conjunctions +to join them. + +For example, a common expression for subscriptions is to filter against an event +topic:: + + 'topic=ftrack.location.component-added' + +However, you can also perform more complex filtering, including accessing +nested parameters:: + + 'topic=ftrack.location.component-added and data.locationId=london' + +.. note:: + + If the structure being tested does not have any value for the specified + key reference then it is treated as *not* matching. + +You can also use a single wildcard '*' at the end of any value for matching +multiple values. For example, the following would match all events that have a +topic starting with 'ftrack.':: + + 'topic=ftrack.*' diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/image/configuring_plugins_directory.png b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/image/configuring_plugins_directory.png new file mode 100644 index 0000000000..7438cb52be Binary files /dev/null and b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/image/configuring_plugins_directory.png differ diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/index.rst new file mode 100644 index 0000000000..e55b27d08c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/index.rst @@ -0,0 +1,42 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +################# +ftrack Python API +################# + +Welcome to the ftrack :term:`Python` :term:`API` documentation. + +.. important:: + + This is the new :term:`Python` client for the ftrack :term:`API`. If you are + migrating from the old client then please read the dedicated + :ref:`migration guide `. + +.. toctree:: + :maxdepth: 1 + + introduction + installing + tutorial + understanding_sessions + working_with_entities + querying + handling_events + caching + locations/index + example/index + api_reference/index + event_list + environment_variables + security_and_authentication + release/index + glossary + +****************** +Indices and tables +****************** + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/installing.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/installing.rst new file mode 100644 index 0000000000..5e42621bee --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/installing.rst @@ -0,0 +1,77 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _installing: + +********** +Installing +********** + +.. highlight:: bash + +Installation is simple with `pip `_:: + + pip install ftrack-python-api + +Building from source +==================== + +You can also build manually from the source for more control. First obtain a +copy of the source by either downloading the +`zipball `_ or +cloning the public repository:: + + git clone git@bitbucket.org:ftrack/ftrack-python-api.git + +Then you can build and install the package into your current Python +site-packages folder:: + + python setup.py install + +Alternatively, just build locally and manage yourself:: + + python setup.py build + +Building documentation from source +---------------------------------- + +To build the documentation from source:: + + python setup.py build_sphinx + +Then view in your browser:: + + file:///path/to/ftrack-python-api/build/doc/html/index.html + +Running tests against the source +-------------------------------- + +With a copy of the source it is also possible to run the unit tests:: + + python setup.py test + +Dependencies +============ + +* `ftrack server `_ >= 3.3.11 +* `Python `_ >= 2.7, < 3 +* `Requests `_ >= 2, <3, +* `Arrow `_ >= 0.4.4, < 1, +* `termcolor `_ >= 1.1.0, < 2, +* `pyparsing `_ >= 2.0, < 3, +* `Clique `_ >= 1.2.0, < 2, +* `websocket-client `_ >= 0.40.0, < 1 + +Additional For building +----------------------- + +* `Sphinx `_ >= 1.2.2, < 2 +* `sphinx_rtd_theme `_ >= 0.1.6, < 1 +* `Lowdown `_ >= 0.1.0, < 2 + +Additional For testing +---------------------- + +* `Pytest `_ >= 2.3.5, < 3 +* `pytest-mock `_ >= 0.4, < 1, +* `pytest-catchlog `_ >= 1, <=2 \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/introduction.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/introduction.rst new file mode 100644 index 0000000000..63fe980749 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/introduction.rst @@ -0,0 +1,26 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _introduction: + +************ +Introduction +************ + +This API allows developers to write :term:`Python` scripts that talk directly +with an ftrack server. The scripts can perform operations against that server +depending on granted permissions. + +With any API it is important to find the right balance between flexibility and +usefulness. If an API is too low level then everyone ends up writing boilerplate +code for common problems and usually in an non-uniform way making it harder to +share scripts with others. It's also harder to get started with such an API. +Conversely, an API that attempts to be too smart can often become restrictive +when trying to do more advanced functionality or optimise for performance. + +With this API we have tried to strike the right balance between these two, +providing an API that should be simple to use out-of-the-box, but also expose +more flexibility and power when needed. + +Nothing is perfect though, so please do provide feedback on ways that we can +continue to improve this API for your specific needs. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/configuring.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/configuring.rst new file mode 100644 index 0000000000..97483221aa --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/configuring.rst @@ -0,0 +1,87 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _locations/configuring: + +********************* +Configuring locations +********************* + +To allow management of data by a location or retrieval of filesystem paths where +supported, a location instance needs to be configured in a session with an +:term:`accessor` and :term:`structure`. + +.. note:: + + The standard builtin locations require no further setup or configuration + and it is not necessary to read the rest of this section to use them. + +Before continuing, make sure that you are familiar with the general concepts +of locations by reading the :ref:`locations/overview`. + +.. _locations/configuring/manually: + +Configuring manually +==================== + +Locations can be configured manually when using a session by retrieving the +location and setting the appropriate attributes:: + + location = session.query('Location where name is "my.location"').one() + location.structure = ftrack_api.structure.id.IdStructure() + location.priority = 50 + +.. _locations/configuring/automatically: + +Configuring automatically +========================= + +Often the configuration of locations should be determined by developers +looking after the core pipeline and so ftrack provides a way for a plugin to +be registered to configure the necessary locations for each session. This can +then be managed centrally if desired. + +The configuration is handled through the standard events system via a topic +*ftrack.api.session.configure-location*. Set up an :ref:`event listener plugin +` as normal with a register function that +accepts a :class:`~ftrack_api.session.Session` instance. Then register a +callback against the relevant topic to configure locations at the appropriate +time:: + + import ftrack_api + import ftrack_api.entity.location + import ftrack_api.accessor.disk + import ftrack_api.structure.id + + + def configure_locations(event): + '''Configure locations for session.''' + session = event['data']['session'] + + # Find location(s) and customise instances. + location = session.query('Location where name is "my.location"').one() + ftrack_api.mixin(location, ftrack_api.entity.location.UnmanagedLocationMixin) + location.accessor = ftrack_api.accessor.disk.DiskAccessor(prefix='') + location.structure = ftrack_api.structure.id.IdStructure() + location.priority = 50 + + + def register(session): + '''Register plugin with *session*.''' + session.event_hub.subscribe( + 'topic=ftrack.api.session.configure-location', + configure_locations + ) + +.. note:: + + If you expect the plugin to also be evaluated by the legacy API, remember + to :ref:`validate the arguments `. + +So long as the directory containing the plugin exists on your +:envvar:`FTRACK_EVENT_PLUGIN_PATH`, the plugin will run for each session +created and any configured locations will then remain configured for the +duration of that related session. + +Be aware that you can configure many locations in one plugin or have separate +plugins for different locations - the choice is entirely up to you! diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/index.rst new file mode 100644 index 0000000000..ac1eaba649 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/index.rst @@ -0,0 +1,18 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _developing/locations: + +********* +Locations +********* + +Learn how to access locations using the API and configure your own location +plugins. + +.. toctree:: + :maxdepth: 1 + + overview + tutorial + configuring diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/overview.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/overview.rst new file mode 100644 index 0000000000..0a6ec171aa --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/overview.rst @@ -0,0 +1,143 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _locations/overview: + +******** +Overview +******** + +Locations provides a way to easily track and manage data (files, image sequences +etc.) using ftrack. + +With locations it is possible to see where published data is in the world and +also to transfer data automatically between different locations, even different +storage mechanisms, by defining a few simple :term:`Python` plugins. By keeping +track of the size of the data it also helps manage storage capacity better. In +addition, the intrinsic links to production information makes assigning work to +others and transferring only the relevant data much simpler as well as greatly +reducing the burden on those responsible for archiving finished work. + +Concepts +======== + +The system is implemented in layers using a few key concepts in order to provide +a balance between out of the box functionality and custom configuration. + +.. _locations/overview/locations: + +Locations +--------- + +Data locations can be varied in scope and meaning - a facility, a laptop, a +specific drive. As such, rather than place a hard limit on what can be +considered a location, ftrack simply requires that a location be identifiable by +a string and that string be unique to that location. + +A global company with facilities in many different parts of the world might +follow a location naming convention similar to the following: + + * 'ftrack.london.server01' + * 'ftrack.london.server02' + * 'ftrack.nyc.server01' + * 'ftrack.amsterdam.server01' + * '..' + +Whereas, for a looser setup, the following might suit better: + + * 'bjorns-workstation' + * 'fredriks-mobile' + * 'martins-laptop' + * 'cloud-backup' + +Availability +------------ + +When tracking data across several locations it is important to be able to +quickly find out where data is available and where it is not. As such, ftrack +provides simple mechanisms for retrieving information on the availability of a +:term:`component` in each location. + +For a single file, the availability with be either 0% or 100%. For containers, +such as file sequences, each file is tracked separately and the availability of +the container calculated as an overall percentage (e.g. 47%). + +.. _locations/overview/accessors: + +Accessors +--------- + +Due to the flexibility of what can be considered a location, the system must be +able to cope with locations that represent different ways of storing data. For +example, data might be stored on a local hard drive, a cloud service or even in +a database. + +In addition, the method of accessing that storage can change depending on +perspective - local filesystem, FTP, S3 API etc. + +To handle this, ftrack introduces the idea of an :term:`accessor` that provides +access to the data in a standard way. An accessor is implemented in +:term:`Python` following a set interface and can be configured at runtime to +provide relevant access to a location. + +With an accessor configured for a location, it becomes possible to not only +track data, but also manage it through ftrack by using the accessor to add and +remove data from the location. + +At present, ftrack includes a :py:class:`disk accessor +` for local filesystem access. More will be +added over time and developers are encouraged to contribute their own. + +.. _locations/overview/structure: + +Structure +--------- + +Another important consideration for locations is how data should be structured +in the location (folder structure and naming conventions). For example, +different facilities may want to use different folder structures, or different +storage mechanisms may use different paths for the data. + +For this, ftrack supports the use of a :term:`Python` structure plugin. This +plugin is called when adding a :term:`component` to a location in order to +determine the correct structure to use. + +.. note:: + + A structure plugin accepts an ftrack entity as its input and so can be + reused for generating general structures as well. For example, an action + callback could be implemented to create the base folder structure for some + selected shots by reusing a structure plugin. + +.. _locations/overview/resource_identifiers: + +Resource identifiers +-------------------- + +When a :term:`component` can be linked to multiple locations it becomes +necessary to store information about the relationship on the link rather than +directly on the :term:`component` itself. The most important information is the +path to the data in that location. + +However, as seen above, not all locations may be filesystem based or accessed +using standard filesystem protocols. For this reason, and to help avoid +confusion, this *path* is referred to as a :term:`resource identifier` and no +limitations are placed on the format. Keep in mind though that accessors use +this information (retrieved from the database) in order to work out how to +access the data, so the format used must be compatible with all the accessors +used for any one location. For this reason, most +:term:`resource identifiers ` should ideally look like +relative filesystem paths. + +.. _locations/overview/resource_identifiers/transformer: + +Transformer +^^^^^^^^^^^ + +To further support custom formats for +:term:`resource identifiers `, it is also possible to +configure a resource identifier transformer plugin which will convert +the identifiers before they are stored centrally and after they are retrieved. + +A possible use case of this might be to store JSON encoded metadata about a path +in the database and convert this to an actual filesystem path on retrieval. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/tutorial.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/tutorial.rst new file mode 100644 index 0000000000..4c5a6c0f13 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/locations/tutorial.rst @@ -0,0 +1,193 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _locations/tutorial: + +******** +Tutorial +******** + +This tutorial is a walkthrough on how you interact with Locations using the +ftrack :term:`API`. Before you read this tutorial, make sure you familiarize +yourself with the location concepts by reading the :ref:`locations/overview`. + +All examples assume you are using Python 2.x, have the :mod:`ftrack_api` +module imported and a :class:`session ` created. + +.. code-block:: python + + import ftrack_api + session = ftrack_api.Session() + +.. _locations/creating-locations: + +Creating locations +================== + +Locations can be created just like any other entity using +:meth:`Session.create `:: + + location = session.create('Location', dict(name='my.location')) + session.commit() + +.. note:: + Location names beginning with ``ftrack.`` are reserved for internal use. Do + not use this prefix for your location names. + +To create a location only if it doesn't already exist use the convenience +method :meth:`Session.ensure `. This will return +either an existing matching location or a newly created one. + +Retrieving locations +==================== + +You can retrieve existing locations using the standard session +:meth:`~ftrack_api.session.Session.get` and +:meth:`~ftrack_api.session.Session.query` methods:: + + # Retrieve location by unique id. + location_by_id = session.get('Location', 'unique-id') + + # Retrieve location by name. + location_by_name = session.query( + 'Location where name is "my.location"' + ).one() + +To retrieve all existing locations use a standard query:: + + all_locations = session.query('Location').all() + for existing_location in all_locations: + print existing_location['name'] + +Configuring locations +===================== + +At this point you have created a custom location "my.location" in the database +and have an instance to reflect that. However, the location cannot be used in +this session to manage data unless it has been configured. To configure a +location for the session, set the appropriate attributes for accessor and +structure:: + + import tempfile + import ftrack_api.accessor.disk + import ftrack_api.structure.id + + # Assign a disk accessor with *temporary* storage + location.accessor = ftrack_api.accessor.disk.DiskAccessor( + prefix=tempfile.mkdtemp() + ) + + # Assign using ID structure. + location.structure = ftrack_api.structure.id.IdStructure() + + # Set a priority which will be used when automatically picking locations. + # Lower number is higher priority. + location.priority = 30 + +To learn more about how to configure locations automatically in a session, see +:ref:`locations/configuring`. + +.. note:: + + If a location is not configured in a session it can still be used as a + standard entity and to find out availability of components + +Using components with locations +=============================== + +The Locations :term:`API` tries to use sane defaults to stay out of your way. +When creating :term:`components `, a location is automatically picked +using :meth:`Session.pick_location `:: + + (_, component_path) = tempfile.mkstemp(suffix='.txt') + component_a = session.create_component(path=component_path) + +To override, specify a location explicitly:: + + (_, component_path) = tempfile.mkstemp(suffix='.txt') + component_b = session.create_component( + path=component_path, location=location + ) + +If you set the location to ``None``, the component will only be present in the +special origin location for the duration of the session:: + + (_, component_path) = tempfile.mkstemp(suffix='.txt') + component_c = session.create_component(path=component_path, location=None) + +After creating a :term:`component` in a location, it can be added to another +location by calling :meth:`Location.add_component +` and passing the location to +use as the *source* location:: + + origin_location = session.query( + 'Location where name is "ftrack.origin"' + ).one() + location.add_component(component_c, origin_location) + +To remove a component from a location use :meth:`Location.remove_component +`:: + + location.remove_component(component_b) + +Each location specifies whether to automatically manage data when adding or +removing components. To ensure that a location does not manage data, mixin the +relevant location mixin class before use:: + + import ftrack_api + import ftrack_api.entity.location + + ftrack_api.mixin(location, ftrack_api.entity.location.UnmanagedLocationMixin) + +Accessing paths +=============== + +The locations system is designed to help avoid having to deal with filesystem +paths directly. This is particularly important when you consider that a number +of locations won't provide any direct filesystem access (such as cloud storage). + +However, it is useful to still be able to get a filesystem path from locations +that support them (typically those configured with a +:class:`~ftrack_api.accessor.disk.DiskAccessor`). For example, you might need to +pass a filesystem path to another application or perform a copy using a faster +protocol. + +To retrieve the path if available, use :meth:`Location.get_filesystem_path +`:: + + print location.get_filesystem_path(component_c) + +Obtaining component availability +================================ + +Components in locations have a notion of availability. For regular components, +consisting of a single file, the availability would be either 0 if the +component is unavailable or 100 percent if the component is available in the +location. Composite components, like image sequences, have an availability +which is proportional to the amount of child components that have been added to +the location. + +For example, an image sequence might currently be in a state of being +transferred to :data:`test.location`. If half of the images are transferred, it +might be possible to start working with the sequence. To check availability use +the helper :meth:`Session.get_component_availability +` method:: + + print session.get_component_availability(component_c) + +There are also convenience methods on both :meth:`components +` and :meth:`locations +` for +retrieving availability as well:: + + print component_c.get_availability() + print location.get_component_availability(component_c) + +Location events +=============== + +If you want to receive event notifications when components are added to or +removed from locations, you can subscribe to the topics published, +:data:`ftrack_api.symbol.COMPONENT_ADDED_TO_LOCATION_TOPIC` or +:data:`ftrack_api.symbol.COMPONENT_REMOVED_FROM_LOCATION_TOPIC` and the callback +you want to be run. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/querying.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/querying.rst new file mode 100644 index 0000000000..7a200529ab --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/querying.rst @@ -0,0 +1,263 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _querying: + +******** +Querying +******** + +.. currentmodule:: ftrack_api.session + +The API provides a simple, but powerful query language in addition to iterating +directly over entity attributes. Using queries can often substantially speed +up your code as well as reduce the amount of code written. + +A query is issued using :meth:`Session.query` and returns a list of matching +entities. The query always has a single *target* entity type that the query +is built against. This means that you cannot currently retrieve back a list of +different entity types in one query, though using :ref:`projections +` does allow retrieving related entities of a different +type in one go. + +The syntax for a query is: + +.. code-block:: none + + select from where + +However, both the selection of projections and criteria are optional. This means +the most basic query is just to fetch all entities of a particular type, such as +all projects in the system:: + + projects = session.query('Project') + +A query always returns a :class:`~ftrack_api.query.QueryResult` instance that +acts like a list with some special behaviour. The main special behaviour is that +the actual query to the server is not issued until you iterate or index into the +query results:: + + for project in projects: + print project['name'] + +You can also explicitly call :meth:`~ftrack_api.query.QueryResult.all` on the +result set:: + + projects = session.query('Project').all() + +.. note:: + + This behaviour exists in order to make way for efficient *paging* and other + optimisations in future. + +.. _querying/criteria: + +Using criteria to narrow results +================================ + +Often you will have some idea of the entities you want to retrieve. In this +case you can optimise your code by not fetching more data than you need. To do +this, add criteria to your query:: + + projects = session.query('Project where status is active') + +Each criteria follows the form: + +.. code-block:: none + + + +You can inspect the entity type or instance to find out which :ref:`attributes +` are available to filter on for a particular +entity type. The list of :ref:`operators ` that can +be applied and the types of values they expect is listed later on. + +.. _querying/criteria/combining: + +Combining criteria +------------------ + +Multiple criteria can be applied in a single expression by joining them with +either ``and`` or ``or``:: + + projects = session.query( + 'Project where status is active and name like "%thrones"' + ) + +You can use parenthesis to control the precedence when compound criteria are +used (by default ``and`` takes precedence):: + + projects = session.query( + 'Project where status is active and ' + '(name like "%thrones" or full_name like "%thrones")' + ) + +.. _querying/criteria/relationships: + +Filtering on relationships +-------------------------- + +Filtering on relationships is also intuitively supported. Simply follow the +relationship using a dotted notation:: + + tasks_in_project = session.query( + 'Task where project.id is "{0}"'.format(project['id']) + ) + +This works even for multiple strides across relationships (though do note that +excessive strides can affect performance):: + + tasks_completed_in_project = session.query( + 'Task where project.id is "{0}" and ' + 'status.type.name is "Done"' + .format(project['id']) + ) + +The same works for collections (where each entity in the collection is compared +against the subsequent condition):: + + import arrow + + tasks_with_time_logged_today = session.query( + 'Task where timelogs.start >= "{0}"'.format(arrow.now().floor('day')) + ) + +In the above query, each *Task* that has at least one *Timelog* with a *start* +time greater than the start of today is returned. + +When filtering on relationships, the conjunctions ``has`` and ``any`` can be +used to specify how the criteria should be applied. This becomes important when +querying using multiple conditions on collection relationships. The relationship +condition can be written against the following form:: + + () + +For optimal performance ``has`` should be used for scalar relationships when +multiple conditions are involved. For example, to find notes by a specific +author when only name is known:: + + notes_written_by_jane_doe = session.query( + 'Note where author has (first_name is "Jane" and last_name is "Doe")' + ) + +This query could be written without ``has``, giving the same results:: + + notes_written_by_jane_doe = session.query( + 'Note where author.first_name is "Jane" and author.last_name is "Doe"' + ) + +``any`` should be used for collection relationships. For example, to find all +projects that have at least one metadata instance that has `key=some_key` +and `value=some_value` the query would be:: + + projects_where_some_key_is_some_value = session.query( + 'Project where metadata any (key=some_key and value=some_value)' + ) + +If the query was written without ``any``, projects with one metadata matching +*key* and another matching the *value* would be returned. + +``any`` can also be used to query for empty relationship collections:: + + users_without_timelogs = session.query( + 'User where not timelogs any ()' + ) + +.. _querying/criteria/operators: + +Supported operators +------------------- + +This is the list of currently supported operators: + ++--------------+----------------+----------------------------------------------+ +| Operators | Description | Example | ++==============+================+==============================================+ +| = | Exactly equal. | name is "martin" | +| is | | | ++--------------+----------------+----------------------------------------------+ +| != | Not exactly | name is_not "martin" | +| is_not | equal. | | ++--------------+----------------+----------------------------------------------+ +| > | Greater than | start after "2015-06-01" | +| after | exclusive. | | +| greater_than | | | ++--------------+----------------+----------------------------------------------+ +| < | Less than | end before "2015-06-01" | +| before | exclusive. | | +| less_than | | | ++--------------+----------------+----------------------------------------------+ +| >= | Greater than | bid >= 10 | +| | inclusive. | | ++--------------+----------------+----------------------------------------------+ +| <= | Less than | bid <= 10 | +| | inclusive. | | ++--------------+----------------+----------------------------------------------+ +| in | One of. | status.type.name in ("In Progress", "Done") | ++--------------+----------------+----------------------------------------------+ +| not_in | Not one of. | status.name not_in ("Omitted", "On Hold") | ++--------------+----------------+----------------------------------------------+ +| like | Matches | name like "%thrones" | +| | pattern. | | ++--------------+----------------+----------------------------------------------+ +| not_like | Does not match | name not_like "%thrones" | +| | pattern. | | ++--------------+----------------+----------------------------------------------+ +| has | Test scalar | author has (first_name is "Jane" and | +| | relationship. | last_name is "Doe") | ++--------------+----------------+----------------------------------------------+ +| any | Test collection| metadata any (key=some_key and | +| | relationship. | value=some_value) | ++--------------+----------------+----------------------------------------------+ + +.. _querying/projections: + +Optimising using projections +============================ + +In :ref:`understanding_sessions` we mentioned :ref:`auto-population +` of attribute values on access. This +meant that when iterating over a lot of entities and attributes a large number +of queries were being sent to the server. Ultimately, this can cause your code +to run slowly:: + + >>> projects = session.query('Project') + >>> for project in projects: + ... print( + ... # Multiple queries issued here for each attribute accessed for + ... # each project in the loop! + ... '{project[full_name]} - {project[status][name]})' + ... .format(project=project) + ... ) + + +Fortunately, there is an easy way to optimise. If you know what attributes you +are interested in ahead of time you can include them in your query string as +*projections* in order to fetch them in one go:: + + >>> projects = session.query( + ... 'select full_name, status.name from Project' + ... ) + >>> for project in projects: + ... print( + ... # No additional queries issued here as the values were already + ... # loaded by the above query! + ... '{project[full_name]} - {project[status][name]})' + ... .format(project=project) + ... ) + +Notice how this works for related entities as well. In the example above, we +also fetched the name of each *Status* entity attached to a project in the same +query, which meant that no further queries had to be issued when accessing those +nested attributes. + +.. note:: + + There are no arbitrary limits to the number (or depth) of projections, but + do be aware that excessive projections can ultimately result in poor + performance also. As always, it is about choosing the right tool for the + job. + +You can also customise the +:ref:`working_with_entities/entity_types/default_projections` to use for each +entity type when none are specified in the query string. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/index.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/index.rst new file mode 100644 index 0000000000..0eef0b7407 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/index.rst @@ -0,0 +1,18 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _release: + +*************************** +Release and migration notes +*************************** + +Find out information about what has changed between versions and any important +migration notes to be aware of when switching to a new version. + +.. toctree:: + :maxdepth: 1 + + release_notes + migration + migrating_from_old_api diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/migrating_from_old_api.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/migrating_from_old_api.rst new file mode 100644 index 0000000000..699ccf224a --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/migrating_from_old_api.rst @@ -0,0 +1,613 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _release/migrating_from_old_api: + +********************** +Migrating from old API +********************** + +.. currentmodule:: ftrack_api.session + +Why a new API? +============== + +With the introduction of Workflows, ftrack is capable of supporting a greater +diversity of industries. We're enabling teams to closely align the system with +their existing practices and naming conventions, resulting in a tool that feels +more natural and intuitive. The old API was locked to specific workflows, making +it impractical to support this new feature naturally. + +We also wanted this new flexibility to extend to developers, so we set about +redesigning the API to fully leverage the power in the system. And while we had +the wrenches out, we figured why not go that extra mile and build in some of the +features that we see developers having to continually implement in-house across +different companies - features such as caching and support for custom pipeline +extensions. In essence, we decided to build the API that, as pipeline +developers, we had always wanted from our production tracking and asset +management systems. We think we succeeded, and we hope you agree. + +Installing +========== + +Before, you used to download the API package from your ftrack instance. With +each release of the new API we make it available on :term:`PyPi`, and +installing is super simple: + +.. code-block:: none + + pip install ftrack-python-api + +Before installing, it is always good to check the latest +:ref:`release/release_notes` to see which version of the ftrack server is +required. + +.. seealso:: :ref:`installing` + +Overview +======== + +An API needs to be approachable, so we built the new API to feel +intuitive and familiar. We bundle all the core functionality into one place – a +session – with consistent methods for interacting with entities in the system:: + + import ftrack_api + session = ftrack_api.Session() + +The session is responsible for loading plugins and communicating with the ftrack +server and allows you to use multiple simultaneous sessions. You will no longer +need to explicitly call :meth:`ftrack.setup` to load plugins. + +The core methods are straightforward: + +Session.create + create a new entity, like a new version. +Session.query + fetch entities from the server using a powerful query language. +Session.delete + delete existing entities. +Session.commit + commit all changes in one efficient call. + +.. note:: + + The new API batches create, update and delete operations by default for + efficiency. To synchronise local changes with the server you need to call + :meth:`Session.commit`. + +In addition all entities in the API now act like simple Python dictionaries, +with some additional helper methods where appropriate. If you know a little +Python (or even if you don't) getting up to speed should be a breeze:: + + >>> print user.keys() + ['first_name', 'last_name', 'email', ...] + >>> print user['email'] + 'old@example.com' + >>> user['email'] = 'new@example.com' + +And of course, relationships between entities are reflected in a natural way as +well:: + + new_timelog = session.create('Timelog', {...}) + task['timelogs'].append(new_timelog) + +.. seealso :: :ref:`tutorial` + +The new API also makes use of caching in order to provide more efficient +retrieval of data by reducing the number of calls to the remote server. + +.. seealso:: :ref:`caching` + +Open source and standard code style +=================================== + +The new API is open source software and developed in public at +`Bitbucket `_. We welcome you +to join us in the development and create pull requests there. + +In the new API, we also follow the standard code style for Python, +:term:`PEP-8`. This means that you will now find that methods and variables are +written using ``snake_case`` instead of ``camelCase``, amongst other things. + +Package name +============ + +The new package is named :mod:`ftrack_api`. By using a new package name, we +enable you to use the old API and the new side-by-side in the same process. + +Old API:: + + import ftrack + +New API:: + + import ftrack_api + +Specifying your credentials +=========================== + +The old API used three environment variables to authenticate with your ftrack +instance. While these continue to work as before, you now also have +the option to specify them when initializing the session:: + + >>> import ftrack_api + >>> session = ftrack_api.Session( + ... server_url='https://mycompany.ftrackapp.com', + ... api_key='7545384e-a653-11e1-a82c-f22c11dd25eq', + ... api_user='martin' + ... ) + +In the examples below, will assume that you have imported the package and +created a session. + +.. seealso:: + + * :ref:`environment_variables` + * :ref:`tutorial` + + +Querying objects +================ + +The old API relied on predefined methods for querying objects and constructors +which enabled you to get an entity by it's id or name. + +Old API:: + + project = ftrack.getProject('dev_tutorial') + task = ftrack.Task('8923b7b3-4bf0-11e5-8811-3c0754289fd3') + user = ftrack.User('jane') + +New API:: + + project = session.query('Project where name is "dev_tutorial"').one() + task = session.get('Task', '8923b7b3-4bf0-11e5-8811-3c0754289fd3') + user = session.query('User where username is "jane"').one() + +While the new API can be a bit more verbose for simple queries, it is much more +powerful and allows you to filter on any field and preload related data:: + + tasks = session.query( + 'select name, parent.name from Task ' + 'where project.full_name is "My Project" ' + 'and status.type.short is "DONE" ' + 'and not timelogs any ()' + ).all() + +The above fetches all tasks for “My Project” that are done but have no timelogs. +It also pre-fetches related information about the tasks parent – all in one +efficient query. + +.. seealso:: :ref:`querying` + +Creating objects +================ + +In the old API, you create objects using specialized methods, such as +:meth:`ftrack.createProject`, :meth:`Project.createSequence` and +:meth:`Task.createShot`. + +In the new API, you can create any object using :meth:`Session.create`. In +addition, there are a few helper methods to reduce the amount of boilerplate +necessary to create certain objects. Don't forget to call :meth:`Session.commit` +once you have issued your create statements to commit your changes. + +As an example, let's look at populating a project with a few entities. + +Old API:: + + project = ftrack.getProject('migration_test') + + # Get default task type and status from project schema + taskType = project.getTaskTypes()[0] + taskStatus = project.getTaskStatuses(taskType)[0] + + sequence = project.createSequence('001') + + # Create five shots with one task each + for shot_number in xrange(10, 60, 10): + shot = sequence.createShot( + '{0:03d}'.format(shot_number) + ) + shot.createTask( + 'Task name', + taskType, + taskStatus + ) + + +New API:: + + project = session.query('Project where name is "migration_test"').one() + + # Get default task type and status from project schema + project_schema = project['project_schema'] + default_shot_status = project_schema.get_statuses('Shot')[0] + default_task_type = project_schema.get_types('Task')[0] + default_task_status = project_schema.get_statuses( + 'Task', default_task_type['id'] + )[0] + + # Create sequence + sequence = session.create('Sequence', { + 'name': '001', + 'parent': project + }) + + # Create five shots with one task each + for shot_number in xrange(10, 60, 10): + shot = session.create('Shot', { + 'name': '{0:03d}'.format(shot_number), + 'parent': sequence, + 'status': default_shot_status + }) + session.create('Task', { + 'name': 'Task name', + 'parent': shot, + 'status': default_task_status, + 'type': default_task_type + }) + + # Commit all changes to the server. + session.commit() + +If you test the example above, one thing you might notice is that the new API +is much more efficient. Thanks to the transaction-based architecture in the new +API only a single call to the server is required to create all the objects. + +.. seealso:: :ref:`working_with_entities/creating` + +Updating objects +================ + +Updating objects in the new API works in a similar way to the old API. Instead +of using the :meth:`set` method on objects, you simply set the key of the +entity to the new value, and call :meth:`Session.commit` to persist the +changes to the database. + +The following example adjusts the duration and comment of a timelog for a +user using the old and new API, respectively. + +Old API:: + + import ftrack + + user = ftrack.User('john') + user.set('email', 'john@example.com') + +New API:: + + import ftrack_api + session = ftrack_api.Session() + + user = session.query('User where username is "john"').one() + user['email'] = 'john@example.com' + session.commit() + +.. seealso:: :ref:`working_with_entities/updating` + + +Date and datetime attributes +============================ + +In the old API, date and datetime attributes where represented using a standard +:mod:`datetime` object. In the new API we have opted to use the :term:`arrow` +library instead. Datetime attributes are represented in the server timezone, +but with the timezone information stripped. + +Old API:: + + >>> import datetime + + >>> task_old_api = ftrack.Task(task_id) + >>> task_old_api.get('startdate') + datetime.datetime(2015, 9, 2, 0, 0) + + >>> # Updating a datetime attribute + >>> task_old_api.set('startdate', datetime.date.today()) + +New API:: + + >>> import arrow + + >>> task_new_api = session.get('Task', task_id) + >>> task_new_api['start_date'] + + + >>> # In the new API, utilize the arrow library when updating a datetime. + >>> task_new_api['start_date'] = arrow.utcnow().floor('day') + >>> session.commit() + +Custom attributes +================= + +In the old API, custom attributes could be retrieved from an entity by using +the methods :meth:`get` and :meth:`set`, like standard attributes. In the new +API, custom attributes can be written and read from entities using the +``custom_attributes`` property, which provides a dictionary-like interface. + +Old API:: + + >>> task_old_api = ftrack.Task(task_id) + >>> task_old_api.get('my_custom_attribute') + + >>> task_old_api.set('my_custom_attribute', 'My new value') + + +New API:: + + >>> task_new_api = session.get('Task', task_id) + >>> task_new_api['custom_attributes']['my_custom_attribute'] + + + >>> task_new_api['custom_attributes']['my_custom_attribute'] = 'My new value' + +For more information on working with custom attributes and existing +limitations, please see: + +.. seealso:: + + :ref:`example/custom_attribute` + + +Using both APIs side-by-side +============================ + +With so many powerful new features and the necessary support for more flexible +workflows, we chose early on to not limit the new API design by necessitating +backwards compatibility. However, we also didn't want to force teams using the +existing API to make a costly all-or-nothing switchover. As such, we have made +the new API capable of coexisting in the same process as the old API:: + + import ftrack + import ftrack_api + +In addition, the old API will continue to be supported for some time, but do +note that it will not support the new `Workflows +`_ and will not have new features back ported +to it. + +In the first example, we obtain a task reference using the old API and +then use the new API to assign a user to it:: + + import ftrack + import ftrack_api + + # Create session for new API, authenticating using envvars. + session = ftrack_api.Session() + + # Obtain task id using old API + shot = ftrack.getShot(['migration_test', '001', '010']) + task = shot.getTasks()[0] + task_id = task.getId() + + user = session.query( + 'User where username is "{0}"'.format(session.api_user) + ).one() + session.create('Appointment', { + 'resource': user, + 'context_id': task_id, + 'type': 'assignment' + }) + +The second example fetches a version using the new API and uploads and sets a +thumbnail using the old API:: + + import arrow + import ftrack + + # fetch a version published today + version = session.query( + 'AssetVersion where date >= "{0}"'.format( + arrow.now().floor('day') + ) + ).first() + + # Create a thumbnail using the old api. + thumbnail_path = '/path/to/thumbnail.jpg' + version_old_api = ftrack.AssetVersion(version['id']) + thumbnail = version_old_api.createThumbnail(thumbnail_path) + + # Also set the same thumbnail on the task linked to the version. + task_old_api = ftrack.Task(version['task_id']) + task_old_api.setThumbnail(thumbnail) + +.. note:: + + It is now possible to set thumbnails using the new API as well, for more + info see :ref:`example/thumbnail`. + +Plugin registration +------------------- + +To make event and location plugin register functions work with both old and new +API the function should be updated to validate the input arguments. For old +plugins the register method should validate that the first input is of type +``ftrack.Registry``, and for the new API it should be of type +:class:`ftrack_api.session.Session`. + +If the input parameter is not validated, a plugin might be mistakenly +registered twice, since both the new and old API will look for plugins the +same directories. + +.. seealso:: + + :ref:`ftrack:release/migration/3.0.29/developer_notes/register_function` + + +Example: publishing a new version +================================= + +In the following example, we look at migrating a script which publishes a new +version with two components. + +Old API:: + + # Query a shot and a task to create the asset against. + shot = ftrack.getShot(['dev_tutorial', '001', '010']) + task = shot.getTasks()[0] + + # Create new asset. + asset = shot.createAsset(name='forest', assetType='geo') + + # Create a new version for the asset. + version = asset.createVersion( + comment='Added more leaves.', + taskid=task.getId() + ) + + # Get the calculated version number. + print version.getVersion() + + # Add some components. + previewPath = '/path/to/forest_preview.mov' + previewComponent = version.createComponent(path=previewPath) + + modelPath = '/path/to/forest_mode.ma' + modelComponent = version.createComponent(name='model', path=modelPath) + + # Publish. + asset.publish() + + # Add thumbnail to version. + thumbnail = version.createThumbnail('/path/to/forest_thumbnail.jpg') + + # Set thumbnail on other objects without duplicating it. + task.setThumbnail(thumbnail) + +New API:: + + # Query a shot and a task to create the asset against. + shot = session.query( + 'Shot where project.name is "dev_tutorial" ' + 'and parent.name is "001" and name is "010"' + ).one() + task = shot['children'][0] + + # Create new asset. + asset_type = session.query('AssetType where short is "geo"').first() + asset = session.create('Asset', { + 'parent': shot, + 'name': 'forest', + 'type': asset_type + }) + + # Create a new version for the asset. + status = session.query('Status where name is "Pending"').one() + version = session.create('AssetVersion', { + 'asset': asset, + 'status': status, + 'comment': 'Added more leaves.', + 'task': task + }) + + # In the new API, the version number is not set until we persist the changes + print 'Version number before commit: {0}'.format(version['version']) + session.commit() + print 'Version number after commit: {0}'.format(version['version']) + + # Add some components. + preview_path = '/path/to/forest_preview.mov' + preview_component = version.create_component(preview_path, location='auto') + + model_path = '/path/to/forest_mode.ma' + model_component = version.create_component(model_path, { + 'name': 'model' + }, location='auto') + + # Publish. Newly created version defaults to being published in the new api, + # but if set to false you can update it by setting the key on the version. + version['is_published'] = True + + # Persist the changes + session.commit() + + # Add thumbnail to version. + thumbnail = version.create_thumbnail( + '/path/to/forest_thumbnail.jpg' + ) + + # Set thumbnail on other objects without duplicating it. + task['thumbnail'] = thumbnail + session.commit() + + +Workarounds for missing convenience methods +=========================================== + +Query object by path +-------------------- + +In the old API, there existed a convenience methods to get an object by +referencing the path (i.e object and parent names). + +Old API:: + + shot = ftrack.getShot(['dev_tutorial', '001', '010']) + +New API:: + + shot = session.query( + 'Shot where project.name is "dev_tutorial" ' + 'and parent.name is "001" and name is "010"' + ) + + +Retrieving an object's parents +------------------------------ + +To retrieve a list of an object's parents, you could call the method +:meth:`getParents` in the old API. Currently, it is not possible to fetch this +in a single call using the new API, so you will have to traverse the ancestors +one-by-one and fetch each object's parent. + +Old API:: + + parents = task.getParents() + +New API:: + + parents = [] + for item in task['link'][:-1]: + parents.append(session.get(item['type'], item['id'])) + +Note that link includes the task itself so `[:-1]` is used to only retreive the +parents. To learn more about the `link` attribute, see +:ref:`Using link attributes example`. + +Limitations in the current version of the API +============================================= + +The new API is still quite young and in active development and there are a few +limitations currently to keep in mind when using it. + +Missing schemas +--------------- + +The following entities are as of the time of writing not currently available +in the new API. Let us know if you depend on any of them. + + * Booking + * Calendar and Calendar Type + * Dependency + * Manager and Manager Type + * Phase + * Role + * Task template + * Temp data + +Action base class +----------------- +There is currently no helper class for creating actions using the new API. We +will add one in the near future. + +In the meantime, it is still possible to create actions without the base class +by listening and responding to the +:ref:`ftrack:developing/events/list/ftrack.action.discover` and +:ref:`ftrack:developing/events/list/ftrack.action.launch` events. + +Legacy location +--------------- + +The ftrack legacy disk locations utilizing the +:class:`InternalResourceIdentifierTransformer` has been deprecated. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/migration.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/migration.rst new file mode 100644 index 0000000000..1df2211f96 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/migration.rst @@ -0,0 +1,98 @@ +.. + :copyright: Copyright (c) 2015 ftrack + +.. _release/migration: + +*************** +Migration notes +*************** + +.. note:: + + Migrating from the old ftrack API? Read the dedicated :ref:`guide + `. + +Migrate to upcoming 2.0.0 +========================= + +.. _release/migration/2.0.0/event_hub: + +Default behavior for connecting to event hub +-------------------------------------------- + +The default behavior for the `ftrack_api.Session` class will change +for the argument `auto_connect_event_hub`, the default value will +switch from True to False. In order for code relying on the event hub +to continue functioning as expected you must modify your code +to explicitly set the argument to True or that you manually call +`session.event_hub.connect()`. + +.. note:: + If you rely on the `ftrack.location.component-added` or + `ftrack.location.component-removed` events to further process created + or deleted components remember that your session must be connected + to the event hub for the events to be published. + + +Migrate to 1.0.3 +================ + +.. _release/migration/1.0.3/mutating_dictionary: + +Mutating custom attribute dictionary +------------------------------------ + +Custom attributes can no longer be set by mutating entire dictionary:: + + # This will result in an error. + task['custom_attributes'] = dict(foo='baz', bar=2) + session.commit() + +Instead the individual values should be changed:: + + # This works better. + task['custom_attributes']['foo'] = 'baz' + task['custom_attributes']['bar'] = 2 + session.commit() + +Migrate to 1.0.0 +================ + +.. _release/migration/1.0.0/chunked_transfer: + +Chunked accessor transfers +-------------------------- + +Data transfers between accessors is now buffered using smaller chunks instead of +all data at the same time. Included accessor file representations such as +:class:`ftrack_api.data.File` and :class:`ftrack_api.accessor.server.ServerFile` +are built to handle that. If you have written your own accessor and file +representation you may have to update it to support multiple reads using the +limit parameter and multiple writes. + +Migrate to 0.2.0 +================ + +.. _release/migration/0.2.0/new_api_name: + +New API name +------------ + +In this release the API has been renamed from `ftrack` to `ftrack_api`. This is +to allow both the old and new API to co-exist in the same environment without +confusion. + +As such, any scripts using this new API need to be updated to import +`ftrack_api` instead of `ftrack`. For example: + +**Previously**:: + + import ftrack + import ftrack.formatter + ... + +**Now**:: + + import ftrack_api + import ftrack_api.formatter + ... diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/release_notes.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/release_notes.rst new file mode 100644 index 0000000000..d7978ac0b8 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/release/release_notes.rst @@ -0,0 +1,1478 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _release/release_notes: + +************* +Release Notes +************* + +.. currentmodule:: ftrack_api.session + +.. release:: 1.8.2 + :date: 2020-01-14 + + .. change:: fixed + :tag: Test + + test_ensure_entity_with_non_string_data_types test fails due to missing parents. + + .. change:: changed + :tags: session + + Use WeakMethod when registering atexit handler to prevent memory leak. + +.. release:: 1.8.1 + :date: 2019-10-30 + + .. change:: changed + :tags: Location + + Increase chunk size for file operations to 1 Megabyte. + This value can now also be set from the environment variable: + + :envvar:`FTRACK_API_FILE_CHUNK_SIZE` + + .. change:: new + :tag: setup + + Add check for correct python version when installing with pip. + + .. change:: new + :tags: Notes + + Add support for note labels in create_note helper method. + + .. change:: changed + :tags: session + + Ensure errors from server are fully reported with stack trace. + +.. release:: 1.8.0 + :date: 2019-02-21 + + .. change:: fixed + :tags: documentation + + Event description component-removed report component-added event signature. + + .. change:: new + :tags: session, attribute + + Add new scalar type `object` to factory. + + .. change:: new + :tags: session, attribute + + Add support for list of `computed` attributes as part of schema + definition. A computed attribute is derived on the server side, and can + be time dependentant and differ between users. As such a computed + attribute is not suitable for long term encoding and will not be encoded + with the `persisted_only` stragey. + + .. change:: changed + + The `delayed_job` method has been deprecated in favour of a direct + `Session.call`. See :ref:`example/sync_with_ldap` for example + usage. + + .. change:: changed + + Private method :meth:`Session._call` has been converted to + a public method, :meth:`Session.call`. + + The private method will continue to work, but a pending deprecation + warning will be issued when used. The private method will be removed + entirely in version 2.0. + + .. change:: changed + :tags: session, events + + Event server connection error is too generic, + the actual error is now reported to users. + +.. release:: 1.7.1 + :date: 2018-11-13 + + .. change:: fixed + :tags: session, events + + Meta events for event hub connect and disconnect does not include + source. + + .. change:: fixed + :tags: session, location + + Missing context argument to + :meth:`ResourceIdentifierTransformer.decode` + in :meth:`Location.get_resource_identifier`. + +.. release:: 1.7.0 + :date: 2018-07-27 + + .. change:: new + :tags: session, events + + Added new events :ref:`event_list/ftrack.api.session.ready` and + :ref:`event_list/ftrack.api.session.reset` which can be used to perform + operations after the session is ready or has been reset, respectively. + + .. change:: changed + + Private method :meth:`Session._entity_reference` has been converted to + a public method, :meth:`Session.entity_reference`. + + The private method will continue to work, but a pending deprecation + warning will be issued when used. The private method will be removed + entirely in version 2.0. + + .. change:: fixed + :tags: session, events + + :meth:`Session.close` raises an exception if event hub was explicitly + connected after session initialization. + +.. release:: 1.6.0 + :date: 2018-05-17 + + .. change:: new + :tags: depreciation, events + + In version 2.0.0 of the `ftrack-python-api` the default behavior for + the :class:`Session` class will change for the argument + *auto_connect_event_hub*, the default value will switch from *True* to + *False*. + + A warning will now be emitted if async events are published or + subscribed to without *auto_connect_event_hub* has not explicitly been + set to *True*. + + .. seealso:: :ref:`release/migration/2.0.0/event_hub`. + + .. change:: fixed + :tags: documentation + + Event payload not same as what is being emitted for + :ref:`event_list/ftrack.location.component-added` and + :ref:`event_list/ftrack.location.component-removed`. + + .. change:: fixed + :tags: events + + Pyparsing is causing random errors in a threaded environment. + +.. release:: 1.5.0 + :date: 2018-04-19 + + .. change:: fixed + :tags: session, cache + + Cached entities not updated correctly when fetched in a nested + query. + +.. release:: 1.4.0 + :date: 2018-02-05 + + .. change:: fixed + :tags: session, cache + + Collection attributes not merged correctly when fetched from + server. + + .. change:: new + :tags: session, user, api key + + New function :meth:`ftrack_api.session.Session.reset_remote` allows + resetting of attributes to their default value. A convenience method + for resetting a users api key utalizing this was also added + :meth:`ftrack_api.entity.user.User.reset_api_key`. + + .. seealso:: :ref:`working_with_entities/resetting` + + .. change:: new + + Add support for sending out invitation emails to users. + See :ref:`example/invite_user` for example usage. + + .. change:: changed + :tags: cache, performance + + Entities fetched from cache are now lazily merged. Improved + performance when dealing with highly populated caches. + +.. release:: 1.3.3 + :date: 2017-11-16 + + + .. change:: new + :tags: users, ldap + + Add support for triggering a synchronization of + users between ldap and ftrack. See :ref:`example/sync_with_ldap` + for example usage. + + .. note:: + + This requires that you run ftrack 3.5.10 or later. + + .. change:: fixed + :tags: metadata + + Not possible to set metadata on creation. + +.. release:: 1.3.2 + :date: 2017-09-18 + + + .. change:: new + :tags: task template + + Added example for managing task templates through the API. See + :ref:`example/task_template` for example usage. + + .. change:: fixed + :tags: custom attributes + + Not possible to set hierarchical custom attributes on an entity that + has not been committed. + + .. change:: fixed + :tags: custom attributes + + Not possible to set custom attributes on an `Asset` that has not been + committed. + + .. change:: fixed + :tags: metadata + + Not possible to set metadata on creation. + +.. release:: 1.3.1 + :date: 2017-07-21 + + .. change:: fixed + :tags: session, events + + Calling disconnect on the event hub is slow. + +.. release:: 1.3.0 + :date: 2017-07-17 + + .. change:: new + :tags: session + + Support using a :class:`Session` as a context manager to aid closing of + session after use:: + + with ftrack_api.Session() as session: + # Perform operations with session. + + .. change:: new + :tags: session + + :meth:`Session.close` automatically called on Python exit if session not + already closed. + + .. change:: new + :tags: session + + Added :meth:`Session.close` to properly close a session's connections to + the server(s) as well as ensure event listeners are properly + unsubscribed. + + .. change:: new + + Added :exc:`ftrack_api.exception.ConnectionClosedError` to represent + error caused when trying to access servers over closed connection. + +.. release:: 1.2.0 + :date: 2017-06-16 + + .. change:: changed + :tags: events + + Updated the websocket-client dependency to version >= 0.40.0 to allow + for http proxies. + + .. change:: fixed + :tags: documentation + + The :ref:`example/publishing` example incorrectly stated that a + location would be automatically picked if the *location* keyword + argument was omitted. + +.. release:: 1.1.1 + :date: 2017-04-27 + + .. change:: fixed + :tags: custom attributes + + Cannot use custom attributes for `Asset` in ftrack versions prior to + `3.5.0`. + + .. change:: fixed + :tags: documentation + + The :ref:`example ` + section for managing `text` custom attributes is not correct. + +.. release:: 1.1.0 + :date: 2017-03-08 + + .. change:: new + :tags: server location, thumbnail + + Added method :meth:`get_thumbnail_url() ` + to server location, which can be used to retrieve a thumbnail URL. + See :ref:`example/thumbnail/url` for example usage. + + .. change:: new + :tags: documentation + + Added :ref:`example ` on how to manage entity + links from the API. + + .. change:: new + :tags: documentation + + Added :ref:`example ` on + how to manage custom attribute configurations from the API. + + .. change:: new + :tags: documentation + + Added :ref:`example ` on how to use + `SecurityRole` and `UserSecurityRole` to manage security roles for + users. + + .. change:: new + :tags: documentation + + Added :ref:`examples ` to show how + to list a user's assigned tasks and all users assigned to a task. + + .. change:: changed + :tags: session, plugins + + Added *plugin_arguments* to :class:`Session` to allow passing of + optional keyword arguments to discovered plugin register functions. Only + arguments defined in a plugin register function signature are passed so + existing plugin register functions do not need updating if the new + functionality is not desired. + + .. change:: fixed + :tags: documentation + + The :ref:`example/project` example can be confusing since the project + schema may not contain the necessary object types. + + .. change:: fixed + :tags: documentation + + Query tutorial article gives misleading information about the ``has`` + operator. + + .. change:: fixed + :tags: session + + Size is not set on sequence components when using + :meth:`Session.create_component`. + +.. release:: 1.0.4 + :date: 2017-01-13 + + .. change:: fixed + :tags: custom attributes + + Custom attribute values cannot be set on entities that are not + persisted. + + .. change:: fixed + :tags: events + + `username` in published event's source data is set to the operating + system user and not the API user. + +.. release:: 1.0.3 + :date: 2017-01-04 + + .. change:: changed + :tags: session, custom attributes + + Increased performance of custom attributes and better support for + filtering when using a version of ftrack that supports non-sparse + attribute values. + + .. change:: changed + :tags: session, custom attributes + + Custom attributes can no longer be set by mutating entire dictionary. + + .. seealso:: :ref:`release/migration/1.0.3/mutating_dictionary`. + +.. release:: 1.0.2 + :date: 2016-11-17 + + .. change:: changed + :tags: session + + Removed version restriction for higher server versions. + +.. release:: 1.0.1 + :date: 2016-11-11 + + .. change:: fixed + + :meth:`EventHub.publish ` + *on_reply* callback only called for first received reply. It should be + called for all relevant replies received. + +.. release:: 1.0.0 + :date: 2016-10-28 + + .. change:: new + :tags: session + + :meth:`Session.get_upload_metadata` has been added. + + .. change:: changed + :tags: locations, backwards-incompatible + + Data transfer between locations using accessors is now chunked to avoid + reading large files into memory. + + .. seealso:: :ref:`release/migration/1.0.0/chunked_transfer`. + + .. change:: changed + :tags: server accessor + + :class:`ftrack_api.accessor.server.ServerFile` has been refactored to + work with large files more efficiently. + + .. change:: changed + :tags: server accessor + + :class:`ftrack_api.accessor.server.ServerFile` has been updated to use + the get_upload_metadata API endpoint instead of + /component/getPutMetadata. + + .. change:: changed + :tags: locations + + :class:`ftrack_api.data.String` is now using a temporary file instead of + StringIO to avoid reading large files into memory. + + .. change:: fixed + :tags: session, locations + + `ftrack.centralized-storage` does not properly validate location + selection during user configuration. + +.. release:: 0.16.0 + :date: 2016-10-18 + + .. change:: new + :tags: session, encode media + + :meth:`Session.encode_media` can now automatically associate the output + with a version by specifying a *version_id* keyword argument. A new + helper method on versions, :meth:`AssetVersion.encode_media + `, can be + used to make versions playable in a browser. A server version of 3.3.32 + or higher is required for it to function properly. + + .. seealso:: :ref:`example/encode_media`. + + .. change:: changed + :tags: session, encode media + + You can now decide if :meth:`Session.encode_media` should keep or + delete the original component by specifying the *keep_original* + keyword argument. + + .. change:: changed + :tags: backwards-incompatible, collection + + Collection mutation now stores collection instance in operations rather + than underlying data structure. + + .. change:: changed + :tags: performance + + Improve performance of commit operations by optimising encoding and + reducing payload sent to server. + + .. change:: fixed + :tags: documentation + + Asset parent variable is declared but never used in + :ref:`example/publishing`. + + .. change:: fixed + :tags: documentation + + Documentation of hierarchical attributes and their limitations are + misleading. See :ref:`example/custom_attribute`. + +.. release:: 0.15.5 + :date: 2016-08-12 + + .. change:: new + :tags: documentation + + Added two new examples for :ref:`example/publishing` and + :ref:`example/web_review`. + + .. change:: fixed + :tags: session, availability + + :meth:`Session.get_component_availabilities` ignores passed locations + shortlist and includes all locations in returned availability mapping. + + .. change:: fixed + :tags: documentation + + Source distribution of ftrack-python-api does not include ftrack.css + in the documentation. + +.. release:: 0.15.4 + :date: 2016-07-12 + + .. change:: fixed + :tags: querying + + Custom offset not respected by + :meth:`QueryResult.first `. + + .. change:: changed + :tags: querying + + Using a custom offset with :meth:`QueryResult.one + ` helper method now raises an + exception as an offset is inappropriate when expecting to select a + single item. + + .. change:: fixed + :tags: caching + + :meth:`LayeredCache.remove ` + incorrectly raises :exc:`~exceptions.KeyError` if key only exists in + sub-layer cache. + +.. release:: 0.15.3 + :date: 2016-06-30 + + .. change:: fixed + :tags: session, caching + + A newly created entity now has the correct + :attr:`ftrack_api.symbol.CREATED` state when checked in caching layer. + Previously the state was :attr:`ftrack_api.symbol.NOT_SET`. Note that + this fix causes a change in logic and the stored + :class:`ftrack_api.operation.CreateEntityOperation` might hold data that + has not been fully :meth:`merged `. + + .. change:: fixed + :tags: documentation + + The second example in the assignments article is not working. + + .. change:: changed + :tags: session, caching + + A callable cache maker can now return ``None`` to indicate that it could + not create a suitable cache, but :class:`Session` instantiation can + continue safely. + +.. release:: 0.15.2 + :date: 2016-06-02 + + .. change:: new + :tags: documentation + + Added an example on how to work with assignments and allocations + :ref:`example/assignments_and_allocations`. + + .. change:: new + :tags: documentation + + Added :ref:`example/entity_links` article with + examples of how to manage asset version dependencies. + + .. change:: fixed + :tags: performance + + Improve performance of large collection management. + + .. change:: fixed + + Entities are not hashable because + :meth:`ftrack_api.entity.base.Entity.__hash__` raises `TypeError`. + +.. release:: 0.15.1 + :date: 2016-05-02 + + .. change:: fixed + :tags: collection, attribute, performance + + Custom attribute configurations does not cache necessary keys, leading + to performance issues. + + .. change:: fixed + :tags: locations, structure + + Standard structure does not work if version relation is not set on + the `Component`. + +.. release:: 0.15.0 + :date: 2016-04-04 + + .. change:: new + :tags: session, locations + + `ftrack.centralized-storage` not working properly on Windows. + +.. release:: 0.14.0 + :date: 2016-03-14 + + .. change:: changed + :tags: session, locations + + The `ftrack.centralized-storage` configurator now validates that name, + label and description for new locations are filled in. + + .. change:: new + :tags: session, client review + + Added :meth:`Session.send_review_session_invite` and + :meth:`Session.send_review_session_invites` that can be used to inform + review session invitees about a review session. + + .. seealso:: :ref:`Usage guide `. + + .. change:: new + :tags: session, locations + + Added `ftrack.centralized-storage` configurator as a private module. It + implements a wizard like interface used to configure a centralised + storage scenario. + + .. change:: new + :tags: session, locations + + `ftrack.centralized-storage` storage scenario is automatically + configured based on information passed from the server with the + `query_server_information` action. + + .. change:: new + :tags: structure + + Added :class:`ftrack_api.structure.standard.StandardStructure` with + hierarchy based resource identifier generation. + + .. change:: new + :tags: documentation + + Added more information to the :ref:`understanding_sessions/plugins` + article. + + .. change:: fixed + + :meth:`~ftrack_api.entity.user.User.start_timer` arguments *comment* + and *name* are ignored. + + .. change:: fixed + + :meth:`~ftrack_api.entity.user.User.stop_timer` calculates the wrong + duration when the server is not running in UTC. + + For the duration to be calculated correctly ftrack server version + >= 3.3.15 is required. + +.. release:: 0.13.0 + :date: 2016-02-10 + + .. change:: new + :tags: component, thumbnail + + Added improved support for handling thumbnails. + + .. seealso:: :ref:`example/thumbnail`. + + .. change:: new + :tags: session, encode media + + Added :meth:`Session.encode_media` that can be used to encode + media to make it playable in a browser. + + .. seealso:: :ref:`example/encode_media`. + + .. change:: fixed + + :meth:`Session.commit` fails when setting a custom attribute on an asset + version that has been created and committed in the same session. + + .. change:: new + :tags: locations + + Added :meth:`ftrack_api.entity.location.Location.get_url` to retrieve a + URL to a component in a location if supported by the + :class:`ftrack_api.accessor.base.Accessor`. + + .. change:: new + :tags: documentation + + Updated :ref:`example/note` and :ref:`example/job` articles with + examples of how to use note and job components. + + .. change:: changed + :tags: logging, performance + + Logged messages now evaluated lazily using + :class:`ftrack_api.logging.LazyLogMessage` as optimisation. + + .. change:: changed + :tags: session, events + + Auto connection of event hub for :class:`Session` now takes place in + background to improve session startup time. + + .. change:: changed + :tags: session, events + + Event hub connection timeout is now 60 seconds instead of 10. + + .. change:: changed + :tags: server version + + ftrack server version >= 3.3.11, < 3.4 required. + + .. change:: changed + :tags: querying, performance + + :class:`ftrack_api.query.QueryResult` now pages internally using a + specified page size in order to optimise record retrieval for large + query results. :meth:`Session.query` has also been updated to allow + passing a custom page size at runtime if desired. + + .. change:: changed + :tags: querying, performance + + Increased performance of :meth:`~ftrack_api.query.QueryResult.first` and + :meth:`~ftrack_api.query.QueryResult.one` by using new `limit` syntax. + +.. release:: 0.12.0 + :date: 2015-12-17 + + .. change:: new + :tags: session, widget url + + Added :meth:`ftrack_api.session.Session.get_widget_url` to retrieve an + authenticated URL to info or tasks widgets. + +.. release:: 0.11.0 + :date: 2015-12-04 + + .. change:: new + :tags: documentation + + Updated :ref:`release/migrating_from_old_api` with new link attribute + and added a :ref:`usage example `. + + .. change:: new + :tags: caching, schemas, performance + + Caching of schemas for increased performance. + :meth:`ftrack_api.session.Session` now accepts `schema_cache_path` + argument to specify location of schema cache. If not set it will use a + temporary folder. + +.. release:: 0.10.0 + :date: 2015-11-24 + + .. change:: changed + :tags: tests + + Updated session test to use mocked schemas for encoding tests. + + .. change:: fixed + + Documentation specifies Python 2.6 instead of Python 2.7 as minimum + interpreter version. + + .. change:: fixed + + Documentation does not reflect current dependencies. + + .. change:: changed + :tags: session, component, locations, performance + + Improved performance of + :meth:`ftrack_api.entity.location.Location.add_components` by batching + database operations. + + As a result it is no longer possible to determine progress of transfer + for container components in realtime as events will be emitted in batch + at end of operation. + + In addition, it is now the callers responsibility to clean up any + transferred data should an error occur during either data transfer or + database registration. + + .. change:: changed + :tags: exception, locations + + :exc:`ftrack_api.exception.ComponentInLocationError` now accepts either + a single component or multiple components and makes them available as + *components* in its *details* parameter. + + .. change:: changed + :tags: tests + + Updated session test to not fail on the new private link attribute. + + .. change:: changed + :tags: session + + Internal method :py:meth:`_fetch_schemas` has beed renamed to + :py:meth:`Session._load_schemas` and now requires a `schema_cache_path` + argument. + +.. release:: 0.9.0 + :date: 2015-10-30 + + .. change:: new + :tags: caching + + Added :meth:`ftrack_api.cache.Cache.values` as helper for retrieving + all values in cache. + + .. change:: fixed + :tags: session, caching + + :meth:`Session.merge` redundantly attempts to expand entity references + that have already been expanded causing performance degradation. + + .. change:: new + :tags: session + + :meth:`Session.rollback` has been added to support cleanly reverting + session state to last good state following a failed commit. + + .. change:: changed + :tags: events + + Event hub will no longer allow unverified SSL connections. + + .. seealso:: :ref:`security_and_authentication`. + + .. change:: changed + :tags: session + + :meth:`Session.reset` no longer resets the connection. It also clears + all local state and re-configures certain aspects that are cache + dependant, such as location plugins. + + .. change:: fixed + :tags: factory + + Debug logging messages using incorrect index for formatting leading to + misleading exception. + +.. release:: 0.8.4 + :date: 2015-10-08 + + .. change:: new + + Added initial support for custom attributes. + + .. seealso:: :ref:`example/custom_attribute`. + + .. change:: new + :tags: collection, attribute + + Added :class:`ftrack_api.collection.CustomAttributeCollectionProxy` and + :class:`ftrack_api.attribute.CustomAttributeCollectionAttribute` to + handle custom attributes. + + .. change:: changed + :tags: collection, attribute + + ``ftrack_api.attribute.MappedCollectionAttribute`` renamed to + :class:`ftrack_api.attribute.KeyValueMappedCollectionAttribute` to more + closely reflect purpose. + + .. change:: changed + :tags: collection + + :class:`ftrack_api.collection.MappedCollectionProxy` has been refactored + as a generic base class with key, value specialisation handled in new + dedicated class + :class:`ftrack_api.collection.KeyValueMappedCollectionProxy`. This is + done to avoid confusion following introduction of new + :class:`ftrack_api.collection.CustomAttributeCollectionProxy` class. + + .. change:: fixed + :tags: events + + The event hub does not always reconnect after computer has come back + from sleep. + +.. release:: 0.8.3 + :date: 2015-09-28 + + .. change:: changed + :tags: server version + + ftrack server version >= 3.2.1, < 3.4 required. + + .. change:: changed + + Updated *ftrack.server* location implementation. A server version of 3.3 + or higher is required for it to function properly. + + .. change:: fixed + + :meth:`ftrack_api.entity.factory.StandardFactory.create` not respecting + *bases* argument. + +.. release:: 0.8.2 + :date: 2015-09-16 + + .. change:: fixed + :tags: session + + Wrong file type set on component when publishing image sequence using + :meth:`Session.create_component`. + +.. release:: 0.8.1 + :date: 2015-09-08 + + .. change:: fixed + :tags: session + + :meth:`Session.ensure` not implemented. + +.. release:: 0.8.0 + :date: 2015-08-28 + + .. change:: changed + :tags: server version + + ftrack server version >= 3.2.1, < 3.3 required. + + .. change:: new + + Added lists example. + + .. seealso:: :ref:`example/list`. + + .. change:: new + + Added convenience methods for handling timers + :class:`~ftrack_api.entity.user.User.start_timer` and + :class:`~ftrack_api.entity.user.User.stop_timer`. + + .. change:: changed + + The dynamic API classes Type, Status, Priority and + StatusType have been renamed to Type, Status, Priority and State. + + .. change:: changed + + :meth:`Session.reset` now also clears the top most level cache (by + default a :class:`~ftrack_api.cache.MemoryCache`). + + .. change:: fixed + + Some invalid server url formats not detected. + + .. change:: fixed + + Reply events not encoded correctly causing them to be misinterpreted by + the server. + +.. release:: 0.7.0 + :date: 2015-08-24 + + .. change:: changed + :tags: server version + + ftrack server version >= 3.2, < 3.3 required. + + .. change:: changed + + Removed automatic set of default statusid, priorityid and typeid on + objects as that is now either not mandatory or handled on server. + + .. change:: changed + + Updated :meth:`~ftrack_api.entity.project_schema.ProjectSchema.get_statuses` + and :meth:`~ftrack_api.entity.project_schema.ProjectSchema.get_types` to + handle custom objects. + +.. release:: 0.6.0 + :date: 2015-08-19 + + .. change:: changed + :tags: server version + + ftrack server version >= 3.1.8, < 3.2 required. + + .. change:: changed + :tags: querying, documentation + + Updated documentation with details on new operators ``has`` and ``any`` + for querying relationships. + + .. seealso:: :ref:`querying/criteria/operators` + +.. release:: 0.5.2 + :date: 2015-07-29 + + .. change:: changed + :tags: server version + + ftrack server version 3.1.5 or greater required. + + .. change:: changed + + Server reported errors are now more readable and are no longer sometimes + presented as an HTML page. + +.. release:: 0.5.1 + :date: 2015-07-06 + + .. change:: changed + + Defaults computed by :class:`~ftrack_api.entity.factory.StandardFactory` + are now memoised per session to improve performance. + + .. change:: changed + + :class:`~ftrack_api.cache.Memoiser` now supports a *return_copies* + parameter to control whether deep copies should be returned when a value + was retrieved from the cache. + +.. release:: 0.5.0 + :date: 2015-07-02 + + .. change:: changed + + Now checks for server compatibility and requires an ftrack server + version of 3.1 or greater. + + .. change:: new + + Added convenience methods to :class:`~ftrack_api.query.QueryResult` to + fetch :meth:`~ftrack_api.query.QueryResult.first` or exactly + :meth:`~ftrack_api.query.QueryResult.one` result. + + .. change:: new + :tags: notes + + Added support for handling notes. + + .. seealso:: :ref:`example/note`. + + .. change:: changed + + Collection attributes generate empty collection on first access when no + remote value available. This allows interacting with a collection on a + newly created entity before committing. + + .. change:: fixed + :tags: session + + Ambiguous error raised when :class:`Session` is started with an invalid + user or key. + + .. change:: fixed + :tags: caching, session + + :meth:`Session.merge` fails against + :class:`~ftrack_api.cache.SerialisedCache` when circular reference + encountered due to entity identity not being prioritised in merge. + +.. release:: 0.4.3 + :date: 2015-06-29 + + .. change:: fixed + :tags: plugins, session, entity types + + Entity types not constructed following standard install. + + This is because the discovery of the default plugins is unreliable + across Python installation processes (pip, wheel etc). Instead, the + default plugins have been added as templates to the :ref:`event_list` + documentation and the + :class:`~ftrack_api.entity.factory.StandardFactory` used to create any + missing classes on :class:`Session` startup. + +.. release:: 0.4.2 + :date: 2015-06-26 + + .. change:: fixed + :tags: metadata + + Setting exact same metadata twice can cause + :exc:`~ftrack_api.exception.ImmutableAttributeError` to be incorrectly + raised. + + .. change:: fixed + :tags: session + + Calling :meth:`Session.commit` does not clear locally set attribute + values leading to immutability checks being bypassed in certain cases. + +.. release:: 0.4.1 + :date: 2015-06-25 + + .. change:: fixed + :tags: metadata + + Setting metadata twice in one session causes `KeyError`. + +.. release:: 0.4.0 + :date: 2015-06-22 + + .. change:: changed + :tags: documentation + + Documentation extensively updated. + + .. change:: new + :tags: Client review + + Added support for handling review sessions. + + .. seealso:: :ref:`Usage guide `. + + .. change:: fixed + + Metadata property not working in line with rest of system, particularly + the caching framework. + + .. change:: new + :tags: collection + + Added :class:`ftrack_api.collection.MappedCollectionProxy` class for + providing a dictionary interface to a standard + :class:`ftrack_api.collection.Collection`. + + .. change:: new + :tags: collection, attribute + + Added :class:`ftrack_api.attribute.MappedCollectionAttribute` class for + describing an attribute that should use the + :class:`ftrack_api.collection.MappedCollectionProxy`. + + .. change:: new + + Entities that use composite primary keys are now fully supported in the + session, including for :meth:`Session.get` and :meth:`Session.populate`. + + .. change:: change + + Base :class:`ftrack_api.entity.factory.Factory` refactored to separate + out attribute instantiation into dedicated methods to make extending + simpler. + + .. change:: change + :tags: collection, attribute + + :class:`ftrack_api.attribute.DictionaryAttribute` and + :class:`ftrack_api.attribute.DictionaryAttributeCollection` removed. + They have been replaced by the new + :class:`ftrack_api.attribute.MappedCollectionAttribute` and + :class:`ftrack_api.collection.MappedCollectionProxy` respectively. + + .. change:: new + :tags: events + + :class:`Session` now supports an *auto_connect_event_hub* argument to + control whether the built in event hub should connect to the server on + session initialisation. This is useful for when only local events should + be supported or when the connection should be manually controlled. + +.. release:: 0.3.0 + :date: 2015-06-14 + + .. change:: fixed + + Session operations may be applied server side in invalid order resulting + in unexpected error. + + .. change:: fixed + + Creating and deleting an entity in single commit causes error as create + operation never persisted to server. + + Now all operations for the entity are ignored on commit when this case + is detected. + + .. change:: changed + + Internally moved from differential state to operation tracking for + determining session changes when persisting. + + .. change:: new + + ``Session.recorded_operations`` attribute for examining current + pending operations on a :class:`Session`. + + .. change:: new + + :meth:`Session.operation_recording` context manager for suspending + recording operations temporarily. Can also manually control + ``Session.record_operations`` boolean. + + .. change:: new + + Operation classes to track individual operations occurring in session. + + .. change:: new + + Public :meth:`Session.merge` method for merging arbitrary values into + the session manually. + + .. change:: changed + + An entity's state is now computed from the operations performed on it + and is no longer manually settable. + + .. change:: changed + + ``Entity.state`` attribute removed. Instead use the new inspection + :func:`ftrack_api.inspection.state`. + + Previously:: + + print entity.state + + Now:: + + import ftrack_api.inspection + print ftrack_api.inspection.state(entity) + + There is also an optimised inspection, + :func:`ftrack_api.inspection.states`. for determining state of many + entities at once. + + .. change:: changed + + Shallow copying a :class:`ftrack_api.symbol.Symbol` instance now + returns same instance. + +.. release:: 0.2.0 + :date: 2015-06-04 + + .. change:: changed + + Changed name of API from `ftrack` to `ftrack_api`. + + .. seealso:: :ref:`release/migration/0.2.0/new_api_name`. + + .. change:: new + :tags: caching + + Configurable caching support in :class:`Session`, including the ability + to use an external persisted cache and new cache implementations. + + .. seealso:: :ref:`caching`. + + .. change:: new + :tags: caching + + :meth:`Session.get` now tries to retrieve matching entity from + configured cache first. + + .. change:: new + :tags: serialisation, caching + + :meth:`Session.encode` supports a new mode *persisted_only* that will + only encode persisted attribute values. + + .. change:: changed + + Session.merge method is now private (:meth:`Session._merge`) until it is + qualified for general usage. + + .. change:: changed + :tags: entity state + + :class:`~ftrack_api.entity.base.Entity` state now managed on the entity + directly rather than stored separately in the :class:`Session`. + + Previously:: + + session.set_state(entity, state) + print session.get_state(entity) + + Now:: + + entity.state = state + print entity.state + + .. change:: changed + :tags: entity state + + Entity states are now :class:`ftrack_api.symbol.Symbol` instances rather + than strings. + + Previously:: + + entity.state = 'created' + + Now:: + + entity.state = ftrack_api.symbol.CREATED + + .. change:: fixed + :tags: entity state + + It is now valid to transition from most entity states to an + :attr:`ftrack_api.symbol.NOT_SET` state. + + .. change:: changed + :tags: caching + + :class:`~ftrack_api.cache.EntityKeyMaker` removed and replaced by + :class:`~ftrack_api.cache.StringKeyMaker`. Entity identity now + computed separately and passed to key maker to allow key maker to work + with non entity instances. + + .. change:: fixed + :tags: entity + + Internal data keys ignored when re/constructing entities reducing + distracting and irrelevant warnings in logs. + + .. change:: fixed + :tags: entity + + :class:`~ftrack_api.entity.base.Entity` equality test raises error when + other is not an entity instance. + + .. change:: changed + :tags: entity, caching + + :meth:`~ftrack_api.entity.base.Entity.merge` now also merges state and + local attributes. In addition, it ensures values being merged have also + been merged into the session and outputs more log messages. + + .. change:: fixed + :tags: inspection + + :func:`ftrack_api.inspection.identity` returns different result for same + entity depending on whether entity type is unicode or string. + + .. change:: fixed + + :func:`ftrack_api.mixin` causes method resolution failure when same + class mixed in multiple times. + + .. change:: changed + + Representations of objects now show plain id rather than converting to + hex. + + .. change:: fixed + :tags: events + + Event hub raises TypeError when listening to ftrack.update events. + + .. change:: fixed + :tags: events + + :meth:`ftrack_api.event.hub.EventHub.subscribe` fails when subscription + argument contains special characters such as `@` or `+`. + + .. change:: fixed + :tags: collection + + :meth:`ftrack_api.collection.Collection` incorrectly modifies entity + state on initialisation. + +.. release:: 0.1.0 + :date: 2015-03-25 + + .. change:: changed + + Moved standardised construct entity type logic to core package (as part + of the :class:`~ftrack_api.entity.factory.StandardFactory`) for easier + reuse and extension. + +.. release:: 0.1.0-beta.2 + :date: 2015-03-17 + + .. change:: new + :tags: locations + + Support for ftrack.server location. The corresponding server build is + required for it to function properly. + + .. change:: new + :tags: locations + + Support for managing components in locations has been added. Check out + the :ref:`dedicated tutorial `. + + .. change:: new + + A new inspection API (:mod:`ftrack_api.inspection`) has been added for + extracting useful information from objects in the system, such as the + identity of an entity. + + .. change:: changed + + ``Entity.primary_key`` and ``Entity.identity`` have been removed. + Instead, use the new :func:`ftrack_api.inspection.primary_key` and + :func:`ftrack_api.inspection.identity` functions. This was done to make it + clearer the the extracted information is determined from the current + entity state and modifying the returned object will have no effect on + the entity instance itself. + + .. change:: changed + + :func:`ftrack_api.inspection.primary_key` now returns a mapping of the + attribute names and values that make up the primary key, rather than + the previous behaviour of returning a tuple of just the values. To + emulate previous behaviour do:: + + ftrack_api.inspection.primary_key(entity).values() + + .. change:: changed + + :meth:`Session.encode` now supports different strategies for encoding + entities via the entity_attribute_strategy* keyword argument. This makes + it possible to use this method for general serialisation of entity + instances. + + .. change:: changed + + Encoded referenced entities are now a mapping containing + *__entity_type__* and then each key, value pair that makes up the + entity's primary key. For example:: + + { + '__entity_type__': 'User', + 'id': '8b90a444-4e65-11e1-a500-f23c91df25eb' + } + + .. change:: changed + + :meth:`Session.decode` no longer automatically adds decoded entities to + the :class:`Session` cache making it possible to use decode + independently. + + .. change:: new + + Added :meth:`Session.merge` for merging entities recursively into the + session cache. + + .. change:: fixed + + Replacing an entity in a :class:`ftrack_api.collection.Collection` with an + identical entity no longer raises + :exc:`ftrack_api.exception.DuplicateItemInCollectionError`. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/resource/example_plugin.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/resource/example_plugin.py new file mode 100644 index 0000000000..5fda0195a9 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/resource/example_plugin.py @@ -0,0 +1,24 @@ +# :coding: utf-8 +import logging + +import ftrack_api.session + + +def register(session, **kw): + '''Register plugin. Called when used as an plugin.''' + logger = logging.getLogger('com.example.example-plugin') + + # Validate that session is an instance of ftrack_api.Session. If not, + # assume that register is being called from an old or incompatible API and + # return without doing anything. + if not isinstance(session, ftrack_api.session.Session): + logger.debug( + 'Not subscribing plugin as passed argument {0!r} is not an ' + 'ftrack_api.Session instance.'.format(session) + ) + return + + # Perform your logic here, such as subscribe to an event. + pass + + logger.debug('Plugin registered') diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/resource/example_plugin_safe.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/resource/example_plugin_safe.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/resource/example_plugin_using_session.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/resource/example_plugin_using_session.py new file mode 100644 index 0000000000..dd11136d69 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/resource/example_plugin_using_session.py @@ -0,0 +1,37 @@ +# :coding: utf-8 +import logging + +import ftrack_api.session + + +def register_with_session_ready(event): + '''Called when session is ready to be used.''' + logger = logging.getLogger('com.example.example-plugin') + logger.debug('Session ready.') + session = event['data']['session'] + + # Session is now ready and can be used to e.g. query objects. + task = session.query('Task').first() + print task['name'] + + +def register(session, **kw): + '''Register plugin. Called when used as an plugin.''' + logger = logging.getLogger('com.example.example-plugin') + + # Validate that session is an instance of ftrack_api.Session. If not, + # assume that register is being called from an old or incompatible API and + # return without doing anything. + if not isinstance(session, ftrack_api.session.Session): + logger.debug( + 'Not subscribing plugin as passed argument {0!r} is not an ' + 'ftrack_api.Session instance.'.format(session) + ) + return + + session.event_hub.subscribe( + 'topic=ftrack.api.session.ready', + register_with_session_ready + ) + + logger.debug('Plugin registered') diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/security_and_authentication.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/security_and_authentication.rst new file mode 100644 index 0000000000..724afa81a6 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/security_and_authentication.rst @@ -0,0 +1,38 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _security_and_authentication: + +*************************** +Security and authentication +*************************** + +Self signed SSL certificate +=========================== + +When using a self signed SSL certificate the API may fail to connect if it +cannot verify the SSL certificate. Under the hood the +`requests `_ library is used and it +must be specified where the trusted certificate authority can be found using the +environment variable ``REQUESTS_CA_BUNDLE``. + +.. seealso:: `SSL Cert Verification `_ + +InsecurePlatformWarning +======================= + +When using this API you may sometimes see a warning:: + + InsecurePlatformWarning: A true SSLContext object is not available. This + prevents urllib3 from configuring SSL appropriately and may cause certain + SSL connections to fail. + +If you encounter this warning, its recommended you upgrade to Python 2.7.9, or +use pyOpenSSL. To use pyOpenSSL simply:: + + pip install pyopenssl ndg-httpsclient pyasn1 + +and the `requests `_ library used by +this API will use pyOpenSSL instead. + +.. seealso:: `InsecurePlatformWarning `_ diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/tutorial.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/tutorial.rst new file mode 100644 index 0000000000..73b352eb2f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/tutorial.rst @@ -0,0 +1,156 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _tutorial: + +******** +Tutorial +******** + +.. currentmodule:: ftrack_api.session + +This tutorial provides a quick dive into using the API and the broad stroke +concepts involved. + +First make sure the ftrack Python API is :ref:`installed `. + +Then start a Python session and import the ftrack API:: + + >>> import ftrack_api + +The API uses :ref:`sessions ` to manage communication +with an ftrack server. Create a session that connects to your ftrack server +(changing the passed values as appropriate):: + + >>> session = ftrack_api.Session( + ... server_url='https://mycompany.ftrackapp.com', + ... api_key='7545384e-a653-11e1-a82c-f22c11dd25eq', + ... api_user='martin' + ... ) + +.. note:: + + A session can use :ref:`environment variables + ` to configure itself. + +Now print a list of the available entity types retrieved from the server:: + + >>> print session.types.keys() + [u'TypedContext', u'ObjectType', u'Priority', u'Project', u'Sequence', + u'Shot', u'Task', u'Status', u'Type', u'Timelog', u'User'] + +Now the list of possible entity types is known, :ref:`query ` the +server to retrieve entities of a particular type by using the +:meth:`Session.query` method:: + + >>> projects = session.query('Project') + +Each project retrieved will be an :ref:`entity ` instance +that behaves much like a standard Python dictionary. For example, to find out +the available keys for an entity, call the +:meth:`~ftrack_api.entity.Entity.keys` method:: + + >>> print projects[0].keys() + [u'status', u'is_global', u'name', u'end_date', u'context_type', + u'id', u'full_name', u'root', u'start_date'] + +Now, iterate over the retrieved entities and print each ones name:: + + >>> for project in projects: + ... print project['name'] + test + client_review + tdb + man_test + ftrack + bunny + +.. note:: + + Many attributes for retrieved entities are loaded on demand when the + attribute is first accessed. Doing this lots of times in a script can be + inefficient, so it is worth using :ref:`projections ` + in queries or :ref:`pre-populating ` + entities where appropriate. You can also :ref:`customise default projections + ` to help others + pre-load common attributes. + +To narrow a search, add :ref:`criteria ` to the query:: + + >>> active_projects = session.query('Project where status is active') + +Combine criteria for more powerful queries:: + + >>> import arrow + >>> + >>> active_projects_ending_before_next_week = session.query( + ... 'Project where status is active and end_date before "{0}"' + ... .format(arrow.now().replace(weeks=+1)) + ... ) + +Some attributes on an entity will refer to another entity or collection of +entities, such as *children* on a *Project* being a collection of *Context* +entities that have the project as their parent:: + + >>> project = session.query('Project').first() + >>> print project['children'] + + +And on each *Context* there is a corresponding *parent* attribute which is a +link back to the parent:: + + >>> child = project['children'][0] + >>> print child['parent'] is project + True + +These relationships can also be used in the criteria for a query:: + + >>> results = session.query( + ... 'Context where parent.name like "te%"' + ... ) + +To create new entities in the system use :meth:`Session.create`:: + + >>> new_sequence = session.create('Sequence', { + ... 'name': 'Starlord Reveal' + ... }) + +The created entity is not yet persisted to the server, but it is still possible +to modify it. + + >>> new_sequence['description'] = 'First hero character reveal.' + +The sequence also needs a parent. This can be done in one of two ways: + +* Set the parent attribute on the sequence:: + + >>> new_sequence['parent'] = project + +* Add the sequence to a parent's children attribute:: + + >>> project['children'].append(new_sequence) + +When ready, persist to the server using :meth:`Session.commit`:: + + >>> session.commit() + +When finished with a :class:`Session`, it is important to :meth:`~Session.close` +it in order to release resources and properly unsubscribe any registered event +listeners. It is also possible to use the session as a context manager in order +to have it closed automatically after use:: + + >>> with ftrack_api.Session() as session: + ... print session.query('User').first() + + >>> print session.closed + True + +Once a :class:`Session` is closed, any operations that attempt to use the closed +connection to the ftrack server will fail:: + + >>> session.query('Project').first() + ConnectionClosedError: Connection closed. + +Continue to the next section to start learning more about the API in greater +depth or jump over to the :ref:`usage examples ` if you prefer to learn +by example. diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/understanding_sessions.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/understanding_sessions.rst new file mode 100644 index 0000000000..e3602c4fa9 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/understanding_sessions.rst @@ -0,0 +1,281 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _understanding_sessions: + +********************** +Understanding sessions +********************** + +.. currentmodule:: ftrack_api.session + +All communication with an ftrack server takes place through a :class:`Session`. +This allows more opportunity for configuring the connection, plugins etc. and +also makes it possible to connect to multiple ftrack servers from within the +same Python process. + +.. _understanding_sessions/connection: + +Connection +========== + +A session can be manually configured at runtime to connect to a server with +certain credentials:: + + >>> session = ftrack_api.Session( + ... server_url='https://mycompany.ftrackapp.com', + ... api_key='7545384e-a653-11e1-a82c-f22c11dd25eq', + ... api_user='martin' + ... ) + +Alternatively, a session can use the following environment variables to +configure itself: + + * :envvar:`FTRACK_SERVER` + * :envvar:`FTRACK_API_USER` + * :envvar:`FTRACK_API_KEY` + +When using environment variables, no server connection arguments need to be +passed manually:: + + >>> session = ftrack_api.Session() + +.. _understanding_sessions/unit_of_work: + +Unit of work +============ + +Each session follows the unit of work pattern. This means that many of the +operations performed using a session will happen locally and only be persisted +to the server at certain times, notably when calling :meth:`Session.commit`. +This approach helps optimise calls to the server and also group related logic +together in a transaction:: + + user = session.create('User', {}) + user['username'] = 'martin' + other_user = session.create('User', {'username': 'bjorn'}) + other_user['email'] = 'bjorn@example.com' + +Behind the scenes a series of :class:`operations +` are recorded reflecting the changes made. You +can take a peek at these operations if desired by examining the +``Session.recorded_operations`` property:: + + >>> for operation in session.recorded_operations: + ... print operation + + + + + +Calling :meth:`Session.commit` persists all recorded operations to the server +and clears the operation log:: + + session.commit() + +.. note:: + + The commit call will optimise operations to be as efficient as possible + without breaking logical ordering. For example, a create followed by updates + on the same entity will be compressed into a single create. + +Queries are special and always issued on demand. As a result, a query may return +unexpected results if the relevant local changes have not yet been sent to the +server:: + + >>> user = session.create('User', {'username': 'some_unique_username'}) + >>> query = 'User where username is "{0}"'.format(user['username']) + >>> print len(session.query(query)) + 0 + >>> session.commit() + >>> print len(session.query(query)) + 1 + +Where possible, query results are merged in with existing data transparently +with any local changes preserved:: + + >>> user = session.query('User').first() + >>> user['email'] = 'me@example.com' # Not yet committed to server. + >>> retrieved = session.query( + ... 'User where id is "{0}"'.format(user['id']) + ... ).one() + >>> print retrieved['email'] # Displays locally set value. + 'me@example.com' + >>> print retrieved is user + True + +This is possible due to the smart :ref:`caching` layer in the session. + +.. _understanding_sessions/auto_population: + +Auto-population +=============== + +Another important concept in a session is that of auto-population. By default a +session is configured to auto-populate missing attribute values on access. This +means that the first time you access an attribute on an entity instance a query +will be sent to the server to fetch the value:: + + user = session.query('User').first() + # The next command will issue a request to the server to fetch the + # 'username' value on demand at this is the first time it is accessed. + print user['username'] + +Once a value has been retrieved it is :ref:`cached ` locally in the +session and accessing it again will not issue more server calls:: + + # On second access no server call is made. + print user['username'] + +You can control the auto population behaviour of a session by either changing +the ``Session.auto_populate`` attribute on a session or using the provided +context helper :meth:`Session.auto_populating` to temporarily change the +setting. When turned off you may see a special +:attr:`~ftrack_api.symbol.NOT_SET` symbol that represents a value has not yet +been fetched:: + + >>> with session.auto_populating(False): + ... print user['email'] + NOT_SET + +Whilst convenient for simple scripts, making many requests to the server for +each attribute can slow execution of a script. To support optimisation the API +includes methods for batch fetching attributes. Read about them in +:ref:`querying/projections` and :ref:`working_with_entities/populating`. + +.. _understanding_sessions/entity_types: + +Entity types +============ + +When a session has successfully connected to the server it will automatically +download schema information and :ref:`create appropriate classes +` for use. This is important as different +servers can support different entity types and configurations. + +This information is readily available and useful if you need to check that the +entity types you expect are present. Here's how to print a list of all entity +types registered for use in the current API session:: + + >>> print session.types.keys() + [u'Task', u'Shot', u'TypedContext', u'Sequence', u'Priority', + u'Status', u'Project', u'User', u'Type', u'ObjectType'] + +Each entity type is backed by a :ref:`customisable class +` that further describes the entity type and +the attributes that are available. + +.. hint:: + + If you need to use an :func:`isinstance` check, always go through the + session as the classes are built dynamically:: + + >>> isinstance(entity, session.types['Project']) + +.. _understanding_sessions/plugins: + +Configuring plugins +=================== + +Plugins are used by the API to extend it with new functionality, such as +:term:`locations ` or adding convenience methods to +:ref:`understanding_sessions/entity_types`. In addition to new API +functionality, event plugins may also be used for event processing by listening +to :ref:`ftrack update events ` or adding custom functionality to ftrack by registering +:term:`actions `. + + +When starting a new :class:`Session` either pass the *plugins_paths* to search +explicitly or rely on the environment variable +:envvar:`FTRACK_EVENT_PLUGIN_PATH`. As each session is independent of others, +you can configure plugins per session. + +The paths will be searched for :term:`plugins `, python files +which expose a `register` function. These functions will be evaluated and can +be used extend the API with new functionality, such as locations or actions. + +If you do not specify any override then the session will attempt to discover and +use the default plugins. + +Plugins are discovered using :func:`ftrack_api.plugin.discover` with the +session instance passed as the sole positional argument. Most plugins should +take the form of a mount function that then subscribes to specific :ref:`events +` on the session:: + + def configure_locations(event): + '''Configure locations for session.''' + session = event['data']['session'] + # Find location(s) and customise instances. + + def register(session): + '''Register plugin with *session*.''' + session.event_hub.subscribe( + 'topic=ftrack.api.session.configure-location', + configure_locations + ) + +Additional keyword arguments can be passed as *plugin_arguments* to the +:class:`Session` on instantiation. These are passed to the plugin register +function if its signature supports them:: + + # a_plugin.py + def register(session, reticulate_splines=False): + '''Register plugin with *session*.''' + ... + + # main.py + session = ftrack_api.Session( + plugin_arguments={ + 'reticulate_splines': True, + 'some_other_argument': 42 + } + ) + +.. seealso:: + + Lists of events which you can subscribe to in your plugins are available + both for :ref:`synchronous event published by the python API ` + and :ref:`asynchronous events published by the server ` + + +Quick setup +----------- + +1. Create a directory where plugins will be stored. Place any plugins you want +loaded automatically in an API *session* here. + +.. image:: /image/configuring_plugins_directory.png + +2. Configure the :envvar:`FTRACK_EVENT_PLUGIN_PATH` to point to the directory. + + +Detailed setup +-------------- + +Start out by creating a directory on your machine where you will store your +plugins. Download :download:`example_plugin.py ` +and place it in the directory. + +Open up a terminal window, and ensure that plugin is picked up when +instantiating the session and manually setting the *plugin_paths*:: + + >>> # Set up basic logging + >>> import logging + >>> logging.basicConfig() + >>> plugin_logger = logging.getLogger('com.example.example-plugin') + >>> plugin_logger.setLevel(logging.DEBUG) + >>> + >>> # Configure the API, loading plugins in the specified paths. + >>> import ftrack_api + >>> plugin_paths = ['/path/to/plugins'] + >>> session = ftrack_api.Session(plugin_paths=plugin_paths) + +If everything is working as expected, you should see the following in the +output:: + + DEBUG:com.example.example-plugin:Plugin registered + +Instead of specifying the plugin paths when instantiating the session, you can +also specify the :envvar:`FTRACK_EVENT_PLUGIN_PATH` to point to the directory. +To specify multiple directories, use the path separator for your operating +system. \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/working_with_entities.rst b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/working_with_entities.rst new file mode 100644 index 0000000000..2d9d26f986 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/doc/working_with_entities.rst @@ -0,0 +1,434 @@ +.. + :copyright: Copyright (c) 2014 ftrack + +.. _working_with_entities: + +********************* +Working with entities +********************* + +.. currentmodule:: ftrack_api.session + +:class:`Entity ` instances are Python dict-like +objects whose keys correspond to attributes for that type in the system. They +may also provide helper methods to perform common operations such as replying to +a note:: + + note = session.query('Note').first() + print note.keys() + print note['content'] + note['content'] = 'A different message!' + reply = note.create_reply(...) + +.. _working_with_entities/attributes: + +Attributes +========== + +Each entity instance is typed according to its underlying entity type on the +server and configured with appropriate attributes. For example, a *task* will be +represented by a *Task* class and have corresponding attributes. You can +:ref:`customise entity classes ` to alter +attribute access or provide your own helper methods. + +To see the available attribute names on an entity use the +:meth:`~ftrack_api.entity.base.Entity.keys` method on the instance:: + + >>> task = session.query('Task').first() + >>> print task.keys() + ['id', 'name', ...] + +If you need more information about the type of attribute, examine the +``attributes`` property on the corresponding class:: + + >>> for attribute in type(task).attributes: + ... print attribute + + + + + + ... + +Notice that there are different types of attribute such as +:class:`~ftrack_api.attribute.ScalarAttribute` for plain values or +:class:`~ftrack_api.attribute.ReferenceAttribute` for relationships. These +different types are reflected in the behaviour on the entity instance when +accessing a particular attribute by key: + + >>> # Scalar + >>> print task['name'] + 'model' + >>> task['name'] = 'comp' + + >>> # Single reference + >>> print task['status'] + + >>> new_status = session.query('Status').first() + >>> task['status'] = new_status + + >>> # Collection + >>> print task['timelogs'] + + >>> print task['timelogs'][:] + [, ...] + >>> new_timelog = session.create('Timelog', {...}) + >>> task['timelogs'].append(new_timelog) + +.. _working_with_entities/attributes/bidirectional: + +Bi-directional relationships +---------------------------- + +Some attributes refer to different sides of a bi-directional relationship. In +the current version of the API bi-directional updates are not propagated +automatically to the other side of the relationship. For example, setting a +*parent* will not update the parent entity's *children* collection locally. +There are plans to support this behaviour better in the future. For now, after +commit, :ref:`populate ` the reverse side +attribute manually. + +.. _working_with_entities/creating: + +Creating entities +================= + +In order to create a new instance of an entity call :meth:`Session.create` +passing in the entity type to create and any initial attribute values:: + + new_user = session.create('User', {'username': 'martin'}) + +If there are any default values that can be set client side then they will be +applied at this point. Typically this will be the unique entity key:: + + >>> print new_user['id'] + 170f02a4-6656-4f15-a5cb-c4dd77ce0540 + +At this point no information has been sent to the server. However, you are free +to continue :ref:`updating ` this object +locally until you are ready to persist the changes by calling +:meth:`Session.commit`. + +If you are wondering about what would happen if you accessed an unset attribute +on a newly created entity, go ahead and give it a go:: + + >>> print new_user['first_name'] + NOT_SET + +The session knows that it is a newly created entity that has not yet been +persisted so it doesn't try to fetch any attributes on access even when +``session.auto_populate`` is turned on. + +.. _working_with_entities/updating: + +Updating entities +================= + +Updating an entity is as simple as modifying the values for specific keys on +the dict-like instance and calling :meth:`Session.commit` when ready. The entity +to update can either be a new entity or a retrieved entity:: + + task = session.query('Task').first() + task['bid'] = 8 + +Remember that, for existing entities, accessing an attribute will load it from +the server automatically. If you are interested in just setting values without +first fetching them from the server, turn :ref:`auto-population +` off temporarily:: + + >>> with session.auto_populating(False): + ... task = session.query('Task').first() + ... task['bid'] = 8 + + +.. _working_with_entities/resetting: + +Server side reset of entity attributes or settings. +=========================== + +Some entities support resetting of attributes, for example +to reset a users api key:: + + + session.reset_remote( + 'api_key', entity=session.query('User where username is "test_user"').one() + ) + +.. note:: + Currently the only attribute possible to reset is 'api_key' on + the user entity type. + + +.. _working_with_entities/deleting: + +Deleting entities +================= + +To delete an entity you need an instance of the entity in your session (either +from having created one or retrieving one). Then call :meth:`Session.delete` on +the entity and :meth:`Session.commit` when ready:: + + task_to_delete = session.query('Task').first() + session.delete(task_to_delete) + ... + session.commit() + +.. note:: + + Even though the entity is deleted, you will still have access to the local + instance and any local data stored on that instance whilst that instance + remains in memory. + +Keep in mind that some deletions, when propagated to the server, will cause +other entities to be deleted also, so you don't have to worry about deleting an +entire hierarchy manually. For example, deleting a *Task* will also delete all +*Notes* on that task. + +.. _working_with_entities/populating: + +Populating entities +=================== + +When an entity is retrieved via :meth:`Session.query` or :meth:`Session.get` it +will have some attributes prepopulated. The rest are dynamically loaded when +they are accessed. If you need to access many attributes it can be more +efficient to request all those attributes be loaded in one go. One way to do +this is to use a :ref:`projections ` in queries. + +However, if you have entities that have been passed to you from elsewhere you +don't have control over the query that was issued to get those entities. In this +case you can you can populate those entities in one go using +:meth:`Session.populate` which works exactly like :ref:`projections +` in queries do, but operating against known entities:: + + >>> users = session.query('User') + >>> session.populate(users, 'first_name, last_name') + >>> with session.auto_populating(False): # Turn off for example purpose. + ... for user in users: + ... print 'Name: {0}'.format(user['first_name']) + ... print 'Email: {0}'.format(user['email']) + Name: Martin + Email: NOT_SET + ... + +.. note:: + + You can populate a single or many entities in one call so long as they are + all the same entity type. + +.. _working_with_entities/entity_states: + +Entity states +============= + +Operations on entities are :ref:`recorded in the session +` as they happen. At any time you can +inspect an entity to determine its current state from those pending operations. + +To do this, use :func:`ftrack_api.inspection.state`:: + + >>> import ftrack_api.inspection + >>> new_user = session.create('User', {}) + >>> print ftrack_api.inspection.state(new_user) + CREATED + >>> existing_user = session.query('User').first() + >>> print ftrack_api.inspection.state(existing_user) + NOT_SET + >>> existing_user['email'] = 'martin@example.com' + >>> print ftrack_api.inspection.state(existing_user) + MODIFIED + >>> session.delete(new_user) + >>> print ftrack_api.inspection.state(new_user) + DELETED + +.. _working_with_entities/entity_types: + +Customising entity types +======================== + +Each type of entity in the system is represented in the Python client by a +dedicated class. However, because the types of entities can vary these classes +are built on demand using schema information retrieved from the server. + +Many of the default classes provide additional helper methods which are mixed +into the generated class at runtime when a session is started. + +In some cases it can be useful to tailor the custom classes to your own pipeline +workflows. Perhaps you want to add more helper functions, change attribute +access rules or even providing a layer of backwards compatibility for existing +code. The Python client was built with this in mind and makes such +customisations as easy as possible. + +When a :class:`Session` is constructed it fetches schema details from the +connected server and then calls an :class:`Entity factory +` to create classes from those schemas. It +does this by emitting a synchronous event, +*ftrack.api.session.construct-entity-type*, for each schema and expecting a +*class* object to be returned. + +In the default setup, a :download:`construct_entity_type.py +<../resource/plugin/construct_entity_type.py>` plugin is placed on the +:envvar:`FTRACK_EVENT_PLUGIN_PATH`. This plugin will register a trivial subclass +of :class:`ftrack_api.entity.factory.StandardFactory` to create the classes in +response to the construct event. The simplest way to get started is to edit this +default plugin as required. + +.. seealso:: :ref:`understanding_sessions/plugins` + +.. _working_with_entities/entity_types/default_projections: + +Default projections +------------------- + +When a :ref:`query ` is issued without any :ref:`projections +`, the session will automatically add default projections +according to the type of the entity. + +For example, the following shows that for a *User*, only *id* is fetched by +default when no projections added to the query:: + + >>> user = session.query('User').first() + >>> with session.auto_populating(False): # For demonstration purpose only. + ... print user.items() + [ + (u'id', u'59f0963a-15e2-11e1-a5f1-0019bb4983d8') + (u'username', Symbol(NOT_SET)), + (u'first_name', Symbol(NOT_SET)), + ... + ] + +.. note:: + + These default projections are also used when you access a relationship + attribute using the dictionary key syntax. + +If you want to default to fetching *username* for a *Task* as well then you can +change the default_projections* in your class factory plugin:: + + class Factory(ftrack_api.entity.factory.StandardFactory): + '''Entity class factory.''' + + def create(self, schema, bases=None): + '''Create and return entity class from *schema*.''' + cls = super(Factory, self).create(schema, bases=bases) + + # Further customise cls before returning. + if schema['id'] == 'User': + cls.default_projections = ['id', 'username'] + + return cls + +Now a projection-less query will also query *username* by default: + +.. note:: + + You will need to start a new session to pick up the change you made:: + + session = ftrack_api.Session() + +.. code-block:: python + + >>> user = session.query('User').first() + >>> with session.auto_populating(False): # For demonstration purpose only. + ... print user.items() + [ + (u'id', u'59f0963a-15e2-11e1-a5f1-0019bb4983d8') + (u'username', u'martin'), + (u'first_name', Symbol(NOT_SET)), + ... + ] + +Note that if any specific projections are applied in a query, those override +the default projections entirely. This allows you to also *reduce* the data +loaded on demand:: + + >>> session = ftrack_api.Session() # Start new session to avoid cache. + >>> user = session.query('select id from User').first() + >>> with session.auto_populating(False): # For demonstration purpose only. + ... print user.items() + [ + (u'id', u'59f0963a-15e2-11e1-a5f1-0019bb4983d8') + (u'username', Symbol(NOT_SET)), + (u'first_name', Symbol(NOT_SET)), + ... + ] + +.. _working_with_entities/entity_types/helper_methods: + +Helper methods +-------------- + +If you want to add additional helper methods to the constructed classes to +better support your pipeline logic, then you can simply patch the created +classes in your factory, much like with changing the default projections:: + + def get_full_name(self): + '''Return full name for user.''' + return '{0} {1}'.format(self['first_name'], self['last_name']).strip() + + class Factory(ftrack_api.entity.factory.StandardFactory): + '''Entity class factory.''' + + def create(self, schema, bases=None): + '''Create and return entity class from *schema*.''' + cls = super(Factory, self).create(schema, bases=bases) + + # Further customise cls before returning. + if schema['id'] == 'User': + cls.get_full_name = get_full_name + + return cls + +Now you have a new helper method *get_full_name* on your *User* entities:: + + >>> session = ftrack_api.Session() # New session to pick up changes. + >>> user = session.query('User').first() + >>> print user.get_full_name() + Martin Pengelly-Phillips + +If you'd rather not patch the existing classes, or perhaps have a lot of helpers +to mixin, you can instead inject your own class as the base class. The only +requirement is that it has the base :class:`~ftrack_api.entity.base.Entity` +class in its ancestor classes:: + + import ftrack_api.entity.base + + + class CustomUser(ftrack_api.entity.base.Entity): + '''Represent user.''' + + def get_full_name(self): + '''Return full name for user.''' + return '{0} {1}'.format(self['first_name'], self['last_name']).strip() + + + class Factory(ftrack_api.entity.factory.StandardFactory): + '''Entity class factory.''' + + def create(self, schema, bases=None): + '''Create and return entity class from *schema*.''' + # Alter base class for constructed class. + if bases is None: + bases = [ftrack_api.entity.base.Entity] + + if schema['id'] == 'User': + bases = [CustomUser] + + cls = super(Factory, self).create(schema, bases=bases) + return cls + +The resulting effect is the same:: + + >>> session = ftrack_api.Session() # New session to pick up changes. + >>> user = session.query('User').first() + >>> print user.get_full_name() + Martin Pengelly-Phillips + +.. note:: + + Your custom class is not the leaf class which will still be a dynamically + generated class. Instead your custom class becomes the base for the leaf + class:: + + >>> print type(user).__mro__ + (, , ...) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/pytest.ini b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/pytest.ini new file mode 100644 index 0000000000..b1f515ee18 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/pytest.ini @@ -0,0 +1,7 @@ +[pytest] +minversion = 2.4.2 +addopts = -v -k-slow --junitxml=test-reports/junit.xml --cache-clear +norecursedirs = .* _* +python_files = test_*.py +python_functions = test_* +mock_use_standalone_module = true \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/resource/plugin/configure_locations.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/resource/plugin/configure_locations.py new file mode 100644 index 0000000000..0682a5eeb0 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/resource/plugin/configure_locations.py @@ -0,0 +1,39 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import logging + +import ftrack_api +import ftrack_api.entity.location +import ftrack_api.accessor.disk + + +def configure_locations(event): + '''Configure locations for session.''' + session = event['data']['session'] + + # Find location(s) and customise instances. + # + # location = session.query('Location where name is "my.location"').one() + # ftrack_api.mixin(location, ftrack_api.entity.location.UnmanagedLocationMixin) + # location.accessor = ftrack_api.accessor.disk.DiskAccessor(prefix='') + + +def register(session): + '''Register plugin with *session*.''' + logger = logging.getLogger('ftrack_plugin:configure_locations.register') + + # Validate that session is an instance of ftrack_api.Session. If not, assume + # that register is being called from an old or incompatible API and return + # without doing anything. + if not isinstance(session, ftrack_api.Session): + logger.debug( + 'Not subscribing plugin as passed argument {0} is not an ' + 'ftrack_api.Session instance.'.format(session) + ) + return + + session.event_hub.subscribe( + 'topic=ftrack.api.session.configure-location', + configure_locations + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/resource/plugin/construct_entity_type.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/resource/plugin/construct_entity_type.py new file mode 100644 index 0000000000..45f7841670 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/resource/plugin/construct_entity_type.py @@ -0,0 +1,46 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import logging + +import ftrack_api.entity.factory + + +class Factory(ftrack_api.entity.factory.StandardFactory): + '''Entity class factory.''' + + def create(self, schema, bases=None): + '''Create and return entity class from *schema*.''' + # Optionally change bases for class to be generated. + cls = super(Factory, self).create(schema, bases=bases) + + # Further customise cls before returning. + + return cls + + +def register(session): + '''Register plugin with *session*.''' + logger = logging.getLogger('ftrack_plugin:construct_entity_type.register') + + # Validate that session is an instance of ftrack_api.Session. If not, assume + # that register is being called from an old or incompatible API and return + # without doing anything. + if not isinstance(session, ftrack_api.Session): + logger.debug( + 'Not subscribing plugin as passed argument {0!r} is not an ' + 'ftrack_api.Session instance.'.format(session) + ) + return + + factory = Factory() + + def construct_entity_type(event): + '''Return class to represent entity type specified by *event*.''' + schema = event['data']['schema'] + return factory.create(schema) + + session.event_hub.subscribe( + 'topic=ftrack.api.session.construct-entity-type', + construct_entity_type + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/setup.cfg b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/setup.cfg new file mode 100644 index 0000000000..b2ad8fd086 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/setup.cfg @@ -0,0 +1,6 @@ +[build_sphinx] +config-dir = doc +source-dir = doc +build-dir = build/doc +builder = html +all_files = 1 diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/setup.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/setup.py new file mode 100644 index 0000000000..da99a572b4 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/setup.py @@ -0,0 +1,81 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import os +import re + +from setuptools import setup, find_packages +from setuptools.command.test import test as TestCommand + + +ROOT_PATH = os.path.dirname(os.path.realpath(__file__)) +RESOURCE_PATH = os.path.join(ROOT_PATH, 'resource') +SOURCE_PATH = os.path.join(ROOT_PATH, 'source') +README_PATH = os.path.join(ROOT_PATH, 'README.rst') + + +# Read version from source. +with open( + os.path.join(SOURCE_PATH, 'ftrack_api', '_version.py') +) as _version_file: + VERSION = re.match( + r'.*__version__ = \'(.*?)\'', _version_file.read(), re.DOTALL + ).group(1) + + +# Custom commands. +class PyTest(TestCommand): + '''Pytest command.''' + + def finalize_options(self): + '''Finalize options to be used.''' + TestCommand.finalize_options(self) + self.test_args = [] + self.test_suite = True + + def run_tests(self): + '''Import pytest and run.''' + import pytest + raise SystemExit(pytest.main(self.test_args)) + + +# Call main setup. +setup( + name='ftrack-python-api', + version=VERSION, + description='Python API for ftrack.', + long_description=open(README_PATH).read(), + keywords='ftrack, python, api', + url='https://bitbucket.org/ftrack/ftrack-python-api', + author='ftrack', + author_email='support@ftrack.com', + license='Apache License (2.0)', + packages=find_packages(SOURCE_PATH), + package_dir={ + '': 'source' + }, + setup_requires=[ + 'sphinx >= 1.2.2, < 2', + 'sphinx_rtd_theme >= 0.1.6, < 1', + 'lowdown >= 0.1.0, < 2' + ], + install_requires=[ + 'requests >= 2, <3', + 'arrow >= 0.4.4, < 1', + 'termcolor >= 1.1.0, < 2', + 'pyparsing >= 2.0, < 3', + 'clique >= 1.2.0, < 2', + 'websocket-client >= 0.40.0, < 1' + ], + tests_require=[ + 'pytest >= 2.7, < 3', + 'pytest-mock >= 0.4, < 1', + 'pytest-catchlog >= 1, <=2' + ], + cmdclass={ + 'test': PyTest + }, + zip_safe=False, + python_requires=">=2.7.9, <3.0" + +) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/__init__.py new file mode 100644 index 0000000000..34833aa0dd --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/__init__.py @@ -0,0 +1 @@ +from ftrack_api import * diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/__init__.py new file mode 100644 index 0000000000..d8ee30bd8f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/__init__.py @@ -0,0 +1,32 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from ._version import __version__ +from .session import Session + + +def mixin(instance, mixin_class, name=None): + '''Mixin *mixin_class* to *instance*. + + *name* can be used to specify new class name. If not specified then one will + be generated. + + ''' + if name is None: + name = '{0}{1}'.format( + instance.__class__.__name__, mixin_class.__name__ + ) + + # Check mixin class not already present in mro in order to avoid consistent + # method resolution failure. + if mixin_class in instance.__class__.mro(): + return + + instance.__class__ = type( + name, + ( + mixin_class, + instance.__class__ + ), + {} + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_centralized_storage_scenario.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_centralized_storage_scenario.py new file mode 100644 index 0000000000..fbe14f3277 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_centralized_storage_scenario.py @@ -0,0 +1,656 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2016 ftrack + +from __future__ import absolute_import + +import logging +import json +import sys +import os + +import ftrack_api +import ftrack_api.structure.standard as _standard +from ftrack_api.logging import LazyLogMessage as L + + +scenario_name = 'ftrack.centralized-storage' + + +class ConfigureCentralizedStorageScenario(object): + '''Configure a centralized storage scenario.''' + + def __init__(self): + '''Instansiate centralized storage scenario.''' + self.logger = logging.getLogger( + __name__ + '.' + self.__class__.__name__ + ) + + @property + def storage_scenario(self): + '''Return storage scenario setting.''' + return self.session.query( + 'select value from Setting ' + 'where name is "storage_scenario" and group is "STORAGE"' + ).one() + + @property + def existing_centralized_storage_configuration(self): + '''Return existing centralized storage configuration.''' + storage_scenario = self.storage_scenario + + try: + configuration = json.loads(storage_scenario['value']) + except (ValueError, TypeError): + return None + + if not isinstance(configuration, dict): + return None + + if configuration.get('scenario') != scenario_name: + return None + + return configuration.get('data', {}) + + def _get_confirmation_text(self, configuration): + '''Return confirmation text from *configuration*.''' + configure_location = configuration.get('configure_location') + select_location = configuration.get('select_location') + select_mount_point = configuration.get('select_mount_point') + + if configure_location: + location_text = unicode( + 'A new location will be created:\n\n' + '* Label: {location_label}\n' + '* Name: {location_name}\n' + '* Description: {location_description}\n' + ).format(**configure_location) + else: + location = self.session.get( + 'Location', select_location['location_id'] + ) + location_text = ( + u'You have choosen to use an existing location: {0}'.format( + location['label'] + ) + ) + + mount_points_text = unicode( + '* Linux: {linux}\n' + '* OS X: {osx}\n' + '* Windows: {windows}\n\n' + ).format( + linux=select_mount_point.get('linux_mount_point') or '*Not set*', + osx=select_mount_point.get('osx_mount_point') or '*Not set*', + windows=select_mount_point.get('windows_mount_point') or '*Not set*' + ) + + mount_points_not_set = [] + + if not select_mount_point.get('linux_mount_point'): + mount_points_not_set.append('Linux') + + if not select_mount_point.get('osx_mount_point'): + mount_points_not_set.append('OS X') + + if not select_mount_point.get('windows_mount_point'): + mount_points_not_set.append('Windows') + + if mount_points_not_set: + mount_points_text += unicode( + 'Please be aware that this location will not be working on ' + '{missing} because the mount points are not set up.' + ).format( + missing=' and '.join(mount_points_not_set) + ) + + text = unicode( + '#Confirm storage setup#\n\n' + 'Almost there! Please take a moment to verify the settings you ' + 'are about to save. You can always come back later and update the ' + 'configuration.\n' + '##Location##\n\n' + '{location}\n' + '##Mount points##\n\n' + '{mount_points}' + ).format( + location=location_text, + mount_points=mount_points_text + ) + + return text + + def configure_scenario(self, event): + '''Configure scenario based on *event* and return form items.''' + steps = ( + 'select_scenario', + 'select_location', + 'configure_location', + 'select_structure', + 'select_mount_point', + 'confirm_summary', + 'save_configuration' + ) + + warning_message = '' + values = event['data'].get('values', {}) + + # Calculate previous step and the next. + previous_step = values.get('step', 'select_scenario') + next_step = steps[steps.index(previous_step) + 1] + state = 'configuring' + + self.logger.info(L( + u'Configuring scenario, previous step: {0}, next step: {1}. ' + u'Values {2!r}.', + previous_step, next_step, values + )) + + if 'configuration' in values: + configuration = values.pop('configuration') + else: + configuration = {} + + if values: + # Update configuration with values from the previous step. + configuration[previous_step] = values + + if previous_step == 'select_location': + values = configuration['select_location'] + if values.get('location_id') != 'create_new_location': + location_exists = self.session.query( + 'Location where id is "{0}"'.format( + values.get('location_id') + ) + ).first() + if not location_exists: + next_step = 'select_location' + warning_message = ( + '**The selected location does not exist. Please choose ' + 'one from the dropdown or create a new one.**' + ) + + if next_step == 'select_location': + try: + location_id = ( + self.existing_centralized_storage_configuration['location_id'] + ) + except (KeyError, TypeError): + location_id = None + + options = [{ + 'label': 'Create new location', + 'value': 'create_new_location' + }] + for location in self.session.query( + 'select name, label, description from Location' + ): + if location['name'] not in ( + 'ftrack.origin', 'ftrack.unmanaged', 'ftrack.connect', + 'ftrack.server', 'ftrack.review' + ): + options.append({ + 'label': u'{label} ({name})'.format( + label=location['label'], name=location['name'] + ), + 'description': location['description'], + 'value': location['id'] + }) + + warning = '' + if location_id is not None: + # If there is already a location configured we must make the + # user aware that changing the location may be problematic. + warning = ( + '\n\n**Be careful if you switch to another location ' + 'for an existing storage scenario. Components that have ' + 'already been published to the previous location will be ' + 'made unavailable for common use.**' + ) + default_value = location_id + elif location_id is None and len(options) == 1: + # No location configured and no existing locations to use. + default_value = 'create_new_location' + else: + # There are existing locations to choose from but non of them + # are currently active in the centralized storage scenario. + default_value = None + + items = [{ + 'type': 'label', + 'value': ( + '#Select location#\n' + 'Choose an already existing location or create a new one ' + 'to represent your centralized storage. {0}'.format( + warning + ) + ) + }, { + 'type': 'enumerator', + 'label': 'Location', + 'name': 'location_id', + 'value': default_value, + 'data': options + }] + + default_location_name = 'studio.central-storage-location' + default_location_label = 'Studio location' + default_location_description = ( + 'The studio central location where all components are ' + 'stored.' + ) + + if previous_step == 'configure_location': + configure_location = configuration.get( + 'configure_location' + ) + + if configure_location: + try: + existing_location = self.session.query( + u'Location where name is "{0}"'.format( + configure_location.get('location_name') + ) + ).first() + except UnicodeEncodeError: + next_step = 'configure_location' + warning_message += ( + '**The location name contains non-ascii characters. ' + 'Please change the name and try again.**' + ) + values = configuration['select_location'] + else: + if existing_location: + next_step = 'configure_location' + warning_message += ( + u'**There is already a location named {0}. ' + u'Please change the name and try again.**'.format( + configure_location.get('location_name') + ) + ) + values = configuration['select_location'] + + if ( + not configure_location.get('location_name') or + not configure_location.get('location_label') or + not configure_location.get('location_description') + ): + next_step = 'configure_location' + warning_message += ( + '**Location name, label and description cannot ' + 'be empty.**' + ) + values = configuration['select_location'] + + if next_step == 'configure_location': + # Populate form with previous configuration. + default_location_label = configure_location['location_label'] + default_location_name = configure_location['location_name'] + default_location_description = ( + configure_location['location_description'] + ) + + if next_step == 'configure_location': + + if values.get('location_id') == 'create_new_location': + # Add options to create a new location. + items = [{ + 'type': 'label', + 'value': ( + '#Create location#\n' + 'Here you will create a new location to be used ' + 'with your new Storage scenario. For your ' + 'convenience we have already filled in some default ' + 'values. If this is the first time you are configuring ' + 'a storage scenario in ftrack we recommend that you ' + 'stick with these settings.' + ) + }, { + 'label': 'Label', + 'name': 'location_label', + 'value': default_location_label, + 'type': 'text' + }, { + 'label': 'Name', + 'name': 'location_name', + 'value': default_location_name, + 'type': 'text' + }, { + 'label': 'Description', + 'name': 'location_description', + 'value': default_location_description, + 'type': 'text' + }] + + else: + # The user selected an existing location. Move on to next + # step. + next_step = 'select_mount_point' + + if next_step == 'select_structure': + # There is only one structure to choose from, go to next step. + next_step = 'select_mount_point' + # items = [ + # { + # 'type': 'label', + # 'value': ( + # '#Select structure#\n' + # 'Select which structure to use with your location. ' + # 'The structure is used to generate the filesystem ' + # 'path for components that are added to this location.' + # ) + # }, + # { + # 'type': 'enumerator', + # 'label': 'Structure', + # 'name': 'structure_id', + # 'value': 'standard', + # 'data': [{ + # 'label': 'Standard', + # 'value': 'standard', + # 'description': ( + # 'The Standard structure uses the names in your ' + # 'project structure to determine the path.' + # ) + # }] + # } + # ] + + if next_step == 'select_mount_point': + try: + mount_points = ( + self.existing_centralized_storage_configuration['accessor']['mount_points'] + ) + except (KeyError, TypeError): + mount_points = dict() + + items = [ + { + 'value': ( + '#Mount points#\n' + 'Set mount points for your centralized storage ' + 'location. For the location to work as expected each ' + 'platform that you intend to use must have the ' + 'corresponding mount point set and the storage must ' + 'be accessible. If not set correctly files will not be ' + 'saved or read.' + ), + 'type': 'label' + }, { + 'type': 'text', + 'label': 'Linux', + 'name': 'linux_mount_point', + 'empty_text': 'E.g. /usr/mnt/MyStorage ...', + 'value': mount_points.get('linux', '') + }, { + 'type': 'text', + 'label': 'OS X', + 'name': 'osx_mount_point', + 'empty_text': 'E.g. /Volumes/MyStorage ...', + 'value': mount_points.get('osx', '') + }, { + 'type': 'text', + 'label': 'Windows', + 'name': 'windows_mount_point', + 'empty_text': 'E.g. \\\\MyStorage ...', + 'value': mount_points.get('windows', '') + } + ] + + if next_step == 'confirm_summary': + items = [{ + 'type': 'label', + 'value': self._get_confirmation_text(configuration) + }] + state = 'confirm' + + if next_step == 'save_configuration': + mount_points = configuration['select_mount_point'] + select_location = configuration['select_location'] + + if select_location['location_id'] == 'create_new_location': + configure_location = configuration['configure_location'] + location = self.session.create( + 'Location', + { + 'name': configure_location['location_name'], + 'label': configure_location['location_label'], + 'description': ( + configure_location['location_description'] + ) + } + ) + + else: + location = self.session.query( + 'Location where id is "{0}"'.format( + select_location['location_id'] + ) + ).one() + + setting_value = json.dumps({ + 'scenario': scenario_name, + 'data': { + 'location_id': location['id'], + 'location_name': location['name'], + 'accessor': { + 'mount_points': { + 'linux': mount_points['linux_mount_point'], + 'osx': mount_points['osx_mount_point'], + 'windows': mount_points['windows_mount_point'] + } + } + } + }) + + self.storage_scenario['value'] = setting_value + self.session.commit() + + # Broadcast an event that storage scenario has been configured. + event = ftrack_api.event.base.Event( + topic='ftrack.storage-scenario.configure-done' + ) + self.session.event_hub.publish(event) + + items = [{ + 'type': 'label', + 'value': ( + '#Done!#\n' + 'Your storage scenario is now configured and ready ' + 'to use. **Note that you may have to restart Connect and ' + 'other applications to start using it.**' + ) + }] + state = 'done' + + if warning_message: + items.insert(0, { + 'type': 'label', + 'value': warning_message + }) + + items.append({ + 'type': 'hidden', + 'value': configuration, + 'name': 'configuration' + }) + items.append({ + 'type': 'hidden', + 'value': next_step, + 'name': 'step' + }) + + return { + 'items': items, + 'state': state + } + + def discover_centralized_scenario(self, event): + '''Return action discover dictionary for *event*.''' + return { + 'id': scenario_name, + 'name': 'Centralized storage scenario', + 'description': ( + '(Recommended) centralized storage scenario where all files ' + 'are kept on a storage that is mounted and available to ' + 'everyone in the studio.' + ) + } + + def register(self, session): + '''Subscribe to events on *session*.''' + self.session = session + + #: TODO: Move these to a separate function. + session.event_hub.subscribe( + unicode( + 'topic=ftrack.storage-scenario.discover ' + 'and source.user.username="{0}"' + ).format( + session.api_user + ), + self.discover_centralized_scenario + ) + session.event_hub.subscribe( + unicode( + 'topic=ftrack.storage-scenario.configure ' + 'and data.scenario_id="{0}" ' + 'and source.user.username="{1}"' + ).format( + scenario_name, + session.api_user + ), + self.configure_scenario + ) + + +class ActivateCentralizedStorageScenario(object): + '''Activate a centralized storage scenario.''' + + def __init__(self): + '''Instansiate centralized storage scenario.''' + self.logger = logging.getLogger( + __name__ + '.' + self.__class__.__name__ + ) + + def activate(self, event): + '''Activate scenario in *event*.''' + storage_scenario = event['data']['storage_scenario'] + + try: + location_data = storage_scenario['data'] + location_name = location_data['location_name'] + location_id = location_data['location_id'] + mount_points = location_data['accessor']['mount_points'] + + except KeyError: + error_message = ( + 'Unable to read storage scenario data.' + ) + self.logger.error(L(error_message)) + raise ftrack_api.exception.LocationError( + 'Unable to configure location based on scenario.' + ) + + else: + location = self.session.create( + 'Location', + data=dict( + name=location_name, + id=location_id + ), + reconstructing=True + ) + + if sys.platform == 'darwin': + prefix = mount_points['osx'] + elif sys.platform == 'linux2': + prefix = mount_points['linux'] + elif sys.platform == 'win32': + prefix = mount_points['windows'] + else: + raise ftrack_api.exception.LocationError( + ( + 'Unable to find accessor prefix for platform {0}.' + ).format(sys.platform) + ) + + location.accessor = ftrack_api.accessor.disk.DiskAccessor( + prefix=prefix + ) + location.structure = _standard.StandardStructure() + location.priority = 1 + self.logger.info(L( + u'Storage scenario activated. Configured {0!r} from ' + u'{1!r}', + location, storage_scenario + )) + + def _verify_startup(self, event): + '''Verify the storage scenario configuration.''' + storage_scenario = event['data']['storage_scenario'] + location_data = storage_scenario['data'] + mount_points = location_data['accessor']['mount_points'] + + prefix = None + if sys.platform == 'darwin': + prefix = mount_points['osx'] + elif sys.platform == 'linux2': + prefix = mount_points['linux'] + elif sys.platform == 'win32': + prefix = mount_points['windows'] + + if not prefix: + return ( + u'The storage scenario has not been configured for your ' + u'operating system. ftrack may not be able to ' + u'store and track files correctly.' + ) + + if not os.path.isdir(prefix): + return ( + unicode( + 'The path {0} does not exist. ftrack may not be able to ' + 'store and track files correctly. \n\nIf the storage is ' + 'newly setup you may want to create necessary folder ' + 'structures. If the storage is a network drive you should ' + 'make sure that it is mounted correctly.' + ).format(prefix) + ) + + def register(self, session): + '''Subscribe to events on *session*.''' + self.session = session + + session.event_hub.subscribe( + ( + 'topic=ftrack.storage-scenario.activate ' + 'and data.storage_scenario.scenario="{0}"'.format( + scenario_name + ) + ), + self.activate + ) + + # Listen to verify startup event from ftrack connect to allow responding + # with a message if something is not working correctly with this + # scenario that the user should be notified about. + self.session.event_hub.subscribe( + ( + 'topic=ftrack.connect.verify-startup ' + 'and data.storage_scenario.scenario="{0}"'.format( + scenario_name + ) + ), + self._verify_startup + ) + +def register(session): + '''Register storage scenario.''' + scenario = ActivateCentralizedStorageScenario() + scenario.register(session) + + +def register_configuration(session): + '''Register storage scenario.''' + scenario = ConfigureCentralizedStorageScenario() + scenario.register(session) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_python_ntpath.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_python_ntpath.py new file mode 100644 index 0000000000..9f79a1850c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_python_ntpath.py @@ -0,0 +1,534 @@ +# pragma: no cover +# Module 'ntpath' -- common operations on WinNT/Win95 pathnames +"""Common pathname manipulations, WindowsNT/95 version. + +Instead of importing this module directly, import os and refer to this +module as os.path. +""" + +import os +import sys +import stat +import genericpath +import warnings + +from genericpath import * + +__all__ = ["normcase","isabs","join","splitdrive","split","splitext", + "basename","dirname","commonprefix","getsize","getmtime", + "getatime","getctime", "islink","exists","lexists","isdir","isfile", + "ismount","walk","expanduser","expandvars","normpath","abspath", + "splitunc","curdir","pardir","sep","pathsep","defpath","altsep", + "extsep","devnull","realpath","supports_unicode_filenames","relpath"] + +# strings representing various path-related bits and pieces +curdir = '.' +pardir = '..' +extsep = '.' +sep = '\\' +pathsep = ';' +altsep = '/' +defpath = '.;C:\\bin' +if 'ce' in sys.builtin_module_names: + defpath = '\\Windows' +elif 'os2' in sys.builtin_module_names: + # OS/2 w/ VACPP + altsep = '/' +devnull = 'nul' + +# Normalize the case of a pathname and map slashes to backslashes. +# Other normalizations (such as optimizing '../' away) are not done +# (this is done by normpath). + +def normcase(s): + """Normalize case of pathname. + + Makes all characters lowercase and all slashes into backslashes.""" + return s.replace("/", "\\").lower() + + +# Return whether a path is absolute. +# Trivial in Posix, harder on the Mac or MS-DOS. +# For DOS it is absolute if it starts with a slash or backslash (current +# volume), or if a pathname after the volume letter and colon / UNC resource +# starts with a slash or backslash. + +def isabs(s): + """Test whether a path is absolute""" + s = splitdrive(s)[1] + return s != '' and s[:1] in '/\\' + + +# Join two (or more) paths. + +def join(a, *p): + """Join two or more pathname components, inserting "\\" as needed. + If any component is an absolute path, all previous path components + will be discarded.""" + path = a + for b in p: + b_wins = 0 # set to 1 iff b makes path irrelevant + if path == "": + b_wins = 1 + + elif isabs(b): + # This probably wipes out path so far. However, it's more + # complicated if path begins with a drive letter: + # 1. join('c:', '/a') == 'c:/a' + # 2. join('c:/', '/a') == 'c:/a' + # But + # 3. join('c:/a', '/b') == '/b' + # 4. join('c:', 'd:/') = 'd:/' + # 5. join('c:/', 'd:/') = 'd:/' + if path[1:2] != ":" or b[1:2] == ":": + # Path doesn't start with a drive letter, or cases 4 and 5. + b_wins = 1 + + # Else path has a drive letter, and b doesn't but is absolute. + elif len(path) > 3 or (len(path) == 3 and + path[-1] not in "/\\"): + # case 3 + b_wins = 1 + + if b_wins: + path = b + else: + # Join, and ensure there's a separator. + assert len(path) > 0 + if path[-1] in "/\\": + if b and b[0] in "/\\": + path += b[1:] + else: + path += b + elif path[-1] == ":": + path += b + elif b: + if b[0] in "/\\": + path += b + else: + path += "\\" + b + else: + # path is not empty and does not end with a backslash, + # but b is empty; since, e.g., split('a/') produces + # ('a', ''), it's best if join() adds a backslash in + # this case. + path += '\\' + + return path + + +# Split a path in a drive specification (a drive letter followed by a +# colon) and the path specification. +# It is always true that drivespec + pathspec == p +def splitdrive(p): + """Split a pathname into drive and path specifiers. Returns a 2-tuple +"(drive,path)"; either part may be empty""" + if p[1:2] == ':': + return p[0:2], p[2:] + return '', p + + +# Parse UNC paths +def splitunc(p): + """Split a pathname into UNC mount point and relative path specifiers. + + Return a 2-tuple (unc, rest); either part may be empty. + If unc is not empty, it has the form '//host/mount' (or similar + using backslashes). unc+rest is always the input path. + Paths containing drive letters never have an UNC part. + """ + if p[1:2] == ':': + return '', p # Drive letter present + firstTwo = p[0:2] + if firstTwo == '//' or firstTwo == '\\\\': + # is a UNC path: + # vvvvvvvvvvvvvvvvvvvv equivalent to drive letter + # \\machine\mountpoint\directories... + # directory ^^^^^^^^^^^^^^^ + normp = normcase(p) + index = normp.find('\\', 2) + if index == -1: + ##raise RuntimeError, 'illegal UNC path: "' + p + '"' + return ("", p) + index = normp.find('\\', index + 1) + if index == -1: + index = len(p) + return p[:index], p[index:] + return '', p + + +# Split a path in head (everything up to the last '/') and tail (the +# rest). After the trailing '/' is stripped, the invariant +# join(head, tail) == p holds. +# The resulting head won't end in '/' unless it is the root. + +def split(p): + """Split a pathname. + + Return tuple (head, tail) where tail is everything after the final slash. + Either part may be empty.""" + + d, p = splitdrive(p) + # set i to index beyond p's last slash + i = len(p) + while i and p[i-1] not in '/\\': + i = i - 1 + head, tail = p[:i], p[i:] # now tail has no slashes + # remove trailing slashes from head, unless it's all slashes + head2 = head + while head2 and head2[-1] in '/\\': + head2 = head2[:-1] + head = head2 or head + return d + head, tail + + +# Split a path in root and extension. +# The extension is everything starting at the last dot in the last +# pathname component; the root is everything before that. +# It is always true that root + ext == p. + +def splitext(p): + return genericpath._splitext(p, sep, altsep, extsep) +splitext.__doc__ = genericpath._splitext.__doc__ + + +# Return the tail (basename) part of a path. + +def basename(p): + """Returns the final component of a pathname""" + return split(p)[1] + + +# Return the head (dirname) part of a path. + +def dirname(p): + """Returns the directory component of a pathname""" + return split(p)[0] + +# Is a path a symbolic link? +# This will always return false on systems where posix.lstat doesn't exist. + +def islink(path): + """Test for symbolic link. + On WindowsNT/95 and OS/2 always returns false + """ + return False + +# alias exists to lexists +lexists = exists + +# Is a path a mount point? Either a root (with or without drive letter) +# or an UNC path with at most a / or \ after the mount point. + +def ismount(path): + """Test whether a path is a mount point (defined as root of drive)""" + unc, rest = splitunc(path) + if unc: + return rest in ("", "/", "\\") + p = splitdrive(path)[1] + return len(p) == 1 and p[0] in '/\\' + + +# Directory tree walk. +# For each directory under top (including top itself, but excluding +# '.' and '..'), func(arg, dirname, filenames) is called, where +# dirname is the name of the directory and filenames is the list +# of files (and subdirectories etc.) in the directory. +# The func may modify the filenames list, to implement a filter, +# or to impose a different order of visiting. + +def walk(top, func, arg): + """Directory tree walk with callback function. + + For each directory in the directory tree rooted at top (including top + itself, but excluding '.' and '..'), call func(arg, dirname, fnames). + dirname is the name of the directory, and fnames a list of the names of + the files and subdirectories in dirname (excluding '.' and '..'). func + may modify the fnames list in-place (e.g. via del or slice assignment), + and walk will only recurse into the subdirectories whose names remain in + fnames; this can be used to implement a filter, or to impose a specific + order of visiting. No semantics are defined for, or required of, arg, + beyond that arg is always passed to func. It can be used, e.g., to pass + a filename pattern, or a mutable object designed to accumulate + statistics. Passing None for arg is common.""" + warnings.warnpy3k("In 3.x, os.path.walk is removed in favor of os.walk.", + stacklevel=2) + try: + names = os.listdir(top) + except os.error: + return + func(arg, top, names) + for name in names: + name = join(top, name) + if isdir(name): + walk(name, func, arg) + + +# Expand paths beginning with '~' or '~user'. +# '~' means $HOME; '~user' means that user's home directory. +# If the path doesn't begin with '~', or if the user or $HOME is unknown, +# the path is returned unchanged (leaving error reporting to whatever +# function is called with the expanded path as argument). +# See also module 'glob' for expansion of *, ? and [...] in pathnames. +# (A function should also be defined to do full *sh-style environment +# variable expansion.) + +def expanduser(path): + """Expand ~ and ~user constructs. + + If user or $HOME is unknown, do nothing.""" + if path[:1] != '~': + return path + i, n = 1, len(path) + while i < n and path[i] not in '/\\': + i = i + 1 + + if 'HOME' in os.environ: + userhome = os.environ['HOME'] + elif 'USERPROFILE' in os.environ: + userhome = os.environ['USERPROFILE'] + elif not 'HOMEPATH' in os.environ: + return path + else: + try: + drive = os.environ['HOMEDRIVE'] + except KeyError: + drive = '' + userhome = join(drive, os.environ['HOMEPATH']) + + if i != 1: #~user + userhome = join(dirname(userhome), path[1:i]) + + return userhome + path[i:] + + +# Expand paths containing shell variable substitutions. +# The following rules apply: +# - no expansion within single quotes +# - '$$' is translated into '$' +# - '%%' is translated into '%' if '%%' are not seen in %var1%%var2% +# - ${varname} is accepted. +# - $varname is accepted. +# - %varname% is accepted. +# - varnames can be made out of letters, digits and the characters '_-' +# (though is not verified in the ${varname} and %varname% cases) +# XXX With COMMAND.COM you can use any characters in a variable name, +# XXX except '^|<>='. + +def expandvars(path): + """Expand shell variables of the forms $var, ${var} and %var%. + + Unknown variables are left unchanged.""" + if '$' not in path and '%' not in path: + return path + import string + varchars = string.ascii_letters + string.digits + '_-' + res = '' + index = 0 + pathlen = len(path) + while index < pathlen: + c = path[index] + if c == '\'': # no expansion within single quotes + path = path[index + 1:] + pathlen = len(path) + try: + index = path.index('\'') + res = res + '\'' + path[:index + 1] + except ValueError: + res = res + path + index = pathlen - 1 + elif c == '%': # variable or '%' + if path[index + 1:index + 2] == '%': + res = res + c + index = index + 1 + else: + path = path[index+1:] + pathlen = len(path) + try: + index = path.index('%') + except ValueError: + res = res + '%' + path + index = pathlen - 1 + else: + var = path[:index] + if var in os.environ: + res = res + os.environ[var] + else: + res = res + '%' + var + '%' + elif c == '$': # variable or '$$' + if path[index + 1:index + 2] == '$': + res = res + c + index = index + 1 + elif path[index + 1:index + 2] == '{': + path = path[index+2:] + pathlen = len(path) + try: + index = path.index('}') + var = path[:index] + if var in os.environ: + res = res + os.environ[var] + else: + res = res + '${' + var + '}' + except ValueError: + res = res + '${' + path + index = pathlen - 1 + else: + var = '' + index = index + 1 + c = path[index:index + 1] + while c != '' and c in varchars: + var = var + c + index = index + 1 + c = path[index:index + 1] + if var in os.environ: + res = res + os.environ[var] + else: + res = res + '$' + var + if c != '': + index = index - 1 + else: + res = res + c + index = index + 1 + return res + + +# Normalize a path, e.g. A//B, A/./B and A/foo/../B all become A\B. +# Previously, this function also truncated pathnames to 8+3 format, +# but as this module is called "ntpath", that's obviously wrong! + +def normpath(path): + """Normalize path, eliminating double slashes, etc.""" + # Preserve unicode (if path is unicode) + backslash, dot = (u'\\', u'.') if isinstance(path, unicode) else ('\\', '.') + if path.startswith(('\\\\.\\', '\\\\?\\')): + # in the case of paths with these prefixes: + # \\.\ -> device names + # \\?\ -> literal paths + # do not do any normalization, but return the path unchanged + return path + path = path.replace("/", "\\") + prefix, path = splitdrive(path) + # We need to be careful here. If the prefix is empty, and the path starts + # with a backslash, it could either be an absolute path on the current + # drive (\dir1\dir2\file) or a UNC filename (\\server\mount\dir1\file). It + # is therefore imperative NOT to collapse multiple backslashes blindly in + # that case. + # The code below preserves multiple backslashes when there is no drive + # letter. This means that the invalid filename \\\a\b is preserved + # unchanged, where a\\\b is normalised to a\b. It's not clear that there + # is any better behaviour for such edge cases. + if prefix == '': + # No drive letter - preserve initial backslashes + while path[:1] == "\\": + prefix = prefix + backslash + path = path[1:] + else: + # We have a drive letter - collapse initial backslashes + if path.startswith("\\"): + prefix = prefix + backslash + path = path.lstrip("\\") + comps = path.split("\\") + i = 0 + while i < len(comps): + if comps[i] in ('.', ''): + del comps[i] + elif comps[i] == '..': + if i > 0 and comps[i-1] != '..': + del comps[i-1:i+1] + i -= 1 + elif i == 0 and prefix.endswith("\\"): + del comps[i] + else: + i += 1 + else: + i += 1 + # If the path is now empty, substitute '.' + if not prefix and not comps: + comps.append(dot) + return prefix + backslash.join(comps) + + +# Return an absolute path. +try: + from nt import _getfullpathname + +except ImportError: # not running on Windows - mock up something sensible + def abspath(path): + """Return the absolute version of a path.""" + if not isabs(path): + if isinstance(path, unicode): + cwd = os.getcwdu() + else: + cwd = os.getcwd() + path = join(cwd, path) + return normpath(path) + +else: # use native Windows method on Windows + def abspath(path): + """Return the absolute version of a path.""" + + if path: # Empty path must return current working directory. + try: + path = _getfullpathname(path) + except WindowsError: + pass # Bad path - return unchanged. + elif isinstance(path, unicode): + path = os.getcwdu() + else: + path = os.getcwd() + return normpath(path) + +# realpath is a no-op on systems without islink support +realpath = abspath +# Win9x family and earlier have no Unicode filename support. +supports_unicode_filenames = (hasattr(sys, "getwindowsversion") and + sys.getwindowsversion()[3] >= 2) + +def _abspath_split(path): + abs = abspath(normpath(path)) + prefix, rest = splitunc(abs) + is_unc = bool(prefix) + if not is_unc: + prefix, rest = splitdrive(abs) + return is_unc, prefix, [x for x in rest.split(sep) if x] + +def relpath(path, start=curdir): + """Return a relative version of a path""" + + if not path: + raise ValueError("no path specified") + + start_is_unc, start_prefix, start_list = _abspath_split(start) + path_is_unc, path_prefix, path_list = _abspath_split(path) + + if path_is_unc ^ start_is_unc: + raise ValueError("Cannot mix UNC and non-UNC paths (%s and %s)" + % (path, start)) + if path_prefix.lower() != start_prefix.lower(): + if path_is_unc: + raise ValueError("path is on UNC root %s, start on UNC root %s" + % (path_prefix, start_prefix)) + else: + raise ValueError("path is on drive %s, start on drive %s" + % (path_prefix, start_prefix)) + # Work out how much of the filepath is shared by start and path. + i = 0 + for e1, e2 in zip(start_list, path_list): + if e1.lower() != e2.lower(): + break + i += 1 + + rel_list = [pardir] * (len(start_list)-i) + path_list[i:] + if not rel_list: + return curdir + return join(*rel_list) + +try: + # The genericpath.isdir implementation uses os.stat and checks the mode + # attribute to tell whether or not the path is a directory. + # This is overkill on Windows - just pass the path to GetFileAttributes + # and check the attribute from there. + from nt import _isdir as isdir +except ImportError: + # Use genericpath.isdir as imported above. + pass diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_version.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_version.py new file mode 100644 index 0000000000..aa1a8c4aba --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_version.py @@ -0,0 +1 @@ +__version__ = '1.8.2' diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_weakref.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_weakref.py new file mode 100644 index 0000000000..69cc6f4b4f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/_weakref.py @@ -0,0 +1,66 @@ +""" +Yet another backport of WeakMethod for Python 2.7. +Changes include removing exception chaining and adding args to super() calls. + +Copyright (c) 2001-2019 Python Software Foundation.All rights reserved. + +Full license available in LICENSE.python. +""" +from weakref import ref + + +class WeakMethod(ref): + """ + A custom `weakref.ref` subclass which simulates a weak reference to + a bound method, working around the lifetime problem of bound methods. + """ + + __slots__ = "_func_ref", "_meth_type", "_alive", "__weakref__" + + def __new__(cls, meth, callback=None): + try: + obj = meth.__self__ + func = meth.__func__ + except AttributeError: + raise TypeError( + "argument should be a bound method, not {}".format(type(meth)) + ) + + def _cb(arg): + # The self-weakref trick is needed to avoid creating a reference + # cycle. + self = self_wr() + if self._alive: + self._alive = False + if callback is not None: + callback(self) + + self = ref.__new__(cls, obj, _cb) + self._func_ref = ref(func, _cb) + self._meth_type = type(meth) + self._alive = True + self_wr = ref(self) + return self + + def __call__(self): + obj = super(WeakMethod, self).__call__() + func = self._func_ref() + if obj is None or func is None: + return None + return self._meth_type(func, obj) + + def __eq__(self, other): + if isinstance(other, WeakMethod): + if not self._alive or not other._alive: + return self is other + return ref.__eq__(self, other) and self._func_ref == other._func_ref + return NotImplemented + + def __ne__(self, other): + if isinstance(other, WeakMethod): + if not self._alive or not other._alive: + return self is not other + return ref.__ne__(self, other) or self._func_ref != other._func_ref + return NotImplemented + + __hash__ = ref.__hash__ diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/__init__.py new file mode 100644 index 0000000000..1aab07ed77 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/base.py new file mode 100644 index 0000000000..6aa9cf0281 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/base.py @@ -0,0 +1,124 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2013 ftrack + +import abc + +import ftrack_api.exception + + +class Accessor(object): + '''Provide data access to a location. + + A location represents a specific storage, but access to that storage may + vary. For example, both local filesystem and FTP access may be possible for + the same storage. An accessor implements these different ways of accessing + the same data location. + + As different accessors may access the same location, only part of a data + path that is commonly understood may be stored in the database. The format + of this path should be a contract between the accessors that require access + to the same location and is left as an implementation detail. As such, this + system provides no guarantee that two different accessors can provide access + to the same location, though this is a clear goal. The path stored centrally + is referred to as the **resource identifier** and should be used when + calling any of the accessor methods that accept a *resource_identifier* + argument. + + ''' + + __metaclass__ = abc.ABCMeta + + def __init__(self): + '''Initialise location accessor.''' + super(Accessor, self).__init__() + + @abc.abstractmethod + def list(self, resource_identifier): + '''Return list of entries in *resource_identifier* container. + + Each entry in the returned list should be a valid resource identifier. + + Raise :exc:`~ftrack_api.exception.AccessorResourceNotFoundError` if + *resource_identifier* does not exist or + :exc:`~ftrack_api.exception.AccessorResourceInvalidError` if + *resource_identifier* is not a container. + + ''' + + @abc.abstractmethod + def exists(self, resource_identifier): + '''Return if *resource_identifier* is valid and exists in location.''' + + @abc.abstractmethod + def is_file(self, resource_identifier): + '''Return whether *resource_identifier* refers to a file.''' + + @abc.abstractmethod + def is_container(self, resource_identifier): + '''Return whether *resource_identifier* refers to a container.''' + + @abc.abstractmethod + def is_sequence(self, resource_identifier): + '''Return whether *resource_identifier* refers to a file sequence.''' + + @abc.abstractmethod + def open(self, resource_identifier, mode='rb'): + '''Return :class:`~ftrack_api.data.Data` for *resource_identifier*.''' + + @abc.abstractmethod + def remove(self, resource_identifier): + '''Remove *resource_identifier*. + + Raise :exc:`~ftrack_api.exception.AccessorResourceNotFoundError` if + *resource_identifier* does not exist. + + ''' + + @abc.abstractmethod + def make_container(self, resource_identifier, recursive=True): + '''Make a container at *resource_identifier*. + + If *recursive* is True, also make any intermediate containers. + + Should silently ignore existing containers and not recreate them. + + ''' + + @abc.abstractmethod + def get_container(self, resource_identifier): + '''Return resource_identifier of container for *resource_identifier*. + + Raise :exc:`~ftrack_api.exception.AccessorParentResourceNotFoundError` + if container of *resource_identifier* could not be determined. + + ''' + + def remove_container(self, resource_identifier): # pragma: no cover + '''Remove container at *resource_identifier*.''' + return self.remove(resource_identifier) + + def get_filesystem_path(self, resource_identifier): # pragma: no cover + '''Return filesystem path for *resource_identifier*. + + Raise :exc:`~ftrack_api.exception.AccessorFilesystemPathError` if + filesystem path could not be determined from *resource_identifier* or + :exc:`~ftrack_api.exception.AccessorUnsupportedOperationError` if + retrieving filesystem paths is not supported by this accessor. + + ''' + raise ftrack_api.exception.AccessorUnsupportedOperationError( + 'get_filesystem_path', resource_identifier=resource_identifier + ) + + def get_url(self, resource_identifier): + '''Return URL for *resource_identifier*. + + Raise :exc:`~ftrack_api.exception.AccessorFilesystemPathError` if + URL could not be determined from *resource_identifier* or + :exc:`~ftrack_api.exception.AccessorUnsupportedOperationError` if + retrieving URL is not supported by this accessor. + + ''' + raise ftrack_api.exception.AccessorUnsupportedOperationError( + 'get_url', resource_identifier=resource_identifier + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/disk.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/disk.py new file mode 100644 index 0000000000..65769603f6 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/disk.py @@ -0,0 +1,250 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2013 ftrack + +import os +import sys +import errno +import contextlib + +import ftrack_api._python_ntpath as ntpath +import ftrack_api.accessor.base +import ftrack_api.data +from ftrack_api.exception import ( + AccessorFilesystemPathError, + AccessorUnsupportedOperationError, + AccessorResourceNotFoundError, + AccessorOperationFailedError, + AccessorPermissionDeniedError, + AccessorResourceInvalidError, + AccessorContainerNotEmptyError, + AccessorParentResourceNotFoundError +) + + +class DiskAccessor(ftrack_api.accessor.base.Accessor): + '''Provide disk access to a location. + + Expect resource identifiers to refer to relative filesystem paths. + + ''' + + def __init__(self, prefix, **kw): + '''Initialise location accessor. + + *prefix* specifies the base folder for the disk based structure and + will be prepended to any path. It should be specified in the syntax of + the current OS. + + ''' + if prefix: + prefix = os.path.expanduser(os.path.expandvars(prefix)) + prefix = os.path.abspath(prefix) + self.prefix = prefix + + super(DiskAccessor, self).__init__(**kw) + + def list(self, resource_identifier): + '''Return list of entries in *resource_identifier* container. + + Each entry in the returned list should be a valid resource identifier. + + Raise :exc:`~ftrack_api.exception.AccessorResourceNotFoundError` if + *resource_identifier* does not exist or + :exc:`~ftrack_api.exception.AccessorResourceInvalidError` if + *resource_identifier* is not a container. + + ''' + filesystem_path = self.get_filesystem_path(resource_identifier) + + with error_handler( + operation='list', resource_identifier=resource_identifier + ): + listing = [] + for entry in os.listdir(filesystem_path): + listing.append(os.path.join(resource_identifier, entry)) + + return listing + + def exists(self, resource_identifier): + '''Return if *resource_identifier* is valid and exists in location.''' + filesystem_path = self.get_filesystem_path(resource_identifier) + return os.path.exists(filesystem_path) + + def is_file(self, resource_identifier): + '''Return whether *resource_identifier* refers to a file.''' + filesystem_path = self.get_filesystem_path(resource_identifier) + return os.path.isfile(filesystem_path) + + def is_container(self, resource_identifier): + '''Return whether *resource_identifier* refers to a container.''' + filesystem_path = self.get_filesystem_path(resource_identifier) + return os.path.isdir(filesystem_path) + + def is_sequence(self, resource_identifier): + '''Return whether *resource_identifier* refers to a file sequence.''' + raise AccessorUnsupportedOperationError(operation='is_sequence') + + def open(self, resource_identifier, mode='rb'): + '''Return :class:`~ftrack_api.Data` for *resource_identifier*.''' + filesystem_path = self.get_filesystem_path(resource_identifier) + + with error_handler( + operation='open', resource_identifier=resource_identifier + ): + data = ftrack_api.data.File(filesystem_path, mode) + + return data + + def remove(self, resource_identifier): + '''Remove *resource_identifier*. + + Raise :exc:`~ftrack_api.exception.AccessorResourceNotFoundError` if + *resource_identifier* does not exist. + + ''' + filesystem_path = self.get_filesystem_path(resource_identifier) + + if self.is_file(resource_identifier): + with error_handler( + operation='remove', resource_identifier=resource_identifier + ): + os.remove(filesystem_path) + + elif self.is_container(resource_identifier): + with error_handler( + operation='remove', resource_identifier=resource_identifier + ): + os.rmdir(filesystem_path) + + else: + raise AccessorResourceNotFoundError( + resource_identifier=resource_identifier + ) + + def make_container(self, resource_identifier, recursive=True): + '''Make a container at *resource_identifier*. + + If *recursive* is True, also make any intermediate containers. + + ''' + filesystem_path = self.get_filesystem_path(resource_identifier) + + with error_handler( + operation='makeContainer', resource_identifier=resource_identifier + ): + try: + if recursive: + os.makedirs(filesystem_path) + else: + try: + os.mkdir(filesystem_path) + except OSError as error: + if error.errno == errno.ENOENT: + raise AccessorParentResourceNotFoundError( + resource_identifier=resource_identifier + ) + else: + raise + + except OSError, error: + if error.errno != errno.EEXIST: + raise + + def get_container(self, resource_identifier): + '''Return resource_identifier of container for *resource_identifier*. + + Raise :exc:`~ftrack_api.exception.AccessorParentResourceNotFoundError` if + container of *resource_identifier* could not be determined. + + ''' + filesystem_path = self.get_filesystem_path(resource_identifier) + + container = os.path.dirname(filesystem_path) + + if self.prefix: + if not container.startswith(self.prefix): + raise AccessorParentResourceNotFoundError( + resource_identifier=resource_identifier, + message='Could not determine container for ' + '{resource_identifier} as container falls outside ' + 'of configured prefix.' + ) + + # Convert container filesystem path into resource identifier. + container = container[len(self.prefix):] + if ntpath.isabs(container): + # Ensure that resulting path is relative by stripping any + # leftover prefixed slashes from string. + # E.g. If prefix was '/tmp' and path was '/tmp/foo/bar' the + # result will be 'foo/bar'. + container = container.lstrip('\\/') + + return container + + def get_filesystem_path(self, resource_identifier): + '''Return filesystem path for *resource_identifier*. + + For example:: + + >>> accessor = DiskAccessor('my.location', '/mountpoint') + >>> print accessor.get_filesystem_path('test.txt') + /mountpoint/test.txt + >>> print accessor.get_filesystem_path('/mountpoint/test.txt') + /mountpoint/test.txt + + Raise :exc:`ftrack_api.exception.AccessorFilesystemPathError` if filesystem + path could not be determined from *resource_identifier*. + + ''' + filesystem_path = resource_identifier + if filesystem_path: + filesystem_path = os.path.normpath(filesystem_path) + + if self.prefix: + if not os.path.isabs(filesystem_path): + filesystem_path = os.path.normpath( + os.path.join(self.prefix, filesystem_path) + ) + + if not filesystem_path.startswith(self.prefix): + raise AccessorFilesystemPathError( + resource_identifier=resource_identifier, + message='Could not determine access path for ' + 'resource_identifier outside of configured prefix: ' + '{resource_identifier}.' + ) + + return filesystem_path + + +@contextlib.contextmanager +def error_handler(**kw): + '''Conform raised OSError/IOError exception to appropriate FTrack error.''' + try: + yield + + except (OSError, IOError) as error: + (exception_type, exception_value, traceback) = sys.exc_info() + kw.setdefault('error', error) + + error_code = getattr(error, 'errno') + if not error_code: + raise AccessorOperationFailedError(**kw), None, traceback + + if error_code == errno.ENOENT: + raise AccessorResourceNotFoundError(**kw), None, traceback + + elif error_code == errno.EPERM: + raise AccessorPermissionDeniedError(**kw), None, traceback + + elif error_code == errno.ENOTEMPTY: + raise AccessorContainerNotEmptyError(**kw), None, traceback + + elif error_code in (errno.ENOTDIR, errno.EISDIR, errno.EINVAL): + raise AccessorResourceInvalidError(**kw), None, traceback + + else: + raise AccessorOperationFailedError(**kw), None, traceback + + except Exception: + raise diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/server.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/server.py new file mode 100644 index 0000000000..9c735084d5 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/accessor/server.py @@ -0,0 +1,240 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import os +import hashlib +import base64 +import json + +import requests + +from .base import Accessor +from ..data import String +import ftrack_api.exception +import ftrack_api.symbol + + +class ServerFile(String): + '''Representation of a server file.''' + + def __init__(self, resource_identifier, session, mode='rb'): + '''Initialise file.''' + self.mode = mode + self.resource_identifier = resource_identifier + self._session = session + self._has_read = False + + super(ServerFile, self).__init__() + + def flush(self): + '''Flush all changes.''' + super(ServerFile, self).flush() + + if self.mode == 'wb': + self._write() + + def read(self, limit=None): + '''Read file.''' + if not self._has_read: + self._read() + self._has_read = True + + return super(ServerFile, self).read(limit) + + def _read(self): + '''Read all remote content from key into wrapped_file.''' + position = self.tell() + self.seek(0) + + response = requests.get( + '{0}/component/get'.format(self._session.server_url), + params={ + 'id': self.resource_identifier, + 'username': self._session.api_user, + 'apiKey': self._session.api_key + }, + stream=True + ) + + try: + response.raise_for_status() + except requests.exceptions.HTTPError as error: + raise ftrack_api.exception.AccessorOperationFailedError( + 'Failed to read data: {0}.'.format(error) + ) + + for block in response.iter_content(ftrack_api.symbol.CHUNK_SIZE): + self.wrapped_file.write(block) + + self.flush() + self.seek(position) + + def _write(self): + '''Write current data to remote key.''' + position = self.tell() + self.seek(0) + + # Retrieve component from cache to construct a filename. + component = self._session.get('FileComponent', self.resource_identifier) + if not component: + raise ftrack_api.exception.AccessorOperationFailedError( + 'Unable to retrieve component with id: {0}.'.format( + self.resource_identifier + ) + ) + + # Construct a name from component name and file_type. + name = component['name'] + if component['file_type']: + name = u'{0}.{1}'.format( + name, + component['file_type'].lstrip('.') + ) + + try: + metadata = self._session.get_upload_metadata( + component_id=self.resource_identifier, + file_name=name, + file_size=self._get_size(), + checksum=self._compute_checksum() + ) + except Exception as error: + raise ftrack_api.exception.AccessorOperationFailedError( + 'Failed to get put metadata: {0}.'.format(error) + ) + + # Ensure at beginning of file before put. + self.seek(0) + + # Put the file based on the metadata. + response = requests.put( + metadata['url'], + data=self.wrapped_file, + headers=metadata['headers'] + ) + + try: + response.raise_for_status() + except requests.exceptions.HTTPError as error: + raise ftrack_api.exception.AccessorOperationFailedError( + 'Failed to put file to server: {0}.'.format(error) + ) + + self.seek(position) + + def _get_size(self): + '''Return size of file in bytes.''' + position = self.tell() + self.seek(0, os.SEEK_END) + length = self.tell() + self.seek(position) + return length + + def _compute_checksum(self): + '''Return checksum for file.''' + fp = self.wrapped_file + buf_size = ftrack_api.symbol.CHUNK_SIZE + hash_obj = hashlib.md5() + spos = fp.tell() + + s = fp.read(buf_size) + while s: + hash_obj.update(s) + s = fp.read(buf_size) + + base64_digest = base64.encodestring(hash_obj.digest()) + if base64_digest[-1] == '\n': + base64_digest = base64_digest[0:-1] + + fp.seek(spos) + return base64_digest + + +class _ServerAccessor(Accessor): + '''Provide server location access.''' + + def __init__(self, session, **kw): + '''Initialise location accessor.''' + super(_ServerAccessor, self).__init__(**kw) + + self._session = session + + def open(self, resource_identifier, mode='rb'): + '''Return :py:class:`~ftrack_api.Data` for *resource_identifier*.''' + return ServerFile(resource_identifier, session=self._session, mode=mode) + + def remove(self, resourceIdentifier): + '''Remove *resourceIdentifier*.''' + response = requests.get( + '{0}/component/remove'.format(self._session.server_url), + params={ + 'id': resourceIdentifier, + 'username': self._session.api_user, + 'apiKey': self._session.api_key + } + ) + if response.status_code != 200: + raise ftrack_api.exception.AccessorOperationFailedError( + 'Failed to remove file.' + ) + + def get_container(self, resource_identifier): + '''Return resource_identifier of container for *resource_identifier*.''' + return None + + def make_container(self, resource_identifier, recursive=True): + '''Make a container at *resource_identifier*.''' + + def list(self, resource_identifier): + '''Return list of entries in *resource_identifier* container.''' + raise NotImplementedError() + + def exists(self, resource_identifier): + '''Return if *resource_identifier* is valid and exists in location.''' + return False + + def is_file(self, resource_identifier): + '''Return whether *resource_identifier* refers to a file.''' + raise NotImplementedError() + + def is_container(self, resource_identifier): + '''Return whether *resource_identifier* refers to a container.''' + raise NotImplementedError() + + def is_sequence(self, resource_identifier): + '''Return whether *resource_identifier* refers to a file sequence.''' + raise NotImplementedError() + + def get_url(self, resource_identifier): + '''Return url for *resource_identifier*.''' + url_string = ( + u'{url}/component/get?id={id}&username={username}' + u'&apiKey={apiKey}' + ) + return url_string.format( + url=self._session.server_url, + id=resource_identifier, + username=self._session.api_user, + apiKey=self._session.api_key + ) + + def get_thumbnail_url(self, resource_identifier, size=None): + '''Return thumbnail url for *resource_identifier*. + + Optionally, specify *size* to constrain the downscaled image to size + x size pixels. + ''' + url_string = ( + u'{url}/component/thumbnail?id={id}&username={username}' + u'&apiKey={apiKey}' + ) + url = url_string.format( + url=self._session.server_url, + id=resource_identifier, + username=self._session.api_user, + apiKey=self._session.api_key + ) + if size: + url += u'&size={0}'.format(size) + + return url diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/attribute.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/attribute.py new file mode 100644 index 0000000000..719b612f39 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/attribute.py @@ -0,0 +1,707 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from __future__ import absolute_import + +import collections +import copy +import logging +import functools + +import ftrack_api.symbol +import ftrack_api.exception +import ftrack_api.collection +import ftrack_api.inspection +import ftrack_api.operation + +logger = logging.getLogger( + __name__ +) + + +def merge_references(function): + '''Decorator to handle merging of references / collections.''' + + @functools.wraps(function) + def get_value(attribute, entity): + '''Merge the attribute with the local cache.''' + + if attribute.name not in entity._inflated: + # Only merge on first access to avoid + # inflating them multiple times. + + logger.debug( + 'Merging potential new data into attached ' + 'entity for attribute {0}.'.format( + attribute.name + ) + ) + + # Local attributes. + local_value = attribute.get_local_value(entity) + if isinstance( + local_value, + ( + ftrack_api.entity.base.Entity, + ftrack_api.collection.Collection, + ftrack_api.collection.MappedCollectionProxy + ) + ): + logger.debug( + 'Merging local value for attribute {0}.'.format(attribute) + ) + + merged_local_value = entity.session._merge( + local_value, merged=dict() + ) + + if merged_local_value is not local_value: + with entity.session.operation_recording(False): + attribute.set_local_value(entity, merged_local_value) + + # Remote attributes. + remote_value = attribute.get_remote_value(entity) + if isinstance( + remote_value, + ( + ftrack_api.entity.base.Entity, + ftrack_api.collection.Collection, + ftrack_api.collection.MappedCollectionProxy + ) + ): + logger.debug( + 'Merging remote value for attribute {0}.'.format(attribute) + ) + + merged_remote_value = entity.session._merge( + remote_value, merged=dict() + ) + + if merged_remote_value is not remote_value: + attribute.set_remote_value(entity, merged_remote_value) + + entity._inflated.add( + attribute.name + ) + + return function( + attribute, entity + ) + + return get_value + + +class Attributes(object): + '''Collection of properties accessible by name.''' + + def __init__(self, attributes=None): + super(Attributes, self).__init__() + self._data = dict() + if attributes is not None: + for attribute in attributes: + self.add(attribute) + + def add(self, attribute): + '''Add *attribute*.''' + existing = self._data.get(attribute.name, None) + if existing: + raise ftrack_api.exception.NotUniqueError( + 'Attribute with name {0} already added as {1}' + .format(attribute.name, existing) + ) + + self._data[attribute.name] = attribute + + def remove(self, attribute): + '''Remove attribute.''' + self._data.pop(attribute.name) + + def get(self, name): + '''Return attribute by *name*. + + If no attribute matches *name* then return None. + + ''' + return self._data.get(name, None) + + def keys(self): + '''Return list of attribute names.''' + return self._data.keys() + + def __contains__(self, item): + '''Return whether *item* present.''' + if not isinstance(item, Attribute): + return False + + return item.name in self._data + + def __iter__(self): + '''Return iterator over attributes.''' + return self._data.itervalues() + + def __len__(self): + '''Return count of attributes.''' + return len(self._data) + + +class Attribute(object): + '''A name and value pair persisted remotely.''' + + def __init__( + self, name, default_value=ftrack_api.symbol.NOT_SET, mutable=True, + computed=False + ): + '''Initialise attribute with *name*. + + *default_value* represents the default value for the attribute. It may + be a callable. It is not used within the attribute when providing + values, but instead exists for other parts of the system to reference. + + If *mutable* is set to False then the local value of the attribute on an + entity can only be set when both the existing local and remote values + are :attr:`ftrack_api.symbol.NOT_SET`. The exception to this is when the + target value is also :attr:`ftrack_api.symbol.NOT_SET`. + + If *computed* is set to True the value is a remote side computed value + and should not be long-term cached. + + ''' + super(Attribute, self).__init__() + self._name = name + self._mutable = mutable + self._computed = computed + self.default_value = default_value + + self._local_key = 'local' + self._remote_key = 'remote' + + def __repr__(self): + '''Return representation of entity.''' + return '<{0}.{1}({2}) object at {3}>'.format( + self.__module__, + self.__class__.__name__, + self.name, + id(self) + ) + + def get_entity_storage(self, entity): + '''Return attribute storage on *entity* creating if missing.''' + storage_key = '_ftrack_attribute_storage' + storage = getattr(entity, storage_key, None) + if storage is None: + storage = collections.defaultdict( + lambda: + { + self._local_key: ftrack_api.symbol.NOT_SET, + self._remote_key: ftrack_api.symbol.NOT_SET + } + ) + setattr(entity, storage_key, storage) + + return storage + + @property + def name(self): + '''Return name.''' + return self._name + + @property + def mutable(self): + '''Return whether attribute is mutable.''' + return self._mutable + + @property + def computed(self): + '''Return whether attribute is computed.''' + return self._computed + + def get_value(self, entity): + '''Return current value for *entity*. + + If a value was set locally then return it, otherwise return last known + remote value. If no remote value yet retrieved, make a request for it + via the session and block until available. + + ''' + value = self.get_local_value(entity) + if value is not ftrack_api.symbol.NOT_SET: + return value + + value = self.get_remote_value(entity) + if value is not ftrack_api.symbol.NOT_SET: + return value + + if not entity.session.auto_populate: + return value + + self.populate_remote_value(entity) + return self.get_remote_value(entity) + + def get_local_value(self, entity): + '''Return locally set value for *entity*.''' + storage = self.get_entity_storage(entity) + return storage[self.name][self._local_key] + + def get_remote_value(self, entity): + '''Return remote value for *entity*. + + .. note:: + + Only return locally stored remote value, do not fetch from remote. + + ''' + storage = self.get_entity_storage(entity) + return storage[self.name][self._remote_key] + + def set_local_value(self, entity, value): + '''Set local *value* for *entity*.''' + if ( + not self.mutable + and self.is_set(entity) + and value is not ftrack_api.symbol.NOT_SET + ): + raise ftrack_api.exception.ImmutableAttributeError(self) + + old_value = self.get_local_value(entity) + + storage = self.get_entity_storage(entity) + storage[self.name][self._local_key] = value + + # Record operation. + if entity.session.record_operations: + entity.session.recorded_operations.push( + ftrack_api.operation.UpdateEntityOperation( + entity.entity_type, + ftrack_api.inspection.primary_key(entity), + self.name, + old_value, + value + ) + ) + + def set_remote_value(self, entity, value): + '''Set remote *value*. + + .. note:: + + Only set locally stored remote value, do not persist to remote. + + ''' + storage = self.get_entity_storage(entity) + storage[self.name][self._remote_key] = value + + def populate_remote_value(self, entity): + '''Populate remote value for *entity*.''' + entity.session.populate([entity], self.name) + + def is_modified(self, entity): + '''Return whether local value set and differs from remote. + + .. note:: + + Will not fetch remote value so may report True even when values + are the same on the remote. + + ''' + local_value = self.get_local_value(entity) + remote_value = self.get_remote_value(entity) + return ( + local_value is not ftrack_api.symbol.NOT_SET + and local_value != remote_value + ) + + def is_set(self, entity): + '''Return whether a value is set for *entity*.''' + return any([ + self.get_local_value(entity) is not ftrack_api.symbol.NOT_SET, + self.get_remote_value(entity) is not ftrack_api.symbol.NOT_SET + ]) + + +class ScalarAttribute(Attribute): + '''Represent a scalar value.''' + + def __init__(self, name, data_type, **kw): + '''Initialise property.''' + super(ScalarAttribute, self).__init__(name, **kw) + self.data_type = data_type + + +class ReferenceAttribute(Attribute): + '''Reference another entity.''' + + def __init__(self, name, entity_type, **kw): + '''Initialise property.''' + super(ReferenceAttribute, self).__init__(name, **kw) + self.entity_type = entity_type + + def populate_remote_value(self, entity): + '''Populate remote value for *entity*. + + As attribute references another entity, use that entity's configured + default projections to auto populate useful attributes when loading. + + ''' + reference_entity_type = entity.session.types[self.entity_type] + default_projections = reference_entity_type.default_projections + + projections = [] + if default_projections: + for projection in default_projections: + projections.append('{0}.{1}'.format(self.name, projection)) + else: + projections.append(self.name) + + entity.session.populate([entity], ', '.join(projections)) + + def is_modified(self, entity): + '''Return whether a local value has been set and differs from remote. + + .. note:: + + Will not fetch remote value so may report True even when values + are the same on the remote. + + ''' + local_value = self.get_local_value(entity) + remote_value = self.get_remote_value(entity) + + if local_value is ftrack_api.symbol.NOT_SET: + return False + + if remote_value is ftrack_api.symbol.NOT_SET: + return True + + if ( + ftrack_api.inspection.identity(local_value) + != ftrack_api.inspection.identity(remote_value) + ): + return True + + return False + + + @merge_references + def get_value(self, entity): + return super(ReferenceAttribute, self).get_value( + entity + ) + +class AbstractCollectionAttribute(Attribute): + '''Base class for collection attributes.''' + + #: Collection class used by attribute. + collection_class = None + + @merge_references + def get_value(self, entity): + '''Return current value for *entity*. + + If a value was set locally then return it, otherwise return last known + remote value. If no remote value yet retrieved, make a request for it + via the session and block until available. + + .. note:: + + As value is a collection that is mutable, will transfer a remote + value into the local value on access if no local value currently + set. + + ''' + super(AbstractCollectionAttribute, self).get_value(entity) + + # Conditionally, copy remote value into local value so that it can be + # mutated without side effects. + local_value = self.get_local_value(entity) + remote_value = self.get_remote_value(entity) + if ( + local_value is ftrack_api.symbol.NOT_SET + and isinstance(remote_value, self.collection_class) + ): + try: + with entity.session.operation_recording(False): + self.set_local_value(entity, copy.copy(remote_value)) + except ftrack_api.exception.ImmutableAttributeError: + pass + + value = self.get_local_value(entity) + + # If the local value is still not set then attempt to set it with a + # suitable placeholder collection so that the caller can interact with + # the collection using its normal interface. This is required for a + # newly created entity for example. It *could* be done as a simple + # default value, but that would incur cost for every collection even + # when they are not modified before commit. + if value is ftrack_api.symbol.NOT_SET: + try: + with entity.session.operation_recording(False): + self.set_local_value( + entity, + # None should be treated as empty collection. + None + ) + except ftrack_api.exception.ImmutableAttributeError: + pass + + return self.get_local_value(entity) + + def set_local_value(self, entity, value): + '''Set local *value* for *entity*.''' + if value is not ftrack_api.symbol.NOT_SET: + value = self._adapt_to_collection(entity, value) + value.mutable = self.mutable + + super(AbstractCollectionAttribute, self).set_local_value(entity, value) + + def set_remote_value(self, entity, value): + '''Set remote *value*. + + .. note:: + + Only set locally stored remote value, do not persist to remote. + + ''' + if value is not ftrack_api.symbol.NOT_SET: + value = self._adapt_to_collection(entity, value) + value.mutable = False + + super(AbstractCollectionAttribute, self).set_remote_value(entity, value) + + def _adapt_to_collection(self, entity, value): + '''Adapt *value* to appropriate collection instance for *entity*. + + .. note:: + + If *value* is None then return a suitable empty collection. + + ''' + raise NotImplementedError() + + +class CollectionAttribute(AbstractCollectionAttribute): + '''Represent a collection of other entities.''' + + #: Collection class used by attribute. + collection_class = ftrack_api.collection.Collection + + def _adapt_to_collection(self, entity, value): + '''Adapt *value* to a Collection instance on *entity*.''' + + if not isinstance(value, ftrack_api.collection.Collection): + + if value is None: + value = ftrack_api.collection.Collection(entity, self) + + elif isinstance(value, list): + value = ftrack_api.collection.Collection( + entity, self, data=value + ) + + else: + raise NotImplementedError( + 'Cannot convert {0!r} to collection.'.format(value) + ) + + else: + if value.attribute is not self: + raise ftrack_api.exception.AttributeError( + 'Collection already bound to a different attribute' + ) + + return value + + +class KeyValueMappedCollectionAttribute(AbstractCollectionAttribute): + '''Represent a mapped key, value collection of entities.''' + + #: Collection class used by attribute. + collection_class = ftrack_api.collection.KeyValueMappedCollectionProxy + + def __init__( + self, name, creator, key_attribute, value_attribute, **kw + ): + '''Initialise attribute with *name*. + + *creator* should be a function that accepts a dictionary of data and + is used by the referenced collection to create new entities in the + collection. + + *key_attribute* should be the name of the attribute on an entity in + the collection that represents the value for 'key' of the dictionary. + + *value_attribute* should be the name of the attribute on an entity in + the collection that represents the value for 'value' of the dictionary. + + ''' + self.creator = creator + self.key_attribute = key_attribute + self.value_attribute = value_attribute + + super(KeyValueMappedCollectionAttribute, self).__init__(name, **kw) + + def _adapt_to_collection(self, entity, value): + '''Adapt *value* to an *entity*.''' + if not isinstance( + value, ftrack_api.collection.KeyValueMappedCollectionProxy + ): + + if value is None: + value = ftrack_api.collection.KeyValueMappedCollectionProxy( + ftrack_api.collection.Collection(entity, self), + self.creator, self.key_attribute, + self.value_attribute + ) + + elif isinstance(value, (list, ftrack_api.collection.Collection)): + + if isinstance(value, list): + value = ftrack_api.collection.Collection( + entity, self, data=value + ) + + value = ftrack_api.collection.KeyValueMappedCollectionProxy( + value, self.creator, self.key_attribute, + self.value_attribute + ) + + elif isinstance(value, collections.Mapping): + # Convert mapping. + # TODO: When backend model improves, revisit this logic. + # First get existing value and delete all references. This is + # needed because otherwise they will not be automatically + # removed server side. + # The following should not cause recursion as the internal + # values should be mapped collections already. + current_value = self.get_value(entity) + if not isinstance( + current_value, + ftrack_api.collection.KeyValueMappedCollectionProxy + ): + raise NotImplementedError( + 'Cannot adapt mapping to collection as current value ' + 'type is not a KeyValueMappedCollectionProxy.' + ) + + # Create the new collection using the existing collection as + # basis. Then update through proxy interface to ensure all + # internal operations called consistently (such as entity + # deletion for key removal). + collection = ftrack_api.collection.Collection( + entity, self, data=current_value.collection[:] + ) + collection_proxy = ( + ftrack_api.collection.KeyValueMappedCollectionProxy( + collection, self.creator, + self.key_attribute, self.value_attribute + ) + ) + + # Remove expired keys from collection. + expired_keys = set(current_value.keys()) - set(value.keys()) + for key in expired_keys: + del collection_proxy[key] + + # Set new values for existing keys / add new keys. + for key, value in value.items(): + collection_proxy[key] = value + + value = collection_proxy + + else: + raise NotImplementedError( + 'Cannot convert {0!r} to collection.'.format(value) + ) + else: + if value.attribute is not self: + raise ftrack_api.exception.AttributeError( + 'Collection already bound to a different attribute.' + ) + + return value + + +class CustomAttributeCollectionAttribute(AbstractCollectionAttribute): + '''Represent a mapped custom attribute collection of entities.''' + + #: Collection class used by attribute. + collection_class = ( + ftrack_api.collection.CustomAttributeCollectionProxy + ) + + def _adapt_to_collection(self, entity, value): + '''Adapt *value* to an *entity*.''' + if not isinstance( + value, ftrack_api.collection.CustomAttributeCollectionProxy + ): + + if value is None: + value = ftrack_api.collection.CustomAttributeCollectionProxy( + ftrack_api.collection.Collection(entity, self) + ) + + elif isinstance(value, (list, ftrack_api.collection.Collection)): + + # Why are we creating a new if it is a list? This will cause + # any merge to create a new proxy and collection. + if isinstance(value, list): + value = ftrack_api.collection.Collection( + entity, self, data=value + ) + + value = ftrack_api.collection.CustomAttributeCollectionProxy( + value + ) + + elif isinstance(value, collections.Mapping): + # Convert mapping. + # TODO: When backend model improves, revisit this logic. + # First get existing value and delete all references. This is + # needed because otherwise they will not be automatically + # removed server side. + # The following should not cause recursion as the internal + # values should be mapped collections already. + current_value = self.get_value(entity) + if not isinstance( + current_value, + ftrack_api.collection.CustomAttributeCollectionProxy + ): + raise NotImplementedError( + 'Cannot adapt mapping to collection as current value ' + 'type is not a MappedCollectionProxy.' + ) + + # Create the new collection using the existing collection as + # basis. Then update through proxy interface to ensure all + # internal operations called consistently (such as entity + # deletion for key removal). + collection = ftrack_api.collection.Collection( + entity, self, data=current_value.collection[:] + ) + collection_proxy = ( + ftrack_api.collection.CustomAttributeCollectionProxy( + collection + ) + ) + + # Remove expired keys from collection. + expired_keys = set(current_value.keys()) - set(value.keys()) + for key in expired_keys: + del collection_proxy[key] + + # Set new values for existing keys / add new keys. + for key, value in value.items(): + collection_proxy[key] = value + + value = collection_proxy + + else: + raise NotImplementedError( + 'Cannot convert {0!r} to collection.'.format(value) + ) + else: + if value.attribute is not self: + raise ftrack_api.exception.AttributeError( + 'Collection already bound to a different attribute.' + ) + + return value diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/cache.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/cache.py new file mode 100644 index 0000000000..49456dc2d7 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/cache.py @@ -0,0 +1,579 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +'''Caching framework. + +Defines a standardised :class:`Cache` interface for storing data against +specific keys. Key generation is also standardised using a :class:`KeyMaker` +interface. + +Combining a Cache and KeyMaker allows for memoisation of function calls with +respect to the arguments used by using a :class:`Memoiser`. + +As a convenience a simple :func:`memoise` decorator is included for quick +memoisation of function using a global cache and standard key maker. + +''' + +import collections +import functools +import abc +import copy +import inspect +import re +import anydbm +import contextlib +try: + import cPickle as pickle +except ImportError: # pragma: no cover + import pickle + +import ftrack_api.inspection +import ftrack_api.symbol + + +class Cache(object): + '''Cache interface. + + Derive from this to define concrete cache implementations. A cache is + centered around the concept of key:value pairings where the key is unique + across the cache. + + ''' + + __metaclass__ = abc.ABCMeta + + @abc.abstractmethod + def get(self, key): + '''Return value for *key*. + + Raise :exc:`KeyError` if *key* not found. + + ''' + + @abc.abstractmethod + def set(self, key, value): + '''Set *value* for *key*.''' + + @abc.abstractmethod + def remove(self, key): + '''Remove *key* and return stored value. + + Raise :exc:`KeyError` if *key* not found. + + ''' + + def keys(self): + '''Return list of keys at this current time. + + .. warning:: + + Actual keys may differ from those returned due to timing of access. + + ''' + raise NotImplementedError() # pragma: no cover + + def values(self): + '''Return values for current keys.''' + values = [] + for key in self.keys(): + try: + value = self.get(key) + except KeyError: + continue + else: + values.append(value) + + return values + + def clear(self, pattern=None): + '''Remove all keys matching *pattern*. + + *pattern* should be a regular expression string. + + If *pattern* is None then all keys will be removed. + + ''' + if pattern is not None: + pattern = re.compile(pattern) + + for key in self.keys(): + if pattern is not None: + if not pattern.search(key): + continue + + try: + self.remove(key) + except KeyError: + pass + + +class ProxyCache(Cache): + '''Proxy another cache.''' + + def __init__(self, proxied): + '''Initialise cache with *proxied* cache instance.''' + self.proxied = proxied + super(ProxyCache, self).__init__() + + def get(self, key): + '''Return value for *key*. + + Raise :exc:`KeyError` if *key* not found. + + ''' + return self.proxied.get(key) + + def set(self, key, value): + '''Set *value* for *key*.''' + return self.proxied.set(key, value) + + def remove(self, key): + '''Remove *key* and return stored value. + + Raise :exc:`KeyError` if *key* not found. + + ''' + return self.proxied.remove(key) + + def keys(self): + '''Return list of keys at this current time. + + .. warning:: + + Actual keys may differ from those returned due to timing of access. + + ''' + return self.proxied.keys() + + +class LayeredCache(Cache): + '''Layered cache.''' + + def __init__(self, caches): + '''Initialise cache with *caches*.''' + super(LayeredCache, self).__init__() + self.caches = caches + + def get(self, key): + '''Return value for *key*. + + Raise :exc:`KeyError` if *key* not found. + + Attempt to retrieve from cache layers in turn, starting with shallowest. + If value retrieved, then also set the value in each higher level cache + up from where retrieved. + + ''' + target_caches = [] + value = ftrack_api.symbol.NOT_SET + + for cache in self.caches: + try: + value = cache.get(key) + except KeyError: + target_caches.append(cache) + continue + else: + break + + if value is ftrack_api.symbol.NOT_SET: + raise KeyError(key) + + # Set value on all higher level caches. + for cache in target_caches: + cache.set(key, value) + + return value + + def set(self, key, value): + '''Set *value* for *key*.''' + for cache in self.caches: + cache.set(key, value) + + def remove(self, key): + '''Remove *key*. + + Raise :exc:`KeyError` if *key* not found in any layer. + + ''' + removed = False + for cache in self.caches: + try: + cache.remove(key) + except KeyError: + pass + else: + removed = True + + if not removed: + raise KeyError(key) + + def keys(self): + '''Return list of keys at this current time. + + .. warning:: + + Actual keys may differ from those returned due to timing of access. + + ''' + keys = [] + for cache in self.caches: + keys.extend(cache.keys()) + + return list(set(keys)) + + +class MemoryCache(Cache): + '''Memory based cache.''' + + def __init__(self): + '''Initialise cache.''' + self._cache = {} + super(MemoryCache, self).__init__() + + def get(self, key): + '''Return value for *key*. + + Raise :exc:`KeyError` if *key* not found. + + ''' + return self._cache[key] + + def set(self, key, value): + '''Set *value* for *key*.''' + self._cache[key] = value + + def remove(self, key): + '''Remove *key*. + + Raise :exc:`KeyError` if *key* not found. + + ''' + del self._cache[key] + + def keys(self): + '''Return list of keys at this current time. + + .. warning:: + + Actual keys may differ from those returned due to timing of access. + + ''' + return self._cache.keys() + + +class FileCache(Cache): + '''File based cache that uses :mod:`anydbm` module. + + .. note:: + + No locking of the underlying file is performed. + + ''' + + def __init__(self, path): + '''Initialise cache at *path*.''' + self.path = path + + # Initialise cache. + cache = anydbm.open(self.path, 'c') + cache.close() + + super(FileCache, self).__init__() + + @contextlib.contextmanager + def _database(self): + '''Yield opened database file.''' + cache = anydbm.open(self.path, 'w') + try: + yield cache + finally: + cache.close() + + def get(self, key): + '''Return value for *key*. + + Raise :exc:`KeyError` if *key* not found. + + ''' + with self._database() as cache: + return cache[key] + + def set(self, key, value): + '''Set *value* for *key*.''' + with self._database() as cache: + cache[key] = value + + def remove(self, key): + '''Remove *key*. + + Raise :exc:`KeyError` if *key* not found. + + ''' + with self._database() as cache: + del cache[key] + + def keys(self): + '''Return list of keys at this current time. + + .. warning:: + + Actual keys may differ from those returned due to timing of access. + + ''' + with self._database() as cache: + return cache.keys() + + +class SerialisedCache(ProxyCache): + '''Proxied cache that stores values as serialised data.''' + + def __init__(self, proxied, encode=None, decode=None): + '''Initialise cache with *encode* and *decode* callables. + + *proxied* is the underlying cache to use for storage. + + ''' + self.encode = encode + self.decode = decode + super(SerialisedCache, self).__init__(proxied) + + def get(self, key): + '''Return value for *key*. + + Raise :exc:`KeyError` if *key* not found. + + ''' + value = super(SerialisedCache, self).get(key) + if self.decode: + value = self.decode(value) + + return value + + def set(self, key, value): + '''Set *value* for *key*.''' + if self.encode: + value = self.encode(value) + + super(SerialisedCache, self).set(key, value) + + +class KeyMaker(object): + '''Generate unique keys.''' + + __metaclass__ = abc.ABCMeta + + def __init__(self): + '''Initialise key maker.''' + super(KeyMaker, self).__init__() + self.item_separator = '' + + def key(self, *items): + '''Return key for *items*.''' + keys = [] + for item in items: + keys.append(self._key(item)) + + return self.item_separator.join(keys) + + @abc.abstractmethod + def _key(self, obj): + '''Return key for *obj*.''' + + +class StringKeyMaker(KeyMaker): + '''Generate string key.''' + + def _key(self, obj): + '''Return key for *obj*.''' + return str(obj) + + +class ObjectKeyMaker(KeyMaker): + '''Generate unique keys for objects.''' + + def __init__(self): + '''Initialise key maker.''' + super(ObjectKeyMaker, self).__init__() + self.item_separator = '\0' + self.mapping_identifier = '\1' + self.mapping_pair_separator = '\2' + self.iterable_identifier = '\3' + self.name_identifier = '\4' + + def _key(self, item): + '''Return key for *item*. + + Returned key will be a pickle like string representing the *item*. This + allows for typically non-hashable objects to be used in key generation + (such as dictionaries). + + If *item* is iterable then each item in it shall also be passed to this + method to ensure correct key generation. + + Special markers are used to distinguish handling of specific cases in + order to ensure uniqueness of key corresponds directly to *item*. + + Example:: + + >>> key_maker = ObjectKeyMaker() + >>> def add(x, y): + ... "Return sum of *x* and *y*." + ... return x + y + ... + >>> key_maker.key(add, (1, 2)) + '\x04add\x00__main__\x00\x03\x80\x02K\x01.\x00\x80\x02K\x02.\x03' + >>> key_maker.key(add, (1, 3)) + '\x04add\x00__main__\x00\x03\x80\x02K\x01.\x00\x80\x02K\x03.\x03' + + ''' + # TODO: Consider using a more robust and comprehensive solution such as + # dill (https://github.com/uqfoundation/dill). + if isinstance(item, collections.Iterable): + if isinstance(item, basestring): + return pickle.dumps(item, pickle.HIGHEST_PROTOCOL) + + if isinstance(item, collections.Mapping): + contents = self.item_separator.join([ + ( + self._key(key) + + self.mapping_pair_separator + + self._key(value) + ) + for key, value in sorted(item.items()) + ]) + return ( + self.mapping_identifier + + contents + + self.mapping_identifier + ) + + else: + contents = self.item_separator.join([ + self._key(item) for item in item + ]) + return ( + self.iterable_identifier + + contents + + self.iterable_identifier + ) + + elif inspect.ismethod(item): + return ''.join(( + self.name_identifier, + item.__name__, + self.item_separator, + item.im_class.__name__, + self.item_separator, + item.__module__ + )) + + elif inspect.isfunction(item) or inspect.isclass(item): + return ''.join(( + self.name_identifier, + item.__name__, + self.item_separator, + item.__module__ + )) + + elif inspect.isbuiltin(item): + return self.name_identifier + item.__name__ + + else: + return pickle.dumps(item, pickle.HIGHEST_PROTOCOL) + + +class Memoiser(object): + '''Memoise function calls using a :class:`KeyMaker` and :class:`Cache`. + + Example:: + + >>> memoiser = Memoiser(MemoryCache(), ObjectKeyMaker()) + >>> def add(x, y): + ... "Return sum of *x* and *y*." + ... print 'Called' + ... return x + y + ... + >>> memoiser.call(add, (1, 2), {}) + Called + >>> memoiser.call(add, (1, 2), {}) + >>> memoiser.call(add, (1, 3), {}) + Called + + ''' + + def __init__(self, cache=None, key_maker=None, return_copies=True): + '''Initialise with *cache* and *key_maker* to use. + + If *cache* is not specified a default :class:`MemoryCache` will be + used. Similarly, if *key_maker* is not specified a default + :class:`ObjectKeyMaker` will be used. + + If *return_copies* is True then all results returned from the cache will + be deep copies to avoid indirect mutation of cached values. + + ''' + self.cache = cache + if self.cache is None: + self.cache = MemoryCache() + + self.key_maker = key_maker + if self.key_maker is None: + self.key_maker = ObjectKeyMaker() + + self.return_copies = return_copies + super(Memoiser, self).__init__() + + def call(self, function, args=None, kw=None): + '''Call *function* with *args* and *kw* and return result. + + If *function* was previously called with exactly the same arguments + then return cached result if available. + + Store result for call in cache. + + ''' + if args is None: + args = () + + if kw is None: + kw = {} + + # Support arguments being passed as positionals or keywords. + arguments = inspect.getcallargs(function, *args, **kw) + + key = self.key_maker.key(function, arguments) + try: + value = self.cache.get(key) + + except KeyError: + value = function(*args, **kw) + self.cache.set(key, value) + + # If requested, deep copy value to return in order to avoid cached value + # being inadvertently altered by the caller. + if self.return_copies: + value = copy.deepcopy(value) + + return value + + +def memoise_decorator(memoiser): + '''Decorator to memoise function calls using *memoiser*.''' + def outer(function): + + @functools.wraps(function) + def inner(*args, **kw): + return memoiser.call(function, args, kw) + + return inner + + return outer + + +#: Default memoiser. +memoiser = Memoiser() + +#: Default memoise decorator using standard cache and key maker. +memoise = memoise_decorator(memoiser) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/collection.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/collection.py new file mode 100644 index 0000000000..91655a7b02 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/collection.py @@ -0,0 +1,507 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from __future__ import absolute_import + +import logging + +import collections +import copy + +import ftrack_api.exception +import ftrack_api.inspection +import ftrack_api.symbol +import ftrack_api.operation +import ftrack_api.cache +from ftrack_api.logging import LazyLogMessage as L + + +class Collection(collections.MutableSequence): + '''A collection of entities.''' + + def __init__(self, entity, attribute, mutable=True, data=None): + '''Initialise collection.''' + self.entity = entity + self.attribute = attribute + self._data = [] + self._identities = set() + + # Set initial dataset. + # Note: For initialisation, immutability is deferred till after initial + # population as otherwise there would be no public way to initialise an + # immutable collection. The reason self._data is not just set directly + # is to ensure other logic can be applied without special handling. + self.mutable = True + try: + if data is None: + data = [] + + with self.entity.session.operation_recording(False): + self.extend(data) + finally: + self.mutable = mutable + + def _identity_key(self, entity): + '''Return identity key for *entity*.''' + return str(ftrack_api.inspection.identity(entity)) + + def __copy__(self): + '''Return shallow copy. + + .. note:: + + To maintain expectations on usage, the shallow copy will include a + shallow copy of the underlying data store. + + ''' + cls = self.__class__ + copied_instance = cls.__new__(cls) + copied_instance.__dict__.update(self.__dict__) + copied_instance._data = copy.copy(self._data) + copied_instance._identities = copy.copy(self._identities) + + return copied_instance + + def _notify(self, old_value): + '''Notify about modification.''' + # Record operation. + if self.entity.session.record_operations: + self.entity.session.recorded_operations.push( + ftrack_api.operation.UpdateEntityOperation( + self.entity.entity_type, + ftrack_api.inspection.primary_key(self.entity), + self.attribute.name, + old_value, + self + ) + ) + + def insert(self, index, item): + '''Insert *item* at *index*.''' + if not self.mutable: + raise ftrack_api.exception.ImmutableCollectionError(self) + + if item in self: + raise ftrack_api.exception.DuplicateItemInCollectionError( + item, self + ) + + old_value = copy.copy(self) + self._data.insert(index, item) + self._identities.add(self._identity_key(item)) + self._notify(old_value) + + def __contains__(self, value): + '''Return whether *value* present in collection.''' + return self._identity_key(value) in self._identities + + def __getitem__(self, index): + '''Return item at *index*.''' + return self._data[index] + + def __setitem__(self, index, item): + '''Set *item* against *index*.''' + if not self.mutable: + raise ftrack_api.exception.ImmutableCollectionError(self) + + try: + existing_index = self.index(item) + except ValueError: + pass + else: + if index != existing_index: + raise ftrack_api.exception.DuplicateItemInCollectionError( + item, self + ) + + old_value = copy.copy(self) + try: + existing_item = self._data[index] + except IndexError: + pass + else: + self._identities.remove(self._identity_key(existing_item)) + + self._data[index] = item + self._identities.add(self._identity_key(item)) + self._notify(old_value) + + def __delitem__(self, index): + '''Remove item at *index*.''' + if not self.mutable: + raise ftrack_api.exception.ImmutableCollectionError(self) + + old_value = copy.copy(self) + item = self._data[index] + del self._data[index] + self._identities.remove(self._identity_key(item)) + self._notify(old_value) + + def __len__(self): + '''Return count of items.''' + return len(self._data) + + def __eq__(self, other): + '''Return whether this collection is equal to *other*.''' + if not isinstance(other, Collection): + return False + + return sorted(self._identities) == sorted(other._identities) + + def __ne__(self, other): + '''Return whether this collection is not equal to *other*.''' + return not self == other + + +class MappedCollectionProxy(collections.MutableMapping): + '''Common base class for mapped collection of entities.''' + + def __init__(self, collection): + '''Initialise proxy for *collection*.''' + self.logger = logging.getLogger( + __name__ + '.' + self.__class__.__name__ + ) + self.collection = collection + super(MappedCollectionProxy, self).__init__() + + def __copy__(self): + '''Return shallow copy. + + .. note:: + + To maintain expectations on usage, the shallow copy will include a + shallow copy of the underlying collection. + + ''' + cls = self.__class__ + copied_instance = cls.__new__(cls) + copied_instance.__dict__.update(self.__dict__) + copied_instance.collection = copy.copy(self.collection) + + return copied_instance + + @property + def mutable(self): + '''Return whether collection is mutable.''' + return self.collection.mutable + + @mutable.setter + def mutable(self, value): + '''Set whether collection is mutable to *value*.''' + self.collection.mutable = value + + @property + def attribute(self): + '''Return attribute bound to.''' + return self.collection.attribute + + @attribute.setter + def attribute(self, value): + '''Set bound attribute to *value*.''' + self.collection.attribute = value + + +class KeyValueMappedCollectionProxy(MappedCollectionProxy): + '''A mapped collection of key, value entities. + + Proxy a standard :class:`Collection` as a mapping where certain attributes + from the entities in the collection are mapped to key, value pairs. + + For example:: + + >>> collection = [Metadata(key='foo', value='bar'), ...] + >>> mapped = KeyValueMappedCollectionProxy( + ... collection, create_metadata, + ... key_attribute='key', value_attribute='value' + ... ) + >>> print mapped['foo'] + 'bar' + >>> mapped['bam'] = 'biz' + >>> print mapped.collection[-1] + Metadata(key='bam', value='biz') + + ''' + + def __init__( + self, collection, creator, key_attribute, value_attribute + ): + '''Initialise collection.''' + self.creator = creator + self.key_attribute = key_attribute + self.value_attribute = value_attribute + super(KeyValueMappedCollectionProxy, self).__init__(collection) + + def _get_entity_by_key(self, key): + '''Return entity instance with matching *key* from collection.''' + for entity in self.collection: + if entity[self.key_attribute] == key: + return entity + + raise KeyError(key) + + def __getitem__(self, key): + '''Return value for *key*.''' + entity = self._get_entity_by_key(key) + return entity[self.value_attribute] + + def __setitem__(self, key, value): + '''Set *value* for *key*.''' + try: + entity = self._get_entity_by_key(key) + except KeyError: + data = { + self.key_attribute: key, + self.value_attribute: value + } + entity = self.creator(self, data) + + if ( + ftrack_api.inspection.state(entity) is + ftrack_api.symbol.CREATED + ): + # Persisting this entity will be handled here, record the + # operation. + self.collection.append(entity) + + else: + # The entity is created and persisted separately by the + # creator. Do not record this operation. + with self.collection.entity.session.operation_recording(False): + # Do not record this operation since it will trigger + # redudant and potentially failing operations. + self.collection.append(entity) + + else: + entity[self.value_attribute] = value + + def __delitem__(self, key): + '''Remove and delete *key*. + + .. note:: + + The associated entity will be deleted as well. + + ''' + for index, entity in enumerate(self.collection): + if entity[self.key_attribute] == key: + break + else: + raise KeyError(key) + + del self.collection[index] + entity.session.delete(entity) + + def __iter__(self): + '''Iterate over all keys.''' + keys = set() + for entity in self.collection: + keys.add(entity[self.key_attribute]) + + return iter(keys) + + def __len__(self): + '''Return count of keys.''' + keys = set() + for entity in self.collection: + keys.add(entity[self.key_attribute]) + + return len(keys) + + +class PerSessionDefaultKeyMaker(ftrack_api.cache.KeyMaker): + '''Generate key for session.''' + + def _key(self, obj): + '''Return key for *obj*.''' + if isinstance(obj, dict): + session = obj.get('session') + if session is not None: + # Key by session only. + return str(id(session)) + + return str(obj) + + +#: Memoiser for use with callables that should be called once per session. +memoise_session = ftrack_api.cache.memoise_decorator( + ftrack_api.cache.Memoiser( + key_maker=PerSessionDefaultKeyMaker(), return_copies=False + ) +) + + +@memoise_session +def _get_custom_attribute_configurations(session): + '''Return list of custom attribute configurations. + + The configuration objects will have key, project_id, id and object_type_id + populated. + + ''' + return session.query( + 'select key, project_id, id, object_type_id, entity_type from ' + 'CustomAttributeConfiguration' + ).all() + + +class CustomAttributeCollectionProxy(MappedCollectionProxy): + '''A mapped collection of custom attribute value entities.''' + + def __init__( + self, collection + ): + '''Initialise collection.''' + self.key_attribute = 'configuration_id' + self.value_attribute = 'value' + super(CustomAttributeCollectionProxy, self).__init__(collection) + + def _get_entity_configurations(self): + '''Return all configurations for current collection entity.''' + entity = self.collection.entity + entity_type = None + project_id = None + object_type_id = None + + if 'object_type_id' in entity.keys(): + project_id = entity['project_id'] + entity_type = 'task' + object_type_id = entity['object_type_id'] + + if entity.entity_type == 'AssetVersion': + project_id = entity['asset']['parent']['project_id'] + entity_type = 'assetversion' + + if entity.entity_type == 'Asset': + project_id = entity['parent']['project_id'] + entity_type = 'asset' + + if entity.entity_type == 'Project': + project_id = entity['id'] + entity_type = 'show' + + if entity.entity_type == 'User': + entity_type = 'user' + + if entity_type is None: + raise ValueError( + 'Entity {!r} not supported.'.format(entity) + ) + + configurations = [] + for configuration in _get_custom_attribute_configurations( + entity.session + ): + if ( + configuration['entity_type'] == entity_type and + configuration['project_id'] in (project_id, None) and + configuration['object_type_id'] == object_type_id + ): + configurations.append(configuration) + + # Return with global configurations at the end of the list. This is done + # so that global conigurations are shadowed by project specific if the + # configurations list is looped when looking for a matching `key`. + return sorted( + configurations, key=lambda item: item['project_id'] is None + ) + + def _get_keys(self): + '''Return a list of all keys.''' + keys = [] + for configuration in self._get_entity_configurations(): + keys.append(configuration['key']) + + return keys + + def _get_entity_by_key(self, key): + '''Return entity instance with matching *key* from collection.''' + configuration_id = self.get_configuration_id_from_key(key) + for entity in self.collection: + if entity[self.key_attribute] == configuration_id: + return entity + + return None + + def get_configuration_id_from_key(self, key): + '''Return id of configuration with matching *key*. + + Raise :exc:`KeyError` if no configuration with matching *key* found. + + ''' + for configuration in self._get_entity_configurations(): + if key == configuration['key']: + return configuration['id'] + + raise KeyError(key) + + def __getitem__(self, key): + '''Return value for *key*.''' + entity = self._get_entity_by_key(key) + + if entity: + return entity[self.value_attribute] + + for configuration in self._get_entity_configurations(): + if configuration['key'] == key: + return configuration['default'] + + raise KeyError(key) + + def __setitem__(self, key, value): + '''Set *value* for *key*.''' + custom_attribute_value = self._get_entity_by_key(key) + + if custom_attribute_value: + custom_attribute_value[self.value_attribute] = value + else: + entity = self.collection.entity + session = entity.session + data = { + self.key_attribute: self.get_configuration_id_from_key(key), + self.value_attribute: value, + 'entity_id': entity['id'] + } + + # Make sure to use the currently active collection. This is + # necessary since a merge might have replaced the current one. + self.collection.entity['custom_attributes'].collection.append( + session.create('CustomAttributeValue', data) + ) + + def __delitem__(self, key): + '''Remove and delete *key*. + + .. note:: + + The associated entity will be deleted as well. + + ''' + custom_attribute_value = self._get_entity_by_key(key) + + if custom_attribute_value: + index = self.collection.index(custom_attribute_value) + del self.collection[index] + + custom_attribute_value.session.delete(custom_attribute_value) + else: + self.logger.warning(L( + 'Cannot delete {0!r} on {1!r}, no custom attribute value set.', + key, self.collection.entity + )) + + def __eq__(self, collection): + '''Return True if *collection* equals proxy collection.''' + if collection is ftrack_api.symbol.NOT_SET: + return False + + return collection.collection == self.collection + + def __iter__(self): + '''Iterate over all keys.''' + keys = self._get_keys() + return iter(keys) + + def __len__(self): + '''Return count of keys.''' + keys = self._get_keys() + return len(keys) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/data.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/data.py new file mode 100644 index 0000000000..1802e380c0 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/data.py @@ -0,0 +1,119 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2013 ftrack + +import os +from abc import ABCMeta, abstractmethod +import tempfile + + +class Data(object): + '''File-like object for manipulating data.''' + + __metaclass__ = ABCMeta + + def __init__(self): + '''Initialise data access.''' + self.closed = False + + @abstractmethod + def read(self, limit=None): + '''Return content from current position up to *limit*.''' + + @abstractmethod + def write(self, content): + '''Write content at current position.''' + + def flush(self): + '''Flush buffers ensuring data written.''' + + def seek(self, offset, whence=os.SEEK_SET): + '''Move internal pointer by *offset*. + + The *whence* argument is optional and defaults to os.SEEK_SET or 0 + (absolute file positioning); other values are os.SEEK_CUR or 1 + (seek relative to the current position) and os.SEEK_END or 2 + (seek relative to the file's end). + + ''' + raise NotImplementedError('Seek not supported.') + + def tell(self): + '''Return current position of internal pointer.''' + raise NotImplementedError('Tell not supported.') + + def close(self): + '''Flush buffers and prevent further access.''' + self.flush() + self.closed = True + + +class FileWrapper(Data): + '''Data wrapper for Python file objects.''' + + def __init__(self, wrapped_file): + '''Initialise access to *wrapped_file*.''' + self.wrapped_file = wrapped_file + self._read_since_last_write = False + super(FileWrapper, self).__init__() + + def read(self, limit=None): + '''Return content from current position up to *limit*.''' + self._read_since_last_write = True + + if limit is None: + limit = -1 + + return self.wrapped_file.read(limit) + + def write(self, content): + '''Write content at current position.''' + if self._read_since_last_write: + # Windows requires a seek before switching from read to write. + self.seek(self.tell()) + + self.wrapped_file.write(content) + self._read_since_last_write = False + + def flush(self): + '''Flush buffers ensuring data written.''' + super(FileWrapper, self).flush() + if hasattr(self.wrapped_file, 'flush'): + self.wrapped_file.flush() + + def seek(self, offset, whence=os.SEEK_SET): + '''Move internal pointer by *offset*.''' + self.wrapped_file.seek(offset, whence) + + def tell(self): + '''Return current position of internal pointer.''' + return self.wrapped_file.tell() + + def close(self): + '''Flush buffers and prevent further access.''' + if not self.closed: + super(FileWrapper, self).close() + if hasattr(self.wrapped_file, 'close'): + self.wrapped_file.close() + + +class File(FileWrapper): + '''Data wrapper accepting filepath.''' + + def __init__(self, path, mode='rb'): + '''Open file at *path* with *mode*.''' + file_object = open(path, mode) + super(File, self).__init__(file_object) + + +class String(FileWrapper): + '''Data wrapper using TemporaryFile instance.''' + + def __init__(self, content=None): + '''Initialise data with *content*.''' + super(String, self).__init__( + tempfile.TemporaryFile() + ) + + if content is not None: + self.wrapped_file.write(content) + self.wrapped_file.seek(0) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/__init__.py new file mode 100644 index 0000000000..1d452f2828 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/asset_version.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/asset_version.py new file mode 100644 index 0000000000..859d94e436 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/asset_version.py @@ -0,0 +1,91 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api.entity.base + + +class AssetVersion(ftrack_api.entity.base.Entity): + '''Represent asset version.''' + + def create_component( + self, path, data=None, location=None + ): + '''Create a new component from *path* with additional *data* + + .. note:: + + This is a helper method. To create components manually use the + standard :meth:`Session.create` method. + + *path* can be a string representing a filesystem path to the data to + use for the component. The *path* can also be specified as a sequence + string, in which case a sequence component with child components for + each item in the sequence will be created automatically. The accepted + format for a sequence is '{head}{padding}{tail} [{ranges}]'. For + example:: + + '/path/to/file.%04d.ext [1-5, 7, 8, 10-20]' + + .. seealso:: + + `Clique documentation `_ + + *data* should be a dictionary of any additional data to construct the + component with (as passed to :meth:`Session.create`). This version is + automatically set as the component's version. + + If *location* is specified then automatically add component to that + location. + + ''' + if data is None: + data = {} + + data.pop('version_id', None) + data['version'] = self + + return self.session.create_component(path, data=data, location=location) + + def encode_media(self, media, keep_original='auto'): + '''Return a new Job that encode *media* to make it playable in browsers. + + *media* can be a path to a file or a FileComponent in the ftrack.server + location. + + The job will encode *media* based on the file type and job data contains + information about encoding in the following format:: + + { + 'output': [{ + 'format': 'video/mp4', + 'component_id': 'e2dc0524-b576-11d3-9612-080027331d74' + }, { + 'format': 'image/jpeg', + 'component_id': '07b82a97-8cf9-11e3-9383-20c9d081909b' + }], + 'source_component_id': 'e3791a09-7e11-4792-a398-3d9d4eefc294', + 'keep_original': True + } + + The output components are associated with the job via the job_components + relation. + + An image component will always be generated if possible, and will be + set as the version's thumbnail. + + The new components will automatically be associated with the version. + A server version of 3.3.32 or higher is required for this to function + properly. + + If *media* is a file path, a new source component will be created and + added to the ftrack server location and a call to :meth:`commit` will be + issued. If *media* is a FileComponent, it will be assumed to be in + available in the ftrack.server location. + + If *keep_original* is not set, the original media will be kept if it + is a FileComponent, and deleted if it is a file path. You can specify + True or False to change this behavior. + ''' + return self.session.encode_media( + media, version_id=self['id'], keep_original=keep_original + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/base.py new file mode 100644 index 0000000000..f5a1a3cec3 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/base.py @@ -0,0 +1,402 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from __future__ import absolute_import + +import abc +import collections +import logging + +import ftrack_api.symbol +import ftrack_api.attribute +import ftrack_api.inspection +import ftrack_api.exception +import ftrack_api.operation +from ftrack_api.logging import LazyLogMessage as L + + +class DynamicEntityTypeMetaclass(abc.ABCMeta): + '''Custom metaclass to customise representation of dynamic classes. + + .. note:: + + Derive from same metaclass as derived bases to avoid conflicts. + + ''' + def __repr__(self): + '''Return representation of class.''' + return ''.format(self.__name__) + + +class Entity(collections.MutableMapping): + '''Base class for all entities.''' + + __metaclass__ = DynamicEntityTypeMetaclass + + entity_type = 'Entity' + attributes = None + primary_key_attributes = None + default_projections = None + + def __init__(self, session, data=None, reconstructing=False): + '''Initialise entity. + + *session* is an instance of :class:`ftrack_api.session.Session` that + this entity instance is bound to. + + *data* is a mapping of key, value pairs to apply as initial attribute + values. + + *reconstructing* indicates whether this entity is being reconstructed, + such as from a query, and therefore should not have any special creation + logic applied, such as initialising defaults for missing data. + + ''' + super(Entity, self).__init__() + self.logger = logging.getLogger( + __name__ + '.' + self.__class__.__name__ + ) + self.session = session + self._inflated = set() + + if data is None: + data = {} + + self.logger.debug(L( + '{0} entity from {1!r}.', + ('Reconstructing' if reconstructing else 'Constructing'), data + )) + + self._ignore_data_keys = ['__entity_type__'] + if not reconstructing: + self._construct(data) + else: + self._reconstruct(data) + + def _construct(self, data): + '''Construct from *data*.''' + # Suspend operation recording so that all modifications can be applied + # in single create operation. In addition, recording a modification + # operation requires a primary key which may not be available yet. + + relational_attributes = dict() + + with self.session.operation_recording(False): + # Set defaults for any unset local attributes. + for attribute in self.__class__.attributes: + if attribute.name not in data: + default_value = attribute.default_value + if callable(default_value): + default_value = default_value(self) + + attribute.set_local_value(self, default_value) + + + # Data represents locally set values. + for key, value in data.items(): + if key in self._ignore_data_keys: + continue + + attribute = self.__class__.attributes.get(key) + if attribute is None: + self.logger.debug(L( + 'Cannot populate {0!r} attribute as no such ' + 'attribute found on entity {1!r}.', key, self + )) + continue + + if not isinstance(attribute, ftrack_api.attribute.ScalarAttribute): + relational_attributes.setdefault( + attribute, value + ) + + else: + attribute.set_local_value(self, value) + + # Record create operation. + # Note: As this operation is recorded *before* any Session.merge takes + # place there is the possibility that the operation will hold references + # to outdated data in entity_data. However, this would be unusual in + # that it would mean the same new entity was created twice and only one + # altered. Conversely, if this operation were recorded *after* + # Session.merge took place, any cache would not be able to determine + # the status of the entity, which could be important if the cache should + # not store newly created entities that have not yet been persisted. Out + # of these two 'evils' this approach is deemed the lesser at this time. + # A third, more involved, approach to satisfy both might be to record + # the operation with a PENDING entity_data value and then update with + # merged values post merge. + if self.session.record_operations: + entity_data = {} + + # Lower level API used here to avoid including any empty + # collections that are automatically generated on access. + for attribute in self.attributes: + value = attribute.get_local_value(self) + if value is not ftrack_api.symbol.NOT_SET: + entity_data[attribute.name] = value + + self.session.recorded_operations.push( + ftrack_api.operation.CreateEntityOperation( + self.entity_type, + ftrack_api.inspection.primary_key(self), + entity_data + ) + ) + + for attribute, value in relational_attributes.items(): + # Finally we set values for "relational" attributes, we need + # to do this at the end in order to get the create operations + # in the correct order as the newly created attributes might + # contain references to the newly created entity. + + attribute.set_local_value( + self, value + ) + + def _reconstruct(self, data): + '''Reconstruct from *data*.''' + # Data represents remote values. + for key, value in data.items(): + if key in self._ignore_data_keys: + continue + + attribute = self.__class__.attributes.get(key) + if attribute is None: + self.logger.debug(L( + 'Cannot populate {0!r} attribute as no such attribute ' + 'found on entity {1!r}.', key, self + )) + continue + + attribute.set_remote_value(self, value) + + def __repr__(self): + '''Return representation of instance.''' + return ''.format( + self.__class__.__name__, id(self) + ) + + def __str__(self): + '''Return string representation of instance.''' + with self.session.auto_populating(False): + primary_key = ['Unknown'] + try: + primary_key = ftrack_api.inspection.primary_key(self).values() + except KeyError: + pass + + return '<{0}({1})>'.format( + self.__class__.__name__, ', '.join(primary_key) + ) + + def __hash__(self): + '''Return hash representing instance.''' + return hash(str(ftrack_api.inspection.identity(self))) + + def __eq__(self, other): + '''Return whether *other* is equal to this instance. + + .. note:: + + Equality is determined by both instances having the same identity. + Values of attributes are not considered. + + ''' + try: + return ( + ftrack_api.inspection.identity(other) + == ftrack_api.inspection.identity(self) + ) + except (AttributeError, KeyError): + return False + + def __getitem__(self, key): + '''Return attribute value for *key*.''' + attribute = self.__class__.attributes.get(key) + if attribute is None: + raise KeyError(key) + + return attribute.get_value(self) + + def __setitem__(self, key, value): + '''Set attribute *value* for *key*.''' + attribute = self.__class__.attributes.get(key) + if attribute is None: + raise KeyError(key) + + attribute.set_local_value(self, value) + + def __delitem__(self, key): + '''Clear attribute value for *key*. + + .. note:: + + Will not remove the attribute, but instead clear any local value + and revert to the last known server value. + + ''' + attribute = self.__class__.attributes.get(key) + attribute.set_local_value(self, ftrack_api.symbol.NOT_SET) + + def __iter__(self): + '''Iterate over all attributes keys.''' + for attribute in self.__class__.attributes: + yield attribute.name + + def __len__(self): + '''Return count of attributes.''' + return len(self.__class__.attributes) + + def values(self): + '''Return list of values.''' + if self.session.auto_populate: + self._populate_unset_scalar_attributes() + + return super(Entity, self).values() + + def items(self): + '''Return list of tuples of (key, value) pairs. + + .. note:: + + Will fetch all values from the server if not already fetched or set + locally. + + ''' + if self.session.auto_populate: + self._populate_unset_scalar_attributes() + + return super(Entity, self).items() + + def clear(self): + '''Reset all locally modified attribute values.''' + for attribute in self: + del self[attribute] + + def merge(self, entity, merged=None): + '''Merge *entity* attribute values and other data into this entity. + + Only merge values from *entity* that are not + :attr:`ftrack_api.symbol.NOT_SET`. + + Return a list of changes made with each change being a mapping with + the keys: + + * type - Either 'remote_attribute', 'local_attribute' or 'property'. + * name - The name of the attribute / property modified. + * old_value - The previous value. + * new_value - The new merged value. + + ''' + log_debug = self.logger.isEnabledFor(logging.DEBUG) + + if merged is None: + merged = {} + + log_message = 'Merged {type} "{name}": {old_value!r} -> {new_value!r}' + changes = [] + + # Attributes. + + # Prioritise by type so that scalar values are set first. This should + # guarantee that the attributes making up the identity of the entity + # are merged before merging any collections that may have references to + # this entity. + attributes = collections.deque() + for attribute in entity.attributes: + if isinstance(attribute, ftrack_api.attribute.ScalarAttribute): + attributes.appendleft(attribute) + else: + attributes.append(attribute) + + for other_attribute in attributes: + attribute = self.attributes.get(other_attribute.name) + + # Local attributes. + other_local_value = other_attribute.get_local_value(entity) + if other_local_value is not ftrack_api.symbol.NOT_SET: + local_value = attribute.get_local_value(self) + if local_value != other_local_value: + merged_local_value = self.session.merge( + other_local_value, merged=merged + ) + + attribute.set_local_value(self, merged_local_value) + changes.append({ + 'type': 'local_attribute', + 'name': attribute.name, + 'old_value': local_value, + 'new_value': merged_local_value + }) + log_debug and self.logger.debug( + log_message.format(**changes[-1]) + ) + + # Remote attributes. + other_remote_value = other_attribute.get_remote_value(entity) + if other_remote_value is not ftrack_api.symbol.NOT_SET: + remote_value = attribute.get_remote_value(self) + if remote_value != other_remote_value: + merged_remote_value = self.session.merge( + other_remote_value, merged=merged + ) + + attribute.set_remote_value( + self, merged_remote_value + ) + + changes.append({ + 'type': 'remote_attribute', + 'name': attribute.name, + 'old_value': remote_value, + 'new_value': merged_remote_value + }) + + log_debug and self.logger.debug( + log_message.format(**changes[-1]) + ) + + # We need to handle collections separately since + # they may store a local copy of the remote attribute + # even though it may not be modified. + if not isinstance( + attribute, ftrack_api.attribute.AbstractCollectionAttribute + ): + continue + + local_value = attribute.get_local_value( + self + ) + + # Populated but not modified, update it. + if ( + local_value is not ftrack_api.symbol.NOT_SET and + local_value == remote_value + ): + attribute.set_local_value( + self, merged_remote_value + ) + changes.append({ + 'type': 'local_attribute', + 'name': attribute.name, + 'old_value': local_value, + 'new_value': merged_remote_value + }) + + log_debug and self.logger.debug( + log_message.format(**changes[-1]) + ) + + return changes + + def _populate_unset_scalar_attributes(self): + '''Populate all unset scalar attributes in one query.''' + projections = [] + for attribute in self.attributes: + if isinstance(attribute, ftrack_api.attribute.ScalarAttribute): + if attribute.get_remote_value(self) is ftrack_api.symbol.NOT_SET: + projections.append(attribute.name) + + if projections: + self.session.populate([self], ', '.join(projections)) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/component.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/component.py new file mode 100644 index 0000000000..9d59c4c051 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/component.py @@ -0,0 +1,74 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api.entity.base + + +class Component(ftrack_api.entity.base.Entity): + '''Represent a component.''' + + def get_availability(self, locations=None): + '''Return availability in *locations*. + + If *locations* is None, all known locations will be checked. + + Return a dictionary of {location_id:percentage_availability} + + ''' + return self.session.get_component_availability( + self, locations=locations + ) + + +class CreateThumbnailMixin(object): + '''Mixin to add create_thumbnail method on entity class.''' + + def create_thumbnail(self, path, data=None): + '''Set entity thumbnail from *path*. + + Creates a thumbnail component using in the ftrack.server location + :meth:`Session.create_component + ` The thumbnail component + will be created using *data* if specified. If no component name is + given, `thumbnail` will be used. + + The file is expected to be of an appropriate size and valid file + type. + + .. note:: + + A :meth:`Session.commit` will be + automatically issued. + + ''' + if data is None: + data = {} + if not data.get('name'): + data['name'] = 'thumbnail' + + thumbnail_component = self.session.create_component( + path, data, location=None + ) + + origin_location = self.session.get( + 'Location', ftrack_api.symbol.ORIGIN_LOCATION_ID + ) + server_location = self.session.get( + 'Location', ftrack_api.symbol.SERVER_LOCATION_ID + ) + server_location.add_component(thumbnail_component, [origin_location]) + + # TODO: This commit can be avoided by reordering the operations in + # this method so that the component is transferred to ftrack.server + # after the thumbnail has been set. + # + # There is currently a bug in the API backend, causing the operations + # to *some* times be ordered wrongly, where the update occurs before + # the component has been created, causing an integrity error. + # + # Once this issue has been resolved, this commit can be removed and + # and the update placed between component creation and registration. + self['thumbnail_id'] = thumbnail_component['id'] + self.session.commit() + + return thumbnail_component diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/factory.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/factory.py new file mode 100644 index 0000000000..e925b70f5a --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/factory.py @@ -0,0 +1,435 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from __future__ import absolute_import + +import logging +import uuid +import functools + +import ftrack_api.attribute +import ftrack_api.entity.base +import ftrack_api.entity.location +import ftrack_api.entity.component +import ftrack_api.entity.asset_version +import ftrack_api.entity.project_schema +import ftrack_api.entity.note +import ftrack_api.entity.job +import ftrack_api.entity.user +import ftrack_api.symbol +import ftrack_api.cache +from ftrack_api.logging import LazyLogMessage as L + + +class Factory(object): + '''Entity class factory.''' + + def __init__(self): + '''Initialise factory.''' + super(Factory, self).__init__() + self.logger = logging.getLogger( + __name__ + '.' + self.__class__.__name__ + ) + + def create(self, schema, bases=None): + '''Create and return entity class from *schema*. + + *bases* should be a list of bases to give the constructed class. If not + specified, default to :class:`ftrack_api.entity.base.Entity`. + + ''' + entity_type = schema['id'] + class_name = entity_type + + class_bases = bases + if class_bases is None: + class_bases = [ftrack_api.entity.base.Entity] + + class_namespace = dict() + + # Build attributes for class. + attributes = ftrack_api.attribute.Attributes() + immutable_properties = schema.get('immutable', []) + computed_properties = schema.get('computed', []) + for name, fragment in schema.get('properties', {}).items(): + mutable = name not in immutable_properties + computed = name in computed_properties + + default = fragment.get('default', ftrack_api.symbol.NOT_SET) + if default == '{uid}': + default = lambda instance: str(uuid.uuid4()) + + data_type = fragment.get('type', ftrack_api.symbol.NOT_SET) + + if data_type is not ftrack_api.symbol.NOT_SET: + + if data_type in ( + 'string', 'boolean', 'integer', 'number', 'variable', + 'object' + ): + # Basic scalar attribute. + if data_type == 'number': + data_type = 'float' + + if data_type == 'string': + data_format = fragment.get('format') + if data_format == 'date-time': + data_type = 'datetime' + + attribute = self.create_scalar_attribute( + class_name, name, mutable, computed, default, data_type + ) + if attribute: + attributes.add(attribute) + + elif data_type == 'array': + attribute = self.create_collection_attribute( + class_name, name, mutable + ) + if attribute: + attributes.add(attribute) + + elif data_type == 'mapped_array': + reference = fragment.get('items', {}).get('$ref') + if not reference: + self.logger.debug(L( + 'Skipping {0}.{1} mapped_array attribute that does ' + 'not define a schema reference.', class_name, name + )) + continue + + attribute = self.create_mapped_collection_attribute( + class_name, name, mutable, reference + ) + if attribute: + attributes.add(attribute) + + else: + self.logger.debug(L( + 'Skipping {0}.{1} attribute with unrecognised data ' + 'type {2}', class_name, name, data_type + )) + else: + # Reference attribute. + reference = fragment.get('$ref', ftrack_api.symbol.NOT_SET) + if reference is ftrack_api.symbol.NOT_SET: + self.logger.debug(L( + 'Skipping {0}.{1} mapped_array attribute that does ' + 'not define a schema reference.', class_name, name + )) + continue + + attribute = self.create_reference_attribute( + class_name, name, mutable, reference + ) + if attribute: + attributes.add(attribute) + + default_projections = schema.get('default_projections', []) + + # Construct class. + class_namespace['entity_type'] = entity_type + class_namespace['attributes'] = attributes + class_namespace['primary_key_attributes'] = schema['primary_key'][:] + class_namespace['default_projections'] = default_projections + + cls = type( + str(class_name), # type doesn't accept unicode. + tuple(class_bases), + class_namespace + ) + + return cls + + def create_scalar_attribute( + self, class_name, name, mutable, computed, default, data_type + ): + '''Return appropriate scalar attribute instance.''' + return ftrack_api.attribute.ScalarAttribute( + name, data_type=data_type, default_value=default, mutable=mutable, + computed=computed + ) + + def create_reference_attribute(self, class_name, name, mutable, reference): + '''Return appropriate reference attribute instance.''' + return ftrack_api.attribute.ReferenceAttribute( + name, reference, mutable=mutable + ) + + def create_collection_attribute(self, class_name, name, mutable): + '''Return appropriate collection attribute instance.''' + return ftrack_api.attribute.CollectionAttribute( + name, mutable=mutable + ) + + def create_mapped_collection_attribute( + self, class_name, name, mutable, reference + ): + '''Return appropriate mapped collection attribute instance.''' + self.logger.debug(L( + 'Skipping {0}.{1} mapped_array attribute that has ' + 'no implementation defined for reference {2}.', + class_name, name, reference + )) + + +class PerSessionDefaultKeyMaker(ftrack_api.cache.KeyMaker): + '''Generate key for defaults.''' + + def _key(self, obj): + '''Return key for *obj*.''' + if isinstance(obj, dict): + entity = obj.get('entity') + if entity is not None: + # Key by session only. + return str(id(entity.session)) + + return str(obj) + + +#: Memoiser for use with default callables that should only be called once per +# session. +memoise_defaults = ftrack_api.cache.memoise_decorator( + ftrack_api.cache.Memoiser( + key_maker=PerSessionDefaultKeyMaker(), return_copies=False + ) +) + +#: Memoiser for use with callables that should be called once per session. +memoise_session = ftrack_api.cache.memoise_decorator( + ftrack_api.cache.Memoiser( + key_maker=PerSessionDefaultKeyMaker(), return_copies=False + ) +) + + +@memoise_session +def _get_custom_attribute_configurations(session): + '''Return list of custom attribute configurations. + + The configuration objects will have key, project_id, id and object_type_id + populated. + + ''' + return session.query( + 'select key, project_id, id, object_type_id, entity_type, ' + 'is_hierarchical from CustomAttributeConfiguration' + ).all() + + +def _get_entity_configurations(entity): + '''Return all configurations for current collection entity.''' + entity_type = None + project_id = None + object_type_id = None + + if 'object_type_id' in entity.keys(): + project_id = entity['project_id'] + entity_type = 'task' + object_type_id = entity['object_type_id'] + + if entity.entity_type == 'AssetVersion': + project_id = entity['asset']['parent']['project_id'] + entity_type = 'assetversion' + + if entity.entity_type == 'Project': + project_id = entity['id'] + entity_type = 'show' + + if entity.entity_type == 'User': + entity_type = 'user' + + if entity.entity_type == 'Asset': + entity_type = 'asset' + + if entity.entity_type in ('TypedContextList', 'AssetVersionList'): + entity_type = 'list' + + if entity_type is None: + raise ValueError( + 'Entity {!r} not supported.'.format(entity) + ) + + configurations = [] + for configuration in _get_custom_attribute_configurations( + entity.session + ): + if ( + configuration['entity_type'] == entity_type and + configuration['project_id'] in (project_id, None) and + configuration['object_type_id'] == object_type_id + ): + # The custom attribute configuration is for the target entity type. + configurations.append(configuration) + elif ( + entity_type in ('asset', 'assetversion', 'show', 'task') and + configuration['project_id'] in (project_id, None) and + configuration['is_hierarchical'] + ): + # The target entity type allows hierarchical attributes. + configurations.append(configuration) + + # Return with global configurations at the end of the list. This is done + # so that global conigurations are shadowed by project specific if the + # configurations list is looped when looking for a matching `key`. + return sorted( + configurations, key=lambda item: item['project_id'] is None + ) + + +class StandardFactory(Factory): + '''Standard entity class factory.''' + + def create(self, schema, bases=None): + '''Create and return entity class from *schema*.''' + if not bases: + bases = [] + + extra_bases = [] + # Customise classes. + if schema['id'] == 'ProjectSchema': + extra_bases = [ftrack_api.entity.project_schema.ProjectSchema] + + elif schema['id'] == 'Location': + extra_bases = [ftrack_api.entity.location.Location] + + elif schema['id'] == 'AssetVersion': + extra_bases = [ftrack_api.entity.asset_version.AssetVersion] + + elif schema['id'].endswith('Component'): + extra_bases = [ftrack_api.entity.component.Component] + + elif schema['id'] == 'Note': + extra_bases = [ftrack_api.entity.note.Note] + + elif schema['id'] == 'Job': + extra_bases = [ftrack_api.entity.job.Job] + + elif schema['id'] == 'User': + extra_bases = [ftrack_api.entity.user.User] + + bases = extra_bases + bases + + # If bases does not contain any items, add the base entity class. + if not bases: + bases = [ftrack_api.entity.base.Entity] + + # Add mixins. + if 'notes' in schema.get('properties', {}): + bases.append( + ftrack_api.entity.note.CreateNoteMixin + ) + + if 'thumbnail_id' in schema.get('properties', {}): + bases.append( + ftrack_api.entity.component.CreateThumbnailMixin + ) + + cls = super(StandardFactory, self).create(schema, bases=bases) + + return cls + + def create_mapped_collection_attribute( + self, class_name, name, mutable, reference + ): + '''Return appropriate mapped collection attribute instance.''' + if reference == 'Metadata': + + def create_metadata(proxy, data, reference): + '''Return metadata for *data*.''' + entity = proxy.collection.entity + session = entity.session + data.update({ + 'parent_id': entity['id'], + 'parent_type': entity.entity_type + }) + return session.create(reference, data) + + creator = functools.partial( + create_metadata, reference=reference + ) + key_attribute = 'key' + value_attribute = 'value' + + return ftrack_api.attribute.KeyValueMappedCollectionAttribute( + name, creator, key_attribute, value_attribute, mutable=mutable + ) + + elif reference == 'CustomAttributeValue': + return ( + ftrack_api.attribute.CustomAttributeCollectionAttribute( + name, mutable=mutable + ) + ) + + elif reference.endswith('CustomAttributeValue'): + def creator(proxy, data): + '''Create a custom attribute based on *proxy* and *data*. + + Raise :py:exc:`KeyError` if related entity is already presisted + to the server. The proxy represents dense custom attribute + values and should never create new custom attribute values + through the proxy if entity exists on the remote. + + If the entity is not persisted the ususal + CustomAttributeValue items cannot be updated as + the related entity does not exist on remote and values not in + the proxy. Instead a CustomAttributeValue will + be reconstructed and an update operation will be recorded. + + ''' + entity = proxy.collection.entity + if ( + ftrack_api.inspection.state(entity) is not + ftrack_api.symbol.CREATED + ): + raise KeyError( + 'Custom attributes must be created explicitly for the ' + 'given entity type before being set.' + ) + + configuration = None + for candidate in _get_entity_configurations(entity): + if candidate['key'] == data['key']: + configuration = candidate + break + + if configuration is None: + raise ValueError( + u'No valid custom attribute for data {0!r} was found.' + .format(data) + ) + + create_data = dict(data.items()) + create_data['configuration_id'] = configuration['id'] + create_data['entity_id'] = entity['id'] + + session = entity.session + + # Create custom attribute by reconstructing it and update the + # value. This will prevent a create operation to be sent to the + # remote, as create operations for this entity type is not + # allowed. Instead an update operation will be recorded. + value = create_data.pop('value') + item = session.create( + reference, + create_data, + reconstructing=True + ) + + # Record update operation. + item['value'] = value + + return item + + key_attribute = 'key' + value_attribute = 'value' + + return ftrack_api.attribute.KeyValueMappedCollectionAttribute( + name, creator, key_attribute, value_attribute, mutable=mutable + ) + + self.logger.debug(L( + 'Skipping {0}.{1} mapped_array attribute that has no configuration ' + 'for reference {2}.', class_name, name, reference + )) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/job.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/job.py new file mode 100644 index 0000000000..ae37922c51 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/job.py @@ -0,0 +1,48 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api.entity.base + + +class Job(ftrack_api.entity.base.Entity): + '''Represent job.''' + + def __init__(self, session, data=None, reconstructing=False): + '''Initialise entity. + + *session* is an instance of :class:`ftrack_api.session.Session` that + this entity instance is bound to. + + *data* is a mapping of key, value pairs to apply as initial attribute + values. + + To set a job `description` visible in the web interface, *data* can + contain a key called `data` which should be a JSON serialised + dictionary containing description:: + + data = { + 'status': 'running', + 'data': json.dumps(dict(description='My job description.')), + ... + } + + Will raise a :py:exc:`ValueError` if *data* contains `type` and `type` + is set to something not equal to "api_job". + + *reconstructing* indicates whether this entity is being reconstructed, + such as from a query, and therefore should not have any special creation + logic applied, such as initialising defaults for missing data. + + ''' + + if not reconstructing: + if data.get('type') not in ('api_job', None): + raise ValueError( + 'Invalid job type "{0}". Must be "api_job"'.format( + data.get('type') + ) + ) + + super(Job, self).__init__( + session, data=data, reconstructing=reconstructing + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/location.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/location.py new file mode 100644 index 0000000000..707f4fa652 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/location.py @@ -0,0 +1,733 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import collections +import functools + +import ftrack_api.entity.base +import ftrack_api.exception +import ftrack_api.event.base +import ftrack_api.symbol +import ftrack_api.inspection +from ftrack_api.logging import LazyLogMessage as L + + +class Location(ftrack_api.entity.base.Entity): + '''Represent storage for components.''' + + def __init__(self, session, data=None, reconstructing=False): + '''Initialise entity. + + *session* is an instance of :class:`ftrack_api.session.Session` that + this entity instance is bound to. + + *data* is a mapping of key, value pairs to apply as initial attribute + values. + + *reconstructing* indicates whether this entity is being reconstructed, + such as from a query, and therefore should not have any special creation + logic applied, such as initialising defaults for missing data. + + ''' + self.accessor = ftrack_api.symbol.NOT_SET + self.structure = ftrack_api.symbol.NOT_SET + self.resource_identifier_transformer = ftrack_api.symbol.NOT_SET + self.priority = 95 + super(Location, self).__init__( + session, data=data, reconstructing=reconstructing + ) + + def __str__(self): + '''Return string representation of instance.''' + representation = super(Location, self).__str__() + + with self.session.auto_populating(False): + name = self['name'] + if name is not ftrack_api.symbol.NOT_SET: + representation = representation.replace( + '(', '("{0}", '.format(name) + ) + + return representation + + def add_component(self, component, source, recursive=True): + '''Add *component* to location. + + *component* should be a single component instance. + + *source* should be an instance of another location that acts as the + source. + + Raise :exc:`ftrack_api.ComponentInLocationError` if the *component* + already exists in this location. + + Raise :exc:`ftrack_api.LocationError` if managing data and the generated + target structure for the component already exists according to the + accessor. This helps prevent potential data loss by avoiding overwriting + existing data. Note that there is a race condition between the check and + the write so if another process creates data at the same target during + that period it will be overwritten. + + .. note:: + + A :meth:`Session.commit` may be + automatically issued as part of the component registration. + + ''' + return self.add_components( + [component], sources=source, recursive=recursive + ) + + def add_components(self, components, sources, recursive=True, _depth=0): + '''Add *components* to location. + + *components* should be a list of component instances. + + *sources* may be either a single source or a list of sources. If a list + then each corresponding index in *sources* will be used for each + *component*. A source should be an instance of another location. + + Raise :exc:`ftrack_api.exception.ComponentInLocationError` if any + component in *components* already exists in this location. In this case, + no changes will be made and no data transferred. + + Raise :exc:`ftrack_api.exception.LocationError` if managing data and the + generated target structure for the component already exists according to + the accessor. This helps prevent potential data loss by avoiding + overwriting existing data. Note that there is a race condition between + the check and the write so if another process creates data at the same + target during that period it will be overwritten. + + .. note:: + + A :meth:`Session.commit` may be + automatically issued as part of the components registration. + + .. important:: + + If this location manages data then the *components* data is first + transferred to the target prescribed by the structure plugin, using + the configured accessor. If any component fails to transfer then + :exc:`ftrack_api.exception.LocationError` is raised and none of the + components are registered with the database. In this case it is left + up to the caller to decide and act on manually cleaning up any + transferred data using the 'transferred' detail in the raised error. + + Likewise, after transfer, all components are registered with the + database in a batch call. If any component causes an error then all + components will remain unregistered and + :exc:`ftrack_api.exception.LocationError` will be raised detailing + issues and any transferred data under the 'transferred' detail key. + + ''' + if ( + isinstance(sources, basestring) + or not isinstance(sources, collections.Sequence) + ): + sources = [sources] + + sources_count = len(sources) + if sources_count not in (1, len(components)): + raise ValueError( + 'sources must be either a single source or a sequence of ' + 'sources with indexes corresponding to passed components.' + ) + + if not self.structure: + raise ftrack_api.exception.LocationError( + 'No structure defined for location {location}.', + details=dict(location=self) + ) + + if not components: + # Optimisation: Return early when no components to process, such as + # when called recursively on an empty sequence component. + return + + indent = ' ' * (_depth + 1) + + # Check that components not already added to location. + existing_components = [] + try: + self.get_resource_identifiers(components) + + except ftrack_api.exception.ComponentNotInLocationError as error: + missing_component_ids = [ + missing_component['id'] + for missing_component in error.details['components'] + ] + for component in components: + if component['id'] not in missing_component_ids: + existing_components.append(component) + + else: + existing_components.extend(components) + + if existing_components: + # Some of the components already present in location. + raise ftrack_api.exception.ComponentInLocationError( + existing_components, self + ) + + # Attempt to transfer each component's data to this location. + transferred = [] + + for index, component in enumerate(components): + try: + # Determine appropriate source. + if sources_count == 1: + source = sources[0] + else: + source = sources[index] + + # Add members first for container components. + is_container = 'members' in component.keys() + if is_container and recursive: + self.add_components( + component['members'], source, recursive=recursive, + _depth=(_depth + 1) + ) + + # Add component to this location. + context = self._get_context(component, source) + resource_identifier = self.structure.get_resource_identifier( + component, context + ) + + # Manage data transfer. + self._add_data(component, resource_identifier, source) + + except Exception as error: + raise ftrack_api.exception.LocationError( + 'Failed to transfer component {component} data to location ' + '{location} due to error:\n{indent}{error}\n{indent}' + 'Transferred component data that may require cleanup: ' + '{transferred}', + details=dict( + indent=indent, + component=component, + location=self, + error=error, + transferred=transferred + ) + ) + + else: + transferred.append((component, resource_identifier)) + + # Register all successfully transferred components. + components_to_register = [] + component_resource_identifiers = [] + + try: + for component, resource_identifier in transferred: + if self.resource_identifier_transformer: + # Optionally encode resource identifier before storing. + resource_identifier = ( + self.resource_identifier_transformer.encode( + resource_identifier, + context={'component': component} + ) + ) + + components_to_register.append(component) + component_resource_identifiers.append(resource_identifier) + + # Store component in location information. + self._register_components_in_location( + components, component_resource_identifiers + ) + + except Exception as error: + raise ftrack_api.exception.LocationError( + 'Failed to register components with location {location} due to ' + 'error:\n{indent}{error}\n{indent}Transferred component data ' + 'that may require cleanup: {transferred}', + details=dict( + indent=indent, + location=self, + error=error, + transferred=transferred + ) + ) + + # Publish events. + for component in components_to_register: + + component_id = ftrack_api.inspection.primary_key( + component + ).values()[0] + location_id = ftrack_api.inspection.primary_key(self).values()[0] + + self.session.event_hub.publish( + ftrack_api.event.base.Event( + topic=ftrack_api.symbol.COMPONENT_ADDED_TO_LOCATION_TOPIC, + data=dict( + component_id=component_id, + location_id=location_id + ), + ), + on_error='ignore' + ) + + def _get_context(self, component, source): + '''Return context for *component* and *source*.''' + context = {} + if source: + try: + source_resource_identifier = source.get_resource_identifier( + component + ) + except ftrack_api.exception.ComponentNotInLocationError: + pass + else: + context.update(dict( + source_resource_identifier=source_resource_identifier + )) + + return context + + def _add_data(self, component, resource_identifier, source): + '''Manage transfer of *component* data from *source*. + + *resource_identifier* specifies the identifier to use with this + locations accessor. + + ''' + self.logger.debug(L( + 'Adding data for component {0!r} from source {1!r} to location ' + '{2!r} using resource identifier {3!r}.', + component, resource_identifier, source, self + )) + + # Read data from source and write to this location. + if not source.accessor: + raise ftrack_api.exception.LocationError( + 'No accessor defined for source location {location}.', + details=dict(location=source) + ) + + if not self.accessor: + raise ftrack_api.exception.LocationError( + 'No accessor defined for target location {location}.', + details=dict(location=self) + ) + + is_container = 'members' in component.keys() + if is_container: + # TODO: Improve this check. Possibly introduce an inspection + # such as ftrack_api.inspection.is_sequence_component. + if component.entity_type != 'SequenceComponent': + self.accessor.make_container(resource_identifier) + + else: + # Try to make container of component. + try: + container = self.accessor.get_container( + resource_identifier + ) + + except ftrack_api.exception.AccessorParentResourceNotFoundError: + # Container could not be retrieved from + # resource_identifier. Assume that there is no need to + # make the container. + pass + + else: + # No need for existence check as make_container does not + # recreate existing containers. + self.accessor.make_container(container) + + if self.accessor.exists(resource_identifier): + # Note: There is a race condition here in that the + # data may be added externally between the check for + # existence and the actual write which would still + # result in potential data loss. However, there is no + # good cross platform, cross accessor solution for this + # at present. + raise ftrack_api.exception.LocationError( + 'Cannot add component as data already exists and ' + 'overwriting could result in data loss. Computed ' + 'target resource identifier was: {0}' + .format(resource_identifier) + ) + + # Read and write data. + source_data = source.accessor.open( + source.get_resource_identifier(component), 'rb' + ) + target_data = self.accessor.open(resource_identifier, 'wb') + + # Read/write data in chunks to avoid reading all into memory at the + # same time. + chunked_read = functools.partial( + source_data.read, ftrack_api.symbol.CHUNK_SIZE + ) + for chunk in iter(chunked_read, ''): + target_data.write(chunk) + + target_data.close() + source_data.close() + + def _register_component_in_location(self, component, resource_identifier): + '''Register *component* in location against *resource_identifier*.''' + return self._register_components_in_location( + [component], [resource_identifier] + ) + + def _register_components_in_location( + self, components, resource_identifiers + ): + '''Register *components* in location against *resource_identifiers*. + + Indices of *components* and *resource_identifiers* should align. + + ''' + for component, resource_identifier in zip( + components, resource_identifiers + ): + self.session.create( + 'ComponentLocation', data=dict( + component=component, + location=self, + resource_identifier=resource_identifier + ) + ) + + self.session.commit() + + def remove_component(self, component, recursive=True): + '''Remove *component* from location. + + .. note:: + + A :meth:`Session.commit` may be + automatically issued as part of the component deregistration. + + ''' + return self.remove_components([component], recursive=recursive) + + def remove_components(self, components, recursive=True): + '''Remove *components* from location. + + .. note:: + + A :meth:`Session.commit` may be + automatically issued as part of the components deregistration. + + ''' + for component in components: + # Check component is in this location + self.get_resource_identifier(component) + + # Remove members first for container components. + is_container = 'members' in component.keys() + if is_container and recursive: + self.remove_components( + component['members'], recursive=recursive + ) + + # Remove data. + self._remove_data(component) + + # Remove metadata. + self._deregister_component_in_location(component) + + # Emit event. + component_id = ftrack_api.inspection.primary_key( + component + ).values()[0] + location_id = ftrack_api.inspection.primary_key(self).values()[0] + self.session.event_hub.publish( + ftrack_api.event.base.Event( + topic=ftrack_api.symbol.COMPONENT_REMOVED_FROM_LOCATION_TOPIC, + data=dict( + component_id=component_id, + location_id=location_id + ) + ), + on_error='ignore' + ) + + def _remove_data(self, component): + '''Remove data associated with *component*.''' + if not self.accessor: + raise ftrack_api.exception.LocationError( + 'No accessor defined for location {location}.', + details=dict(location=self) + ) + + try: + self.accessor.remove( + self.get_resource_identifier(component) + ) + except ftrack_api.exception.AccessorResourceNotFoundError: + # If accessor does not support detecting sequence paths then an + # AccessorResourceNotFoundError is raised. For now, if the + # component type is 'SequenceComponent' assume success. + if not component.entity_type == 'SequenceComponent': + raise + + def _deregister_component_in_location(self, component): + '''Deregister *component* from location.''' + component_id = ftrack_api.inspection.primary_key(component).values()[0] + location_id = ftrack_api.inspection.primary_key(self).values()[0] + + # TODO: Use session.get for optimisation. + component_location = self.session.query( + 'ComponentLocation where component_id is {0} and location_id is ' + '{1}'.format(component_id, location_id) + )[0] + + self.session.delete(component_location) + + # TODO: Should auto-commit here be optional? + self.session.commit() + + def get_component_availability(self, component): + '''Return availability of *component* in this location as a float.''' + return self.session.get_component_availability( + component, locations=[self] + )[self['id']] + + def get_component_availabilities(self, components): + '''Return availabilities of *components* in this location. + + Return list of float values corresponding to each component. + + ''' + return [ + availability[self['id']] for availability in + self.session.get_component_availabilities( + components, locations=[self] + ) + ] + + def get_resource_identifier(self, component): + '''Return resource identifier for *component*. + + Raise :exc:`ftrack_api.exception.ComponentNotInLocationError` if the + component is not present in this location. + + ''' + return self.get_resource_identifiers([component])[0] + + def get_resource_identifiers(self, components): + '''Return resource identifiers for *components*. + + Raise :exc:`ftrack_api.exception.ComponentNotInLocationError` if any + of the components are not present in this location. + + ''' + resource_identifiers = self._get_resource_identifiers(components) + + # Optionally decode resource identifier. + if self.resource_identifier_transformer: + for index, resource_identifier in enumerate(resource_identifiers): + resource_identifiers[index] = ( + self.resource_identifier_transformer.decode( + resource_identifier, + context={'component': components[index]} + ) + ) + + return resource_identifiers + + def _get_resource_identifiers(self, components): + '''Return resource identifiers for *components*. + + Raise :exc:`ftrack_api.exception.ComponentNotInLocationError` if any + of the components are not present in this location. + + ''' + component_ids_mapping = collections.OrderedDict() + for component in components: + component_id = ftrack_api.inspection.primary_key( + component + ).values()[0] + component_ids_mapping[component_id] = component + + component_locations = self.session.query( + 'select component_id, resource_identifier from ComponentLocation ' + 'where location_id is {0} and component_id in ({1})' + .format( + ftrack_api.inspection.primary_key(self).values()[0], + ', '.join(component_ids_mapping.keys()) + ) + ) + + resource_identifiers_map = {} + for component_location in component_locations: + resource_identifiers_map[component_location['component_id']] = ( + component_location['resource_identifier'] + ) + + resource_identifiers = [] + missing = [] + for component_id, component in component_ids_mapping.items(): + if component_id not in resource_identifiers_map: + missing.append(component) + else: + resource_identifiers.append( + resource_identifiers_map[component_id] + ) + + if missing: + raise ftrack_api.exception.ComponentNotInLocationError( + missing, self + ) + + return resource_identifiers + + def get_filesystem_path(self, component): + '''Return filesystem path for *component*.''' + return self.get_filesystem_paths([component])[0] + + def get_filesystem_paths(self, components): + '''Return filesystem paths for *components*.''' + resource_identifiers = self.get_resource_identifiers(components) + + filesystem_paths = [] + for resource_identifier in resource_identifiers: + filesystem_paths.append( + self.accessor.get_filesystem_path(resource_identifier) + ) + + return filesystem_paths + + def get_url(self, component): + '''Return url for *component*. + + Raise :exc:`~ftrack_api.exception.AccessorFilesystemPathError` if + URL could not be determined from *component* or + :exc:`~ftrack_api.exception.AccessorUnsupportedOperationError` if + retrieving URL is not supported by the location's accessor. + ''' + resource_identifier = self.get_resource_identifier(component) + + return self.accessor.get_url(resource_identifier) + + +class MemoryLocationMixin(object): + '''Represent storage for components. + + Unlike a standard location, only store metadata for components in this + location in memory rather than persisting to the database. + + ''' + + @property + def _cache(self): + '''Return cache.''' + try: + cache = self.__cache + except AttributeError: + cache = self.__cache = {} + + return cache + + def _register_component_in_location(self, component, resource_identifier): + '''Register *component* in location with *resource_identifier*.''' + component_id = ftrack_api.inspection.primary_key(component).values()[0] + self._cache[component_id] = resource_identifier + + def _register_components_in_location( + self, components, resource_identifiers + ): + '''Register *components* in location against *resource_identifiers*. + + Indices of *components* and *resource_identifiers* should align. + + ''' + for component, resource_identifier in zip( + components, resource_identifiers + ): + self._register_component_in_location(component, resource_identifier) + + def _deregister_component_in_location(self, component): + '''Deregister *component* in location.''' + component_id = ftrack_api.inspection.primary_key(component).values()[0] + self._cache.pop(component_id) + + def _get_resource_identifiers(self, components): + '''Return resource identifiers for *components*. + + Raise :exc:`ftrack_api.exception.ComponentNotInLocationError` if any + of the referenced components are not present in this location. + + ''' + resource_identifiers = [] + missing = [] + for component in components: + component_id = ftrack_api.inspection.primary_key( + component + ).values()[0] + resource_identifier = self._cache.get(component_id) + if resource_identifier is None: + missing.append(component) + else: + resource_identifiers.append(resource_identifier) + + if missing: + raise ftrack_api.exception.ComponentNotInLocationError( + missing, self + ) + + return resource_identifiers + + +class UnmanagedLocationMixin(object): + '''Location that does not manage data.''' + + def _add_data(self, component, resource_identifier, source): + '''Manage transfer of *component* data from *source*. + + *resource_identifier* specifies the identifier to use with this + locations accessor. + + Overridden to have no effect. + + ''' + return + + def _remove_data(self, component): + '''Remove data associated with *component*. + + Overridden to have no effect. + + ''' + return + + +class OriginLocationMixin(MemoryLocationMixin, UnmanagedLocationMixin): + '''Special origin location that expects sources as filepaths.''' + + def _get_context(self, component, source): + '''Return context for *component* and *source*.''' + context = {} + if source: + context.update(dict( + source_resource_identifier=source + )) + + return context + + +class ServerLocationMixin(object): + '''Location representing ftrack server. + + Adds convenience methods to location, specific to ftrack server. + ''' + def get_thumbnail_url(self, component, size=None): + '''Return thumbnail url for *component*. + + Optionally, specify *size* to constrain the downscaled image to size + x size pixels. + + Raise :exc:`~ftrack_api.exception.AccessorFilesystemPathError` if + URL could not be determined from *resource_identifier* or + :exc:`~ftrack_api.exception.AccessorUnsupportedOperationError` if + retrieving URL is not supported by the location's accessor. + ''' + resource_identifier = self.get_resource_identifier(component) + return self.accessor.get_thumbnail_url(resource_identifier, size) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/note.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/note.py new file mode 100644 index 0000000000..f5a9403728 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/note.py @@ -0,0 +1,105 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import warnings + +import ftrack_api.entity.base + + +class Note(ftrack_api.entity.base.Entity): + '''Represent a note.''' + + def create_reply( + self, content, author + ): + '''Create a reply with *content* and *author*. + + .. note:: + + This is a helper method. To create replies manually use the + standard :meth:`Session.create` method. + + ''' + reply = self.session.create( + 'Note', { + 'author': author, + 'content': content + } + ) + + self['replies'].append(reply) + + return reply + + +class CreateNoteMixin(object): + '''Mixin to add create_note method on entity class.''' + + def create_note( + self, content, author, recipients=None, category=None, labels=None + ): + '''Create note with *content*, *author*. + + NoteLabels can be set by including *labels*. + + Note category can be set by including *category*. + + *recipients* can be specified as a list of user or group instances. + + ''' + note_label_support = 'NoteLabel' in self.session.types + + if not labels: + labels = [] + + if labels and not note_label_support: + raise ValueError( + 'NoteLabel is not supported by the current server version.' + ) + + if category and labels: + raise ValueError( + 'Both category and labels cannot be set at the same time.' + ) + + if not recipients: + recipients = [] + + data = { + 'content': content, + 'author': author + } + + if category: + if note_label_support: + labels = [category] + warnings.warn( + 'category argument will be removed in an upcoming version, ' + 'please use labels instead.', + PendingDeprecationWarning + ) + else: + data['category_id'] = category['id'] + + note = self.session.create('Note', data) + + self['notes'].append(note) + + for resource in recipients: + recipient = self.session.create('Recipient', { + 'note_id': note['id'], + 'resource_id': resource['id'] + }) + + note['recipients'].append(recipient) + + for label in labels: + self.session.create( + 'NoteLabelLink', + { + 'label_id': label['id'], + 'note_id': note['id'] + } + ) + + return note diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/project_schema.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/project_schema.py new file mode 100644 index 0000000000..ec6db7c019 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/project_schema.py @@ -0,0 +1,94 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api.entity.base + + +class ProjectSchema(ftrack_api.entity.base.Entity): + '''Class representing ProjectSchema.''' + + def get_statuses(self, schema, type_id=None): + '''Return statuses for *schema* and optional *type_id*. + + *type_id* is the id of the Type for a TypedContext and can be used to + get statuses where the workflow has been overridden. + + ''' + # Task has overrides and need to be handled separately. + if schema == 'Task': + if type_id is not None: + overrides = self['_overrides'] + for override in overrides: + if override['type_id'] == type_id: + return override['workflow_schema']['statuses'][:] + + return self['_task_workflow']['statuses'][:] + + elif schema == 'AssetVersion': + return self['_version_workflow']['statuses'][:] + + else: + try: + EntityTypeClass = self.session.types[schema] + except KeyError: + raise ValueError('Schema {0} does not exist.'.format(schema)) + + object_type_id_attribute = EntityTypeClass.attributes.get( + 'object_type_id' + ) + + try: + object_type_id = object_type_id_attribute.default_value + except AttributeError: + raise ValueError( + 'Schema {0} does not have statuses.'.format(schema) + ) + + for _schema in self['_schemas']: + if _schema['type_id'] == object_type_id: + result = self.session.query( + 'select task_status from SchemaStatus ' + 'where schema_id is {0}'.format(_schema['id']) + ) + return [ + schema_type['task_status'] for schema_type in result + ] + + raise ValueError( + 'No valid statuses were found for schema {0}.'.format(schema) + ) + + def get_types(self, schema): + '''Return types for *schema*.''' + # Task need to be handled separately. + if schema == 'Task': + return self['_task_type_schema']['types'][:] + + else: + try: + EntityTypeClass = self.session.types[schema] + except KeyError: + raise ValueError('Schema {0} does not exist.'.format(schema)) + + object_type_id_attribute = EntityTypeClass.attributes.get( + 'object_type_id' + ) + + try: + object_type_id = object_type_id_attribute.default_value + except AttributeError: + raise ValueError( + 'Schema {0} does not have types.'.format(schema) + ) + + for _schema in self['_schemas']: + if _schema['type_id'] == object_type_id: + result = self.session.query( + 'select task_type from SchemaType ' + 'where schema_id is {0}'.format(_schema['id']) + ) + return [schema_type['task_type'] for schema_type in result] + + raise ValueError( + 'No valid types were found for schema {0}.'.format(schema) + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/user.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/user.py new file mode 100644 index 0000000000..511ad4ba99 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/entity/user.py @@ -0,0 +1,123 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import arrow + +import ftrack_api.entity.base +import ftrack_api.exception + + +class User(ftrack_api.entity.base.Entity): + '''Represent a user.''' + + def start_timer(self, context=None, comment='', name=None, force=False): + '''Start a timer for *context* and return it. + + *force* can be used to automatically stop an existing timer and create a + timelog for it. If you need to get access to the created timelog, use + :func:`stop_timer` instead. + + *comment* and *name* are optional but will be set on the timer. + + .. note:: + + This method will automatically commit the changes and if *force* is + False then it will fail with a + :class:`ftrack_api.exception.NotUniqueError` exception if a + timer is already running. + + ''' + if force: + try: + self.stop_timer() + except ftrack_api.exception.NoResultFoundError: + self.logger.debug('Failed to stop existing timer.') + + timer = self.session.create('Timer', { + 'user': self, + 'context': context, + 'name': name, + 'comment': comment + }) + + # Commit the new timer and try to catch any error that indicate another + # timelog already exists and inform the user about it. + try: + self.session.commit() + except ftrack_api.exception.ServerError as error: + if 'IntegrityError' in str(error): + raise ftrack_api.exception.NotUniqueError( + ('Failed to start a timelog for user with id: {0}, it is ' + 'likely that a timer is already running. Either use ' + 'force=True or stop the timer first.').format(self['id']) + ) + else: + # Reraise the error as it might be something unrelated. + raise + + return timer + + def stop_timer(self): + '''Stop the current timer and return a timelog created from it. + + If a timer is not running, a + :exc:`ftrack_api.exception.NoResultFoundError` exception will be + raised. + + .. note:: + + This method will automatically commit the changes. + + ''' + timer = self.session.query( + 'Timer where user_id = "{0}"'.format(self['id']) + ).one() + + # If the server is running in the same timezone as the local + # timezone, we remove the TZ offset to get the correct duration. + is_timezone_support_enabled = self.session.server_information.get( + 'is_timezone_support_enabled', None + ) + if is_timezone_support_enabled is None: + self.logger.warning( + 'Could not identify if server has timezone support enabled. ' + 'Will assume server is running in UTC.' + ) + is_timezone_support_enabled = True + + if is_timezone_support_enabled: + now = arrow.now() + else: + now = arrow.now().replace(tzinfo='utc') + + delta = now - timer['start'] + duration = delta.days * 24 * 60 * 60 + delta.seconds + + timelog = self.session.create('Timelog', { + 'user_id': timer['user_id'], + 'context_id': timer['context_id'], + 'comment': timer['comment'], + 'start': timer['start'], + 'duration': duration, + 'name': timer['name'] + }) + + self.session.delete(timer) + self.session.commit() + + return timelog + + def send_invite(self): + '''Send a invation email to the user''' + + self.session.send_user_invite( + self + ) + def reset_api_key(self): + '''Reset the users api key.''' + + response = self.session.reset_remote( + 'api_key', entity=self + ) + + return response['api_key'] diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/__init__.py new file mode 100644 index 0000000000..1aab07ed77 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/base.py new file mode 100644 index 0000000000..b5fd57da78 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/base.py @@ -0,0 +1,85 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import uuid +import collections + + +class Event(collections.MutableMapping): + '''Represent a single event.''' + + def __init__(self, topic, id=None, data=None, sent=None, + source=None, target='', in_reply_to_event=None): + '''Initialise event. + + *topic* is the required topic for the event. It can use a dotted + notation to demarcate groupings. For example, 'ftrack.update'. + + *id* is the unique id for this event instance. It is primarily used when + replying to an event. If not supplied a default uuid based value will + be used. + + *data* refers to event specific data. It should be a mapping structure + and defaults to an empty dictionary if not supplied. + + *sent* is the timestamp the event is sent. It will be set automatically + as send time unless specified here. + + *source* is information about where the event originated. It should be + a mapping and include at least a unique id value under an 'id' key. If + not specified, senders usually populate the value automatically at + publish time. + + *target* can be an expression that targets this event. For example, + a reply event would target the event to the sender of the source event. + The expression will be tested against subscriber information only. + + *in_reply_to_event* is used when replying to an event and should contain + the unique id of the event being replied to. + + ''' + super(Event, self).__init__() + self._data = dict( + id=id or uuid.uuid4().hex, + data=data or {}, + topic=topic, + sent=sent, + source=source or {}, + target=target, + in_reply_to_event=in_reply_to_event + ) + self._stopped = False + + def stop(self): + '''Stop further processing of this event.''' + self._stopped = True + + def is_stopped(self): + '''Return whether event has been stopped.''' + return self._stopped + + def __str__(self): + '''Return string representation.''' + return '<{0} {1}>'.format( + self.__class__.__name__, str(self._data) + ) + + def __getitem__(self, key): + '''Return value for *key*.''' + return self._data[key] + + def __setitem__(self, key, value): + '''Set *value* for *key*.''' + self._data[key] = value + + def __delitem__(self, key): + '''Remove *key*.''' + del self._data[key] + + def __iter__(self): + '''Iterate over all keys.''' + return iter(self._data) + + def __len__(self): + '''Return count of keys.''' + return len(self._data) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/expression.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/expression.py new file mode 100644 index 0000000000..0535e4fd5f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/expression.py @@ -0,0 +1,282 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from operator import eq, ne, ge, le, gt, lt + +from pyparsing import (Group, Word, CaselessKeyword, Forward, + FollowedBy, Suppress, oneOf, OneOrMore, Optional, + alphanums, quotedString, removeQuotes) + +import ftrack_api.exception + +# Do not enable packrat since it is not thread-safe and will result in parsing +# exceptions in a multi threaded environment. +# ParserElement.enablePackrat() + + +class Parser(object): + '''Parse string based expression into :class:`Expression` instance.''' + + def __init__(self): + '''Initialise parser.''' + self._operators = { + '=': eq, + '!=': ne, + '>=': ge, + '<=': le, + '>': gt, + '<': lt + } + self._parser = self._construct_parser() + super(Parser, self).__init__() + + def _construct_parser(self): + '''Construct and return parser.''' + field = Word(alphanums + '_.') + operator = oneOf(self._operators.keys()) + value = Word(alphanums + '-_,./*@+') + quoted_value = quotedString('quoted_value').setParseAction(removeQuotes) + + condition = Group( + field + operator + (quoted_value | value) + )('condition') + + not_ = Optional(Suppress(CaselessKeyword('not')))('not') + and_ = Suppress(CaselessKeyword('and'))('and') + or_ = Suppress(CaselessKeyword('or'))('or') + + expression = Forward() + parenthesis = Suppress('(') + expression + Suppress(')') + previous = condition | parenthesis + + for conjunction in (not_, and_, or_): + current = Forward() + + if conjunction in (and_, or_): + conjunction_expression = ( + FollowedBy(previous + conjunction + previous) + + Group( + previous + OneOrMore(conjunction + previous) + )(conjunction.resultsName) + ) + + elif conjunction in (not_, ): + conjunction_expression = ( + FollowedBy(conjunction.expr + current) + + Group(conjunction + current)(conjunction.resultsName) + ) + + else: # pragma: no cover + raise ValueError('Unrecognised conjunction.') + + current <<= (conjunction_expression | previous) + previous = current + + expression <<= previous + return expression('expression') + + def parse(self, expression): + '''Parse string *expression* into :class:`Expression`. + + Raise :exc:`ftrack_api.exception.ParseError` if *expression* could + not be parsed. + + ''' + result = None + expression = expression.strip() + if expression: + try: + result = self._parser.parseString( + expression, parseAll=True + ) + except Exception as error: + raise ftrack_api.exception.ParseError( + 'Failed to parse: {0}. {1}'.format(expression, error) + ) + + return self._process(result) + + def _process(self, result): + '''Process *result* using appropriate method. + + Method called is determined by the name of the result. + + ''' + method_name = '_process_{0}'.format(result.getName()) + method = getattr(self, method_name) + return method(result) + + def _process_expression(self, result): + '''Process *result* as expression.''' + return self._process(result[0]) + + def _process_not(self, result): + '''Process *result* as NOT operation.''' + return Not(self._process(result[0])) + + def _process_and(self, result): + '''Process *result* as AND operation.''' + return All([self._process(entry) for entry in result]) + + def _process_or(self, result): + '''Process *result* as OR operation.''' + return Any([self._process(entry) for entry in result]) + + def _process_condition(self, result): + '''Process *result* as condition.''' + key, operator, value = result + return Condition(key, self._operators[operator], value) + + def _process_quoted_value(self, result): + '''Process *result* as quoted value.''' + return result + + +class Expression(object): + '''Represent a structured expression to test candidates against.''' + + def __str__(self): + '''Return string representation.''' + return '<{0}>'.format(self.__class__.__name__) + + def match(self, candidate): + '''Return whether *candidate* satisfies this expression.''' + return True + + +class All(Expression): + '''Match candidate that matches all of the specified expressions. + + .. note:: + + If no expressions are supplied then will always match. + + ''' + + def __init__(self, expressions=None): + '''Initialise with list of *expressions* to match against.''' + self._expressions = expressions or [] + super(All, self).__init__() + + def __str__(self): + '''Return string representation.''' + return '<{0} [{1}]>'.format( + self.__class__.__name__, + ' '.join(map(str, self._expressions)) + ) + + def match(self, candidate): + '''Return whether *candidate* satisfies this expression.''' + return all([ + expression.match(candidate) for expression in self._expressions + ]) + + +class Any(Expression): + '''Match candidate that matches any of the specified expressions. + + .. note:: + + If no expressions are supplied then will never match. + + ''' + + def __init__(self, expressions=None): + '''Initialise with list of *expressions* to match against.''' + self._expressions = expressions or [] + super(Any, self).__init__() + + def __str__(self): + '''Return string representation.''' + return '<{0} [{1}]>'.format( + self.__class__.__name__, + ' '.join(map(str, self._expressions)) + ) + + def match(self, candidate): + '''Return whether *candidate* satisfies this expression.''' + return any([ + expression.match(candidate) for expression in self._expressions + ]) + + +class Not(Expression): + '''Negate expression.''' + + def __init__(self, expression): + '''Initialise with *expression* to negate.''' + self._expression = expression + super(Not, self).__init__() + + def __str__(self): + '''Return string representation.''' + return '<{0} {1}>'.format( + self.__class__.__name__, + self._expression + ) + + def match(self, candidate): + '''Return whether *candidate* satisfies this expression.''' + return not self._expression.match(candidate) + + +class Condition(Expression): + '''Represent condition.''' + + def __init__(self, key, operator, value): + '''Initialise condition. + + *key* is the key to check on the data when matching. It can be a nested + key represented by dots. For example, 'data.eventType' would attempt to + match candidate['data']['eventType']. If the candidate is missing any + of the requested keys then the match fails immediately. + + *operator* is the operator function to use to perform the match between + the retrieved candidate value and the conditional *value*. + + If *value* is a string, it can use a wildcard '*' at the end to denote + that any values matching the substring portion are valid when matching + equality only. + + ''' + self._key = key + self._operator = operator + self._value = value + self._wildcard = '*' + self._operatorMapping = { + eq: '=', + ne: '!=', + ge: '>=', + le: '<=', + gt: '>', + lt: '<' + } + + def __str__(self): + '''Return string representation.''' + return '<{0} {1}{2}{3}>'.format( + self.__class__.__name__, + self._key, + self._operatorMapping.get(self._operator, self._operator), + self._value + ) + + def match(self, candidate): + '''Return whether *candidate* satisfies this expression.''' + key_parts = self._key.split('.') + + try: + value = candidate + for keyPart in key_parts: + value = value[keyPart] + except (KeyError, TypeError): + return False + + if ( + self._operator is eq + and isinstance(self._value, basestring) + and self._value[-1] == self._wildcard + ): + return self._value[:-1] in value + else: + return self._operator(value, self._value) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/hub.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/hub.py new file mode 100644 index 0000000000..9f4ba80c6e --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/hub.py @@ -0,0 +1,1091 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2013 ftrack + +from __future__ import absolute_import + +import collections +import urlparse +import threading +import Queue as queue +import logging +import time +import uuid +import operator +import functools +import json +import socket +import warnings + +import requests +import requests.exceptions +import websocket + +import ftrack_api.exception +import ftrack_api.event.base +import ftrack_api.event.subscriber +import ftrack_api.event.expression +from ftrack_api.logging import LazyLogMessage as L + + +SocketIoSession = collections.namedtuple('SocketIoSession', [ + 'id', + 'heartbeatTimeout', + 'supportedTransports', +]) + + +ServerDetails = collections.namedtuple('ServerDetails', [ + 'scheme', + 'hostname', + 'port', +]) + + + + +class EventHub(object): + '''Manage routing of events.''' + + _future_signature_warning = ( + 'When constructing your Session object you did not explicitly define ' + 'auto_connect_event_hub as True even though you appear to be publishing ' + 'and / or subscribing to asynchronous events. In version version 2.0 of ' + 'the ftrack-python-api the default behavior will change from True ' + 'to False. Please make sure to update your tools. You can read more at ' + 'http://ftrack-python-api.rtd.ftrack.com/en/stable/release/migration.html' + ) + + def __init__(self, server_url, api_user, api_key): + '''Initialise hub, connecting to ftrack *server_url*. + + *api_user* is the user to authenticate as and *api_key* is the API key + to authenticate with. + + ''' + super(EventHub, self).__init__() + self.logger = logging.getLogger( + __name__ + '.' + self.__class__.__name__ + ) + self.id = uuid.uuid4().hex + self._connection = None + + self._unique_packet_id = 0 + self._packet_callbacks = {} + self._lock = threading.RLock() + + self._wait_timeout = 4 + + self._subscribers = [] + self._reply_callbacks = {} + self._intentional_disconnect = False + + self._event_queue = queue.Queue() + self._event_namespace = 'ftrack.event' + self._expression_parser = ftrack_api.event.expression.Parser() + + # Default values for auto reconnection timeout on unintentional + # disconnection. Equates to 5 minutes. + self._auto_reconnect_attempts = 30 + self._auto_reconnect_delay = 10 + + self._deprecation_warning_auto_connect = False + + # Mapping of Socket.IO codes to meaning. + self._code_name_mapping = { + '0': 'disconnect', + '1': 'connect', + '2': 'heartbeat', + '3': 'message', + '4': 'json', + '5': 'event', + '6': 'acknowledge', + '7': 'error' + } + self._code_name_mapping.update( + dict((name, code) for code, name in self._code_name_mapping.items()) + ) + + self._server_url = server_url + self._api_user = api_user + self._api_key = api_key + + # Parse server URL and store server details. + url_parse_result = urlparse.urlparse(self._server_url) + if not url_parse_result.scheme: + raise ValueError('Could not determine scheme from server url.') + + if not url_parse_result.hostname: + raise ValueError('Could not determine hostname from server url.') + + self.server = ServerDetails( + url_parse_result.scheme, + url_parse_result.hostname, + url_parse_result.port + ) + + def get_server_url(self): + '''Return URL to server.''' + return '{0}://{1}'.format( + self.server.scheme, self.get_network_location() + ) + + def get_network_location(self): + '''Return network location part of url (hostname with optional port).''' + if self.server.port: + return '{0}:{1}'.format(self.server.hostname, self.server.port) + else: + return self.server.hostname + + @property + def secure(self): + '''Return whether secure connection used.''' + return self.server.scheme == 'https' + + def connect(self): + '''Initialise connection to server. + + Raise :exc:`ftrack_api.exception.EventHubConnectionError` if already + connected or connection fails. + + ''' + + self._deprecation_warning_auto_connect = False + + if self.connected: + raise ftrack_api.exception.EventHubConnectionError( + 'Already connected.' + ) + + # Reset flag tracking whether disconnection was intentional. + self._intentional_disconnect = False + + try: + # Connect to socket.io server using websocket transport. + session = self._get_socket_io_session() + + if 'websocket' not in session.supportedTransports: + raise ValueError( + 'Server does not support websocket sessions.' + ) + + scheme = 'wss' if self.secure else 'ws' + url = '{0}://{1}/socket.io/1/websocket/{2}'.format( + scheme, self.get_network_location(), session.id + ) + + # timeout is set to 60 seconds to avoid the issue where the socket + # ends up in a bad state where it is reported as connected but the + # connection has been closed. The issue happens often when connected + # to a secure socket and the computer goes to sleep. + # More information on how the timeout works can be found here: + # https://docs.python.org/2/library/socket.html#socket.socket.setblocking + self._connection = websocket.create_connection(url, timeout=60) + + except Exception as error: + error_message = ( + 'Failed to connect to event server at {server_url} with ' + 'error: "{error}".' + ) + + error_details = { + 'error': unicode(error), + 'server_url': self.get_server_url() + } + + self.logger.debug( + L( + error_message, **error_details + ), + exc_info=1 + ) + raise ftrack_api.exception.EventHubConnectionError( + error_message, + details=error_details + ) + + # Start background processing thread. + self._processor_thread = _ProcessorThread(self) + self._processor_thread.start() + + # Subscribe to reply events if not already. Note: Only adding the + # subscriber locally as the following block will notify server of all + # existing subscribers, which would cause the server to report a + # duplicate subscriber error if EventHub.subscribe was called here. + try: + self._add_subscriber( + 'topic=ftrack.meta.reply', + self._handle_reply, + subscriber=dict( + id=self.id + ) + ) + except ftrack_api.exception.NotUniqueError: + pass + + # Now resubscribe any existing stored subscribers. This can happen when + # reconnecting automatically for example. + for subscriber in self._subscribers[:]: + self._notify_server_about_subscriber(subscriber) + + @property + def connected(self): + '''Return if connected.''' + return self._connection is not None and self._connection.connected + + def disconnect(self, unsubscribe=True): + '''Disconnect from server. + + Raise :exc:`ftrack_api.exception.EventHubConnectionError` if not + currently connected. + + If *unsubscribe* is True then unsubscribe all current subscribers + automatically before disconnecting. + + ''' + if not self.connected: + raise ftrack_api.exception.EventHubConnectionError( + 'Not currently connected.' + ) + + else: + # Set flag to indicate disconnection was intentional. + self._intentional_disconnect = True + + # Set blocking to true on socket to make sure unsubscribe events + # are emitted before closing the connection. + self._connection.sock.setblocking(1) + + # Unsubscribe all subscribers. + if unsubscribe: + for subscriber in self._subscribers[:]: + self.unsubscribe(subscriber.metadata['id']) + + # Now disconnect. + self._connection.close() + self._connection = None + + # Shutdown background processing thread. + self._processor_thread.cancel() + + # Join to it if it is not current thread to help ensure a clean + # shutdown. + if threading.current_thread() != self._processor_thread: + self._processor_thread.join(self._wait_timeout) + + def reconnect(self, attempts=10, delay=5): + '''Reconnect to server. + + Make *attempts* number of attempts with *delay* in seconds between each + attempt. + + .. note:: + + All current subscribers will be automatically resubscribed after + successful reconnection. + + Raise :exc:`ftrack_api.exception.EventHubConnectionError` if fail to + reconnect. + + ''' + try: + self.disconnect(unsubscribe=False) + except ftrack_api.exception.EventHubConnectionError: + pass + + for attempt in range(attempts): + self.logger.debug(L( + 'Reconnect attempt {0} of {1}', attempt, attempts + )) + + # Silence logging temporarily to avoid lots of failed connection + # related information. + try: + logging.disable(logging.CRITICAL) + + try: + self.connect() + except ftrack_api.exception.EventHubConnectionError: + time.sleep(delay) + else: + break + + finally: + logging.disable(logging.NOTSET) + + if not self.connected: + raise ftrack_api.exception.EventHubConnectionError( + 'Failed to reconnect to event server at {0} after {1} attempts.' + .format(self.get_server_url(), attempts) + ) + + def wait(self, duration=None): + '''Wait for events and handle as they arrive. + + If *duration* is specified, then only process events until duration is + reached. *duration* is in seconds though float values can be used for + smaller values. + + ''' + started = time.time() + + while True: + try: + event = self._event_queue.get(timeout=0.1) + except queue.Empty: + pass + else: + self._handle(event) + + # Additional special processing of events. + if event['topic'] == 'ftrack.meta.disconnected': + break + + if duration is not None: + if (time.time() - started) > duration: + break + + def get_subscriber_by_identifier(self, identifier): + '''Return subscriber with matching *identifier*. + + Return None if no subscriber with *identifier* found. + + ''' + for subscriber in self._subscribers[:]: + if subscriber.metadata.get('id') == identifier: + return subscriber + + return None + + def subscribe(self, subscription, callback, subscriber=None, priority=100): + '''Register *callback* for *subscription*. + + A *subscription* is a string that can specify in detail which events the + callback should receive. The filtering is applied against each event + object. Nested references are supported using '.' separators. + For example, 'topic=foo and data.eventType=Shot' would match the + following event:: + + + + The *callback* should accept an instance of + :class:`ftrack_api.event.base.Event` as its sole argument. + + Callbacks are called in order of *priority*. The lower the priority + number the sooner it will be called, with 0 being the first. The + default priority is 100. Note that priority only applies against other + callbacks registered with this hub and not as a global priority. + + An earlier callback can prevent processing of subsequent callbacks by + calling :meth:`Event.stop` on the passed `event` before + returning. + + .. warning:: + + Handlers block processing of other received events. For long + running callbacks it is advisable to delegate the main work to + another process or thread. + + A *callback* can be attached to *subscriber* information that details + the subscriber context. A subscriber context will be generated + automatically if not supplied. + + .. note:: + + The subscription will be stored locally, but until the server + receives notification of the subscription it is possible the + callback will not be called. + + Return subscriber identifier. + + Raise :exc:`ftrack_api.exception.NotUniqueError` if a subscriber with + the same identifier already exists. + + ''' + # Add subscriber locally. + subscriber = self._add_subscriber( + subscription, callback, subscriber, priority + ) + + # Notify server now if possible. + try: + self._notify_server_about_subscriber(subscriber) + except ftrack_api.exception.EventHubConnectionError: + self.logger.debug(L( + 'Failed to notify server about new subscriber {0} ' + 'as server not currently reachable.', subscriber.metadata['id'] + )) + + return subscriber.metadata['id'] + + def _add_subscriber( + self, subscription, callback, subscriber=None, priority=100 + ): + '''Add subscriber locally. + + See :meth:`subscribe` for argument descriptions. + + Return :class:`ftrack_api.event.subscriber.Subscriber` instance. + + Raise :exc:`ftrack_api.exception.NotUniqueError` if a subscriber with + the same identifier already exists. + + ''' + if subscriber is None: + subscriber = {} + + subscriber.setdefault('id', uuid.uuid4().hex) + + # Check subscriber not already subscribed. + existing_subscriber = self.get_subscriber_by_identifier( + subscriber['id'] + ) + + if existing_subscriber is not None: + raise ftrack_api.exception.NotUniqueError( + 'Subscriber with identifier {0} already exists.' + .format(subscriber['id']) + ) + + subscriber = ftrack_api.event.subscriber.Subscriber( + subscription=subscription, + callback=callback, + metadata=subscriber, + priority=priority + ) + + self._subscribers.append(subscriber) + + return subscriber + + def _notify_server_about_subscriber(self, subscriber): + '''Notify server of new *subscriber*.''' + subscribe_event = ftrack_api.event.base.Event( + topic='ftrack.meta.subscribe', + data=dict( + subscriber=subscriber.metadata, + subscription=str(subscriber.subscription) + ) + ) + + self._publish( + subscribe_event, + callback=functools.partial(self._on_subscribed, subscriber) + ) + + def _on_subscribed(self, subscriber, response): + '''Handle acknowledgement of subscription.''' + if response.get('success') is False: + self.logger.warning(L( + 'Server failed to subscribe subscriber {0}: {1}', + subscriber.metadata['id'], response.get('message') + )) + + def unsubscribe(self, subscriber_identifier): + '''Unsubscribe subscriber with *subscriber_identifier*. + + .. note:: + + If the server is not reachable then it won't be notified of the + unsubscription. However, the subscriber will be removed locally + regardless. + + ''' + subscriber = self.get_subscriber_by_identifier(subscriber_identifier) + + if subscriber is None: + raise ftrack_api.exception.NotFoundError( + 'Cannot unsubscribe missing subscriber with identifier {0}' + .format(subscriber_identifier) + ) + + self._subscribers.pop(self._subscribers.index(subscriber)) + + # Notify the server if possible. + unsubscribe_event = ftrack_api.event.base.Event( + topic='ftrack.meta.unsubscribe', + data=dict(subscriber=subscriber.metadata) + ) + + try: + self._publish( + unsubscribe_event, + callback=functools.partial(self._on_unsubscribed, subscriber) + ) + except ftrack_api.exception.EventHubConnectionError: + self.logger.debug(L( + 'Failed to notify server to unsubscribe subscriber {0} as ' + 'server not currently reachable.', subscriber.metadata['id'] + )) + + def _on_unsubscribed(self, subscriber, response): + '''Handle acknowledgement of unsubscribing *subscriber*.''' + if response.get('success') is not True: + self.logger.warning(L( + 'Server failed to unsubscribe subscriber {0}: {1}', + subscriber.metadata['id'], response.get('message') + )) + + def _prepare_event(self, event): + '''Prepare *event* for sending.''' + event['source'].setdefault('id', self.id) + event['source'].setdefault('user', { + 'username': self._api_user + }) + + def _prepare_reply_event(self, event, source_event, source=None): + '''Prepare *event* as a reply to another *source_event*. + + Modify *event*, setting appropriate values to target event correctly as + a reply. + + ''' + event['target'] = 'id={0}'.format(source_event['source']['id']) + event['in_reply_to_event'] = source_event['id'] + if source is not None: + event['source'] = source + + def publish( + self, event, synchronous=False, on_reply=None, on_error='raise' + ): + '''Publish *event*. + + If *synchronous* is specified as True then this method will wait and + return a list of results from any called callbacks. + + .. note:: + + Currently, if synchronous is True then only locally registered + callbacks will be called and no event will be sent to the server. + This may change in future. + + *on_reply* is an optional callable to call with any reply event that is + received in response to the published *event*. + + .. note:: + + Will not be called when *synchronous* is True. + + If *on_error* is set to 'ignore' then errors raised during publish of + event will be caught by this method and ignored. + + ''' + if self._deprecation_warning_auto_connect and not synchronous: + warnings.warn( + self._future_signature_warning, FutureWarning + ) + + try: + return self._publish( + event, synchronous=synchronous, on_reply=on_reply + ) + except Exception: + if on_error == 'ignore': + pass + else: + raise + + def publish_reply(self, source_event, data, source=None): + '''Publish a reply event to *source_event* with supplied *data*. + + If *source* is specified it will be used for the source value of the + sent event. + + ''' + reply_event = ftrack_api.event.base.Event( + 'ftrack.meta.reply', + data=data + ) + self._prepare_reply_event(reply_event, source_event, source=source) + self.publish(reply_event) + + def _publish(self, event, synchronous=False, callback=None, on_reply=None): + '''Publish *event*. + + If *synchronous* is specified as True then this method will wait and + return a list of results from any called callbacks. + + .. note:: + + Currently, if synchronous is True then only locally registered + callbacks will be called and no event will be sent to the server. + This may change in future. + + A *callback* can also be specified. This callback will be called once + the server acknowledges receipt of the sent event. A default callback + that checks for errors from the server will be used if not specified. + + *on_reply* is an optional callable to call with any reply event that is + received in response to the published *event*. Note that there is no + guarantee that a reply will be sent. + + Raise :exc:`ftrack_api.exception.EventHubConnectionError` if not + currently connected. + + ''' + # Prepare event adding any relevant additional information. + self._prepare_event(event) + + if synchronous: + # Bypass emitting event to server and instead call locally + # registered handlers directly, collecting and returning results. + return self._handle(event, synchronous=synchronous) + + if not self.connected: + raise ftrack_api.exception.EventHubConnectionError( + 'Cannot publish event asynchronously as not connected to ' + 'server.' + ) + + # Use standard callback if none specified. + if callback is None: + callback = functools.partial(self._on_published, event) + + # Emit event to central server for asynchronous processing. + try: + # Register on reply callback if specified. + if on_reply is not None: + # TODO: Add cleanup process that runs after a set duration to + # garbage collect old reply callbacks and prevent dictionary + # growing too large. + self._reply_callbacks[event['id']] = on_reply + + try: + self._emit_event_packet( + self._event_namespace, event, callback=callback + ) + except ftrack_api.exception.EventHubConnectionError: + # Connection may have dropped temporarily. Wait a few moments to + # see if background thread reconnects automatically. + time.sleep(15) + + self._emit_event_packet( + self._event_namespace, event, callback=callback + ) + except: + raise + + except Exception: + # Failure to send event should not cause caller to fail. + # TODO: This behaviour is inconsistent with the failing earlier on + # lack of connection and also with the error handling parameter of + # EventHub.publish. Consider refactoring. + self.logger.exception(L('Error sending event {0}.', event)) + + def _on_published(self, event, response): + '''Handle acknowledgement of published event.''' + if response.get('success', False) is False: + self.logger.error(L( + 'Server responded with error while publishing event {0}. ' + 'Error was: {1}', event, response.get('message') + )) + + def _handle(self, event, synchronous=False): + '''Handle *event*. + + If *synchronous* is True, do not send any automatic reply events. + + ''' + # Sort by priority, lower is higher. + # TODO: Use a sorted list to avoid sorting each time in order to improve + # performance. + subscribers = sorted( + self._subscribers, key=operator.attrgetter('priority') + ) + + results = [] + + target = event.get('target', None) + target_expression = None + if target: + try: + target_expression = self._expression_parser.parse(target) + except Exception: + self.logger.exception(L( + 'Cannot handle event as failed to parse event target ' + 'information: {0}', event + )) + return + + for subscriber in subscribers: + # Check if event is targeted to the subscriber. + if ( + target_expression is not None + and not target_expression.match(subscriber.metadata) + ): + continue + + # Check if subscriber interested in the event. + if not subscriber.interested_in(event): + continue + + response = None + + try: + response = subscriber.callback(event) + results.append(response) + except Exception: + self.logger.exception(L( + 'Error calling subscriber {0} for event {1}.', + subscriber, event + )) + + # Automatically publish a non None response as a reply when not in + # synchronous mode. + if not synchronous: + if self._deprecation_warning_auto_connect: + warnings.warn( + self._future_signature_warning, FutureWarning + ) + + if response is not None: + try: + self.publish_reply( + event, data=response, source=subscriber.metadata + ) + + except Exception: + self.logger.exception(L( + 'Error publishing response {0} from subscriber {1} ' + 'for event {2}.', response, subscriber, event + )) + + # Check whether to continue processing topic event. + if event.is_stopped(): + self.logger.debug(L( + 'Subscriber {0} stopped event {1}. Will not process ' + 'subsequent subscriber callbacks for this event.', + subscriber, event + )) + break + + return results + + def _handle_reply(self, event): + '''Handle reply *event*, passing it to any registered callback.''' + callback = self._reply_callbacks.get(event['in_reply_to_event'], None) + if callback is not None: + callback(event) + + def subscription(self, subscription, callback, subscriber=None, + priority=100): + '''Return context manager with *callback* subscribed to *subscription*. + + The subscribed callback will be automatically unsubscribed on exit + of the context manager. + + ''' + return _SubscriptionContext( + self, subscription, callback, subscriber=subscriber, + priority=priority, + ) + + # Socket.IO interface. + # + + def _get_socket_io_session(self): + '''Connect to server and retrieve session information.''' + socket_io_url = ( + '{0}://{1}/socket.io/1/?api_user={2}&api_key={3}' + ).format( + self.server.scheme, + self.get_network_location(), + self._api_user, + self._api_key + ) + try: + response = requests.get( + socket_io_url, + timeout=60 # 60 seconds timeout to recieve errors faster. + ) + except requests.exceptions.Timeout as error: + raise ftrack_api.exception.EventHubConnectionError( + 'Timed out connecting to server: {0}.'.format(error) + ) + except requests.exceptions.SSLError as error: + raise ftrack_api.exception.EventHubConnectionError( + 'Failed to negotiate SSL with server: {0}.'.format(error) + ) + except requests.exceptions.ConnectionError as error: + raise ftrack_api.exception.EventHubConnectionError( + 'Failed to connect to server: {0}.'.format(error) + ) + else: + status = response.status_code + if status != 200: + raise ftrack_api.exception.EventHubConnectionError( + 'Received unexpected status code {0}.'.format(status) + ) + + # Parse result and return session information. + parts = response.text.split(':') + return SocketIoSession( + parts[0], + parts[1], + parts[3].split(',') + ) + + def _add_packet_callback(self, callback): + '''Store callback against a new unique packet ID. + + Return the unique packet ID. + + ''' + with self._lock: + self._unique_packet_id += 1 + unique_identifier = self._unique_packet_id + + self._packet_callbacks[unique_identifier] = callback + + return '{0}+'.format(unique_identifier) + + def _pop_packet_callback(self, packet_identifier): + '''Pop and return callback for *packet_identifier*.''' + return self._packet_callbacks.pop(packet_identifier) + + def _emit_event_packet(self, namespace, event, callback): + '''Send *event* packet under *namespace*.''' + data = self._encode( + dict(name=namespace, args=[event]) + ) + self._send_packet( + self._code_name_mapping['event'], data=data, callback=callback + ) + + def _acknowledge_packet(self, packet_identifier, *args): + '''Send acknowledgement of packet with *packet_identifier*.''' + packet_identifier = packet_identifier.rstrip('+') + data = str(packet_identifier) + if args: + data += '+{1}'.format(self._encode(args)) + + self._send_packet(self._code_name_mapping['acknowledge'], data=data) + + def _send_packet(self, code, data='', callback=None): + '''Send packet via connection.''' + path = '' + packet_identifier = ( + self._add_packet_callback(callback) if callback else '' + ) + packet_parts = (str(code), packet_identifier, path, data) + packet = ':'.join(packet_parts) + + try: + self._connection.send(packet) + self.logger.debug(L(u'Sent packet: {0}', packet)) + except socket.error as error: + raise ftrack_api.exception.EventHubConnectionError( + 'Failed to send packet: {0}'.format(error) + ) + + def _receive_packet(self): + '''Receive and return packet via connection.''' + try: + packet = self._connection.recv() + except Exception as error: + raise ftrack_api.exception.EventHubConnectionError( + 'Error receiving packet: {0}'.format(error) + ) + + try: + parts = packet.split(':', 3) + except AttributeError: + raise ftrack_api.exception.EventHubPacketError( + 'Received invalid packet {0}'.format(packet) + ) + + code, packet_identifier, path, data = None, None, None, None + + count = len(parts) + if count == 4: + code, packet_identifier, path, data = parts + elif count == 3: + code, packet_identifier, path = parts + elif count == 1: + code = parts[0] + else: + raise ftrack_api.exception.EventHubPacketError( + 'Received invalid packet {0}'.format(packet) + ) + + self.logger.debug(L('Received packet: {0}', packet)) + return code, packet_identifier, path, data + + def _handle_packet(self, code, packet_identifier, path, data): + '''Handle packet received from server.''' + code_name = self._code_name_mapping[code] + + if code_name == 'connect': + self.logger.debug('Connected to event server.') + event = ftrack_api.event.base.Event('ftrack.meta.connected') + self._prepare_event(event) + self._event_queue.put(event) + + elif code_name == 'disconnect': + self.logger.debug('Disconnected from event server.') + if not self._intentional_disconnect: + self.logger.debug( + 'Disconnected unexpectedly. Attempting to reconnect.' + ) + try: + self.reconnect( + attempts=self._auto_reconnect_attempts, + delay=self._auto_reconnect_delay + ) + except ftrack_api.exception.EventHubConnectionError: + self.logger.debug('Failed to reconnect automatically.') + else: + self.logger.debug('Reconnected successfully.') + + if not self.connected: + event = ftrack_api.event.base.Event('ftrack.meta.disconnected') + self._prepare_event(event) + self._event_queue.put(event) + + elif code_name == 'heartbeat': + # Reply with heartbeat. + self._send_packet(self._code_name_mapping['heartbeat']) + + elif code_name == 'message': + self.logger.debug(L('Message received: {0}', data)) + + elif code_name == 'event': + payload = self._decode(data) + args = payload.get('args', []) + + if len(args) == 1: + event_payload = args[0] + if isinstance(event_payload, collections.Mapping): + try: + event = ftrack_api.event.base.Event(**event_payload) + except Exception: + self.logger.exception(L( + 'Failed to convert payload into event: {0}', + event_payload + )) + return + + self._event_queue.put(event) + + elif code_name == 'acknowledge': + parts = data.split('+', 1) + acknowledged_packet_identifier = int(parts[0]) + args = [] + if len(parts) == 2: + args = self._decode(parts[1]) + + try: + callback = self._pop_packet_callback( + acknowledged_packet_identifier + ) + except KeyError: + pass + else: + callback(*args) + + elif code_name == 'error': + self.logger.error(L('Event server reported error: {0}.', data)) + + else: + self.logger.debug(L('{0}: {1}', code_name, data)) + + def _encode(self, data): + '''Return *data* encoded as JSON formatted string.''' + return json.dumps( + data, + default=self._encode_object_hook, + ensure_ascii=False + ) + + def _encode_object_hook(self, item): + '''Return *item* transformed for encoding.''' + if isinstance(item, ftrack_api.event.base.Event): + # Convert to dictionary for encoding. + item = dict(**item) + + if 'in_reply_to_event' in item: + # Convert keys to server convention. + item['inReplyToEvent'] = item.pop('in_reply_to_event') + + return item + + raise TypeError('{0!r} is not JSON serializable'.format(item)) + + def _decode(self, string): + '''Return decoded JSON *string* as Python object.''' + return json.loads(string, object_hook=self._decode_object_hook) + + def _decode_object_hook(self, item): + '''Return *item* transformed.''' + if isinstance(item, collections.Mapping): + if 'inReplyToEvent' in item: + item['in_reply_to_event'] = item.pop('inReplyToEvent') + + return item + + +class _SubscriptionContext(object): + '''Context manager for a one-off subscription.''' + + def __init__(self, hub, subscription, callback, subscriber, priority): + '''Initialise context.''' + self._hub = hub + self._subscription = subscription + self._callback = callback + self._subscriber = subscriber + self._priority = priority + self._subscriberIdentifier = None + + def __enter__(self): + '''Enter context subscribing callback to topic.''' + self._subscriberIdentifier = self._hub.subscribe( + self._subscription, self._callback, subscriber=self._subscriber, + priority=self._priority + ) + + def __exit__(self, exception_type, exception_value, traceback): + '''Exit context unsubscribing callback from topic.''' + self._hub.unsubscribe(self._subscriberIdentifier) + + +class _ProcessorThread(threading.Thread): + '''Process messages from server.''' + + daemon = True + + def __init__(self, client): + '''Initialise thread with Socket.IO *client* instance.''' + super(_ProcessorThread, self).__init__() + self.logger = logging.getLogger( + __name__ + '.' + self.__class__.__name__ + ) + self.client = client + self.done = threading.Event() + + def run(self): + '''Perform work in thread.''' + while not self.done.is_set(): + try: + code, packet_identifier, path, data = self.client._receive_packet() + self.client._handle_packet(code, packet_identifier, path, data) + + except ftrack_api.exception.EventHubPacketError as error: + self.logger.debug(L('Ignoring invalid packet: {0}', error)) + continue + + except ftrack_api.exception.EventHubConnectionError: + self.cancel() + + # Fake a disconnection event in order to trigger reconnection + # when necessary. + self.client._handle_packet('0', '', '', '') + + break + + except Exception as error: + self.logger.debug(L('Aborting processor thread: {0}', error)) + self.cancel() + break + + def cancel(self): + '''Cancel work as soon as possible.''' + self.done.set() diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/subscriber.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/subscriber.py new file mode 100644 index 0000000000..0d38463aaf --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/subscriber.py @@ -0,0 +1,27 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import ftrack_api.event.subscription + + +class Subscriber(object): + '''Represent event subscriber.''' + + def __init__(self, subscription, callback, metadata, priority): + '''Initialise subscriber.''' + self.subscription = ftrack_api.event.subscription.Subscription( + subscription + ) + self.callback = callback + self.metadata = metadata + self.priority = priority + + def __str__(self): + '''Return string representation.''' + return '<{0} metadata={1} subscription="{2}">'.format( + self.__class__.__name__, self.metadata, self.subscription + ) + + def interested_in(self, event): + '''Return whether subscriber interested in *event*.''' + return self.subscription.includes(event) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/subscription.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/subscription.py new file mode 100644 index 0000000000..0b208d9977 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/event/subscription.py @@ -0,0 +1,23 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import ftrack_api.event.expression + + +class Subscription(object): + '''Represent a subscription.''' + + parser = ftrack_api.event.expression.Parser() + + def __init__(self, subscription): + '''Initialise with *subscription*.''' + self._subscription = subscription + self._expression = self.parser.parse(subscription) + + def __str__(self): + '''Return string representation.''' + return self._subscription + + def includes(self, event): + '''Return whether subscription includes *event*.''' + return self._expression.match(event) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/exception.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/exception.py new file mode 100644 index 0000000000..8a2eb9bc04 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/exception.py @@ -0,0 +1,392 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import sys +import traceback + +import ftrack_api.entity.base + + +class Error(Exception): + '''ftrack specific error.''' + + default_message = 'Unspecified error occurred.' + + def __init__(self, message=None, details=None): + '''Initialise exception with *message*. + + If *message* is None, the class 'default_message' will be used. + + *details* should be a mapping of extra information that can be used in + the message and also to provide more context. + + ''' + if message is None: + message = self.default_message + + self.message = message + self.details = details + if self.details is None: + self.details = {} + + self.traceback = traceback.format_exc() + + def __str__(self): + '''Return string representation.''' + keys = {} + for key, value in self.details.iteritems(): + if isinstance(value, unicode): + value = value.encode(sys.getfilesystemencoding()) + keys[key] = value + + return str(self.message.format(**keys)) + + +class AuthenticationError(Error): + '''Raise when an authentication error occurs.''' + + default_message = 'Authentication error.' + + +class ServerError(Error): + '''Raise when the server reports an error.''' + + default_message = 'Server reported error processing request.' + + +class ServerCompatibilityError(ServerError): + '''Raise when server appears incompatible.''' + + default_message = 'Server incompatible.' + + +class NotFoundError(Error): + '''Raise when something that should exist is not found.''' + + default_message = 'Not found.' + + +class NotUniqueError(Error): + '''Raise when unique value required and duplicate detected.''' + + default_message = 'Non-unique value detected.' + + +class IncorrectResultError(Error): + '''Raise when a result is incorrect.''' + + default_message = 'Incorrect result detected.' + + +class NoResultFoundError(IncorrectResultError): + '''Raise when a result was expected but no result was found.''' + + default_message = 'Expected result, but no result was found.' + + +class MultipleResultsFoundError(IncorrectResultError): + '''Raise when a single result expected, but multiple results found.''' + + default_message = 'Expected single result, but received multiple results.' + + +class EntityTypeError(Error): + '''Raise when an entity type error occurs.''' + + default_message = 'Entity type error.' + + +class UnrecognisedEntityTypeError(EntityTypeError): + '''Raise when an unrecognised entity type detected.''' + + default_message = 'Entity type "{entity_type}" not recognised.' + + def __init__(self, entity_type, **kw): + '''Initialise with *entity_type* that is unrecognised.''' + kw.setdefault('details', {}).update(dict( + entity_type=entity_type + )) + super(UnrecognisedEntityTypeError, self).__init__(**kw) + + +class OperationError(Error): + '''Raise when an operation error occurs.''' + + default_message = 'Operation error.' + + +class InvalidStateError(Error): + '''Raise when an invalid state detected.''' + + default_message = 'Invalid state.' + + +class InvalidStateTransitionError(InvalidStateError): + '''Raise when an invalid state transition detected.''' + + default_message = ( + 'Invalid transition from {current_state!r} to {target_state!r} state ' + 'for entity {entity!r}' + ) + + def __init__(self, current_state, target_state, entity, **kw): + '''Initialise error.''' + kw.setdefault('details', {}).update(dict( + current_state=current_state, + target_state=target_state, + entity=entity + )) + super(InvalidStateTransitionError, self).__init__(**kw) + + +class AttributeError(Error): + '''Raise when an error related to an attribute occurs.''' + + default_message = 'Attribute error.' + + +class ImmutableAttributeError(AttributeError): + '''Raise when modification of immutable attribute attempted.''' + + default_message = ( + 'Cannot modify value of immutable {attribute.name!r} attribute.' + ) + + def __init__(self, attribute, **kw): + '''Initialise error.''' + kw.setdefault('details', {}).update(dict( + attribute=attribute + )) + super(ImmutableAttributeError, self).__init__(**kw) + + +class CollectionError(Error): + '''Raise when an error related to collections occurs.''' + + default_message = 'Collection error.' + + def __init__(self, collection, **kw): + '''Initialise error.''' + kw.setdefault('details', {}).update(dict( + collection=collection + )) + super(CollectionError, self).__init__(**kw) + + +class ImmutableCollectionError(CollectionError): + '''Raise when modification of immutable collection attempted.''' + + default_message = ( + 'Cannot modify value of immutable collection {collection!r}.' + ) + + +class DuplicateItemInCollectionError(CollectionError): + '''Raise when duplicate item in collection detected.''' + + default_message = ( + 'Item {item!r} already exists in collection {collection!r}.' + ) + + def __init__(self, item, collection, **kw): + '''Initialise error.''' + kw.setdefault('details', {}).update(dict( + item=item + )) + super(DuplicateItemInCollectionError, self).__init__(collection, **kw) + + +class ParseError(Error): + '''Raise when a parsing error occurs.''' + + default_message = 'Failed to parse.' + + +class EventHubError(Error): + '''Raise when issues related to event hub occur.''' + + default_message = 'Event hub error occurred.' + + +class EventHubConnectionError(EventHubError): + '''Raise when event hub encounters connection problem.''' + + default_message = 'Event hub is not connected.' + + +class EventHubPacketError(EventHubError): + '''Raise when event hub encounters an issue with a packet.''' + + default_message = 'Invalid packet.' + + +class PermissionDeniedError(Error): + '''Raise when permission is denied.''' + + default_message = 'Permission denied.' + + +class LocationError(Error): + '''Base for errors associated with locations.''' + + default_message = 'Unspecified location error' + + +class ComponentNotInAnyLocationError(LocationError): + '''Raise when component not available in any location.''' + + default_message = 'Component not available in any location.' + + +class ComponentNotInLocationError(LocationError): + '''Raise when component(s) not in location.''' + + default_message = ( + 'Component(s) {formatted_components} not found in location {location}.' + ) + + def __init__(self, components, location, **kw): + '''Initialise with *components* and *location*.''' + if isinstance(components, ftrack_api.entity.base.Entity): + components = [components] + + kw.setdefault('details', {}).update(dict( + components=components, + formatted_components=', '.join( + [str(component) for component in components] + ), + location=location + )) + + super(ComponentNotInLocationError, self).__init__(**kw) + + +class ComponentInLocationError(LocationError): + '''Raise when component(s) already exists in location.''' + + default_message = ( + 'Component(s) {formatted_components} already exist in location ' + '{location}.' + ) + + def __init__(self, components, location, **kw): + '''Initialise with *components* and *location*.''' + if isinstance(components, ftrack_api.entity.base.Entity): + components = [components] + + kw.setdefault('details', {}).update(dict( + components=components, + formatted_components=', '.join( + [str(component) for component in components] + ), + location=location + )) + + super(ComponentInLocationError, self).__init__(**kw) + + +class AccessorError(Error): + '''Base for errors associated with accessors.''' + + default_message = 'Unspecified accessor error' + + +class AccessorOperationFailedError(AccessorError): + '''Base for failed operations on accessors.''' + + default_message = 'Operation {operation} failed: {error}' + + def __init__( + self, operation='', resource_identifier=None, error=None, **kw + ): + kw.setdefault('details', {}).update(dict( + operation=operation, + resource_identifier=resource_identifier, + error=error + )) + super(AccessorOperationFailedError, self).__init__(**kw) + + +class AccessorUnsupportedOperationError(AccessorOperationFailedError): + '''Raise when operation is unsupported.''' + + default_message = 'Operation {operation} unsupported.' + + +class AccessorPermissionDeniedError(AccessorOperationFailedError): + '''Raise when permission denied.''' + + default_message = ( + 'Cannot {operation} {resource_identifier}. Permission denied.' + ) + + +class AccessorResourceIdentifierError(AccessorError): + '''Raise when a error related to a resource_identifier occurs.''' + + default_message = 'Resource identifier is invalid: {resource_identifier}.' + + def __init__(self, resource_identifier, **kw): + kw.setdefault('details', {}).update(dict( + resource_identifier=resource_identifier + )) + super(AccessorResourceIdentifierError, self).__init__(**kw) + + +class AccessorFilesystemPathError(AccessorResourceIdentifierError): + '''Raise when a error related to an accessor filesystem path occurs.''' + + default_message = ( + 'Could not determine filesystem path from resource identifier: ' + '{resource_identifier}.' + ) + + +class AccessorResourceError(AccessorError): + '''Base for errors associated with specific resource.''' + + default_message = 'Unspecified resource error: {resource_identifier}' + + def __init__(self, operation='', resource_identifier=None, error=None, + **kw): + kw.setdefault('details', {}).update(dict( + operation=operation, + resource_identifier=resource_identifier + )) + super(AccessorResourceError, self).__init__(**kw) + + +class AccessorResourceNotFoundError(AccessorResourceError): + '''Raise when a required resource is not found.''' + + default_message = 'Resource not found: {resource_identifier}' + + +class AccessorParentResourceNotFoundError(AccessorResourceError): + '''Raise when a parent resource (such as directory) is not found.''' + + default_message = 'Parent resource is missing: {resource_identifier}' + + +class AccessorResourceInvalidError(AccessorResourceError): + '''Raise when a resource is not the right type.''' + + default_message = 'Resource invalid: {resource_identifier}' + + +class AccessorContainerNotEmptyError(AccessorResourceError): + '''Raise when container is not empty.''' + + default_message = 'Container is not empty: {resource_identifier}' + + +class StructureError(Error): + '''Base for errors associated with structures.''' + + default_message = 'Unspecified structure error' + + +class ConnectionClosedError(Error): + '''Raise when attempt to use closed connection detected.''' + + default_message = "Connection closed." diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/formatter.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/formatter.py new file mode 100644 index 0000000000..c282fcc814 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/formatter.py @@ -0,0 +1,131 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import termcolor + +import ftrack_api.entity.base +import ftrack_api.collection +import ftrack_api.symbol +import ftrack_api.inspection + + +#: Useful filters to pass to :func:`format`.` +FILTER = { + 'ignore_unset': ( + lambda entity, name, value: value is not ftrack_api.symbol.NOT_SET + ) +} + + +def format( + entity, formatters=None, attribute_filter=None, recursive=False, + indent=0, indent_first_line=True, _seen=None +): + '''Return formatted string representing *entity*. + + *formatters* can be used to customise formatting of elements. It should be a + mapping with one or more of the following keys: + + * header - Used to format entity type. + * label - Used to format attribute names. + + Specify an *attribute_filter* to control which attributes to include. By + default all attributes are included. The *attribute_filter* should be a + callable that accepts `(entity, attribute_name, attribute_value)` and + returns True if the attribute should be included in the output. For example, + to filter out all unset values:: + + attribute_filter=ftrack_api.formatter.FILTER['ignore_unset'] + + If *recursive* is True then recurse into Collections and format each entity + present. + + *indent* specifies the overall indentation in spaces of the formatted text, + whilst *indent_first_line* determines whether to apply that indent to the + first generated line. + + .. warning:: + + Iterates over all *entity* attributes which may cause multiple queries + to the server. Turn off auto populating in the session to prevent this. + + ''' + # Initialise default formatters. + if formatters is None: + formatters = dict() + + formatters.setdefault( + 'header', lambda text: termcolor.colored( + text, 'white', 'on_blue', attrs=['bold'] + ) + ) + formatters.setdefault( + 'label', lambda text: termcolor.colored( + text, 'blue', attrs=['bold'] + ) + ) + + # Determine indents. + spacer = ' ' * indent + if indent_first_line: + first_line_spacer = spacer + else: + first_line_spacer = '' + + # Avoid infinite recursion on circular references. + if _seen is None: + _seen = set() + + identifier = str(ftrack_api.inspection.identity(entity)) + if identifier in _seen: + return ( + first_line_spacer + + formatters['header'](entity.entity_type) + '{...}' + ) + + _seen.add(identifier) + information = list() + + information.append( + first_line_spacer + formatters['header'](entity.entity_type) + ) + for key, value in sorted(entity.items()): + if attribute_filter is not None: + if not attribute_filter(entity, key, value): + continue + + child_indent = indent + len(key) + 3 + + if isinstance(value, ftrack_api.entity.base.Entity): + value = format( + value, + formatters=formatters, + attribute_filter=attribute_filter, + recursive=recursive, + indent=child_indent, + indent_first_line=False, + _seen=_seen.copy() + ) + + if isinstance(value, ftrack_api.collection.Collection): + if recursive: + child_values = [] + for index, child in enumerate(value): + child_value = format( + child, + formatters=formatters, + attribute_filter=attribute_filter, + recursive=recursive, + indent=child_indent, + indent_first_line=index != 0, + _seen=_seen.copy() + ) + child_values.append(child_value) + + value = '\n'.join(child_values) + + information.append( + spacer + u' {0}: {1}'.format(formatters['label'](key), value) + ) + + return '\n'.join(information) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/inspection.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/inspection.py new file mode 100644 index 0000000000..d8b815200e --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/inspection.py @@ -0,0 +1,135 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import collections + +import ftrack_api.symbol +import ftrack_api.operation + + +def identity(entity): + '''Return unique identity of *entity*.''' + return ( + str(entity.entity_type), + primary_key(entity).values() + ) + + +def primary_key(entity): + '''Return primary key of *entity* as an ordered mapping of {field: value}. + + To get just the primary key values:: + + primary_key(entity).values() + + ''' + primary_key = collections.OrderedDict() + for name in entity.primary_key_attributes: + value = entity[name] + if value is ftrack_api.symbol.NOT_SET: + raise KeyError( + 'Missing required value for primary key attribute "{0}" on ' + 'entity {1!r}.'.format(name, entity) + ) + + primary_key[str(name)] = str(value) + + return primary_key + + +def _state(operation, state): + '''Return state following *operation* against current *state*.''' + if ( + isinstance( + operation, ftrack_api.operation.CreateEntityOperation + ) + and state is ftrack_api.symbol.NOT_SET + ): + state = ftrack_api.symbol.CREATED + + elif ( + isinstance( + operation, ftrack_api.operation.UpdateEntityOperation + ) + and state is ftrack_api.symbol.NOT_SET + ): + state = ftrack_api.symbol.MODIFIED + + elif isinstance( + operation, ftrack_api.operation.DeleteEntityOperation + ): + state = ftrack_api.symbol.DELETED + + return state + + +def state(entity): + '''Return current *entity* state. + + .. seealso:: :func:`ftrack_api.inspection.states`. + + ''' + value = ftrack_api.symbol.NOT_SET + + for operation in entity.session.recorded_operations: + # Determine if operation refers to an entity and whether that entity + # is *entity*. + if ( + isinstance( + operation, + ( + ftrack_api.operation.CreateEntityOperation, + ftrack_api.operation.UpdateEntityOperation, + ftrack_api.operation.DeleteEntityOperation + ) + ) + and operation.entity_type == entity.entity_type + and operation.entity_key == primary_key(entity) + ): + value = _state(operation, value) + + return value + + +def states(entities): + '''Return current states of *entities*. + + An optimised function for determining states of multiple entities in one + go. + + .. note:: + + All *entities* should belong to the same session. + + .. seealso:: :func:`ftrack_api.inspection.state`. + + ''' + if not entities: + return [] + + session = entities[0].session + + entities_by_identity = collections.OrderedDict() + for entity in entities: + key = (entity.entity_type, str(primary_key(entity).values())) + entities_by_identity[key] = ftrack_api.symbol.NOT_SET + + for operation in session.recorded_operations: + if ( + isinstance( + operation, + ( + ftrack_api.operation.CreateEntityOperation, + ftrack_api.operation.UpdateEntityOperation, + ftrack_api.operation.DeleteEntityOperation + ) + ) + ): + key = (operation.entity_type, str(operation.entity_key.values())) + if key not in entities_by_identity: + continue + + value = _state(operation, entities_by_identity[key]) + entities_by_identity[key] = value + + return entities_by_identity.values() diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/logging.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/logging.py new file mode 100644 index 0000000000..41969c5b2a --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/logging.py @@ -0,0 +1,43 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2016 ftrack + +import functools +import warnings + + +def deprecation_warning(message): + def decorator(function): + @functools.wraps(function) + def wrapper(*args, **kwargs): + warnings.warn( + message, + PendingDeprecationWarning + ) + return function(*args, **kwargs) + return wrapper + + return decorator + + +class LazyLogMessage(object): + '''A log message that can be evaluated lazily for improved performance. + + Example:: + + # Formatting of string will not occur unless debug logging enabled. + logger.debug(LazyLogMessage( + 'Hello {0}', 'world' + )) + + ''' + + def __init__(self, message, *args, **kwargs): + '''Initialise with *message* format string and arguments.''' + self.message = message + self.args = args + self.kwargs = kwargs + + def __str__(self): + '''Return string representation.''' + return self.message.format(*self.args, **self.kwargs) + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/operation.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/operation.py new file mode 100644 index 0000000000..bb3bb4ee2c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/operation.py @@ -0,0 +1,115 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import copy + + +class Operations(object): + '''Stack of operations.''' + + def __init__(self): + '''Initialise stack.''' + self._stack = [] + super(Operations, self).__init__() + + def clear(self): + '''Clear all operations.''' + del self._stack[:] + + def push(self, operation): + '''Push *operation* onto stack.''' + self._stack.append(operation) + + def pop(self): + '''Pop and return most recent operation from stack.''' + return self._stack.pop() + + def __len__(self): + '''Return count of operations.''' + return len(self._stack) + + def __iter__(self): + '''Return iterator over operations.''' + return iter(self._stack) + + +class Operation(object): + '''Represent an operation.''' + + +class CreateEntityOperation(Operation): + '''Represent create entity operation.''' + + def __init__(self, entity_type, entity_key, entity_data): + '''Initialise operation. + + *entity_type* should be the type of entity in string form (as returned + from :attr:`ftrack_api.entity.base.Entity.entity_type`). + + *entity_key* should be the unique key for the entity and should follow + the form returned from :func:`ftrack_api.inspection.primary_key`. + + *entity_data* should be a mapping of the initial data to populate the + entity with when creating. + + .. note:: + + Shallow copies will be made of each value in *entity_data*. + + ''' + super(CreateEntityOperation, self).__init__() + self.entity_type = entity_type + self.entity_key = entity_key + self.entity_data = {} + for key, value in entity_data.items(): + self.entity_data[key] = copy.copy(value) + + +class UpdateEntityOperation(Operation): + '''Represent update entity operation.''' + + def __init__( + self, entity_type, entity_key, attribute_name, old_value, new_value + ): + '''Initialise operation. + + *entity_type* should be the type of entity in string form (as returned + from :attr:`ftrack_api.entity.base.Entity.entity_type`). + + *entity_key* should be the unique key for the entity and should follow + the form returned from :func:`ftrack_api.inspection.primary_key`. + + *attribute_name* should be the string name of the attribute being + modified and *old_value* and *new_value* should reflect the change in + value. + + .. note:: + + Shallow copies will be made of both *old_value* and *new_value*. + + ''' + super(UpdateEntityOperation, self).__init__() + self.entity_type = entity_type + self.entity_key = entity_key + self.attribute_name = attribute_name + self.old_value = copy.copy(old_value) + self.new_value = copy.copy(new_value) + + +class DeleteEntityOperation(Operation): + '''Represent delete entity operation.''' + + def __init__(self, entity_type, entity_key): + '''Initialise operation. + + *entity_type* should be the type of entity in string form (as returned + from :attr:`ftrack_api.entity.base.Entity.entity_type`). + + *entity_key* should be the unique key for the entity and should follow + the form returned from :func:`ftrack_api.inspection.primary_key`. + + ''' + super(DeleteEntityOperation, self).__init__() + self.entity_type = entity_type + self.entity_key = entity_key + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/plugin.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/plugin.py new file mode 100644 index 0000000000..2c7a9a4500 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/plugin.py @@ -0,0 +1,121 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from __future__ import absolute_import + +import logging +import os +import uuid +import imp +import inspect + + +def discover(paths, positional_arguments=None, keyword_arguments=None): + '''Find and load plugins in search *paths*. + + Each discovered module should implement a register function that accepts + *positional_arguments* and *keyword_arguments* as \*args and \*\*kwargs + respectively. + + If a register function does not accept variable arguments, then attempt to + only pass accepted arguments to the function by inspecting its signature. + + ''' + logger = logging.getLogger(__name__ + '.discover') + + if positional_arguments is None: + positional_arguments = [] + + if keyword_arguments is None: + keyword_arguments = {} + + for path in paths: + # Ignore empty paths that could resolve to current directory. + path = path.strip() + if not path: + continue + + for base, directories, filenames in os.walk(path): + for filename in filenames: + name, extension = os.path.splitext(filename) + if extension != '.py': + continue + + module_path = os.path.join(base, filename) + unique_name = uuid.uuid4().hex + + try: + module = imp.load_source(unique_name, module_path) + except Exception as error: + logger.warning( + 'Failed to load plugin from "{0}": {1}' + .format(module_path, error) + ) + continue + + try: + module.register + except AttributeError: + logger.warning( + 'Failed to load plugin that did not define a ' + '"register" function at the module level: {0}' + .format(module_path) + ) + else: + # Attempt to only pass arguments that are accepted by the + # register function. + specification = inspect.getargspec(module.register) + + selected_positional_arguments = positional_arguments + selected_keyword_arguments = keyword_arguments + + if ( + not specification.varargs and + len(positional_arguments) > len(specification.args) + ): + logger.warning( + 'Culling passed arguments to match register ' + 'function signature.' + ) + + selected_positional_arguments = positional_arguments[ + len(specification.args): + ] + selected_keyword_arguments = {} + + elif not specification.keywords: + # Remove arguments that have been passed as positionals. + remainder = specification.args[ + len(positional_arguments): + ] + + # Determine remaining available keyword arguments. + defined_keyword_arguments = [] + if specification.defaults: + defined_keyword_arguments = specification.args[ + -len(specification.defaults): + ] + + remaining_keyword_arguments = set([ + keyword_argument for keyword_argument + in defined_keyword_arguments + if keyword_argument in remainder + ]) + + if not set(keyword_arguments.keys()).issubset( + remaining_keyword_arguments + ): + logger.warning( + 'Culling passed arguments to match register ' + 'function signature.' + ) + selected_keyword_arguments = { + key: value + for key, value in keyword_arguments.items() + if key in remaining_keyword_arguments + } + + module.register( + *selected_positional_arguments, + **selected_keyword_arguments + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/query.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/query.py new file mode 100644 index 0000000000..ea101a29d4 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/query.py @@ -0,0 +1,202 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import re +import collections + +import ftrack_api.exception + + +class QueryResult(collections.Sequence): + '''Results from a query.''' + + OFFSET_EXPRESSION = re.compile('(?Poffset (?P\d+))') + LIMIT_EXPRESSION = re.compile('(?Plimit (?P\d+))') + + def __init__(self, session, expression, page_size=500): + '''Initialise result set. + + *session* should be an instance of :class:`ftrack_api.session.Session` + that will be used for executing the query *expression*. + + *page_size* should be an integer specifying the maximum number of + records to fetch in one request allowing the results to be fetched + incrementally in a transparent manner for optimal performance. Any + offset or limit specified in *expression* are honoured for final result + set, but intermediate queries may be issued with different offsets and + limits in order to fetch pages. When an embedded limit is smaller than + the given *page_size* it will be used instead and no paging will take + place. + + .. warning:: + + Setting *page_size* to a very large amount may negatively impact + performance of not only the caller, but the server in general. + + ''' + super(QueryResult, self).__init__() + self._session = session + self._results = [] + + ( + self._expression, + self._offset, + self._limit + ) = self._extract_offset_and_limit(expression) + + self._page_size = page_size + if self._limit is not None and self._limit < self._page_size: + # Optimise case where embedded limit is less than fetching a + # single page. + self._page_size = self._limit + + self._next_offset = self._offset + if self._next_offset is None: + # Initialise with zero offset. + self._next_offset = 0 + + def _extract_offset_and_limit(self, expression): + '''Process *expression* extracting offset and limit. + + Return (expression, offset, limit). + + ''' + offset = None + match = self.OFFSET_EXPRESSION.search(expression) + if match: + offset = int(match.group('value')) + expression = ( + expression[:match.start('offset')] + + expression[match.end('offset'):] + ) + + limit = None + match = self.LIMIT_EXPRESSION.search(expression) + if match: + limit = int(match.group('value')) + expression = ( + expression[:match.start('limit')] + + expression[match.end('limit'):] + ) + + return expression.strip(), offset, limit + + def __getitem__(self, index): + '''Return value at *index*.''' + while self._can_fetch_more() and index >= len(self._results): + self._fetch_more() + + return self._results[index] + + def __len__(self): + '''Return number of items.''' + while self._can_fetch_more(): + self._fetch_more() + + return len(self._results) + + def _can_fetch_more(self): + '''Return whether more results are available to fetch.''' + return self._next_offset is not None + + def _fetch_more(self): + '''Fetch next page of results if available.''' + if not self._can_fetch_more(): + return + + expression = '{0} offset {1} limit {2}'.format( + self._expression, self._next_offset, self._page_size + ) + records, metadata = self._session._query(expression) + self._results.extend(records) + + if self._limit is not None and (len(self._results) >= self._limit): + # Original limit reached. + self._next_offset = None + del self._results[self._limit:] + else: + # Retrieve next page offset from returned metadata. + self._next_offset = metadata.get('next', {}).get('offset', None) + + def all(self): + '''Fetch and return all data.''' + return list(self) + + def one(self): + '''Return exactly one single result from query by applying a limit. + + Raise :exc:`ValueError` if an existing limit is already present in the + expression. + + Raise :exc:`ValueError` if an existing offset is already present in the + expression as offset is inappropriate when expecting a single item. + + Raise :exc:`~ftrack_api.exception.MultipleResultsFoundError` if more + than one result was available or + :exc:`~ftrack_api.exception.NoResultFoundError` if no results were + available. + + .. note:: + + Both errors subclass + :exc:`~ftrack_api.exception.IncorrectResultError` if you want to + catch only one error type. + + ''' + expression = self._expression + + if self._limit is not None: + raise ValueError( + 'Expression already contains a limit clause.' + ) + + if self._offset is not None: + raise ValueError( + 'Expression contains an offset clause which does not make ' + 'sense when selecting a single item.' + ) + + # Apply custom limit as optimisation. A limit of 2 is used rather than + # 1 so that it is possible to test for multiple matching entries + # case. + expression += ' limit 2' + + results, metadata = self._session._query(expression) + + if not results: + raise ftrack_api.exception.NoResultFoundError() + + if len(results) != 1: + raise ftrack_api.exception.MultipleResultsFoundError() + + return results[0] + + def first(self): + '''Return first matching result from query by applying a limit. + + Raise :exc:`ValueError` if an existing limit is already present in the + expression. + + If no matching result available return None. + + ''' + expression = self._expression + + if self._limit is not None: + raise ValueError( + 'Expression already contains a limit clause.' + ) + + # Apply custom offset if present. + if self._offset is not None: + expression += ' offset {0}'.format(self._offset) + + # Apply custom limit as optimisation. + expression += ' limit 1' + + results, metadata = self._session._query(expression) + + if results: + return results[0] + + return None diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/resource_identifier_transformer/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/resource_identifier_transformer/__init__.py new file mode 100644 index 0000000000..1aab07ed77 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/resource_identifier_transformer/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/resource_identifier_transformer/base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/resource_identifier_transformer/base.py new file mode 100644 index 0000000000..ee069b57b6 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/resource_identifier_transformer/base.py @@ -0,0 +1,50 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + + +class ResourceIdentifierTransformer(object): + '''Transform resource identifiers. + + Provide ability to modify resource identifier before it is stored centrally + (:meth:`encode`), or after it has been retrieved, but before it is used + locally (:meth:`decode`). + + For example, you might want to decompose paths into a set of key, value + pairs to store centrally and then compose a path from those values when + reading back. + + .. note:: + + This is separate from any transformations an + :class:`ftrack_api.accessor.base.Accessor` may perform and is targeted + towards common transformations. + + ''' + + def __init__(self, session): + '''Initialise resource identifier transformer. + + *session* should be the :class:`ftrack_api.session.Session` instance + to use for communication with the server. + + ''' + self.session = session + super(ResourceIdentifierTransformer, self).__init__() + + def encode(self, resource_identifier, context=None): + '''Return encoded *resource_identifier* for storing centrally. + + A mapping of *context* values may be supplied to guide the + transformation. + + ''' + return resource_identifier + + def decode(self, resource_identifier, context=None): + '''Return decoded *resource_identifier* for use locally. + + A mapping of *context* values may be supplied to guide the + transformation. + + ''' + return resource_identifier diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/session.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/session.py new file mode 100644 index 0000000000..1a5da44432 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/session.py @@ -0,0 +1,2515 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from __future__ import absolute_import + +import json +import logging +import collections +import datetime +import os +import getpass +import functools +import itertools +import distutils.version +import hashlib +import tempfile +import threading +import atexit +import warnings + +import requests +import requests.auth +import arrow +import clique + +import ftrack_api +import ftrack_api.exception +import ftrack_api.entity.factory +import ftrack_api.entity.base +import ftrack_api.entity.location +import ftrack_api.cache +import ftrack_api.symbol +import ftrack_api.query +import ftrack_api.attribute +import ftrack_api.collection +import ftrack_api.event.hub +import ftrack_api.event.base +import ftrack_api.plugin +import ftrack_api.inspection +import ftrack_api.operation +import ftrack_api.accessor.disk +import ftrack_api.structure.origin +import ftrack_api.structure.entity_id +import ftrack_api.accessor.server +import ftrack_api._centralized_storage_scenario +import ftrack_api.logging +from ftrack_api.logging import LazyLogMessage as L + +try: + from weakref import WeakMethod +except ImportError: + from ftrack_api._weakref import WeakMethod + + +class SessionAuthentication(requests.auth.AuthBase): + '''Attach ftrack session authentication information to requests.''' + + def __init__(self, api_key, api_user): + '''Initialise with *api_key* and *api_user*.''' + self.api_key = api_key + self.api_user = api_user + super(SessionAuthentication, self).__init__() + + def __call__(self, request): + '''Modify *request* to have appropriate headers.''' + request.headers.update({ + 'ftrack-api-key': self.api_key, + 'ftrack-user': self.api_user + }) + return request + + +class Session(object): + '''An isolated session for interaction with an ftrack server.''' + + def __init__( + self, server_url=None, api_key=None, api_user=None, auto_populate=True, + plugin_paths=None, cache=None, cache_key_maker=None, + auto_connect_event_hub=None, schema_cache_path=None, + plugin_arguments=None + ): + '''Initialise session. + + *server_url* should be the URL of the ftrack server to connect to + including any port number. If not specified attempt to look up from + :envvar:`FTRACK_SERVER`. + + *api_key* should be the API key to use for authentication whilst + *api_user* should be the username of the user in ftrack to record + operations against. If not specified, *api_key* should be retrieved + from :envvar:`FTRACK_API_KEY` and *api_user* from + :envvar:`FTRACK_API_USER`. + + If *auto_populate* is True (the default), then accessing entity + attributes will cause them to be automatically fetched from the server + if they are not already. This flag can be changed on the session + directly at any time. + + *plugin_paths* should be a list of paths to search for plugins. If not + specified, default to looking up :envvar:`FTRACK_EVENT_PLUGIN_PATH`. + + *cache* should be an instance of a cache that fulfils the + :class:`ftrack_api.cache.Cache` interface and will be used as the cache + for the session. It can also be a callable that will be called with the + session instance as sole argument. The callable should return ``None`` + if a suitable cache could not be configured, but session instantiation + can continue safely. + + .. note:: + + The session will add the specified cache to a pre-configured layered + cache that specifies the top level cache as a + :class:`ftrack_api.cache.MemoryCache`. Therefore, it is unnecessary + to construct a separate memory cache for typical behaviour. Working + around this behaviour or removing the memory cache can lead to + unexpected behaviour. + + *cache_key_maker* should be an instance of a key maker that fulfils the + :class:`ftrack_api.cache.KeyMaker` interface and will be used to + generate keys for objects being stored in the *cache*. If not specified, + a :class:`~ftrack_api.cache.StringKeyMaker` will be used. + + If *auto_connect_event_hub* is True then embedded event hub will be + automatically connected to the event server and allow for publishing and + subscribing to **non-local** events. If False, then only publishing and + subscribing to **local** events will be possible until the hub is + manually connected using :meth:`EventHub.connect + `. + + .. note:: + + The event hub connection is performed in a background thread to + improve session startup time. If a registered plugin requires a + connected event hub then it should check the event hub connection + status explicitly. Subscribing to events does *not* require a + connected event hub. + + Enable schema caching by setting *schema_cache_path* to a folder path. + If not set, :envvar:`FTRACK_API_SCHEMA_CACHE_PATH` will be used to + determine the path to store cache in. If the environment variable is + also not specified then a temporary directory will be used. Set to + `False` to disable schema caching entirely. + + *plugin_arguments* should be an optional mapping (dict) of keyword + arguments to pass to plugin register functions upon discovery. If a + discovered plugin has a signature that is incompatible with the passed + arguments, the discovery mechanism will attempt to reduce the passed + arguments to only those that the plugin accepts. Note that a warning + will be logged in this case. + + ''' + super(Session, self).__init__() + self.logger = logging.getLogger( + __name__ + '.' + self.__class__.__name__ + ) + self._closed = False + + if server_url is None: + server_url = os.environ.get('FTRACK_SERVER') + + if not server_url: + raise TypeError( + 'Required "server_url" not specified. Pass as argument or set ' + 'in environment variable FTRACK_SERVER.' + ) + + self._server_url = server_url + + if api_key is None: + api_key = os.environ.get( + 'FTRACK_API_KEY', + # Backwards compatibility + os.environ.get('FTRACK_APIKEY') + ) + + if not api_key: + raise TypeError( + 'Required "api_key" not specified. Pass as argument or set in ' + 'environment variable FTRACK_API_KEY.' + ) + + self._api_key = api_key + + if api_user is None: + api_user = os.environ.get('FTRACK_API_USER') + if not api_user: + try: + api_user = getpass.getuser() + except Exception: + pass + + if not api_user: + raise TypeError( + 'Required "api_user" not specified. Pass as argument, set in ' + 'environment variable FTRACK_API_USER or one of the standard ' + 'environment variables used by Python\'s getpass module.' + ) + + self._api_user = api_user + + # Currently pending operations. + self.recorded_operations = ftrack_api.operation.Operations() + self.record_operations = True + + self.cache_key_maker = cache_key_maker + if self.cache_key_maker is None: + self.cache_key_maker = ftrack_api.cache.StringKeyMaker() + + # Enforce always having a memory cache at top level so that the same + # in-memory instance is returned from session. + self.cache = ftrack_api.cache.LayeredCache([ + ftrack_api.cache.MemoryCache() + ]) + + if cache is not None: + if callable(cache): + cache = cache(self) + + if cache is not None: + self.cache.caches.append(cache) + + self._managed_request = None + self._request = requests.Session() + self._request.auth = SessionAuthentication( + self._api_key, self._api_user + ) + + self.auto_populate = auto_populate + + # Fetch server information and in doing so also check credentials. + self._server_information = self._fetch_server_information() + + # Now check compatibility of server based on retrieved information. + self.check_server_compatibility() + + # Construct event hub and load plugins. + self._event_hub = ftrack_api.event.hub.EventHub( + self._server_url, + self._api_user, + self._api_key, + ) + + self._auto_connect_event_hub_thread = None + if auto_connect_event_hub in (None, True): + # Connect to event hub in background thread so as not to block main + # session usage waiting for event hub connection. + self._auto_connect_event_hub_thread = threading.Thread( + target=self._event_hub.connect + ) + self._auto_connect_event_hub_thread.daemon = True + self._auto_connect_event_hub_thread.start() + + # To help with migration from auto_connect_event_hub default changing + # from True to False. + self._event_hub._deprecation_warning_auto_connect = ( + auto_connect_event_hub is None + ) + + # Register to auto-close session on exit. + atexit.register(WeakMethod(self.close)) + + self._plugin_paths = plugin_paths + if self._plugin_paths is None: + self._plugin_paths = os.environ.get( + 'FTRACK_EVENT_PLUGIN_PATH', '' + ).split(os.pathsep) + + self._discover_plugins(plugin_arguments=plugin_arguments) + + # TODO: Make schemas read-only and non-mutable (or at least without + # rebuilding types)? + if schema_cache_path is not False: + if schema_cache_path is None: + schema_cache_path = os.environ.get( + 'FTRACK_API_SCHEMA_CACHE_PATH', tempfile.gettempdir() + ) + + schema_cache_path = os.path.join( + schema_cache_path, 'ftrack_api_schema_cache.json' + ) + + self.schemas = self._load_schemas(schema_cache_path) + self.types = self._build_entity_type_classes(self.schemas) + + ftrack_api._centralized_storage_scenario.register(self) + + self._configure_locations() + self.event_hub.publish( + ftrack_api.event.base.Event( + topic='ftrack.api.session.ready', + data=dict( + session=self + ) + ), + synchronous=True + ) + + def __enter__(self): + '''Return session as context manager.''' + return self + + def __exit__(self, exception_type, exception_value, traceback): + '''Exit session context, closing session in process.''' + self.close() + + @property + def _request(self): + '''Return request session. + + Raise :exc:`ftrack_api.exception.ConnectionClosedError` if session has + been closed and connection unavailable. + + ''' + if self._managed_request is None: + raise ftrack_api.exception.ConnectionClosedError() + + return self._managed_request + + @_request.setter + def _request(self, value): + '''Set request session to *value*.''' + self._managed_request = value + + @property + def closed(self): + '''Return whether session has been closed.''' + return self._closed + + @property + def server_information(self): + '''Return server information such as server version.''' + return self._server_information.copy() + + @property + def server_url(self): + '''Return server ulr used for session.''' + return self._server_url + + @property + def api_user(self): + '''Return username used for session.''' + return self._api_user + + @property + def api_key(self): + '''Return API key used for session.''' + return self._api_key + + @property + def event_hub(self): + '''Return event hub.''' + return self._event_hub + + @property + def _local_cache(self): + '''Return top level memory cache.''' + return self.cache.caches[0] + + def check_server_compatibility(self): + '''Check compatibility with connected server.''' + server_version = self.server_information.get('version') + if server_version is None: + raise ftrack_api.exception.ServerCompatibilityError( + 'Could not determine server version.' + ) + + # Perform basic version check. + if server_version != 'dev': + min_server_version = '3.3.11' + if ( + distutils.version.LooseVersion(min_server_version) + > distutils.version.LooseVersion(server_version) + ): + raise ftrack_api.exception.ServerCompatibilityError( + 'Server version {0} incompatible with this version of the ' + 'API which requires a server version >= {1}'.format( + server_version, + min_server_version + ) + ) + + def close(self): + '''Close session. + + Close connections to server. Clear any pending operations and local + cache. + + Use this to ensure that session is cleaned up properly after use. + + ''' + if self.closed: + self.logger.debug('Session already closed.') + return + + self._closed = True + + self.logger.debug('Closing session.') + if self.recorded_operations: + self.logger.warning( + 'Closing session with pending operations not persisted.' + ) + + # Clear pending operations. + self.recorded_operations.clear() + + # Clear top level cache (expected to be enforced memory cache). + self._local_cache.clear() + + # Close connections. + self._request.close() + self._request = None + + try: + self.event_hub.disconnect() + if self._auto_connect_event_hub_thread: + self._auto_connect_event_hub_thread.join() + except ftrack_api.exception.EventHubConnectionError: + pass + + self.logger.debug('Session closed.') + + def reset(self): + '''Reset session clearing local state. + + Clear all pending operations and expunge all entities from session. + + Also clear the local cache. If the cache used by the session is a + :class:`~ftrack_api.cache.LayeredCache` then only clear top level cache. + Otherwise, clear the entire cache. + + Plugins are not rediscovered or reinitialised, but certain plugin events + are re-emitted to properly configure session aspects that are dependant + on cache (such as location plugins). + + .. warning:: + + Previously attached entities are not reset in memory and will retain + their state, but should not be used. Doing so will cause errors. + + ''' + if self.recorded_operations: + self.logger.warning( + 'Resetting session with pending operations not persisted.' + ) + + # Clear pending operations. + self.recorded_operations.clear() + + # Clear top level cache (expected to be enforced memory cache). + self._local_cache.clear() + + # Re-configure certain session aspects that may be dependant on cache. + self._configure_locations() + + self.event_hub.publish( + ftrack_api.event.base.Event( + topic='ftrack.api.session.reset', + data=dict( + session=self + ) + ), + synchronous=True + ) + + def auto_populating(self, auto_populate): + '''Temporarily set auto populate to *auto_populate*. + + The current setting will be restored automatically when done. + + Example:: + + with session.auto_populating(False): + print entity['name'] + + ''' + return AutoPopulatingContext(self, auto_populate) + + def operation_recording(self, record_operations): + '''Temporarily set operation recording to *record_operations*. + + The current setting will be restored automatically when done. + + Example:: + + with session.operation_recording(False): + entity['name'] = 'change_not_recorded' + + ''' + return OperationRecordingContext(self, record_operations) + + @property + def created(self): + '''Return list of newly created entities.''' + entities = self._local_cache.values() + states = ftrack_api.inspection.states(entities) + + return [ + entity for (entity, state) in itertools.izip(entities, states) + if state is ftrack_api.symbol.CREATED + ] + + @property + def modified(self): + '''Return list of locally modified entities.''' + entities = self._local_cache.values() + states = ftrack_api.inspection.states(entities) + + return [ + entity for (entity, state) in itertools.izip(entities, states) + if state is ftrack_api.symbol.MODIFIED + ] + + @property + def deleted(self): + '''Return list of deleted entities.''' + entities = self._local_cache.values() + states = ftrack_api.inspection.states(entities) + + return [ + entity for (entity, state) in itertools.izip(entities, states) + if state is ftrack_api.symbol.DELETED + ] + + def reset_remote(self, reset_type, entity=None): + '''Perform a server side reset. + + *reset_type* is a server side supported reset type, + passing the optional *entity* to perform the option upon. + + Please refer to ftrack documentation for a complete list of + supported server side reset types. + ''' + + payload = { + 'action': 'reset_remote', + 'reset_type': reset_type + } + + if entity is not None: + payload.update({ + 'entity_type': entity.entity_type, + 'entity_key': entity.get('id') + }) + + result = self.call( + [payload] + ) + + return result[0]['data'] + + def create(self, entity_type, data=None, reconstructing=False): + '''Create and return an entity of *entity_type* with initial *data*. + + If specified, *data* should be a dictionary of key, value pairs that + should be used to populate attributes on the entity. + + If *reconstructing* is False then create a new entity setting + appropriate defaults for missing data. If True then reconstruct an + existing entity. + + Constructed entity will be automatically :meth:`merged ` + into the session. + + ''' + entity = self._create(entity_type, data, reconstructing=reconstructing) + entity = self.merge(entity) + return entity + + def _create(self, entity_type, data, reconstructing): + '''Create and return an entity of *entity_type* with initial *data*.''' + try: + EntityTypeClass = self.types[entity_type] + except KeyError: + raise ftrack_api.exception.UnrecognisedEntityTypeError(entity_type) + + return EntityTypeClass(self, data=data, reconstructing=reconstructing) + + def ensure(self, entity_type, data, identifying_keys=None): + '''Retrieve entity of *entity_type* with *data*, creating if necessary. + + *data* should be a dictionary of the same form passed to :meth:`create`. + + By default, check for an entity that has matching *data*. If + *identifying_keys* is specified as a list of keys then only consider the + values from *data* for those keys when searching for existing entity. If + *data* is missing an identifying key then raise :exc:`KeyError`. + + If no *identifying_keys* specified then use all of the keys from the + passed *data*. Raise :exc:`ValueError` if no *identifying_keys* can be + determined. + + Each key should be a string. + + .. note:: + + Currently only top level scalars supported. To ensure an entity by + looking at relationships, manually issue the :meth:`query` and + :meth:`create` calls. + + If more than one entity matches the determined filter criteria then + raise :exc:`~ftrack_api.exception.MultipleResultsFoundError`. + + If no matching entity found then create entity using supplied *data*. + + If a matching entity is found, then update it if necessary with *data*. + + .. note:: + + If entity created or updated then a :meth:`commit` will be issued + automatically. If this behaviour is undesired, perform the + :meth:`query` and :meth:`create` calls manually. + + Return retrieved or created entity. + + Example:: + + # First time, a new entity with `username=martin` is created. + entity = session.ensure('User', {'username': 'martin'}) + + # After that, the existing entity is retrieved. + entity = session.ensure('User', {'username': 'martin'}) + + # When existing entity retrieved, entity may also be updated to + # match supplied data. + entity = session.ensure( + 'User', {'username': 'martin', 'email': 'martin@example.com'} + ) + + ''' + if not identifying_keys: + identifying_keys = data.keys() + + self.logger.debug(L( + 'Ensuring entity {0!r} with data {1!r} using identifying keys ' + '{2!r}', entity_type, data, identifying_keys + )) + + if not identifying_keys: + raise ValueError( + 'Could not determine any identifying data to check against ' + 'when ensuring {0!r} with data {1!r}. Identifying keys: {2!r}' + .format(entity_type, data, identifying_keys) + ) + + expression = '{0} where'.format(entity_type) + criteria = [] + for identifying_key in identifying_keys: + value = data[identifying_key] + + if isinstance(value, basestring): + value = '"{0}"'.format(value) + + elif isinstance( + value, (arrow.Arrow, datetime.datetime, datetime.date) + ): + # Server does not store microsecond or timezone currently so + # need to strip from query. + # TODO: When datetime handling improved, update this logic. + value = ( + arrow.get(value).naive.replace(microsecond=0).isoformat() + ) + value = '"{0}"'.format(value) + + criteria.append('{0} is {1}'.format(identifying_key, value)) + + expression = '{0} {1}'.format( + expression, ' and '.join(criteria) + ) + + try: + entity = self.query(expression).one() + + except ftrack_api.exception.NoResultFoundError: + self.logger.debug('Creating entity as did not already exist.') + + # Create entity. + entity = self.create(entity_type, data) + self.commit() + + else: + self.logger.debug('Retrieved matching existing entity.') + + # Update entity if required. + updated = False + for key, target_value in data.items(): + if entity[key] != target_value: + entity[key] = target_value + updated = True + + if updated: + self.logger.debug('Updating existing entity to match new data.') + self.commit() + + return entity + + def delete(self, entity): + '''Mark *entity* for deletion.''' + if self.record_operations: + self.recorded_operations.push( + ftrack_api.operation.DeleteEntityOperation( + entity.entity_type, + ftrack_api.inspection.primary_key(entity) + ) + ) + + def get(self, entity_type, entity_key): + '''Return entity of *entity_type* with unique *entity_key*. + + First check for an existing entry in the configured cache, otherwise + issue a query to the server. + + If no matching entity found, return None. + + ''' + self.logger.debug(L('Get {0} with key {1}', entity_type, entity_key)) + + primary_key_definition = self.types[entity_type].primary_key_attributes + if isinstance(entity_key, basestring): + entity_key = [entity_key] + + if len(entity_key) != len(primary_key_definition): + raise ValueError( + 'Incompatible entity_key {0!r} supplied. Entity type {1} ' + 'expects a primary key composed of {2} values ({3}).' + .format( + entity_key, entity_type, len(primary_key_definition), + ', '.join(primary_key_definition) + ) + ) + + entity = None + try: + entity = self._get(entity_type, entity_key) + + + except KeyError: + + # Query for matching entity. + self.logger.debug( + 'Entity not present in cache. Issuing new query.' + ) + condition = [] + for key, value in zip(primary_key_definition, entity_key): + condition.append('{0} is "{1}"'.format(key, value)) + + expression = '{0} where ({1})'.format( + entity_type, ' and '.join(condition) + ) + + results = self.query(expression).all() + if results: + entity = results[0] + + return entity + + def _get(self, entity_type, entity_key): + '''Return cached entity of *entity_type* with unique *entity_key*. + + Raise :exc:`KeyError` if no such entity in the cache. + + ''' + # Check cache for existing entity emulating + # ftrack_api.inspection.identity result object to pass to key maker. + cache_key = self.cache_key_maker.key( + (str(entity_type), map(str, entity_key)) + ) + self.logger.debug(L( + 'Checking cache for entity with key {0}', cache_key + )) + entity = self.cache.get(cache_key) + self.logger.debug(L( + 'Retrieved existing entity from cache: {0} at {1}', + entity, id(entity) + )) + + return entity + + def query(self, expression, page_size=500): + '''Query against remote data according to *expression*. + + *expression* is not executed directly. Instead return an + :class:`ftrack_api.query.QueryResult` instance that will execute remote + call on access. + + *page_size* specifies the maximum page size that the returned query + result object should be configured with. + + .. seealso:: :ref:`querying` + + ''' + self.logger.debug(L('Query {0!r}', expression)) + + # Add in sensible projections if none specified. Note that this is + # done here rather than on the server to allow local modification of the + # schema setting to include commonly used custom attributes for example. + # TODO: Use a proper parser perhaps? + if not expression.startswith('select'): + entity_type = expression.split(' ', 1)[0] + EntityTypeClass = self.types[entity_type] + projections = EntityTypeClass.default_projections + + expression = 'select {0} from {1}'.format( + ', '.join(projections), + expression + ) + + query_result = ftrack_api.query.QueryResult( + self, expression, page_size=page_size + ) + return query_result + + def _query(self, expression): + '''Execute *query* and return (records, metadata). + + Records will be a list of entities retrieved via the query and metadata + a dictionary of accompanying information about the result set. + + ''' + # TODO: Actually support batching several queries together. + # TODO: Should batches have unique ids to match them up later. + batch = [{ + 'action': 'query', + 'expression': expression + }] + + # TODO: When should this execute? How to handle background=True? + results = self.call(batch) + + # Merge entities into local cache and return merged entities. + data = [] + merged = dict() + for entity in results[0]['data']: + data.append(self._merge_recursive(entity, merged)) + + return data, results[0]['metadata'] + + def merge(self, value, merged=None): + '''Merge *value* into session and return merged value. + + *merged* should be a mapping to record merges during run and should be + used to avoid infinite recursion. If not set will default to a + dictionary. + + ''' + if merged is None: + merged = {} + + with self.operation_recording(False): + return self._merge(value, merged) + + def _merge(self, value, merged): + '''Return merged *value*.''' + log_debug = self.logger.isEnabledFor(logging.DEBUG) + + if isinstance(value, ftrack_api.entity.base.Entity): + log_debug and self.logger.debug( + 'Merging entity into session: {0} at {1}' + .format(value, id(value)) + ) + + return self._merge_entity(value, merged=merged) + + elif isinstance(value, ftrack_api.collection.Collection): + log_debug and self.logger.debug( + 'Merging collection into session: {0!r} at {1}' + .format(value, id(value)) + ) + + merged_collection = [] + for entry in value: + merged_collection.append( + self._merge(entry, merged=merged) + ) + + return merged_collection + + elif isinstance(value, ftrack_api.collection.MappedCollectionProxy): + log_debug and self.logger.debug( + 'Merging mapped collection into session: {0!r} at {1}' + .format(value, id(value)) + ) + + merged_collection = [] + for entry in value.collection: + merged_collection.append( + self._merge(entry, merged=merged) + ) + + return merged_collection + + else: + return value + + def _merge_recursive(self, entity, merged=None): + '''Merge *entity* and all its attributes recursivly.''' + log_debug = self.logger.isEnabledFor(logging.DEBUG) + + if merged is None: + merged = {} + + attached = self.merge(entity, merged) + + for attribute in entity.attributes: + # Remote attributes. + remote_value = attribute.get_remote_value(entity) + + if isinstance( + remote_value, + ( + ftrack_api.entity.base.Entity, + ftrack_api.collection.Collection, + ftrack_api.collection.MappedCollectionProxy + ) + ): + log_debug and self.logger.debug( + 'Merging remote value for attribute {0}.'.format(attribute) + ) + + if isinstance(remote_value, ftrack_api.entity.base.Entity): + self._merge_recursive(remote_value, merged=merged) + + elif isinstance( + remote_value, ftrack_api.collection.Collection + ): + for entry in remote_value: + self._merge_recursive(entry, merged=merged) + + elif isinstance( + remote_value, ftrack_api.collection.MappedCollectionProxy + ): + for entry in remote_value.collection: + self._merge_recursive(entry, merged=merged) + + return attached + + def _merge_entity(self, entity, merged=None): + '''Merge *entity* into session returning merged entity. + + Merge is recursive so any references to other entities will also be + merged. + + *entity* will never be modified in place. Ensure that the returned + merged entity instance is used. + + ''' + log_debug = self.logger.isEnabledFor(logging.DEBUG) + + if merged is None: + merged = {} + + with self.auto_populating(False): + entity_key = self.cache_key_maker.key( + ftrack_api.inspection.identity(entity) + ) + + # Check whether this entity has already been processed. + attached_entity = merged.get(entity_key) + if attached_entity is not None: + log_debug and self.logger.debug( + 'Entity already processed for key {0} as {1} at {2}' + .format(entity_key, attached_entity, id(attached_entity)) + ) + + return attached_entity + else: + log_debug and self.logger.debug( + 'Entity not already processed for key {0}.' + .format(entity_key) + ) + + # Check for existing instance of entity in cache. + log_debug and self.logger.debug( + 'Checking for entity in cache with key {0}'.format(entity_key) + ) + try: + attached_entity = self.cache.get(entity_key) + + log_debug and self.logger.debug( + 'Retrieved existing entity from cache: {0} at {1}' + .format(attached_entity, id(attached_entity)) + ) + + except KeyError: + # Construct new minimal instance to store in cache. + attached_entity = self._create( + entity.entity_type, {}, reconstructing=True + ) + + log_debug and self.logger.debug( + 'Entity not present in cache. Constructed new instance: ' + '{0} at {1}'.format(attached_entity, id(attached_entity)) + ) + + # Mark entity as seen to avoid infinite loops. + merged[entity_key] = attached_entity + + changes = attached_entity.merge(entity, merged=merged) + if changes: + self.cache.set(entity_key, attached_entity) + self.logger.debug('Cache updated with merged entity.') + + else: + self.logger.debug( + 'Cache not updated with merged entity as no differences ' + 'detected.' + ) + + return attached_entity + + def populate(self, entities, projections): + '''Populate *entities* with attributes specified by *projections*. + + Any locally set values included in the *projections* will not be + overwritten with the retrieved remote value. If this 'synchronise' + behaviour is required, first clear the relevant values on the entity by + setting them to :attr:`ftrack_api.symbol.NOT_SET`. Deleting the key will + have the same effect:: + + >>> print(user['username']) + martin + >>> del user['username'] + >>> print(user['username']) + Symbol(NOT_SET) + + .. note:: + + Entities that have been created and not yet persisted will be + skipped as they have no remote values to fetch. + + ''' + self.logger.debug(L( + 'Populate {0!r} projections for {1}.', projections, entities + )) + + if not isinstance( + entities, (list, tuple, ftrack_api.query.QueryResult) + ): + entities = [entities] + + # TODO: How to handle a mixed collection of different entity types + # Should probably fail, but need to consider handling hierarchies such + # as User and Group both deriving from Resource. Actually, could just + # proceed and ignore projections that are not present in entity type. + + entities_to_process = [] + + for entity in entities: + if ftrack_api.inspection.state(entity) is ftrack_api.symbol.CREATED: + # Created entities that are not yet persisted have no remote + # values. Don't raise an error here as it is reasonable to + # iterate over an entities properties and see that some of them + # are NOT_SET. + self.logger.debug(L( + 'Skipping newly created entity {0!r} for population as no ' + 'data will exist in the remote for this entity yet.', entity + )) + continue + + entities_to_process.append(entity) + + if entities_to_process: + reference_entity = entities_to_process[0] + entity_type = reference_entity.entity_type + query = 'select {0} from {1}'.format(projections, entity_type) + + primary_key_definition = reference_entity.primary_key_attributes + entity_keys = [ + ftrack_api.inspection.primary_key(entity).values() + for entity in entities_to_process + ] + + if len(primary_key_definition) > 1: + # Composite keys require full OR syntax unfortunately. + conditions = [] + for entity_key in entity_keys: + condition = [] + for key, value in zip(primary_key_definition, entity_key): + condition.append('{0} is "{1}"'.format(key, value)) + + conditions.append('({0})'.format('and '.join(condition))) + + query = '{0} where {1}'.format(query, ' or '.join(conditions)) + + else: + primary_key = primary_key_definition[0] + + if len(entity_keys) > 1: + query = '{0} where {1} in ({2})'.format( + query, primary_key, + ','.join([ + str(entity_key[0]) for entity_key in entity_keys + ]) + ) + else: + query = '{0} where {1} is {2}'.format( + query, primary_key, str(entity_keys[0][0]) + ) + + result = self.query(query) + + # Fetch all results now. Doing so will cause them to populate the + # relevant entities in the cache. + result.all() + + # TODO: Should we check that all requested attributes were + # actually populated? If some weren't would we mark that to avoid + # repeated calls or perhaps raise an error? + + # TODO: Make atomic. + def commit(self): + '''Commit all local changes to the server.''' + batch = [] + + with self.auto_populating(False): + for operation in self.recorded_operations: + + # Convert operation to payload. + if isinstance( + operation, ftrack_api.operation.CreateEntityOperation + ): + # At present, data payload requires duplicating entity + # type in data and also ensuring primary key added. + entity_data = { + '__entity_type__': operation.entity_type, + } + entity_data.update(operation.entity_key) + entity_data.update(operation.entity_data) + + payload = OperationPayload({ + 'action': 'create', + 'entity_type': operation.entity_type, + 'entity_key': operation.entity_key.values(), + 'entity_data': entity_data + }) + + elif isinstance( + operation, ftrack_api.operation.UpdateEntityOperation + ): + entity_data = { + # At present, data payload requires duplicating entity + # type. + '__entity_type__': operation.entity_type, + operation.attribute_name: operation.new_value + } + + payload = OperationPayload({ + 'action': 'update', + 'entity_type': operation.entity_type, + 'entity_key': operation.entity_key.values(), + 'entity_data': entity_data + }) + + elif isinstance( + operation, ftrack_api.operation.DeleteEntityOperation + ): + payload = OperationPayload({ + 'action': 'delete', + 'entity_type': operation.entity_type, + 'entity_key': operation.entity_key.values() + }) + + else: + raise ValueError( + 'Cannot commit. Unrecognised operation type {0} ' + 'detected.'.format(type(operation)) + ) + + batch.append(payload) + + # Optimise batch. + # TODO: Might be better to perform these on the operations list instead + # so all operation contextual information available. + + # If entity was created and deleted in one batch then remove all + # payloads for that entity. + created = set() + deleted = set() + + for payload in batch: + if payload['action'] == 'create': + created.add( + (payload['entity_type'], str(payload['entity_key'])) + ) + + elif payload['action'] == 'delete': + deleted.add( + (payload['entity_type'], str(payload['entity_key'])) + ) + + created_then_deleted = deleted.intersection(created) + if created_then_deleted: + optimised_batch = [] + for payload in batch: + entity_type = payload.get('entity_type') + entity_key = str(payload.get('entity_key')) + + if (entity_type, entity_key) in created_then_deleted: + continue + + optimised_batch.append(payload) + + batch = optimised_batch + + # Remove early update operations so that only last operation on + # attribute is applied server side. + updates_map = set() + for payload in reversed(batch): + if payload['action'] in ('update', ): + for key, value in payload['entity_data'].items(): + if key == '__entity_type__': + continue + + identity = ( + payload['entity_type'], str(payload['entity_key']), key + ) + if identity in updates_map: + del payload['entity_data'][key] + else: + updates_map.add(identity) + + # Remove NOT_SET values from entity_data. + for payload in batch: + entity_data = payload.get('entity_data', {}) + for key, value in entity_data.items(): + if value is ftrack_api.symbol.NOT_SET: + del entity_data[key] + + # Remove payloads with redundant entity_data. + optimised_batch = [] + for payload in batch: + entity_data = payload.get('entity_data') + if entity_data is not None: + keys = entity_data.keys() + if not keys or keys == ['__entity_type__']: + continue + + optimised_batch.append(payload) + + batch = optimised_batch + + # Collapse updates that are consecutive into one payload. Also, collapse + # updates that occur immediately after creation into the create payload. + optimised_batch = [] + previous_payload = None + + for payload in batch: + if ( + previous_payload is not None + and payload['action'] == 'update' + and previous_payload['action'] in ('create', 'update') + and previous_payload['entity_type'] == payload['entity_type'] + and previous_payload['entity_key'] == payload['entity_key'] + ): + previous_payload['entity_data'].update(payload['entity_data']) + continue + + else: + optimised_batch.append(payload) + previous_payload = payload + + batch = optimised_batch + + # Process batch. + if batch: + result = self.call(batch) + + # Clear recorded operations. + self.recorded_operations.clear() + + # As optimisation, clear local values which are not primary keys to + # avoid redundant merges when merging references. Note: primary keys + # remain as needed for cache retrieval on new entities. + with self.auto_populating(False): + with self.operation_recording(False): + for entity in self._local_cache.values(): + for attribute in entity: + if attribute not in entity.primary_key_attributes: + del entity[attribute] + + # Process results merging into cache relevant data. + for entry in result: + + if entry['action'] in ('create', 'update'): + # Merge returned entities into local cache. + self.merge(entry['data']) + + elif entry['action'] == 'delete': + # TODO: Detach entity - need identity returned? + # TODO: Expunge entity from cache. + pass + # Clear remaining local state, including local values for primary + # keys on entities that were merged. + with self.auto_populating(False): + with self.operation_recording(False): + for entity in self._local_cache.values(): + entity.clear() + + def rollback(self): + '''Clear all recorded operations and local state. + + Typically this would be used following a failed :meth:`commit` in order + to revert the session to a known good state. + + Newly created entities not yet persisted will be detached from the + session / purged from cache and no longer contribute, but the actual + objects are not deleted from memory. They should no longer be used and + doing so could cause errors. + + ''' + with self.auto_populating(False): + with self.operation_recording(False): + + # Detach all newly created entities and remove from cache. This + # is done because simply clearing the local values of newly + # created entities would result in entities with no identity as + # primary key was local while not persisted. In addition, it + # makes no sense for failed created entities to exist in session + # or cache. + for operation in self.recorded_operations: + if isinstance( + operation, ftrack_api.operation.CreateEntityOperation + ): + entity_key = str(( + str(operation.entity_type), + operation.entity_key.values() + )) + try: + self.cache.remove(entity_key) + except KeyError: + pass + + # Clear locally stored modifications on remaining entities. + for entity in self._local_cache.values(): + entity.clear() + + self.recorded_operations.clear() + + def _fetch_server_information(self): + '''Return server information.''' + result = self.call([{'action': 'query_server_information'}]) + return result[0] + + def _discover_plugins(self, plugin_arguments=None): + '''Find and load plugins in search paths. + + Each discovered module should implement a register function that + accepts this session as first argument. Typically the function should + register appropriate event listeners against the session's event hub. + + def register(session): + session.event_hub.subscribe( + 'topic=ftrack.api.session.construct-entity-type', + construct_entity_type + ) + + *plugin_arguments* should be an optional mapping of keyword arguments + and values to pass to plugin register functions upon discovery. + + ''' + plugin_arguments = plugin_arguments or {} + ftrack_api.plugin.discover( + self._plugin_paths, [self], plugin_arguments + ) + + def _read_schemas_from_cache(self, schema_cache_path): + '''Return schemas and schema hash from *schema_cache_path*. + + *schema_cache_path* should be the path to the file containing the + schemas in JSON format. + + ''' + self.logger.debug(L( + 'Reading schemas from cache {0!r}', schema_cache_path + )) + + if not os.path.exists(schema_cache_path): + self.logger.info(L( + 'Cache file not found at {0!r}.', schema_cache_path + )) + + return [], None + + with open(schema_cache_path, 'r') as schema_file: + schemas = json.load(schema_file) + hash_ = hashlib.md5( + json.dumps(schemas, sort_keys=True) + ).hexdigest() + + return schemas, hash_ + + def _write_schemas_to_cache(self, schemas, schema_cache_path): + '''Write *schemas* to *schema_cache_path*. + + *schema_cache_path* should be a path to a file that the schemas can be + written to in JSON format. + + ''' + self.logger.debug(L( + 'Updating schema cache {0!r} with new schemas.', schema_cache_path + )) + + with open(schema_cache_path, 'w') as local_cache_file: + json.dump(schemas, local_cache_file, indent=4) + + def _load_schemas(self, schema_cache_path): + '''Load schemas. + + First try to load schemas from cache at *schema_cache_path*. If the + cache is not available or the cache appears outdated then load schemas + from server and store fresh copy in cache. + + If *schema_cache_path* is set to `False`, always load schemas from + server bypassing cache. + + ''' + local_schema_hash = None + schemas = [] + + if schema_cache_path: + try: + schemas, local_schema_hash = self._read_schemas_from_cache( + schema_cache_path + ) + except (IOError, TypeError, AttributeError, ValueError): + # Catch any known exceptions when trying to read the local + # schema cache to prevent API from being unusable. + self.logger.exception(L( + 'Schema cache could not be loaded from {0!r}', + schema_cache_path + )) + + # Use `dictionary.get` to retrieve hash to support older version of + # ftrack server not returning a schema hash. + server_hash = self._server_information.get( + 'schema_hash', False + ) + if local_schema_hash != server_hash: + self.logger.debug(L( + 'Loading schemas from server due to hash not matching.' + 'Local: {0!r} != Server: {1!r}', local_schema_hash, server_hash + )) + schemas = self.call([{'action': 'query_schemas'}])[0] + + if schema_cache_path: + try: + self._write_schemas_to_cache(schemas, schema_cache_path) + except (IOError, TypeError): + self.logger.exception(L( + 'Failed to update schema cache {0!r}.', + schema_cache_path + )) + + else: + self.logger.debug(L( + 'Using cached schemas from {0!r}', schema_cache_path + )) + + return schemas + + def _build_entity_type_classes(self, schemas): + '''Build default entity type classes.''' + fallback_factory = ftrack_api.entity.factory.StandardFactory() + classes = {} + + for schema in schemas: + results = self.event_hub.publish( + ftrack_api.event.base.Event( + topic='ftrack.api.session.construct-entity-type', + data=dict( + schema=schema, + schemas=schemas + ) + ), + synchronous=True + ) + + results = [result for result in results if result is not None] + + if not results: + self.logger.debug(L( + 'Using default StandardFactory to construct entity type ' + 'class for "{0}"', schema['id'] + )) + entity_type_class = fallback_factory.create(schema) + + elif len(results) > 1: + raise ValueError( + 'Expected single entity type to represent schema "{0}" but ' + 'received {1} entity types instead.' + .format(schema['id'], len(results)) + ) + + else: + entity_type_class = results[0] + + classes[entity_type_class.entity_type] = entity_type_class + + return classes + + def _configure_locations(self): + '''Configure locations.''' + # First configure builtin locations, by injecting them into local cache. + + # Origin. + location = self.create( + 'Location', + data=dict( + name='ftrack.origin', + id=ftrack_api.symbol.ORIGIN_LOCATION_ID + ), + reconstructing=True + ) + ftrack_api.mixin( + location, ftrack_api.entity.location.OriginLocationMixin, + name='OriginLocation' + ) + location.accessor = ftrack_api.accessor.disk.DiskAccessor(prefix='') + location.structure = ftrack_api.structure.origin.OriginStructure() + location.priority = 100 + + # Unmanaged. + location = self.create( + 'Location', + data=dict( + name='ftrack.unmanaged', + id=ftrack_api.symbol.UNMANAGED_LOCATION_ID + ), + reconstructing=True + ) + ftrack_api.mixin( + location, ftrack_api.entity.location.UnmanagedLocationMixin, + name='UnmanagedLocation' + ) + location.accessor = ftrack_api.accessor.disk.DiskAccessor(prefix='') + location.structure = ftrack_api.structure.origin.OriginStructure() + # location.resource_identifier_transformer = ( + # ftrack_api.resource_identifier_transformer.internal.InternalResourceIdentifierTransformer(session) + # ) + location.priority = 90 + + # Review. + location = self.create( + 'Location', + data=dict( + name='ftrack.review', + id=ftrack_api.symbol.REVIEW_LOCATION_ID + ), + reconstructing=True + ) + ftrack_api.mixin( + location, ftrack_api.entity.location.UnmanagedLocationMixin, + name='UnmanagedLocation' + ) + location.accessor = ftrack_api.accessor.disk.DiskAccessor(prefix='') + location.structure = ftrack_api.structure.origin.OriginStructure() + location.priority = 110 + + # Server. + location = self.create( + 'Location', + data=dict( + name='ftrack.server', + id=ftrack_api.symbol.SERVER_LOCATION_ID + ), + reconstructing=True + ) + ftrack_api.mixin( + location, ftrack_api.entity.location.ServerLocationMixin, + name='ServerLocation' + ) + location.accessor = ftrack_api.accessor.server._ServerAccessor( + session=self + ) + location.structure = ftrack_api.structure.entity_id.EntityIdStructure() + location.priority = 150 + + # Master location based on server scenario. + storage_scenario = self.server_information.get('storage_scenario') + + if ( + storage_scenario and + storage_scenario.get('scenario') + ): + self.event_hub.publish( + ftrack_api.event.base.Event( + topic='ftrack.storage-scenario.activate', + data=dict( + storage_scenario=storage_scenario + ) + ), + synchronous=True + ) + + # Next, allow further configuration of locations via events. + self.event_hub.publish( + ftrack_api.event.base.Event( + topic='ftrack.api.session.configure-location', + data=dict( + session=self + ) + ), + synchronous=True + ) + + @ftrack_api.logging.deprecation_warning( + 'Session._call is now available as public method Session.call. The ' + 'private method will be removed in version 2.0.' + ) + def _call(self, data): + '''Make request to server with *data* batch describing the actions. + + .. note:: + + This private method is now available as public method + :meth:`entity_reference`. This alias remains for backwards + compatibility, but will be removed in version 2.0. + + ''' + return self.call(data) + + def call(self, data): + '''Make request to server with *data* batch describing the actions.''' + url = self._server_url + '/api' + headers = { + 'content-type': 'application/json', + 'accept': 'application/json' + } + data = self.encode(data, entity_attribute_strategy='modified_only') + + self.logger.debug(L('Calling server {0} with {1!r}', url, data)) + + response = self._request.post( + url, + headers=headers, + data=data + ) + + self.logger.debug(L('Call took: {0}', response.elapsed.total_seconds())) + + self.logger.debug(L('Response: {0!r}', response.text)) + try: + result = self.decode(response.text) + + except Exception: + error_message = ( + 'Server reported error in unexpected format. Raw error was: {0}' + .format(response.text) + ) + self.logger.exception(error_message) + raise ftrack_api.exception.ServerError(error_message) + + else: + if 'exception' in result: + # Handle exceptions. + error_message = 'Server reported error: {0}({1})'.format( + result['exception'], result['content'] + ) + self.logger.exception(error_message) + raise ftrack_api.exception.ServerError(error_message) + + return result + + def encode(self, data, entity_attribute_strategy='set_only'): + '''Return *data* encoded as JSON formatted string. + + *entity_attribute_strategy* specifies how entity attributes should be + handled. The following strategies are available: + + * *all* - Encode all attributes, loading any that are currently NOT_SET. + * *set_only* - Encode only attributes that are currently set without + loading any from the remote. + * *modified_only* - Encode only attributes that have been modified + locally. + * *persisted_only* - Encode only remote (persisted) attribute values. + + ''' + entity_attribute_strategies = ( + 'all', 'set_only', 'modified_only', 'persisted_only' + ) + if entity_attribute_strategy not in entity_attribute_strategies: + raise ValueError( + 'Unsupported entity_attribute_strategy "{0}". Must be one of ' + '{1}'.format( + entity_attribute_strategy, + ', '.join(entity_attribute_strategies) + ) + ) + + return json.dumps( + data, + sort_keys=True, + default=functools.partial( + self._encode, + entity_attribute_strategy=entity_attribute_strategy + ) + ) + + def _encode(self, item, entity_attribute_strategy='set_only'): + '''Return JSON encodable version of *item*. + + *entity_attribute_strategy* specifies how entity attributes should be + handled. See :meth:`Session.encode` for available strategies. + + ''' + if isinstance(item, (arrow.Arrow, datetime.datetime, datetime.date)): + return { + '__type__': 'datetime', + 'value': item.isoformat() + } + + if isinstance(item, OperationPayload): + data = dict(item.items()) + if "entity_data" in data: + for key, value in data["entity_data"].items(): + if isinstance(value, ftrack_api.entity.base.Entity): + data["entity_data"][key] = self.entity_reference(value) + + return data + + if isinstance(item, ftrack_api.entity.base.Entity): + data = self.entity_reference(item) + + with self.auto_populating(True): + + for attribute in item.attributes: + value = ftrack_api.symbol.NOT_SET + + if entity_attribute_strategy == 'all': + value = attribute.get_value(item) + + elif entity_attribute_strategy == 'set_only': + if attribute.is_set(item): + value = attribute.get_local_value(item) + if value is ftrack_api.symbol.NOT_SET: + value = attribute.get_remote_value(item) + + elif entity_attribute_strategy == 'modified_only': + if attribute.is_modified(item): + value = attribute.get_local_value(item) + + elif entity_attribute_strategy == 'persisted_only': + if not attribute.computed: + value = attribute.get_remote_value(item) + + if value is not ftrack_api.symbol.NOT_SET: + if isinstance( + attribute, ftrack_api.attribute.ReferenceAttribute + ): + if isinstance(value, ftrack_api.entity.base.Entity): + value = self.entity_reference(value) + + data[attribute.name] = value + + return data + + if isinstance( + item, ftrack_api.collection.MappedCollectionProxy + ): + # Use proxied collection for serialisation. + item = item.collection + + if isinstance(item, ftrack_api.collection.Collection): + data = [] + for entity in item: + data.append(self.entity_reference(entity)) + + return data + + raise TypeError('{0!r} is not JSON serializable'.format(item)) + + def entity_reference(self, entity): + '''Return entity reference that uniquely identifies *entity*. + + Return a mapping containing the __entity_type__ of the entity along with + the key, value pairs that make up it's primary key. + + ''' + reference = { + '__entity_type__': entity.entity_type + } + with self.auto_populating(False): + reference.update(ftrack_api.inspection.primary_key(entity)) + + return reference + + @ftrack_api.logging.deprecation_warning( + 'Session._entity_reference is now available as public method ' + 'Session.entity_reference. The private method will be removed ' + 'in version 2.0.' + ) + def _entity_reference(self, entity): + '''Return entity reference that uniquely identifies *entity*. + + Return a mapping containing the __entity_type__ of the entity along + with the key, value pairs that make up it's primary key. + + .. note:: + + This private method is now available as public method + :meth:`entity_reference`. This alias remains for backwards + compatibility, but will be removed in version 2.0. + + ''' + return self.entity_reference(entity) + + def decode(self, string): + '''Return decoded JSON *string* as Python object.''' + with self.operation_recording(False): + return json.loads(string, object_hook=self._decode) + + def _decode(self, item): + '''Return *item* transformed into appropriate representation.''' + if isinstance(item, collections.Mapping): + if '__type__' in item: + if item['__type__'] == 'datetime': + item = arrow.get(item['value']) + + elif '__entity_type__' in item: + item = self._create( + item['__entity_type__'], item, reconstructing=True + ) + + return item + + def _get_locations(self, filter_inaccessible=True): + '''Helper to returns locations ordered by priority. + + If *filter_inaccessible* is True then only accessible locations will be + included in result. + + ''' + # Optimise this call. + locations = self.query('Location') + + # Filter. + if filter_inaccessible: + locations = filter( + lambda location: location.accessor, + locations + ) + + # Sort by priority. + locations = sorted( + locations, key=lambda location: location.priority + ) + + return locations + + def pick_location(self, component=None): + '''Return suitable location to use. + + If no *component* specified then return highest priority accessible + location. Otherwise, return highest priority accessible location that + *component* is available in. + + Return None if no suitable location could be picked. + + ''' + if component: + return self.pick_locations([component])[0] + + else: + locations = self._get_locations() + if locations: + return locations[0] + else: + return None + + def pick_locations(self, components): + '''Return suitable locations for *components*. + + Return list of locations corresponding to *components* where each + picked location is the highest priority accessible location for that + component. If a component has no location available then its + corresponding entry will be None. + + ''' + candidate_locations = self._get_locations() + availabilities = self.get_component_availabilities( + components, locations=candidate_locations + ) + + locations = [] + for component, availability in zip(components, availabilities): + location = None + + for candidate_location in candidate_locations: + if availability.get(candidate_location['id']) > 0.0: + location = candidate_location + break + + locations.append(location) + + return locations + + def create_component( + self, path, data=None, location='auto' + ): + '''Create a new component from *path* with additional *data* + + .. note:: + + This is a helper method. To create components manually use the + standard :meth:`Session.create` method. + + *path* can be a string representing a filesystem path to the data to + use for the component. The *path* can also be specified as a sequence + string, in which case a sequence component with child components for + each item in the sequence will be created automatically. The accepted + format for a sequence is '{head}{padding}{tail} [{ranges}]'. For + example:: + + '/path/to/file.%04d.ext [1-5, 7, 8, 10-20]' + + .. seealso:: + + `Clique documentation `_ + + *data* should be a dictionary of any additional data to construct the + component with (as passed to :meth:`Session.create`). + + If *location* is specified then automatically add component to that + location. The default of 'auto' will automatically pick a suitable + location to add the component to if one is available. To not add to any + location specifiy locations as None. + + .. note:: + + A :meth:`Session.commit` may be + automatically issued as part of the components registration in the + location. + ''' + if data is None: + data = {} + + if location == 'auto': + # Check if the component name matches one of the ftrackreview + # specific names. Add the component to the ftrack.review location if + # so. This is used to not break backwards compatibility. + if data.get('name') in ( + 'ftrackreview-mp4', 'ftrackreview-webm', 'ftrackreview-image' + ): + location = self.get( + 'Location', ftrack_api.symbol.REVIEW_LOCATION_ID + ) + + else: + location = self.pick_location() + + try: + collection = clique.parse(path) + + except ValueError: + # Assume is a single file. + if 'size' not in data: + data['size'] = self._get_filesystem_size(path) + + data.setdefault('file_type', os.path.splitext(path)[-1]) + + return self._create_component( + 'FileComponent', path, data, location + ) + + else: + # Calculate size of container and members. + member_sizes = {} + container_size = data.get('size') + + if container_size is not None: + if len(collection.indexes) > 0: + member_size = int( + round(container_size / len(collection.indexes)) + ) + for item in collection: + member_sizes[item] = member_size + + else: + container_size = 0 + for item in collection: + member_sizes[item] = self._get_filesystem_size(item) + container_size += member_sizes[item] + + # Create sequence component + container_path = collection.format('{head}{padding}{tail}') + data.setdefault('padding', collection.padding) + data.setdefault('file_type', os.path.splitext(container_path)[-1]) + data.setdefault('size', container_size) + + container = self._create_component( + 'SequenceComponent', container_path, data, location=None + ) + + # Create member components for sequence. + for member_path in collection: + member_data = { + 'name': collection.match(member_path).group('index'), + 'container': container, + 'size': member_sizes[member_path], + 'file_type': os.path.splitext(member_path)[-1] + } + + component = self._create_component( + 'FileComponent', member_path, member_data, location=None + ) + container['members'].append(component) + + if location: + origin_location = self.get( + 'Location', ftrack_api.symbol.ORIGIN_LOCATION_ID + ) + location.add_component( + container, origin_location, recursive=True + ) + + return container + + def _create_component(self, entity_type, path, data, location): + '''Create and return component. + + See public function :py:func:`createComponent` for argument details. + + ''' + component = self.create(entity_type, data) + + # Add to special origin location so that it is possible to add to other + # locations. + origin_location = self.get( + 'Location', ftrack_api.symbol.ORIGIN_LOCATION_ID + ) + origin_location.add_component(component, path, recursive=False) + + if location: + location.add_component(component, origin_location, recursive=False) + + return component + + def _get_filesystem_size(self, path): + '''Return size from *path*''' + try: + size = os.path.getsize(path) + except OSError: + size = 0 + + return size + + def get_component_availability(self, component, locations=None): + '''Return availability of *component*. + + If *locations* is set then limit result to availability of *component* + in those *locations*. + + Return a dictionary of {location_id:percentage_availability} + + ''' + return self.get_component_availabilities( + [component], locations=locations + )[0] + + def get_component_availabilities(self, components, locations=None): + '''Return availabilities of *components*. + + If *locations* is set then limit result to availabilities of + *components* in those *locations*. + + Return a list of dictionaries of {location_id:percentage_availability}. + The list indexes correspond to those of *components*. + + ''' + availabilities = [] + + if locations is None: + locations = self.query('Location') + + # Separate components into two lists, those that are containers and + # those that are not, so that queries can be optimised. + standard_components = [] + container_components = [] + + for component in components: + if 'members' in component.keys(): + container_components.append(component) + else: + standard_components.append(component) + + # Perform queries. + if standard_components: + self.populate( + standard_components, 'component_locations.location_id' + ) + + if container_components: + self.populate( + container_components, + 'members, component_locations.location_id' + ) + + base_availability = {} + for location in locations: + base_availability[location['id']] = 0.0 + + for component in components: + availability = base_availability.copy() + availabilities.append(availability) + + is_container = 'members' in component.keys() + if is_container and len(component['members']): + member_availabilities = self.get_component_availabilities( + component['members'], locations=locations + ) + multiplier = 1.0 / len(component['members']) + for member, member_availability in zip( + component['members'], member_availabilities + ): + for location_id, ratio in member_availability.items(): + availability[location_id] += ( + ratio * multiplier + ) + else: + for component_location in component['component_locations']: + location_id = component_location['location_id'] + if location_id in availability: + availability[location_id] = 100.0 + + for location_id, percentage in availability.items(): + # Avoid quantization error by rounding percentage and clamping + # to range 0-100. + adjusted_percentage = round(percentage, 9) + adjusted_percentage = max(0.0, min(adjusted_percentage, 100.0)) + availability[location_id] = adjusted_percentage + + return availabilities + + @ftrack_api.logging.deprecation_warning( + 'Session.delayed_job has been deprecated in favour of session.call. ' + 'Please refer to the release notes for more information.' + ) + def delayed_job(self, job_type): + '''Execute a delayed job on the server, a `ftrack.entity.job.Job` is returned. + + *job_type* should be one of the allowed job types. There is currently + only one remote job type "SYNC_USERS_LDAP". + ''' + if job_type not in (ftrack_api.symbol.JOB_SYNC_USERS_LDAP, ): + raise ValueError( + u'Invalid Job type: {0}.'.format(job_type) + ) + + operation = { + 'action': 'delayed_job', + 'job_type': job_type.name + } + + try: + result = self.call( + [operation] + )[0] + + except ftrack_api.exception.ServerError as error: + raise + + return result['data'] + + def get_widget_url(self, name, entity=None, theme=None): + '''Return an authenticated URL for widget with *name* and given options. + + The returned URL will be authenticated using a token which will expire + after 6 minutes. + + *name* should be the name of the widget to return and should be one of + 'info', 'tasks' or 'tasks_browser'. + + Certain widgets require an entity to be specified. If so, specify it by + setting *entity* to a valid entity instance. + + *theme* sets the theme of the widget and can be either 'light' or 'dark' + (defaulting to 'dark' if an invalid option given). + + ''' + operation = { + 'action': 'get_widget_url', + 'name': name, + 'theme': theme + } + if entity: + operation['entity_type'] = entity.entity_type + operation['entity_key'] = ( + ftrack_api.inspection.primary_key(entity).values() + ) + + try: + result = self.call([operation]) + + except ftrack_api.exception.ServerError as error: + # Raise informative error if the action is not supported. + if 'Invalid action u\'get_widget_url\'' in error.message: + raise ftrack_api.exception.ServerCompatibilityError( + 'Server version {0!r} does not support "get_widget_url", ' + 'please update server and try again.'.format( + self.server_information.get('version') + ) + ) + else: + raise + + else: + return result[0]['widget_url'] + + def encode_media(self, media, version_id=None, keep_original='auto'): + '''Return a new Job that encode *media* to make it playable in browsers. + + *media* can be a path to a file or a FileComponent in the ftrack.server + location. + + The job will encode *media* based on the file type and job data contains + information about encoding in the following format:: + + { + 'output': [{ + 'format': 'video/mp4', + 'component_id': 'e2dc0524-b576-11d3-9612-080027331d74' + }, { + 'format': 'image/jpeg', + 'component_id': '07b82a97-8cf9-11e3-9383-20c9d081909b' + }], + 'source_component_id': 'e3791a09-7e11-4792-a398-3d9d4eefc294', + 'keep_original': True + } + + The output components are associated with the job via the job_components + relation. + + An image component will always be generated if possible that can be used + as a thumbnail. + + If *media* is a file path, a new source component will be created and + added to the ftrack server location and a call to :meth:`commit` will be + issued. If *media* is a FileComponent, it will be assumed to be in + available in the ftrack.server location. + + If *version_id* is specified, the new components will automatically be + associated with the AssetVersion. Otherwise, the components will not + be associated to a version even if the supplied *media* belongs to one. + A server version of 3.3.32 or higher is required for the version_id + argument to function properly. + + If *keep_original* is not set, the original media will be kept if it + is a FileComponent, and deleted if it is a file path. You can specify + True or False to change this behavior. + ''' + if isinstance(media, basestring): + # Media is a path to a file. + server_location = self.get( + 'Location', ftrack_api.symbol.SERVER_LOCATION_ID + ) + if keep_original == 'auto': + keep_original = False + + component_data = None + if keep_original: + component_data = dict(version_id=version_id) + + component = self.create_component( + path=media, + data=component_data, + location=server_location + ) + + # Auto commit to ensure component exists when sent to server. + self.commit() + + elif ( + hasattr(media, 'entity_type') and + media.entity_type in ('FileComponent',) + ): + # Existing file component. + component = media + if keep_original == 'auto': + keep_original = True + + else: + raise ValueError( + 'Unable to encode media of type: {0}'.format(type(media)) + ) + + operation = { + 'action': 'encode_media', + 'component_id': component['id'], + 'version_id': version_id, + 'keep_original': keep_original + } + + try: + result = self.call([operation]) + + except ftrack_api.exception.ServerError as error: + # Raise informative error if the action is not supported. + if 'Invalid action u\'encode_media\'' in error.message: + raise ftrack_api.exception.ServerCompatibilityError( + 'Server version {0!r} does not support "encode_media", ' + 'please update server and try again.'.format( + self.server_information.get('version') + ) + ) + else: + raise + + return self.get('Job', result[0]['job_id']) + + def get_upload_metadata( + self, component_id, file_name, file_size, checksum=None + ): + '''Return URL and headers used to upload data for *component_id*. + + *file_name* and *file_size* should match the components details. + + The returned URL should be requested using HTTP PUT with the specified + headers. + + The *checksum* is used as the Content-MD5 header and should contain + the base64-encoded 128-bit MD5 digest of the message (without the + headers) according to RFC 1864. This can be used as a message integrity + check to verify that the data is the same data that was originally sent. + ''' + operation = { + 'action': 'get_upload_metadata', + 'component_id': component_id, + 'file_name': file_name, + 'file_size': file_size, + 'checksum': checksum + } + + try: + result = self.call([operation]) + + except ftrack_api.exception.ServerError as error: + # Raise informative error if the action is not supported. + if 'Invalid action u\'get_upload_metadata\'' in error.message: + raise ftrack_api.exception.ServerCompatibilityError( + 'Server version {0!r} does not support ' + '"get_upload_metadata", please update server and try ' + 'again.'.format( + self.server_information.get('version') + ) + ) + else: + raise + + return result[0] + + def send_user_invite(self, user): + '''Send a invitation to the provided *user*. + + *user* is a User instance + + ''' + + self.send_user_invites( + [user] + ) + + def send_user_invites(self, users): + '''Send a invitation to the provided *user*. + + *users* is a list of User instances + + ''' + + operations = [] + + for user in users: + operations.append( + { + 'action':'send_user_invite', + 'user_id': user['id'] + } + ) + + try: + self.call(operations) + + except ftrack_api.exception.ServerError as error: + # Raise informative error if the action is not supported. + if 'Invalid action u\'send_user_invite\'' in error.message: + raise ftrack_api.exception.ServerCompatibilityError( + 'Server version {0!r} does not support ' + '"send_user_invite", please update server and ' + 'try again.'.format( + self.server_information.get('version') + ) + ) + else: + raise + + def send_review_session_invite(self, invitee): + '''Send an invite to a review session to *invitee*. + + *invitee* is a instance of ReviewSessionInvitee. + + .. note:: + + The *invitee* must be committed. + + ''' + self.send_review_session_invites([invitee]) + + def send_review_session_invites(self, invitees): + '''Send an invite to a review session to a list of *invitees*. + + *invitee* is a list of ReviewSessionInvitee objects. + + .. note:: + + All *invitees* must be committed. + + ''' + operations = [] + + for invitee in invitees: + operations.append( + { + 'action': 'send_review_session_invite', + 'review_session_invitee_id': invitee['id'] + } + ) + + try: + self.call(operations) + except ftrack_api.exception.ServerError as error: + # Raise informative error if the action is not supported. + if 'Invalid action u\'send_review_session_invite\'' in error.message: + raise ftrack_api.exception.ServerCompatibilityError( + 'Server version {0!r} does not support ' + '"send_review_session_invite", please update server and ' + 'try again.'.format( + self.server_information.get('version') + ) + ) + else: + raise + + +class AutoPopulatingContext(object): + '''Context manager for temporary change of session auto_populate value.''' + + def __init__(self, session, auto_populate): + '''Initialise context.''' + super(AutoPopulatingContext, self).__init__() + self._session = session + self._auto_populate = auto_populate + self._current_auto_populate = None + + def __enter__(self): + '''Enter context switching to desired auto populate setting.''' + self._current_auto_populate = self._session.auto_populate + self._session.auto_populate = self._auto_populate + + def __exit__(self, exception_type, exception_value, traceback): + '''Exit context resetting auto populate to original setting.''' + self._session.auto_populate = self._current_auto_populate + + +class OperationRecordingContext(object): + '''Context manager for temporary change of session record_operations.''' + + def __init__(self, session, record_operations): + '''Initialise context.''' + super(OperationRecordingContext, self).__init__() + self._session = session + self._record_operations = record_operations + self._current_record_operations = None + + def __enter__(self): + '''Enter context.''' + self._current_record_operations = self._session.record_operations + self._session.record_operations = self._record_operations + + def __exit__(self, exception_type, exception_value, traceback): + '''Exit context.''' + self._session.record_operations = self._current_record_operations + + +class OperationPayload(collections.MutableMapping): + '''Represent operation payload.''' + + def __init__(self, *args, **kwargs): + '''Initialise payload.''' + super(OperationPayload, self).__init__() + self._data = dict() + self.update(dict(*args, **kwargs)) + + def __str__(self): + '''Return string representation.''' + return '<{0} {1}>'.format( + self.__class__.__name__, str(self._data) + ) + + def __getitem__(self, key): + '''Return value for *key*.''' + return self._data[key] + + def __setitem__(self, key, value): + '''Set *value* for *key*.''' + self._data[key] = value + + def __delitem__(self, key): + '''Remove *key*.''' + del self._data[key] + + def __iter__(self): + '''Iterate over all keys.''' + return iter(self._data) + + def __len__(self): + '''Return count of keys.''' + return len(self._data) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/__init__.py new file mode 100644 index 0000000000..1aab07ed77 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/base.py new file mode 100644 index 0000000000..eae3784dc2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/base.py @@ -0,0 +1,38 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from abc import ABCMeta, abstractmethod + + +class Structure(object): + '''Structure plugin interface. + + A structure plugin should compute appropriate paths for data. + + ''' + + __metaclass__ = ABCMeta + + def __init__(self, prefix=''): + '''Initialise structure.''' + self.prefix = prefix + self.path_separator = '/' + super(Structure, self).__init__() + + @abstractmethod + def get_resource_identifier(self, entity, context=None): + '''Return a resource identifier for supplied *entity*. + + *context* can be a mapping that supplies additional information. + + ''' + + def _get_sequence_expression(self, sequence): + '''Return a sequence expression for *sequence* component.''' + padding = sequence['padding'] + if padding: + expression = '%0{0}d'.format(padding) + else: + expression = '%d' + + return expression diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/entity_id.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/entity_id.py new file mode 100644 index 0000000000..ae466bf6d9 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/entity_id.py @@ -0,0 +1,12 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api.structure.base + + +class EntityIdStructure(ftrack_api.structure.base.Structure): + '''Entity id pass-through structure.''' + + def get_resource_identifier(self, entity, context=None): + '''Return a *resourceIdentifier* for supplied *entity*.''' + return entity['id'] diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/id.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/id.py new file mode 100644 index 0000000000..acc3e21b02 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/id.py @@ -0,0 +1,91 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import os + +import ftrack_api.symbol +import ftrack_api.structure.base + + +class IdStructure(ftrack_api.structure.base.Structure): + '''Id based structure supporting Components only. + + A components unique id will be used to form a path to store the data at. + To avoid millions of entries in one directory each id is chunked into four + prefix directories with the remainder used to name the file:: + + /prefix/1/2/3/4/56789 + + If the component has a defined filetype it will be added to the path:: + + /prefix/1/2/3/4/56789.exr + + Components that are children of container components will be placed inside + the id structure of their parent:: + + /prefix/1/2/3/4/56789/355827648d.exr + /prefix/1/2/3/4/56789/ajf24215b5.exr + + However, sequence children will be named using their label as an index and + a common prefix of 'file.':: + + /prefix/1/2/3/4/56789/file.0001.exr + /prefix/1/2/3/4/56789/file.0002.exr + + ''' + + def get_resource_identifier(self, entity, context=None): + '''Return a resource identifier for supplied *entity*. + + *context* can be a mapping that supplies additional information. + + ''' + if entity.entity_type in ('FileComponent',): + # When in a container, place the file inside a directory named + # after the container. + container = entity['container'] + if container and container is not ftrack_api.symbol.NOT_SET: + path = self.get_resource_identifier(container) + + if container.entity_type in ('SequenceComponent',): + # Label doubles as index for now. + name = 'file.{0}{1}'.format( + entity['name'], entity['file_type'] + ) + parts = [os.path.dirname(path), name] + + else: + # Just place uniquely identified file into directory + name = entity['id'] + entity['file_type'] + parts = [path, name] + + else: + name = entity['id'][4:] + entity['file_type'] + parts = ([self.prefix] + list(entity['id'][:4]) + [name]) + + elif entity.entity_type in ('SequenceComponent',): + name = 'file' + + # Add a sequence identifier. + sequence_expression = self._get_sequence_expression(entity) + name += '.{0}'.format(sequence_expression) + + if ( + entity['file_type'] and + entity['file_type'] is not ftrack_api.symbol.NOT_SET + ): + name += entity['file_type'] + + parts = ([self.prefix] + list(entity['id'][:4]) + + [entity['id'][4:]] + [name]) + + elif entity.entity_type in ('ContainerComponent',): + # Just an id directory + parts = ([self.prefix] + + list(entity['id'][:4]) + [entity['id'][4:]]) + + else: + raise NotImplementedError('Cannot generate path for unsupported ' + 'entity {0}'.format(entity)) + + return self.path_separator.join(parts).strip('/') diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/origin.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/origin.py new file mode 100644 index 0000000000..0d4d3a57f5 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/origin.py @@ -0,0 +1,28 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +from .base import Structure + + +class OriginStructure(Structure): + '''Origin structure that passes through existing resource identifier.''' + + def get_resource_identifier(self, entity, context=None): + '''Return a resource identifier for supplied *entity*. + + *context* should be a mapping that includes at least a + 'source_resource_identifier' key that refers to the resource identifier + to pass through. + + ''' + if context is None: + context = {} + + resource_identifier = context.get('source_resource_identifier') + if resource_identifier is None: + raise ValueError( + 'Could not generate resource identifier as no source resource ' + 'identifier found in passed context.' + ) + + return resource_identifier diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/standard.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/standard.py new file mode 100644 index 0000000000..0b0602df00 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/structure/standard.py @@ -0,0 +1,217 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import os +import re +import unicodedata + +import ftrack_api.symbol +import ftrack_api.structure.base + + +class StandardStructure(ftrack_api.structure.base.Structure): + '''Project hierarchy based structure that only supports Components. + + The resource identifier is generated from the project code, the name + of objects in the project structure, asset name and version number:: + + my_project/folder_a/folder_b/asset_name/v003 + + If the component is a `FileComponent` then the name of the component and the + file type are used as filename in the resource_identifier:: + + my_project/folder_a/folder_b/asset_name/v003/foo.jpg + + If the component is a `SequenceComponent` then a sequence expression, + `%04d`, is used. E.g. a component with the name `foo` yields:: + + my_project/folder_a/folder_b/asset_name/v003/foo.%04d.jpg + + For the member components their index in the sequence is used:: + + my_project/folder_a/folder_b/asset_name/v003/foo.0042.jpg + + The name of the component is added to the resource identifier if the + component is a `ContainerComponent`. E.g. a container component with the + name `bar` yields:: + + my_project/folder_a/folder_b/asset_name/v003/bar + + For a member of that container the file name is based on the component name + and file type:: + + my_project/folder_a/folder_b/asset_name/v003/bar/baz.pdf + + ''' + + def __init__( + self, project_versions_prefix=None, illegal_character_substitute='_' + ): + '''Initialise structure. + + If *project_versions_prefix* is defined, insert after the project code + for versions published directly under the project:: + + my_project//v001/foo.jpg + + Replace illegal characters with *illegal_character_substitute* if + defined. + + .. note:: + + Nested component containers/sequences are not supported. + + ''' + super(StandardStructure, self).__init__() + self.project_versions_prefix = project_versions_prefix + self.illegal_character_substitute = illegal_character_substitute + + def _get_parts(self, entity): + '''Return resource identifier parts from *entity*.''' + session = entity.session + + version = entity['version'] + + if version is ftrack_api.symbol.NOT_SET and entity['version_id']: + version = session.get('AssetVersion', entity['version_id']) + + error_message = ( + 'Component {0!r} must be attached to a committed ' + 'version and a committed asset with a parent context.'.format( + entity + ) + ) + + if ( + version is ftrack_api.symbol.NOT_SET or + version in session.created + ): + raise ftrack_api.exception.StructureError(error_message) + + link = version['link'] + + if not link: + raise ftrack_api.exception.StructureError(error_message) + + structure_names = [ + item['name'] + for item in link[1:-1] + ] + + project_id = link[0]['id'] + project = session.get('Project', project_id) + asset = version['asset'] + + version_number = self._format_version(version['version']) + + parts = [] + parts.append(project['name']) + + if structure_names: + parts.extend(structure_names) + elif self.project_versions_prefix: + # Add *project_versions_prefix* if configured and the version is + # published directly under the project. + parts.append(self.project_versions_prefix) + + parts.append(asset['name']) + parts.append(version_number) + + return [self.sanitise_for_filesystem(part) for part in parts] + + def _format_version(self, number): + '''Return a formatted string representing version *number*.''' + return 'v{0:03d}'.format(number) + + def sanitise_for_filesystem(self, value): + '''Return *value* with illegal filesystem characters replaced. + + An illegal character is one that is not typically valid for filesystem + usage, such as non ascii characters, or can be awkward to use in a + filesystem, such as spaces. Replace these characters with + the character specified by *illegal_character_substitute* on + initialisation. If no character was specified as substitute then return + *value* unmodified. + + ''' + if self.illegal_character_substitute is None: + return value + + if isinstance(value, str): + value = value.decode('utf-8') + + value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore') + value = re.sub('[^\w\.-]', self.illegal_character_substitute, value) + return unicode(value.strip().lower()) + + def get_resource_identifier(self, entity, context=None): + '''Return a resource identifier for supplied *entity*. + + *context* can be a mapping that supplies additional information, but + is unused in this implementation. + + + Raise a :py:exc:`ftrack_api.exeption.StructureError` if *entity* is not + attached to a committed version and a committed asset with a parent + context. + + ''' + if entity.entity_type in ('FileComponent',): + container = entity['container'] + + if container: + # Get resource identifier for container. + container_path = self.get_resource_identifier(container) + + if container.entity_type in ('SequenceComponent',): + # Strip the sequence component expression from the parent + # container and back the correct filename, i.e. + # /sequence/component/sequence_component_name.0012.exr. + name = '{0}.{1}{2}'.format( + container['name'], entity['name'], entity['file_type'] + ) + parts = [ + os.path.dirname(container_path), + self.sanitise_for_filesystem(name) + ] + + else: + # Container is not a sequence component so add it as a + # normal component inside the container. + name = entity['name'] + entity['file_type'] + parts = [ + container_path, self.sanitise_for_filesystem(name) + ] + + else: + # File component does not have a container, construct name from + # component name and file type. + parts = self._get_parts(entity) + name = entity['name'] + entity['file_type'] + parts.append(self.sanitise_for_filesystem(name)) + + elif entity.entity_type in ('SequenceComponent',): + # Create sequence expression for the sequence component and add it + # to the parts. + parts = self._get_parts(entity) + sequence_expression = self._get_sequence_expression(entity) + parts.append( + '{0}.{1}{2}'.format( + self.sanitise_for_filesystem(entity['name']), + sequence_expression, + self.sanitise_for_filesystem(entity['file_type']) + ) + ) + + elif entity.entity_type in ('ContainerComponent',): + # Add the name of the container to the resource identifier parts. + parts = self._get_parts(entity) + parts.append(self.sanitise_for_filesystem(entity['name'])) + + else: + raise NotImplementedError( + 'Cannot generate resource identifier for unsupported ' + 'entity {0!r}'.format(entity) + ) + + return self.path_separator.join(parts) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/symbol.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/symbol.py new file mode 100644 index 0000000000..f46760f634 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/source/ftrack_api/symbol.py @@ -0,0 +1,77 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import os + + +class Symbol(object): + '''A constant symbol.''' + + def __init__(self, name, value=True): + '''Initialise symbol with unique *name* and *value*. + + *value* is used for nonzero testing. + + ''' + self.name = name + self.value = value + + def __str__(self): + '''Return string representation.''' + return self.name + + def __repr__(self): + '''Return representation.''' + return '{0}({1})'.format(self.__class__.__name__, self.name) + + def __nonzero__(self): + '''Return whether symbol represents non-zero value.''' + return bool(self.value) + + def __copy__(self): + '''Return shallow copy. + + Overridden to always return same instance. + + ''' + return self + + +#: Symbol representing that no value has been set or loaded. +NOT_SET = Symbol('NOT_SET', False) + +#: Symbol representing created state. +CREATED = Symbol('CREATED') + +#: Symbol representing modified state. +MODIFIED = Symbol('MODIFIED') + +#: Symbol representing deleted state. +DELETED = Symbol('DELETED') + +#: Topic published when component added to a location. +COMPONENT_ADDED_TO_LOCATION_TOPIC = 'ftrack.location.component-added' + +#: Topic published when component removed from a location. +COMPONENT_REMOVED_FROM_LOCATION_TOPIC = 'ftrack.location.component-removed' + +#: Identifier of builtin origin location. +ORIGIN_LOCATION_ID = 'ce9b348f-8809-11e3-821c-20c9d081909b' + +#: Identifier of builtin unmanaged location. +UNMANAGED_LOCATION_ID = 'cb268ecc-8809-11e3-a7e2-20c9d081909b' + +#: Identifier of builtin review location. +REVIEW_LOCATION_ID = 'cd41be70-8809-11e3-b98a-20c9d081909b' + +#: Identifier of builtin connect location. +CONNECT_LOCATION_ID = '07b82a97-8cf9-11e3-9383-20c9d081909b' + +#: Identifier of builtin server location. +SERVER_LOCATION_ID = '3a372bde-05bc-11e4-8908-20c9d081909b' + +#: Chunk size used when working with data, default to 1Mb. +CHUNK_SIZE = int(os.getenv('FTRACK_API_FILE_CHUNK_SIZE', 0)) or 1024*1024 + +#: Symbol representing syncing users with ldap +JOB_SYNC_USERS_LDAP = Symbol('SYNC_USERS_LDAP') diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/colour_wheel.mov b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/colour_wheel.mov new file mode 100644 index 0000000000..db34709c24 Binary files /dev/null and b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/colour_wheel.mov differ diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/image-resized-10.png b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/image-resized-10.png new file mode 100644 index 0000000000..da6ec77209 Binary files /dev/null and b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/image-resized-10.png differ diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/image.png b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/image.png new file mode 100644 index 0000000000..cd4d0045d5 Binary files /dev/null and b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/media/image.png differ diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/configure_locations.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/configure_locations.py new file mode 100644 index 0000000000..5fcf034b8f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/configure_locations.py @@ -0,0 +1,40 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import logging + +import ftrack_api +import ftrack_api.entity.location +import ftrack_api.accessor.disk + + +def configure_locations(event): + '''Configure locations for session.''' + session = event['data']['session'] + + # Find location(s) and customise instances. + location = session.ensure('Location', {'name': 'test.location'}) + ftrack_api.mixin( + location, ftrack_api.entity.location.UnmanagedLocationMixin + ) + location.accessor = ftrack_api.accessor.disk.DiskAccessor(prefix='') + + +def register(session): + '''Register plugin with *session*.''' + logger = logging.getLogger('ftrack_plugin:configure_locations.register') + + # Validate that session is an instance of ftrack_api.Session. If not, assume + # that register is being called from an old or incompatible API and return + # without doing anything. + if not isinstance(session, ftrack_api.Session): + logger.debug( + 'Not subscribing plugin as passed argument {0} is not an ' + 'ftrack_api.Session instance.'.format(session) + ) + return + + session.event_hub.subscribe( + 'topic=ftrack.api.session.configure-location', + configure_locations + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/construct_entity_type.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/construct_entity_type.py new file mode 100644 index 0000000000..bb2f8c42d3 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/construct_entity_type.py @@ -0,0 +1,52 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import logging + +import ftrack_api.entity.factory + + +def stub(self): + '''A stub method for testing only.''' + + +class Factory(ftrack_api.entity.factory.StandardFactory): + '''Entity class factory.''' + + def create(self, schema, bases=None): + '''Create and return entity class from *schema*.''' + # Optionally change bases for class to be generated. + cls = super(Factory, self).create(schema, bases=bases) + + # Further customise cls before returning. + if schema['id'] == 'User': + cls.stub = stub + + return cls + + +def register(session): + '''Register plugin with *session*.''' + logger = logging.getLogger('ftrack_plugin:construct_entity_type.register') + + # Validate that session is an instance of ftrack_api.Session. If not, assume + # that register is being called from an old or incompatible API and return + # without doing anything. + if not isinstance(session, ftrack_api.Session): + logger.debug( + 'Not subscribing plugin as passed argument {0!r} is not an ' + 'ftrack_api.Session instance.'.format(session) + ) + return + + factory = Factory() + + def construct_entity_type(event): + '''Return class to represent entity type specified by *event*.''' + schema = event['data']['schema'] + return factory.create(schema) + + session.event_hub.subscribe( + 'topic=ftrack.api.session.construct-entity-type', + construct_entity_type + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/count_session_event.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/count_session_event.py new file mode 100644 index 0000000000..37938ae8a1 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/fixture/plugin/count_session_event.py @@ -0,0 +1,41 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2018 ftrack +import logging +import collections + +import ftrack_api.session + + +def count_session_event(event): + '''Called when session is ready to be used.''' + logger = logging.getLogger('com.ftrack.test-session-event-plugin') + event_topic = event['topic'] + logger.debug(u'Event received: {}'.format(event_topic)) + session = event['data']['session'] + session._test_called_events[event_topic] += 1 + + +def register(session, **kw): + '''Register plugin. Called when used as an plugin.''' + logger = logging.getLogger('com.ftrack.test-session-event-plugin') + + # Validate that session is an instance of ftrack_api.Session. If not, + # assume that register is being called from an old or incompatible API and + # return without doing anything. + if not isinstance(session, ftrack_api.session.Session): + logger.debug( + 'Not subscribing plugin as passed argument {0!r} is not an ' + 'ftrack_api.Session instance.'.format(session) + ) + return + + session._test_called_events = collections.defaultdict(int) + session.event_hub.subscribe( + 'topic=ftrack.api.session.ready', + count_session_event + ) + session.event_hub.subscribe( + 'topic=ftrack.api.session.reset', + count_session_event + ) + logger.debug('Plugin registered') diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/__init__.py new file mode 100644 index 0000000000..1aab07ed77 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/__init__.py new file mode 100644 index 0000000000..bc98f15de2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/test_disk.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/test_disk.py new file mode 100644 index 0000000000..82895d923b --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/test_disk.py @@ -0,0 +1,267 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import os +import tempfile + +import pytest + +import ftrack_api +import ftrack_api.exception +import ftrack_api.accessor.disk +import ftrack_api.data + + +def test_get_filesystem_path(temporary_path): + '''Convert paths to filesystem paths.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + # Absolute paths outside of configured prefix fail. + with pytest.raises(ftrack_api.exception.AccessorFilesystemPathError): + accessor.get_filesystem_path(os.path.join('/', 'test', 'foo.txt')) + + # Absolute root path. + assert accessor.get_filesystem_path(temporary_path) == temporary_path + + # Absolute path within prefix. + assert ( + accessor.get_filesystem_path( + os.path.join(temporary_path, 'test.txt') + ) == + os.path.join(temporary_path, 'test.txt') + ) + + # Relative root path + assert accessor.get_filesystem_path('') == temporary_path + + # Relative path for file at root + assert (accessor.get_filesystem_path('test.txt') == + os.path.join(temporary_path, 'test.txt')) + + # Relative path for file in subdirectory + assert (accessor.get_filesystem_path('test/foo.txt') == + os.path.join(temporary_path, 'test', 'foo.txt')) + + # Relative path non-collapsed + assert (accessor.get_filesystem_path('test/../foo.txt') == + os.path.join(temporary_path, 'foo.txt')) + + # Relative directory path without trailing slash + assert (accessor.get_filesystem_path('test') == + os.path.join(temporary_path, 'test')) + + # Relative directory path with trailing slash + assert (accessor.get_filesystem_path('test/') == + os.path.join(temporary_path, 'test')) + + +def test_list(temporary_path): + '''List entries.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + # File in root directory + assert accessor.list('') == [] + data = accessor.open('test.txt', 'w+') + data.close() + assert accessor.list('') == ['test.txt'] + + # File in subdirectory + accessor.make_container('test_dir') + assert accessor.list('test_dir') == [] + data = accessor.open('test_dir/test.txt', 'w+') + data.close() + + listing = accessor.list('test_dir') + assert listing == [os.path.join('test_dir', 'test.txt')] + + # Is a valid resource + assert accessor.exists(listing[0]) is True + + +def test_exists(temporary_path): + '''Valid path exists.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + _, temporary_file = tempfile.mkstemp(dir=temporary_path) + assert accessor.exists(temporary_file) is True + + +def test_missing_does_not_exist(temporary_path): + '''Missing path does not exist.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + assert accessor.exists('non-existant.txt') is False + + +def test_is_file(temporary_path): + '''Valid file is considered a file.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + _, temporary_file = tempfile.mkstemp(dir=temporary_path) + assert accessor.is_file(temporary_file) is True + + +def test_missing_is_not_file(temporary_path): + '''Missing path is not considered a file.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + assert accessor.is_file('non_existant.txt') is False + + +def test_container_is_not_file(temporary_path): + '''Valid container is not considered a file.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + temporary_directory = tempfile.mkdtemp(dir=temporary_path) + assert accessor.is_file(temporary_directory) is False + + +def test_is_container(temporary_path): + '''Valid container is considered a container.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + temporary_directory = tempfile.mkdtemp(dir=temporary_path) + assert accessor.is_container(temporary_directory) is True + + +def test_missing_is_not_container(temporary_path): + '''Missing path is not considered a container.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + assert accessor.is_container('non_existant') is False + + +def test_file_is_not_container(temporary_path): + '''Valid file is not considered a container.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + _, temporary_file = tempfile.mkstemp(dir=temporary_path) + assert accessor.is_container(temporary_file) is False + + +def test_is_sequence(temporary_path): + '''Sequence detection unsupported.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + with pytest.raises( + ftrack_api.exception.AccessorUnsupportedOperationError + ): + accessor.is_sequence('foo.%04d.exr') + + +def test_open(temporary_path): + '''Open file.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + with pytest.raises(ftrack_api.exception.AccessorResourceNotFoundError): + accessor.open('test.txt', 'r') + + data = accessor.open('test.txt', 'w+') + assert isinstance(data, ftrack_api.data.Data) is True + assert data.read() == '' + data.write('test data') + data.close() + + data = accessor.open('test.txt', 'r') + assert (data.read() == 'test data') + data.close() + + +def test_remove_file(temporary_path): + '''Delete file at path.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + file_handle, temporary_file = tempfile.mkstemp(dir=temporary_path) + os.close(file_handle) + accessor.remove(temporary_file) + assert os.path.exists(temporary_file) is False + + +def test_remove_container(temporary_path): + '''Delete container at path.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + temporary_directory = tempfile.mkdtemp(dir=temporary_path) + accessor.remove(temporary_directory) + assert os.path.exists(temporary_directory) is False + + +def test_remove_missing(temporary_path): + '''Fail to remove path that does not exist.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + with pytest.raises(ftrack_api.exception.AccessorResourceNotFoundError): + accessor.remove('non_existant') + + +def test_make_container(temporary_path): + '''Create container.''' + accessor = ftrack_api.accessor.disk.DiskAccessor(temporary_path) + + accessor.make_container('test') + assert os.path.isdir(os.path.join(temporary_path, 'test')) is True + + # Recursive + accessor.make_container('test/a/b/c') + assert ( + os.path.isdir( + os.path.join(temporary_path, 'test', 'a', 'b', 'c') + ) is + True + ) + + # Non-recursive fail + with pytest.raises( + ftrack_api.exception.AccessorParentResourceNotFoundError + ): + accessor.make_container('test/d/e/f', recursive=False) + + # Existing succeeds + accessor.make_container('test/a/b/c') + + +def test_get_container(temporary_path): + '''Get container from resource_identifier.''' + # With prefix. + accessor = ftrack_api.accessor.disk.DiskAccessor(prefix=temporary_path) + + assert ( + accessor.get_container(os.path.join('test', 'a')) == + 'test' + ) + + assert ( + accessor.get_container(os.path.join('test', 'a/')) == + 'test' + ) + + assert ( + accessor.get_container('test') == + '' + ) + + with pytest.raises( + ftrack_api.exception.AccessorParentResourceNotFoundError + ): + accessor.get_container('') + + with pytest.raises( + ftrack_api.exception.AccessorParentResourceNotFoundError + ): + accessor.get_container(temporary_path) + + # Without prefix. + accessor = ftrack_api.accessor.disk.DiskAccessor(prefix='') + + assert ( + accessor.get_container(os.path.join(temporary_path, 'test', 'a')) == + os.path.join(temporary_path, 'test') + ) + + assert ( + accessor.get_container( + os.path.join(temporary_path, 'test', 'a/') + ) == + os.path.join(temporary_path, 'test') + ) + + assert ( + accessor.get_container(os.path.join(temporary_path, 'test')) == + temporary_path + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/test_server.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/test_server.py new file mode 100644 index 0000000000..bb32426a27 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/accessor/test_server.py @@ -0,0 +1,41 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import uuid + +import pytest + +import ftrack_api +import ftrack_api.exception +import ftrack_api.accessor.server +import ftrack_api.data + + +def test_read_and_write(new_component, session): + '''Read and write data from server accessor.''' + random_data = uuid.uuid1().hex + + accessor = ftrack_api.accessor.server._ServerAccessor(session) + http_file = accessor.open(new_component['id'], mode='wb') + http_file.write(random_data) + http_file.close() + + data = accessor.open(new_component['id'], 'r') + assert data.read() == random_data, 'Read data is the same as written.' + data.close() + + +def test_remove_data(new_component, session): + '''Remove data using server accessor.''' + random_data = uuid.uuid1().hex + + accessor = ftrack_api.accessor.server._ServerAccessor(session) + http_file = accessor.open(new_component['id'], mode='wb') + http_file.write(random_data) + http_file.close() + + accessor.remove(new_component['id']) + + data = accessor.open(new_component['id'], 'r') + with pytest.raises(ftrack_api.exception.AccessorOperationFailedError): + data.read() diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/conftest.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/conftest.py new file mode 100644 index 0000000000..cf4fe3ccb6 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/conftest.py @@ -0,0 +1,539 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import uuid +import tempfile +import shutil +import os + +import pytest +import clique + +import ftrack_api +import ftrack_api.symbol + + +def pytest_generate_tests(metafunc): + '''Parametrize tests dynamically. + + If a test function has a corresponding parametrize function then call it + passing along the *metafunc*. For example, for a "test_foo" function, look + for and call "parametrize_test_foo" if it exists. + + This is useful when more complex dynamic parametrization is needed than the + standard pytest.mark.parametrize decorator can provide. + + ''' + generator_name = 'parametrize_{}'.format(metafunc.function.__name__) + generator = getattr(metafunc.module, generator_name, None) + if callable(generator): + generator(metafunc) + + +def _temporary_file(request, **kwargs): + '''Return temporary file.''' + file_handle, path = tempfile.mkstemp(**kwargs) + os.close(file_handle) + + def cleanup(): + '''Remove temporary file.''' + try: + os.remove(path) + except OSError: + pass + + request.addfinalizer(cleanup) + return path + + +@pytest.fixture() +def temporary_file(request): + '''Return temporary file.''' + return _temporary_file(request) + + +@pytest.fixture() +def temporary_image(request): + '''Return temporary file.''' + return _temporary_file(request, suffix='.jpg') + + +@pytest.fixture() +def temporary_directory(request): + '''Return temporary directory.''' + path = tempfile.mkdtemp() + + def cleanup(): + '''Remove temporary directory.''' + shutil.rmtree(path) + + request.addfinalizer(cleanup) + + return path + + +@pytest.fixture() +def temporary_sequence(temporary_directory): + '''Return temporary sequence of three files. + + Return the path using the `clique + `_ format, for example:: + + /tmp/asfjsfjoj3/%04d.jpg [1-3] + + ''' + items = [] + for index in range(3): + item_path = os.path.join( + temporary_directory, '{0:04d}.jpg'.format(index) + ) + with open(item_path, 'w') as file_descriptor: + file_descriptor.write(uuid.uuid4().hex) + file_descriptor.close() + + items.append(item_path) + + collections, _ = clique.assemble(items) + sequence_path = collections[0].format() + + return sequence_path + + +@pytest.fixture() +def video_path(): + '''Return a path to a video file.''' + video = os.path.abspath( + os.path.join( + os.path.dirname(__file__), + '..', + 'fixture', + 'media', + 'colour_wheel.mov' + ) + ) + + return video + + +@pytest.fixture() +def session(): + '''Return session instance.''' + return ftrack_api.Session() + + +@pytest.fixture() +def session_no_autoconnect_hub(): + '''Return session instance not auto connected to hub.''' + return ftrack_api.Session(auto_connect_event_hub=False) + + +@pytest.fixture() +def unique_name(): + '''Return a unique name.''' + return 'test-{0}'.format(uuid.uuid4()) + + +@pytest.fixture() +def temporary_path(request): + '''Return temporary path.''' + path = tempfile.mkdtemp() + + def cleanup(): + '''Remove created path.''' + try: + shutil.rmtree(path) + except OSError: + pass + + request.addfinalizer(cleanup) + + return path + + +@pytest.fixture() +def new_user(request, session, unique_name): + '''Return a newly created unique user.''' + entity = session.create('User', {'username': unique_name}) + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(entity) + session.commit() + + request.addfinalizer(cleanup) + + return entity + + +@pytest.fixture() +def user(session): + '''Return the same user entity for entire session.''' + # Jenkins user + entity = session.get('User', 'd07ae5d0-66e1-11e1-b5e9-f23c91df25eb') + assert entity is not None + + return entity + + +@pytest.fixture() +def project_schema(session): + '''Return project schema.''' + # VFX Scheme + entity = session.get( + 'ProjectSchema', '69cb7f92-4dbf-11e1-9902-f23c91df25eb' + ) + assert entity is not None + return entity + + +@pytest.fixture() +def new_project_tree(request, session, user): + '''Return new project with basic tree.''' + project_schema = session.query('ProjectSchema').first() + default_shot_status = project_schema.get_statuses('Shot')[0] + default_task_type = project_schema.get_types('Task')[0] + default_task_status = project_schema.get_statuses( + 'Task', default_task_type['id'] + )[0] + + project_name = 'python_api_test_{0}'.format(uuid.uuid1().hex) + project = session.create('Project', { + 'name': project_name, + 'full_name': project_name + '_full', + 'project_schema': project_schema + }) + + for sequence_number in range(1): + sequence = session.create('Sequence', { + 'name': 'sequence_{0:03d}'.format(sequence_number), + 'parent': project + }) + + for shot_number in range(1): + shot = session.create('Shot', { + 'name': 'shot_{0:03d}'.format(shot_number * 10), + 'parent': sequence, + 'status': default_shot_status + }) + + for task_number in range(1): + task = session.create('Task', { + 'name': 'task_{0:03d}'.format(task_number), + 'parent': shot, + 'status': default_task_status, + 'type': default_task_type + }) + + session.create('Appointment', { + 'type': 'assignment', + 'context': task, + 'resource': user + }) + + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(project) + session.commit() + + request.addfinalizer(cleanup) + + return project + + +@pytest.fixture() +def new_project(request, session, user): + '''Return new empty project.''' + project_schema = session.query('ProjectSchema').first() + project_name = 'python_api_test_{0}'.format(uuid.uuid1().hex) + project = session.create('Project', { + 'name': project_name, + 'full_name': project_name + '_full', + 'project_schema': project_schema + }) + + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(project) + session.commit() + + request.addfinalizer(cleanup) + + return project + + +@pytest.fixture() +def project(session): + '''Return same project for entire session.''' + # Test project. + entity = session.get('Project', '5671dcb0-66de-11e1-8e6e-f23c91df25eb') + assert entity is not None + + return entity + + +@pytest.fixture() +def new_task(request, session, unique_name): + '''Return a new task.''' + project = session.query( + 'Project where id is 5671dcb0-66de-11e1-8e6e-f23c91df25eb' + ).one() + project_schema = project['project_schema'] + default_task_type = project_schema.get_types('Task')[0] + default_task_status = project_schema.get_statuses( + 'Task', default_task_type['id'] + )[0] + + task = session.create('Task', { + 'name': unique_name, + 'parent': project, + 'status': default_task_status, + 'type': default_task_type + }) + + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(task) + session.commit() + + request.addfinalizer(cleanup) + + return task + + +@pytest.fixture() +def task(session): + '''Return same task for entire session.''' + # Tests/python_api/tasks/t1 + entity = session.get('Task', 'adb4ad6c-7679-11e2-8df2-f23c91df25eb') + assert entity is not None + + return entity + + +@pytest.fixture() +def new_scope(request, session, unique_name): + '''Return a new scope.''' + scope = session.create('Scope', { + 'name': unique_name + }) + + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(scope) + session.commit() + + request.addfinalizer(cleanup) + + return scope + + +@pytest.fixture() +def new_job(request, session, unique_name, user): + '''Return a new scope.''' + job = session.create('Job', { + 'type': 'api_job', + 'user': user + }) + + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(job) + session.commit() + + request.addfinalizer(cleanup) + + return job + + +@pytest.fixture() +def new_note(request, session, unique_name, new_task, user): + '''Return a new note attached to a task.''' + note = new_task.create_note(unique_name, user) + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(note) + session.commit() + + request.addfinalizer(cleanup) + + return note + + +@pytest.fixture() +def new_asset_version(request, session): + '''Return a new asset version.''' + asset_version = session.create('AssetVersion', { + 'asset_id': 'dd9a7e2e-c5eb-11e1-9885-f23c91df25eb' + }) + session.commit() + + # Do not cleanup the version as that will sometimes result in a deadlock + # database error. + + return asset_version + + +@pytest.fixture() +def new_component(request, session, temporary_file): + '''Return a new component not in any location except origin.''' + component = session.create_component(temporary_file, location=None) + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(component) + session.commit() + + request.addfinalizer(cleanup) + + return component + + +@pytest.fixture() +def new_container_component(request, session, temporary_directory): + '''Return a new container component not in any location except origin.''' + component = session.create('ContainerComponent') + + # Add to special origin location so that it is possible to add to other + # locations. + origin_location = session.get( + 'Location', ftrack_api.symbol.ORIGIN_LOCATION_ID + ) + origin_location.add_component( + component, temporary_directory, recursive=False + ) + + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(component) + session.commit() + + request.addfinalizer(cleanup) + + return component + + +@pytest.fixture() +def new_sequence_component(request, session, temporary_sequence): + '''Return a new sequence component not in any location except origin.''' + component = session.create_component(temporary_sequence, location=None) + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(component) + session.commit() + + request.addfinalizer(cleanup) + + return component + + +@pytest.fixture +def mocked_schemas(): + '''Return a list of mocked schemas.''' + return [{ + 'id': 'Foo', + 'type': 'object', + 'properties': { + 'id': { + 'type': 'string' + }, + 'string': { + 'type': 'string' + }, + 'integer': { + 'type': 'integer' + }, + 'number': { + 'type': 'number' + }, + 'boolean': { + 'type': 'boolean' + }, + 'bars': { + 'type': 'array', + 'items': { + 'ref': '$Bar' + } + }, + 'date': { + 'type': 'string', + 'format': 'date-time' + } + }, + 'immutable': [ + 'id' + ], + 'primary_key': [ + 'id' + ], + 'required': [ + 'id' + ], + 'default_projections': [ + 'id' + ] + }, { + 'id': 'Bar', + 'type': 'object', + 'properties': { + 'id': { + 'type': 'string' + }, + 'name': { + 'type': 'string' + }, + 'computed_value': { + 'type': 'string', + } + }, + 'computed': [ + 'computed_value' + ], + 'immutable': [ + 'id' + ], + 'primary_key': [ + 'id' + ], + 'required': [ + 'id' + ], + 'default_projections': [ + 'id' + ] + }] + + +@pytest.yield_fixture +def mocked_schema_session(mocker, mocked_schemas): + '''Return a session instance with mocked schemas.''' + with mocker.patch.object( + ftrack_api.Session, + '_load_schemas', + return_value=mocked_schemas + ): + # Mock _configure_locations since it will fail if no location schemas + # exist. + with mocker.patch.object( + ftrack_api.Session, + '_configure_locations' + ): + patched_session = ftrack_api.Session() + yield patched_session diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/__init__.py new file mode 100644 index 0000000000..bc98f15de2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_asset_version.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_asset_version.py new file mode 100644 index 0000000000..78d61a62d1 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_asset_version.py @@ -0,0 +1,54 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack +import json + + +def test_create_component(new_asset_version, temporary_file): + '''Create component on asset version.''' + session = new_asset_version.session + component = new_asset_version.create_component( + temporary_file, location=None + ) + assert component['version'] is new_asset_version + + # Have to delete component before can delete asset version. + session.delete(component) + + +def test_create_component_specifying_different_version( + new_asset_version, temporary_file +): + '''Create component on asset version ignoring specified version.''' + session = new_asset_version.session + component = new_asset_version.create_component( + temporary_file, location=None, + data=dict( + version_id='this-value-should-be-ignored', + version='this-value-should-be-overridden' + ) + ) + assert component['version'] is new_asset_version + + # Have to delete component before can delete asset version. + session.delete(component) + + +def test_encode_media(new_asset_version, video_path): + '''Encode media based on a file path + + Encoded components should be associated with the version. + ''' + session = new_asset_version.session + job = new_asset_version.encode_media(video_path) + assert job.entity_type == 'Job' + + job_data = json.loads(job['data']) + assert 'output' in job_data + assert len(job_data['output']) + assert 'component_id' in job_data['output'][0] + + component_id = job_data['output'][0]['component_id'] + component = session.get('FileComponent', component_id) + + # Component should be associated with the version. + assert component['version_id'] == new_asset_version['id'] diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_base.py new file mode 100644 index 0000000000..aff456e238 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_base.py @@ -0,0 +1,14 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2016 ftrack + +import pytest + + +def test_hash(project, task, user): + '''Entities can be hashed.''' + test_set = set() + test_set.add(project) + test_set.add(task) + test_set.add(user) + + assert test_set == set((project, task, user)) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_component.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_component.py new file mode 100644 index 0000000000..347c74a50d --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_component.py @@ -0,0 +1,70 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack +import os + +import pytest + + +def test_get_availability(new_component): + '''Retrieve availability in locations.''' + session = new_component.session + availability = new_component.get_availability() + + # Note: Currently the origin location is also 0.0 as the link is not + # persisted to the server. This may change in future and this test would + # need updating as a result. + assert set(availability.values()) == set([0.0]) + + # Add to a location. + source_location = session.query( + 'Location where name is "ftrack.origin"' + ).one() + + target_location = session.query( + 'Location where name is "ftrack.unmanaged"' + ).one() + + target_location.add_component(new_component, source_location) + + # Recalculate availability. + + # Currently have to manually expire the related attribute. This should be + # solved in future by bi-directional relationship updating. + del new_component['component_locations'] + + availability = new_component.get_availability() + target_availability = availability.pop(target_location['id']) + assert target_availability == 100.0 + + # All other locations should still be 0. + assert set(availability.values()) == set([0.0]) + +@pytest.fixture() +def image_path(): + '''Return a path to an image file.''' + image_path = os.path.abspath( + os.path.join( + os.path.dirname(__file__), + '..', + '..', + 'fixture', + 'media', + 'image.png' + ) + ) + + return image_path + +def test_create_task_thumbnail(task, image_path): + '''Successfully create thumbnail component and set as task thumbnail.''' + component = task.create_thumbnail(image_path) + component.session.commit() + assert component['id'] == task['thumbnail_id'] + + +def test_create_thumbnail_with_data(task, image_path, unique_name): + '''Successfully create thumbnail component with custom data.''' + data = {'name': unique_name} + component = task.create_thumbnail(image_path, data=data) + component.session.commit() + assert component['name'] == unique_name diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_factory.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_factory.py new file mode 100644 index 0000000000..5d5a0baa7c --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_factory.py @@ -0,0 +1,25 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api.entity.factory + + +class CustomUser(ftrack_api.entity.base.Entity): + '''Represent custom user.''' + + +def test_extend_standard_factory_with_bases(session): + '''Successfully add extra bases to standard factory.''' + standard_factory = ftrack_api.entity.factory.StandardFactory() + + schemas = session._load_schemas(False) + user_schema = [ + schema for schema in schemas if schema['id'] == 'User' + ].pop() + + user_class = standard_factory.create(user_schema, bases=[CustomUser]) + session.types[user_class.entity_type] = user_class + + user = session.query('User').first() + + assert CustomUser in type(user).__mro__ diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_job.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_job.py new file mode 100644 index 0000000000..52ddbda0ac --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_job.py @@ -0,0 +1,42 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import pytest + + +def test_create_job(session, user): + '''Create job.''' + job = session.create('Job', { + 'user': user + }) + + assert job + session.commit() + assert job['type'] == 'api_job' + + session.delete(job) + session.commit() + + +def test_create_job_with_valid_type(session, user): + '''Create job explicitly specifying valid type.''' + job = session.create('Job', { + 'user': user, + 'type': 'api_job' + }) + + assert job + session.commit() + assert job['type'] == 'api_job' + + session.delete(job) + session.commit() + + +def test_create_job_using_faulty_type(session, user): + '''Fail to create job with faulty type.''' + with pytest.raises(ValueError): + session.create('Job', { + 'user': user, + 'type': 'not-allowed-type' + }) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_location.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_location.py new file mode 100644 index 0000000000..5bb90e451f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_location.py @@ -0,0 +1,516 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import os +import base64 +import filecmp + +import pytest +import requests + +import ftrack_api.exception +import ftrack_api.accessor.disk +import ftrack_api.structure.origin +import ftrack_api.structure.id +import ftrack_api.entity.location +import ftrack_api.resource_identifier_transformer.base as _transformer +import ftrack_api.symbol + + +class Base64ResourceIdentifierTransformer( + _transformer.ResourceIdentifierTransformer +): + '''Resource identifier transformer for test purposes. + + Store resource identifier as base 64 encoded string. + + ''' + + def encode(self, resource_identifier, context=None): + '''Return encoded *resource_identifier* for storing centrally. + + A mapping of *context* values may be supplied to guide the + transformation. + + ''' + return base64.encodestring(resource_identifier) + + def decode(self, resource_identifier, context=None): + '''Return decoded *resource_identifier* for use locally. + + A mapping of *context* values may be supplied to guide the + transformation. + + ''' + return base64.decodestring(resource_identifier) + + +@pytest.fixture() +def new_location(request, session, unique_name, temporary_directory): + '''Return new managed location.''' + location = session.create('Location', { + 'name': 'test-location-{}'.format(unique_name) + }) + + location.accessor = ftrack_api.accessor.disk.DiskAccessor( + prefix=os.path.join(temporary_directory, 'location') + ) + location.structure = ftrack_api.structure.id.IdStructure() + location.priority = 10 + + session.commit() + + def cleanup(): + '''Remove created entity.''' + # First auto-remove all components in location. + for location_component in location['location_components']: + session.delete(location_component) + + # At present, need this intermediate commit otherwise server errors + # complaining that location still has components in it. + session.commit() + + session.delete(location) + session.commit() + + request.addfinalizer(cleanup) + + return location + + +@pytest.fixture() +def new_unmanaged_location(request, session, unique_name): + '''Return new unmanaged location.''' + location = session.create('Location', { + 'name': 'test-location-{}'.format(unique_name) + }) + + # TODO: Change to managed and use a temporary directory cleaned up after. + ftrack_api.mixin( + location, ftrack_api.entity.location.UnmanagedLocationMixin, + name='UnmanagedTestLocation' + ) + location.accessor = ftrack_api.accessor.disk.DiskAccessor(prefix='') + location.structure = ftrack_api.structure.origin.OriginStructure() + location.priority = 10 + + session.commit() + + def cleanup(): + '''Remove created entity.''' + # First auto-remove all components in location. + for location_component in location['location_components']: + session.delete(location_component) + + # At present, need this intermediate commit otherwise server errors + # complaining that location still has components in it. + session.commit() + + session.delete(location) + session.commit() + + request.addfinalizer(cleanup) + + return location + + +@pytest.fixture() +def origin_location(session): + '''Return origin location.''' + return session.query('Location where name is "ftrack.origin"').one() + +@pytest.fixture() +def server_location(session): + '''Return server location.''' + return session.get('Location', ftrack_api.symbol.SERVER_LOCATION_ID) + + +@pytest.fixture() +def server_image_component(request, session, server_location): + image_file = os.path.abspath( + os.path.join( + os.path.dirname(__file__), + '..', + '..', + 'fixture', + 'media', + 'image.png' + ) + ) + component = session.create_component( + image_file, location=server_location + ) + + def cleanup(): + server_location.remove_component(component) + request.addfinalizer(cleanup) + + return component + + +@pytest.mark.parametrize('name', [ + 'named', + None +], ids=[ + 'named', + 'unnamed' +]) +def test_string_representation(session, name): + '''Return string representation.''' + location = session.create('Location', {'id': '1'}) + if name: + location['name'] = name + assert str(location) == '' + else: + assert str(location) == '' + + +def test_add_components(new_location, origin_location, session, temporary_file): + '''Add components.''' + component_a = session.create_component( + temporary_file, location=None + ) + component_b = session.create_component( + temporary_file, location=None + ) + + assert ( + new_location.get_component_availabilities([component_a, component_b]) + == [0.0, 0.0] + ) + + new_location.add_components( + [component_a, component_b], [origin_location, origin_location] + ) + + # Recalculate availability. + + # Currently have to manually expire the related attribute. This should be + # solved in future by bi-directional relationship updating. + del component_a['component_locations'] + del component_b['component_locations'] + + assert ( + new_location.get_component_availabilities([component_a, component_b]) + == [100.0, 100.0] + ) + + +def test_add_components_from_single_location( + new_location, origin_location, session, temporary_file +): + '''Add components from single location.''' + component_a = session.create_component( + temporary_file, location=None + ) + component_b = session.create_component( + temporary_file, location=None + ) + + assert ( + new_location.get_component_availabilities([component_a, component_b]) + == [0.0, 0.0] + ) + + new_location.add_components([component_a, component_b], origin_location) + + # Recalculate availability. + + # Currently have to manually expire the related attribute. This should be + # solved in future by bi-directional relationship updating. + del component_a['component_locations'] + del component_b['component_locations'] + + assert ( + new_location.get_component_availabilities([component_a, component_b]) + == [100.0, 100.0] + ) + + +def test_add_components_with_mismatching_sources(new_location, new_component): + '''Fail to add components when sources mismatched.''' + with pytest.raises(ValueError): + new_location.add_components([new_component], []) + + +def test_add_components_with_undefined_structure(new_location, mocker): + '''Fail to add components when location structure undefined.''' + mocker.patch.object(new_location, 'structure', None) + + with pytest.raises(ftrack_api.exception.LocationError): + new_location.add_components([], []) + + +def test_add_components_already_in_location( + session, temporary_file, new_location, new_component, origin_location +): + '''Fail to add components already in location.''' + new_location.add_component(new_component, origin_location) + + another_new_component = session.create_component( + temporary_file, location=None + ) + + with pytest.raises(ftrack_api.exception.ComponentInLocationError): + new_location.add_components( + [another_new_component, new_component], origin_location + ) + + +def test_add_component_when_data_already_exists( + new_location, new_component, origin_location +): + '''Fail to add component when data already exists.''' + # Inject pre-existing data on disk. + resource_identifier = new_location.structure.get_resource_identifier( + new_component + ) + container = new_location.accessor.get_container(resource_identifier) + new_location.accessor.make_container(container) + data = new_location.accessor.open(resource_identifier, 'w') + data.close() + + with pytest.raises(ftrack_api.exception.LocationError): + new_location.add_component(new_component, origin_location) + + +def test_add_component_missing_source_accessor( + new_location, new_component, origin_location, mocker +): + '''Fail to add component when source is missing accessor.''' + mocker.patch.object(origin_location, 'accessor', None) + + with pytest.raises(ftrack_api.exception.LocationError): + new_location.add_component(new_component, origin_location) + + +def test_add_component_missing_target_accessor( + new_location, new_component, origin_location, mocker +): + '''Fail to add component when target is missing accessor.''' + mocker.patch.object(new_location, 'accessor', None) + + with pytest.raises(ftrack_api.exception.LocationError): + new_location.add_component(new_component, origin_location) + + +def test_add_container_component( + new_container_component, new_location, origin_location +): + '''Add container component.''' + new_location.add_component(new_container_component, origin_location) + + assert ( + new_location.get_component_availability(new_container_component) + == 100.0 + ) + + +def test_add_sequence_component_recursively( + new_sequence_component, new_location, origin_location +): + '''Add sequence component recursively.''' + new_location.add_component( + new_sequence_component, origin_location, recursive=True + ) + + assert ( + new_location.get_component_availability(new_sequence_component) + == 100.0 + ) + + +def test_add_sequence_component_non_recursively( + new_sequence_component, new_location, origin_location +): + '''Add sequence component non recursively.''' + new_location.add_component( + new_sequence_component, origin_location, recursive=False + ) + + assert ( + new_location.get_component_availability(new_sequence_component) + == 0.0 + ) + + +def test_remove_components( + session, new_location, origin_location, temporary_file +): + '''Remove components.''' + component_a = session.create_component( + temporary_file, location=None + ) + component_b = session.create_component( + temporary_file, location=None + ) + + new_location.add_components([component_a, component_b], origin_location) + assert ( + new_location.get_component_availabilities([component_a, component_b]) + == [100.0, 100.0] + ) + + new_location.remove_components([ + component_a, component_b + ]) + + # Recalculate availability. + + # Currently have to manually expire the related attribute. This should be + # solved in future by bi-directional relationship updating. + del component_a['component_locations'] + del component_b['component_locations'] + + assert ( + new_location.get_component_availabilities([component_a, component_b]) + == [0.0, 0.0] + ) + + +def test_remove_sequence_component_recursively( + new_sequence_component, new_location, origin_location +): + '''Remove sequence component recursively.''' + new_location.add_component( + new_sequence_component, origin_location, recursive=True + ) + + new_location.remove_component( + new_sequence_component, recursive=True + ) + + assert ( + new_location.get_component_availability(new_sequence_component) + == 0.0 + ) + + +def test_remove_sequence_component_non_recursively( + new_sequence_component, new_location, origin_location +): + '''Remove sequence component non recursively.''' + new_location.add_component( + new_sequence_component, origin_location, recursive=False + ) + + new_location.remove_component( + new_sequence_component, recursive=False + ) + + assert ( + new_location.get_component_availability(new_sequence_component) + == 0.0 + ) + + +def test_remove_component_missing_accessor( + new_location, new_component, origin_location, mocker +): + '''Fail to remove component when location is missing accessor.''' + new_location.add_component(new_component, origin_location) + mocker.patch.object(new_location, 'accessor', None) + + with pytest.raises(ftrack_api.exception.LocationError): + new_location.remove_component(new_component) + + +def test_resource_identifier_transformer( + new_component, new_unmanaged_location, origin_location, mocker +): + '''Transform resource identifier.''' + session = new_unmanaged_location.session + + transformer = Base64ResourceIdentifierTransformer(session) + mocker.patch.object( + new_unmanaged_location, 'resource_identifier_transformer', transformer + ) + + new_unmanaged_location.add_component(new_component, origin_location) + + original_resource_identifier = origin_location.get_resource_identifier( + new_component + ) + assert ( + new_component['component_locations'][0]['resource_identifier'] + == base64.encodestring(original_resource_identifier) + ) + + assert ( + new_unmanaged_location.get_resource_identifier(new_component) + == original_resource_identifier + ) + + +def test_get_filesystem_path(new_component, new_location, origin_location): + '''Retrieve filesystem path.''' + new_location.add_component(new_component, origin_location) + resource_identifier = new_location.structure.get_resource_identifier( + new_component + ) + expected = os.path.normpath( + os.path.join(new_location.accessor.prefix, resource_identifier) + ) + assert new_location.get_filesystem_path(new_component) == expected + + +def test_get_context(new_component, new_location, origin_location): + '''Retrieve context for component.''' + resource_identifier = origin_location.get_resource_identifier( + new_component + ) + context = new_location._get_context(new_component, origin_location) + assert context == { + 'source_resource_identifier': resource_identifier + } + + +def test_get_context_for_component_not_in_source(new_component, new_location): + '''Retrieve context for component not in source location.''' + context = new_location._get_context(new_component, new_location) + assert context == {} + + +def test_data_transfer(session, new_location, origin_location): + '''Transfer a real file and make sure it is identical.''' + video_file = os.path.abspath( + os.path.join( + os.path.dirname(__file__), + '..', + '..', + 'fixture', + 'media', + 'colour_wheel.mov' + ) + ) + component = session.create_component( + video_file, location=new_location + ) + new_video_file = new_location.get_filesystem_path(component) + + assert filecmp.cmp(video_file, new_video_file) + + +def test_get_thumbnail_url(server_location, server_image_component): + '''Test download a thumbnail image from server location''' + thumbnail_url = server_location.get_thumbnail_url( + server_image_component, + size=10 + ) + assert thumbnail_url + + response = requests.get(thumbnail_url) + response.raise_for_status() + + image_file = os.path.abspath( + os.path.join( + os.path.dirname(__file__), + '..', + '..', + 'fixture', + 'media', + 'image-resized-10.png' + ) + ) + expected_image_contents = open(image_file).read() + assert response.content == expected_image_contents diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_metadata.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_metadata.py new file mode 100644 index 0000000000..3a81fdbe85 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_metadata.py @@ -0,0 +1,135 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import uuid + +import ftrack_api + + +def test_query_metadata(new_project): + '''Query metadata.''' + session = new_project.session + + metadata_key = uuid.uuid1().hex + metadata_value = uuid.uuid1().hex + new_project['metadata'][metadata_key] = metadata_value + session.commit() + + results = session.query( + 'Project where metadata.key is {0}'.format(metadata_key) + ) + + assert len(results) == 1 + assert new_project['id'] == results[0]['id'] + + results = session.query( + 'Project where metadata.value is {0}'.format(metadata_value) + ) + + assert len(results) == 1 + assert new_project['id'] == results[0]['id'] + + results = session.query( + 'Project where metadata.key is {0} and ' + 'metadata.value is {1}'.format(metadata_key, metadata_value) + ) + + assert len(results) == 1 + assert new_project['id'] == results[0]['id'] + + +def test_set_get_metadata_from_different_sessions(new_project): + '''Get and set metadata using different sessions.''' + session = new_project.session + + metadata_key = uuid.uuid1().hex + metadata_value = uuid.uuid1().hex + new_project['metadata'][metadata_key] = metadata_value + session.commit() + + new_session = ftrack_api.Session() + project = new_session.query( + 'Project where id is {0}'.format(new_project['id']) + )[0] + + assert project['metadata'][metadata_key] == metadata_value + + project['metadata'][metadata_key] = uuid.uuid1().hex + + new_session.commit() + + new_session = ftrack_api.Session() + project = new_session.query( + 'Project where id is {0}'.format(project['id']) + )[0] + + assert project['metadata'][metadata_key] != metadata_value + + +def test_get_set_multiple_metadata(new_project): + '''Get and set multiple metadata.''' + session = new_project.session + + new_project['metadata'] = { + 'key1': 'value1', + 'key2': 'value2' + } + session.commit() + + assert set(new_project['metadata'].keys()) == set(['key1', 'key2']) + + new_session = ftrack_api.Session() + retrieved = new_session.query( + 'Project where id is {0}'.format(new_project['id']) + )[0] + + assert set(retrieved['metadata'].keys()) == set(['key1', 'key2']) + + +def test_metadata_parent_type_remains_in_schema_id_format(session, new_project): + '''Metadata parent_type remains in schema id format post commit.''' + entity = session.create('Metadata', { + 'key': 'key', 'value': 'value', + 'parent_type': new_project.entity_type, + 'parent_id': new_project['id'] + }) + + session.commit() + + assert entity['parent_type'] == new_project.entity_type + + +def test_set_metadata_twice(new_project): + '''Set metadata twice in a row.''' + session = new_project.session + + new_project['metadata'] = { + 'key1': 'value1', + 'key2': 'value2' + } + session.commit() + + assert set(new_project['metadata'].keys()) == set(['key1', 'key2']) + + new_project['metadata'] = { + 'key3': 'value3', + 'key4': 'value4' + } + session.commit() + + +def test_set_same_metadata_on_retrieved_entity(new_project): + '''Set same metadata on retrieved entity.''' + session = new_project.session + + new_project['metadata'] = { + 'key1': 'value1' + } + session.commit() + + project = session.get('Project', new_project['id']) + + project['metadata'] = { + 'key1': 'value1' + } + session.commit() diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_note.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_note.py new file mode 100644 index 0000000000..5d854eaed4 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_note.py @@ -0,0 +1,67 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api +import ftrack_api.inspection + + +def test_create_reply(session, new_note, user, unique_name): + '''Create reply to a note.''' + reply_text = 'My reply on note' + new_note.create_reply(reply_text, user) + + session.commit() + + assert len(new_note['replies']) == 1 + + assert reply_text == new_note['replies'][0]['content'] + + +def test_create_note_on_entity(session, new_task, user, unique_name): + '''Create note attached to an entity.''' + note = new_task.create_note(unique_name, user) + session.commit() + + session.reset() + retrieved_task = session.get(*ftrack_api.inspection.identity(new_task)) + assert len(retrieved_task['notes']) == 1 + assert ( + ftrack_api.inspection.identity(retrieved_task['notes'][0]) + == ftrack_api.inspection.identity(note) + ) + + +def test_create_note_on_entity_specifying_recipients( + session, new_task, user, unique_name, new_user +): + '''Create note with specified recipients attached to an entity.''' + recipient = new_user + note = new_task.create_note(unique_name, user, recipients=[recipient]) + session.commit() + + session.reset() + retrieved_note = session.get(*ftrack_api.inspection.identity(note)) + + # Note: The calling user is automatically added server side so there will be + # 2 recipients. + assert len(retrieved_note['recipients']) == 2 + specified_recipient_present = False + for entry in retrieved_note['recipients']: + if entry['resource_id'] == recipient['id']: + specified_recipient_present = True + break + + assert specified_recipient_present + + +def test_create_note_on_entity_specifying_category( + session, new_task, user, unique_name +): + '''Create note with specified category attached to an entity.''' + category = session.query('NoteCategory').first() + note = new_task.create_note(unique_name, user, category=category) + session.commit() + + session.reset() + retrieved_note = session.get(*ftrack_api.inspection.identity(note)) + assert retrieved_note['category']['id'] == category['id'] diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_project_schema.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_project_schema.py new file mode 100644 index 0000000000..10ef485aed --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_project_schema.py @@ -0,0 +1,64 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import inspect + +import pytest + + +@pytest.mark.parametrize('schema, expected', [ + ('Task', [ + 'Not started', 'In progress', 'Awaiting approval', 'Approved' + ]), + ('Shot', [ + 'Normal', 'Omitted', 'On Hold' + ]), + ('AssetVersion', [ + 'Approved', 'Pending' + ]), + ('AssetBuild', [ + 'Normal', 'Omitted', 'On Hold' + ]), + ('Invalid', ValueError) +], ids=[ + 'task', + 'shot', + 'asset version', + 'asset build', + 'invalid' +]) +def test_get_statuses(project_schema, schema, expected): + '''Retrieve statuses for schema and optional type.''' + if inspect.isclass(expected) and issubclass(expected, Exception): + with pytest.raises(expected): + project_schema.get_statuses(schema) + + else: + statuses = project_schema.get_statuses(schema) + status_names = [status['name'] for status in statuses] + assert sorted(status_names) == sorted(expected) + + +@pytest.mark.parametrize('schema, expected', [ + ('Task', [ + 'Generic', 'Animation', 'Modeling', 'Previz', 'Lookdev', 'Hair', + 'Cloth', 'FX', 'Lighting', 'Compositing', 'Tracking', 'Rigging', + 'test 1', 'test type 2' + ]), + ('AssetBuild', ['Character', 'Prop', 'Environment', 'Matte Painting']), + ('Invalid', ValueError) +], ids=[ + 'task', + 'asset build', + 'invalid' +]) +def test_get_types(project_schema, schema, expected): + '''Retrieve types for schema.''' + if inspect.isclass(expected) and issubclass(expected, Exception): + with pytest.raises(expected): + project_schema.get_types(schema) + + else: + types = project_schema.get_types(schema) + type_names = [type_['name'] for type_ in types] + assert sorted(type_names) == sorted(expected) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_scopes.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_scopes.py new file mode 100644 index 0000000000..1a5afe70c9 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_scopes.py @@ -0,0 +1,24 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + + +def test_add_remove_and_query_scopes_for_tasks(session, new_task, new_scope): + '''Add, remove and query scopes for task.''' + query_string = 'Task where scopes.name is {0}'.format(new_scope['name']) + tasks = session.query(query_string) + + assert len(tasks) == 0 + + new_task['scopes'].append(new_scope) + session.commit() + + tasks = session.query(query_string) + + assert len(tasks) == 1 and tasks[0] == new_task + + new_task['scopes'].remove(new_scope) + session.commit() + + tasks = session.query(query_string) + + assert len(tasks) == 0 diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_user.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_user.py new file mode 100644 index 0000000000..4d7e455042 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/entity/test_user.py @@ -0,0 +1,49 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2016 ftrack + + +def test_force_start_timer(new_user, task): + '''Successfully force starting a timer when another timer is running.''' + first_timer = new_user.start_timer(context=task) + second_timer = new_user.start_timer(context=task, force=True) + + assert first_timer['id'] + assert second_timer['id'] + assert first_timer['id'] != second_timer['id'] + + +def test_timer_creates_timelog(new_user, task, unique_name): + '''Successfully create time log when stopping timer. + + A timer which was immediately stopped should have a duration less than + a minute. + + ''' + comment = 'comment' + unique_name + timer = new_user.start_timer( + context=task, + name=unique_name, + comment=comment + ) + timer_start = timer['start'] + timelog = new_user.stop_timer() + + assert timelog['user_id'] == new_user['id'] + assert timelog['context_id']== task['id'] + assert timelog['name'] == unique_name + assert timelog['comment'] == comment + assert timelog['start'] == timer_start + assert isinstance(timelog['duration'], (int, long, float)) + assert timelog['duration'] < 60 + + +def test_reset_user_api_key(new_user): + '''Test resetting of api keys.''' + + api_keys = list() + for i in range(0, 10): + api_keys.append(new_user.reset_api_key()) + + # make sure all api keys are unique + assert len(set(api_keys)) == 10 + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/__init__.py new file mode 100644 index 0000000000..bc98f15de2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/event_hub_server_heartbeat.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/event_hub_server_heartbeat.py new file mode 100644 index 0000000000..09b270a043 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/event_hub_server_heartbeat.py @@ -0,0 +1,92 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import sys +import time +import logging +import argparse + +import ftrack_api +from ftrack_api.event.base import Event + + +TOPIC = 'test_event_hub_server_heartbeat' +RECEIVED = [] + + +def callback(event): + '''Track received messages.''' + counter = event['data']['counter'] + RECEIVED.append(counter) + print('Received message {0} ({1} in total)'.format(counter, len(RECEIVED))) + + +def main(arguments=None): + '''Publish and receive heartbeat test.''' + parser = argparse.ArgumentParser() + parser.add_argument('mode', choices=['publish', 'subscribe']) + + namespace = parser.parse_args(arguments) + logging.basicConfig(level=logging.INFO) + + session = ftrack_api.Session() + + message_count = 100 + sleep_time_per_message = 1 + + if namespace.mode == 'publish': + max_atempts = 100 + retry_interval = 0.1 + atempt = 0 + while not session.event_hub.connected: + print ( + 'Session is not yet connected to event hub, sleeping for 0.1s' + ) + time.sleep(retry_interval) + + atempt = atempt + 1 + if atempt > max_atempts: + raise Exception( + 'Unable to connect to server within {0} seconds'.format( + max_atempts * retry_interval + ) + ) + + print('Sending {0} messages...'.format(message_count)) + + for counter in range(1, message_count + 1): + session.event_hub.publish( + Event(topic=TOPIC, data=dict(counter=counter)) + ) + print('Sent message {0}'.format(counter)) + + if counter < message_count: + time.sleep(sleep_time_per_message) + + elif namespace.mode == 'subscribe': + session.event_hub.subscribe('topic={0}'.format(TOPIC), callback) + session.event_hub.wait( + duration=( + ((message_count - 1) * sleep_time_per_message) + 15 + ) + ) + + if len(RECEIVED) != message_count: + print( + '>> Failed to receive all messages. Dropped {0} <<' + .format(message_count - len(RECEIVED)) + ) + return False + + # Give time to flush all buffers. + time.sleep(5) + + return True + + +if __name__ == '__main__': + result = main(sys.argv[1:]) + if not result: + raise SystemExit(1) + else: + raise SystemExit(0) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_base.py new file mode 100644 index 0000000000..d9496fe070 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_base.py @@ -0,0 +1,36 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api.event.base + + +def test_string_representation(): + '''String representation.''' + event = ftrack_api.event.base.Event('test', id='some-id') + assert str(event) == ( + "" + ) + + +def test_stop(): + '''Set stopped flag on event.''' + event = ftrack_api.event.base.Event('test', id='some-id') + + assert event.is_stopped() is False + + event.stop() + assert event.is_stopped() is True + + +def test_is_stopped(): + '''Report stopped status of event.''' + event = ftrack_api.event.base.Event('test', id='some-id') + + assert event.is_stopped() is False + + event.stop() + assert event.is_stopped() is True + + event.stop() + assert event.is_stopped() is True diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_expression.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_expression.py new file mode 100644 index 0000000000..4cf68b58f0 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_expression.py @@ -0,0 +1,174 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import operator +import inspect + +import pytest + +from ftrack_api.event.expression import ( + Expression, All, Any, Not, Condition, Parser +) +from ftrack_api.exception import ParseError + + +@pytest.fixture() +def candidate(): + '''Return common candidate to test expressions against.''' + return { + 'id': 10, + 'name': 'value', + 'change': { + 'name': 'value', + 'new_value': 10 + } + } + + +@pytest.mark.parametrize('expression, expected', [ + pytest.mark.xfail(('', Expression())), + ('invalid', ParseError), + ('key=value nor other=value', ParseError), + ('key=value', Condition('key', operator.eq, 'value')), + ('key="value"', Condition('key', operator.eq, 'value')), + ( + 'a=b and ((c=d or e!=f) and not g.h > 10)', + All([ + Condition('a', operator.eq, 'b'), + All([ + Any([ + Condition('c', operator.eq, 'd'), + Condition('e', operator.ne, 'f') + ]), + Not( + Condition('g.h', operator.gt, 10) + ) + ]) + ]) + ) +], ids=[ + 'empty expression', + 'invalid expression', + 'invalid conjunction', + 'basic condition', + 'basic quoted condition', + 'complex condition' +]) +def test_parser_parse(expression, expected): + '''Parse expression into Expression instances.''' + parser = Parser() + + if inspect.isclass(expected)and issubclass(expected, Exception): + with pytest.raises(expected): + parser.parse(expression) + else: + assert str(parser.parse(expression)) == str(expected) + + +@pytest.mark.parametrize('expression, expected', [ + (Expression(), ''), + (All([Expression(), Expression()]), ' ]>'), + (Any([Expression(), Expression()]), ' ]>'), + (Not(Expression()), '>'), + (Condition('key', '=', 'value'), '') +], ids=[ + 'Expression', + 'All', + 'Any', + 'Not', + 'Condition' +]) +def test_string_representation(expression, expected): + '''String representation of expression.''' + assert str(expression) == expected + + +@pytest.mark.parametrize('expression, expected', [ + # Expression + (Expression(), True), + + # All + (All(), True), + (All([Expression(), Expression()]), True), + (All([Expression(), Condition('test', operator.eq, 'value')]), False), + + # Any + (Any(), False), + (Any([Expression(), Condition('test', operator.eq, 'value')]), True), + (Any([ + Condition('test', operator.eq, 'value'), + Condition('other', operator.eq, 'value') + ]), False), + + # Not + (Not(Expression()), False), + (Not(Not(Expression())), True) +], ids=[ + 'Expression-always matches', + + 'All-no expressions always matches', + 'All-all match', + 'All-not all match', + + 'Any-no expressions never matches', + 'Any-some match', + 'Any-none match', + + 'Not-invert positive match', + 'Not-double negative is positive match' +]) +def test_match(expression, candidate, expected): + '''Determine if candidate matches expression.''' + assert expression.match(candidate) is expected + + +def parametrize_test_condition_match(metafunc): + '''Parametrize condition_match tests.''' + identifiers = [] + data = [] + + matrix = { + # Operator, match, no match + operator.eq: { + 'match': 10, 'no-match': 20, + 'wildcard-match': 'valu*', 'wildcard-no-match': 'values*' + }, + operator.ne: {'match': 20, 'no-match': 10}, + operator.ge: {'match': 10, 'no-match': 20}, + operator.le: {'match': 10, 'no-match': 0}, + operator.gt: {'match': 0, 'no-match': 10}, + operator.lt: {'match': 20, 'no-match': 10} + } + + for operator_function, values in matrix.items(): + for value_label, value in values.items(): + if value_label.startswith('wildcard'): + key_options = { + 'plain': 'name', + 'nested': 'change.name' + } + else: + key_options = { + 'plain': 'id', + 'nested': 'change.new_value' + } + + for key_label, key in key_options.items(): + identifiers.append('{} operator {} key {}'.format( + operator_function.__name__, key_label, value_label + )) + + data.append(( + key, operator_function, value, + 'no-match' not in value_label + )) + + metafunc.parametrize( + 'key, operator, value, expected', data, ids=identifiers + ) + + +def test_condition_match(key, operator, value, candidate, expected): + '''Determine if candidate matches condition expression.''' + condition = Condition(key, operator, value) + assert condition.match(candidate) is expected diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_hub.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_hub.py new file mode 100644 index 0000000000..6f1920dddf --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_hub.py @@ -0,0 +1,701 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import inspect +import json +import os +import time +import subprocess +import sys + +import pytest + +import ftrack_api.event.hub +import ftrack_api.event.subscriber +from ftrack_api.event.base import Event +import ftrack_api.exception + + +class MockClass(object): + '''Mock class for testing.''' + + def method(self): + '''Mock method for testing.''' + + +def mockFunction(): + '''Mock function for testing.''' + + +class MockConnection(object): + '''Mock connection for testing.''' + + @property + def connected(self): + '''Return whether connected.''' + return True + + def close(self): + '''Close mock connection.''' + pass + + +def assert_callbacks(hub, callbacks): + '''Assert hub has exactly *callbacks* subscribed.''' + # Subscribers always starts with internal handle_reply subscriber. + subscribers = hub._subscribers[:] + subscribers.pop(0) + + if len(subscribers) != len(callbacks): + raise AssertionError( + 'Number of subscribers ({0}) != number of callbacks ({1})' + .format(len(subscribers), len(callbacks)) + ) + + for index, subscriber in enumerate(subscribers): + if subscriber.callback != callbacks[index]: + raise AssertionError( + 'Callback at {0} != subscriber callback at same index.' + .format(index) + ) + + +@pytest.fixture() +def event_hub(request, session): + '''Return event hub to test against. + + Hub is automatically connected at start of test and disconnected at end. + + ''' + hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + hub.connect() + + def cleanup(): + '''Cleanup.''' + if hub.connected: + hub.disconnect() + + request.addfinalizer(cleanup) + + return hub + + +@pytest.mark.parametrize('server_url, expected', [ + ('https://test.ftrackapp.com', 'https://test.ftrackapp.com'), + ('https://test.ftrackapp.com:9000', 'https://test.ftrackapp.com:9000') +], ids=[ + 'with port', + 'without port' +]) +def test_get_server_url(server_url, expected): + '''Return server url.''' + event_hub = ftrack_api.event.hub.EventHub( + server_url, 'user', 'key' + ) + assert event_hub.get_server_url() == expected + + +@pytest.mark.parametrize('server_url, expected', [ + ('https://test.ftrackapp.com', 'test.ftrackapp.com'), + ('https://test.ftrackapp.com:9000', 'test.ftrackapp.com:9000') +], ids=[ + 'with port', + 'without port' +]) +def test_get_network_location(server_url, expected): + '''Return network location of server url.''' + event_hub = ftrack_api.event.hub.EventHub( + server_url, 'user', 'key' + ) + assert event_hub.get_network_location() == expected + + +@pytest.mark.parametrize('server_url, expected', [ + ('https://test.ftrackapp.com', True), + ('http://test.ftrackapp.com', False) +], ids=[ + 'secure', + 'not secure' +]) +def test_secure_property(server_url, expected, mocker): + '''Return whether secure connection used.''' + event_hub = ftrack_api.event.hub.EventHub( + server_url, 'user', 'key' + ) + assert event_hub.secure is expected + + +def test_connected_property(session): + '''Return connected state.''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + assert event_hub.connected is False + + event_hub.connect() + assert event_hub.connected is True + + event_hub.disconnect() + assert event_hub.connected is False + + +@pytest.mark.parametrize('server_url, expected', [ + ('https://test.ftrackapp.com', 'https://test.ftrackapp.com'), + ('https://test.ftrackapp.com:9000', 'https://test.ftrackapp.com:9000'), + ('test.ftrackapp.com', ValueError), + ('https://:9000', ValueError), +], ids=[ + 'with port', + 'without port', + 'missing scheme', + 'missing hostname' +]) +def test_initialise_against_server_url(server_url, expected): + '''Initialise against server url.''' + if inspect.isclass(expected) and issubclass(expected, Exception): + with pytest.raises(expected): + ftrack_api.event.hub.EventHub( + server_url, 'user', 'key' + ) + else: + event_hub = ftrack_api.event.hub.EventHub( + server_url, 'user', 'key' + ) + assert event_hub.get_server_url() == expected + + +def test_connect(session): + '''Connect.''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + event_hub.connect() + + assert event_hub.connected is True + event_hub.disconnect() + + +def test_connect_when_already_connected(event_hub): + '''Fail to connect when already connected''' + assert event_hub.connected is True + + with pytest.raises(ftrack_api.exception.EventHubConnectionError) as error: + event_hub.connect() + + assert 'Already connected' in str(error) + + +def test_connect_failure(session, mocker): + '''Fail to connect to server.''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + + def force_fail(*args, **kwargs): + '''Force connection failure.''' + raise Exception('Forced fail.') + + mocker.patch('websocket.create_connection', force_fail) + with pytest.raises(ftrack_api.exception.EventHubConnectionError): + event_hub.connect() + + +def test_connect_missing_required_transport(session, mocker, caplog): + '''Fail to connect to server that does not provide correct transport.''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + + original_get_socket_io_session = event_hub._get_socket_io_session + + def _get_socket_io_session(): + '''Patched to return no transports.''' + session = original_get_socket_io_session() + return ftrack_api.event.hub.SocketIoSession( + session[0], session[1], [] + ) + + mocker.patch.object( + event_hub, '_get_socket_io_session', _get_socket_io_session + ) + + with pytest.raises(ftrack_api.exception.EventHubConnectionError): + event_hub.connect() + + logs = caplog.records() + assert ( + 'Server does not support websocket sessions.' in str(logs[-1].exc_info) + ) + + +def test_disconnect(event_hub): + '''Disconnect and unsubscribe all subscribers.''' + event_hub.disconnect() + assert len(event_hub._subscribers) == 0 + assert event_hub.connected is False + + +def test_disconnect_without_unsubscribing(event_hub): + '''Disconnect without unsubscribing all subscribers.''' + event_hub.disconnect(unsubscribe=False) + assert len(event_hub._subscribers) > 0 + assert event_hub.connected is False + + +def test_close_connection_from_manually_connected_hub(session_no_autoconnect_hub): + '''Close connection from manually connected hub.''' + session_no_autoconnect_hub.event_hub.connect() + session_no_autoconnect_hub.close() + assert session_no_autoconnect_hub.event_hub.connected is False + + +def test_disconnect_when_not_connected(session): + '''Fail to disconnect when not connected''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + with pytest.raises(ftrack_api.exception.EventHubConnectionError) as error: + event_hub.disconnect() + + assert 'Not currently connected' in str(error) + + +def test_reconnect(event_hub): + '''Reconnect successfully.''' + assert event_hub.connected is True + event_hub.reconnect() + assert event_hub.connected is True + + +def test_reconnect_when_not_connected(session): + '''Reconnect successfully even if not already connected.''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + assert event_hub.connected is False + + event_hub.reconnect() + assert event_hub.connected is True + + event_hub.disconnect() + + +def test_fail_to_reconnect(session, mocker): + '''Fail to reconnect.''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + event_hub.connect() + assert event_hub.connected is True + + def force_fail(*args, **kwargs): + '''Force connection failure.''' + raise Exception('Forced fail.') + + mocker.patch('websocket.create_connection', force_fail) + + attempts = 2 + with pytest.raises(ftrack_api.exception.EventHubConnectionError) as error: + event_hub.reconnect(attempts=attempts, delay=0.5) + + assert 'Failed to reconnect to event server' in str(error) + assert 'after {} attempts'.format(attempts) in str(error) + + +def test_wait(event_hub): + '''Wait for event and handle as they arrive.''' + called = {'callback': False} + + def callback(event): + called['callback'] = True + + event_hub.subscribe('topic=test-subscribe', callback) + + event_hub.publish(Event(topic='test-subscribe')) + + # Until wait, the event should not have been processed even if received. + time.sleep(1) + assert called == {'callback': False} + + event_hub.wait(2) + assert called == {'callback': True} + + +def test_wait_interrupted_by_disconnect(event_hub): + '''Interrupt wait loop with disconnect event.''' + wait_time = 5 + start = time.time() + + # Inject event directly for test purposes. + event = Event(topic='ftrack.meta.disconnected') + event_hub._event_queue.put(event) + + event_hub.wait(wait_time) + + assert time.time() - start < wait_time + + +@pytest.mark.parametrize('identifier, registered', [ + ('registered-test-subscriber', True), + ('unregistered-test-subscriber', False) +], ids=[ + 'registered', + 'missing' +]) +def test_get_subscriber_by_identifier(event_hub, identifier, registered): + '''Return subscriber by identifier.''' + def callback(event): + pass + + subscriber = { + 'id': 'registered-test-subscriber' + } + + event_hub.subscribe('topic=test-subscribe', callback, subscriber) + retrieved = event_hub.get_subscriber_by_identifier(identifier) + + if registered: + assert isinstance(retrieved, ftrack_api.event.subscriber.Subscriber) + assert retrieved.metadata.get('id') == subscriber['id'] + else: + assert retrieved is None + + +def test_subscribe(event_hub): + '''Subscribe to topics.''' + called = {'a': False, 'b': False} + + def callback_a(event): + called['a'] = True + + def callback_b(event): + called['b'] = True + + event_hub.subscribe('topic=test-subscribe', callback_a) + event_hub.subscribe('topic=test-subscribe-other', callback_b) + + event_hub.publish(Event(topic='test-subscribe')) + event_hub.wait(2) + + assert called == {'a': True, 'b': False} + + +def test_subscribe_before_connected(session): + '''Subscribe to topic before connected.''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + + called = {'callback': False} + + def callback(event): + called['callback'] = True + + identifier = 'test-subscriber' + event_hub.subscribe( + 'topic=test-subscribe', callback, subscriber={'id': identifier} + ) + assert event_hub.get_subscriber_by_identifier(identifier) is not None + + event_hub.connect() + + try: + event_hub.publish(Event(topic='test-subscribe')) + event_hub.wait(2) + finally: + event_hub.disconnect() + + assert called == {'callback': True} + + +def test_duplicate_subscriber(event_hub): + '''Fail to subscribe same subscriber more than once.''' + subscriber = {'id': 'test-subscriber'} + event_hub.subscribe('topic=test', None, subscriber=subscriber) + + with pytest.raises(ftrack_api.exception.NotUniqueError) as error: + event_hub.subscribe('topic=test', None, subscriber=subscriber) + + assert '{0} already exists'.format(subscriber['id']) in str(error) + + +def test_unsubscribe(event_hub): + '''Unsubscribe a specific callback.''' + def callback_a(event): + pass + + def callback_b(event): + pass + + identifier_a = event_hub.subscribe('topic=test', callback_a) + identifier_b = event_hub.subscribe('topic=test', callback_b) + + assert_callbacks(event_hub, [callback_a, callback_b]) + + event_hub.unsubscribe(identifier_a) + + # Unsubscribe requires confirmation event so wait here to give event a + # chance to process. + time.sleep(5) + + assert_callbacks(event_hub, [callback_b]) + + +def test_unsubscribe_whilst_disconnected(event_hub): + '''Unsubscribe whilst disconnected.''' + identifier = event_hub.subscribe('topic=test', None) + event_hub.disconnect(unsubscribe=False) + + event_hub.unsubscribe(identifier) + assert_callbacks(event_hub, []) + + +def test_unsubscribe_missing_subscriber(event_hub): + '''Fail to unsubscribe a non-subscribed subscriber.''' + identifier = 'non-subscribed-subscriber' + with pytest.raises(ftrack_api.exception.NotFoundError) as error: + event_hub.unsubscribe(identifier) + + assert ( + 'missing subscriber with identifier {}'.format(identifier) + in str(error) + ) + + +@pytest.mark.parametrize('event_data', [ + dict(source=dict(id='1', user=dict(username='auto'))), + dict(source=dict(user=dict(username='auto'))), + dict(source=dict(id='1')), + dict() +], ids=[ + 'pre-prepared', + 'missing id', + 'missing user', + 'no source' +]) +def test_prepare_event(session, event_data): + '''Prepare event.''' + # Replace username `auto` in event data with API user. + try: + if event_data['source']['user']['username'] == 'auto': + event_data['source']['user']['username'] = session.api_user + except KeyError: + pass + + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + event_hub.id = '1' + + event = Event('test', id='event-id', **event_data) + expected = Event( + 'test', id='event-id', source=dict(id='1', user=dict(username=session.api_user)) + ) + event_hub._prepare_event(event) + assert event == expected + + +def test_prepare_reply_event(session): + '''Prepare reply event.''' + event_hub = ftrack_api.event.hub.EventHub( + session.server_url, session.api_user, session.api_key + ) + + source_event = Event('source', source=dict(id='source-id')) + reply_event = Event('reply') + + event_hub._prepare_reply_event(reply_event, source_event) + assert source_event['source']['id'] in reply_event['target'] + assert reply_event['in_reply_to_event'] == source_event['id'] + + event_hub._prepare_reply_event(reply_event, source_event, {'id': 'source'}) + assert reply_event['source'] == {'id': 'source'} + + +def test_publish(event_hub): + '''Publish asynchronous event.''' + called = {'callback': False} + + def callback(event): + called['callback'] = True + + event_hub.subscribe('topic=test-subscribe', callback) + + event_hub.publish(Event(topic='test-subscribe')) + event_hub.wait(2) + + assert called == {'callback': True} + + +def test_publish_raising_error(event_hub): + '''Raise error, when configured, on failed publish.''' + # Note that the event hub currently only fails publish when not connected. + # All other errors are inconsistently swallowed. + event_hub.disconnect() + event = Event(topic='a-topic', data=dict(status='fail')) + + with pytest.raises(Exception): + event_hub.publish(event, on_error='raise') + + +def test_publish_ignoring_error(event_hub): + '''Ignore error, when configured, on failed publish.''' + # Note that the event hub currently only fails publish when not connected. + # All other errors are inconsistently swallowed. + event_hub.disconnect() + event = Event(topic='a-topic', data=dict(status='fail')) + event_hub.publish(event, on_error='ignore') + + +def test_publish_logs_other_errors(event_hub, caplog, mocker): + '''Log publish errors other than connection error.''' + # Mock connection to force error. + mocker.patch.object(event_hub, '_connection', MockConnection()) + + event = Event(topic='a-topic', data=dict(status='fail')) + event_hub.publish(event) + + expected = 'Error sending event {0}.'.format(event) + messages = [record.getMessage().strip() for record in caplog.records()] + assert expected in messages, 'Expected log message missing in output.' + + +def test_synchronous_publish(event_hub): + '''Publish event synchronously and collect results.''' + def callback_a(event): + return 'A' + + def callback_b(event): + return 'B' + + def callback_c(event): + return 'C' + + event_hub.subscribe('topic=test', callback_a, priority=50) + event_hub.subscribe('topic=test', callback_b, priority=60) + event_hub.subscribe('topic=test', callback_c, priority=70) + + results = event_hub.publish(Event(topic='test'), synchronous=True) + assert results == ['A', 'B', 'C'] + + +def test_publish_with_reply(event_hub): + '''Publish asynchronous event with on reply handler.''' + + def replier(event): + '''Replier.''' + return 'Replied' + + event_hub.subscribe('topic=test', replier) + + called = {'callback': None} + + def on_reply(event): + called['callback'] = event['data'] + + event_hub.publish(Event(topic='test'), on_reply=on_reply) + event_hub.wait(2) + + assert called['callback'] == 'Replied' + + +def test_publish_with_multiple_replies(event_hub): + '''Publish asynchronous event and retrieve multiple replies.''' + + def replier_one(event): + '''Replier.''' + return 'One' + + def replier_two(event): + '''Replier.''' + return 'Two' + + event_hub.subscribe('topic=test', replier_one) + event_hub.subscribe('topic=test', replier_two) + + called = {'callback': []} + + def on_reply(event): + called['callback'].append(event['data']) + + event_hub.publish(Event(topic='test'), on_reply=on_reply) + event_hub.wait(2) + + assert sorted(called['callback']) == ['One', 'Two'] + + +@pytest.mark.slow +def test_server_heartbeat_response(): + '''Maintain connection by responding to server heartbeat request.''' + test_script = os.path.join( + os.path.dirname(__file__), 'event_hub_server_heartbeat.py' + ) + + # Start subscriber that will listen for all three messages. + subscriber = subprocess.Popen([sys.executable, test_script, 'subscribe']) + + # Give subscriber time to connect to server. + time.sleep(10) + + # Start publisher to publish three messages. + publisher = subprocess.Popen([sys.executable, test_script, 'publish']) + + publisher.wait() + subscriber.wait() + + assert subscriber.returncode == 0 + + +def test_stop_event(event_hub): + '''Stop processing of subsequent local handlers when stop flag set.''' + called = { + 'a': False, + 'b': False, + 'c': False + } + + def callback_a(event): + called['a'] = True + + def callback_b(event): + called['b'] = True + event.stop() + + def callback_c(event): + called['c'] = True + + event_hub.subscribe('topic=test', callback_a, priority=50) + event_hub.subscribe('topic=test', callback_b, priority=60) + event_hub.subscribe('topic=test', callback_c, priority=70) + + event_hub.publish(Event(topic='test')) + event_hub.wait(2) + + assert called == { + 'a': True, + 'b': True, + 'c': False + } + + +def test_encode(session): + '''Encode event data.''' + encoded = session.event_hub._encode( + dict(name='ftrack.event', args=[Event('test')]) + ) + assert 'inReplyToEvent' in encoded + assert 'in_reply_to_event' not in encoded + + +def test_decode(session): + '''Decode event data.''' + decoded = session.event_hub._decode( + json.dumps({ + 'inReplyToEvent': 'id' + }) + ) + + assert 'in_reply_to_event' in decoded + assert 'inReplyToEvent' not in decoded diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_subscriber.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_subscriber.py new file mode 100644 index 0000000000..dc8ac69fd9 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_subscriber.py @@ -0,0 +1,33 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import pytest + +import ftrack_api.event.subscriber +from ftrack_api.event.base import Event + + +def test_string_representation(): + '''String representation.''' + subscriber = ftrack_api.event.subscriber.Subscriber( + 'topic=test', lambda x: None, {'meta': 'info'}, 100 + ) + + assert str(subscriber) == ( + '' + ) + + +@pytest.mark.parametrize('expression, event, expected', [ + ('topic=test', Event(topic='test'), True), + ('topic=test', Event(topic='other-test'), False) +], ids=[ + 'interested', + 'not interested' +]) +def test_interested_in(expression, event, expected): + '''Determine if subscriber interested in event.''' + subscriber = ftrack_api.event.subscriber.Subscriber( + expression, lambda x: None, {'meta': 'info'}, 100 + ) + assert subscriber.interested_in(event) is expected diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_subscription.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_subscription.py new file mode 100644 index 0000000000..1535309f25 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/event/test_subscription.py @@ -0,0 +1,28 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import pytest + +import ftrack_api.event.subscription +from ftrack_api.event.base import Event + + +def test_string_representation(): + '''String representation is subscription expression.''' + expression = 'topic=some-topic' + subscription = ftrack_api.event.subscription.Subscription(expression) + + assert str(subscription) == expression + + +@pytest.mark.parametrize('expression, event, expected', [ + ('topic=test', Event(topic='test'), True), + ('topic=test', Event(topic='other-test'), False) +], ids=[ + 'match', + 'no match' +]) +def test_includes(expression, event, expected): + '''Subscription includes event.''' + subscription = ftrack_api.event.subscription.Subscription(expression) + assert subscription.includes(event) is expected diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/resource_identifier_transformer/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/resource_identifier_transformer/__init__.py new file mode 100644 index 0000000000..bc98f15de2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/resource_identifier_transformer/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/resource_identifier_transformer/test_base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/resource_identifier_transformer/test_base.py new file mode 100644 index 0000000000..51c896f96b --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/resource_identifier_transformer/test_base.py @@ -0,0 +1,36 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import pytest + +import ftrack_api.resource_identifier_transformer.base as _transformer + + +@pytest.fixture() +def transformer(session): + '''Return instance of ResourceIdentifierTransformer.''' + return _transformer.ResourceIdentifierTransformer(session) + + +@pytest.mark.parametrize('resource_identifier, context, expected', [ + ('identifier', None, 'identifier'), + ('identifier', {'user': {'username': 'user'}}, 'identifier') +], ids=[ + 'no context', + 'basic context' +]) +def test_encode(transformer, resource_identifier, context, expected): + '''Encode resource identifier.''' + assert transformer.encode(resource_identifier, context) == expected + + +@pytest.mark.parametrize('resource_identifier, context, expected', [ + ('identifier', None, 'identifier'), + ('identifier', {'user': {'username': 'user'}}, 'identifier') +], ids=[ + 'no context', + 'basic context' +]) +def test_decode(transformer, resource_identifier, context, expected): + '''Encode resource identifier.''' + assert transformer.decode(resource_identifier, context) == expected diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/__init__.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/__init__.py new file mode 100644 index 0000000000..bc98f15de2 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/__init__.py @@ -0,0 +1,2 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_base.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_base.py new file mode 100644 index 0000000000..dbf91ead20 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_base.py @@ -0,0 +1,31 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import pytest + +import ftrack_api.structure.base + + +class Concrete(ftrack_api.structure.base.Structure): + '''Concrete implementation to allow testing non-abstract methods.''' + + def get_resource_identifier(self, entity, context=None): + '''Return a resource identifier for supplied *entity*. + + *context* can be a mapping that supplies additional information. + + ''' + return 'resource_identifier' + + +@pytest.mark.parametrize('sequence, expected', [ + ({'padding': None}, '%d'), + ({'padding': 4}, '%04d') +], ids=[ + 'no padding', + 'padded' +]) +def test_get_sequence_expression(sequence, expected): + '''Get sequence expression from sequence.''' + structure = Concrete() + assert structure._get_sequence_expression(sequence) == expected diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_entity_id.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_entity_id.py new file mode 100644 index 0000000000..01ccb35ac8 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_entity_id.py @@ -0,0 +1,49 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import inspect + +import pytest +import mock + +import ftrack_api +import ftrack_api.structure.entity_id + + +@pytest.fixture(scope='session') +def structure(): + '''Return structure.''' + return ftrack_api.structure.entity_id.EntityIdStructure() + + +# Note: When it is possible to use indirect=True on just a few arguments, the +# called functions here can change to standard fixtures. +# https://github.com/pytest-dev/pytest/issues/579 + +def valid_entity(): + '''Return valid entity.''' + session = ftrack_api.Session() + + entity = session.create('FileComponent', { + 'id': 'f6cd40cb-d1c0-469f-a2d5-10369be8a724', + 'name': 'file_component', + 'file_type': '.png' + }) + + return entity + + +@pytest.mark.parametrize('entity, context, expected', [ + (valid_entity(), {}, 'f6cd40cb-d1c0-469f-a2d5-10369be8a724'), + (mock.Mock(), {}, Exception) +], ids=[ + 'valid-entity', + 'non-entity' +]) +def test_get_resource_identifier(structure, entity, context, expected): + '''Get resource identifier.''' + if inspect.isclass(expected) and issubclass(expected, Exception): + with pytest.raises(expected): + structure.get_resource_identifier(entity, context) + else: + assert structure.get_resource_identifier(entity, context) == expected diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_id.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_id.py new file mode 100644 index 0000000000..ef81da2d65 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_id.py @@ -0,0 +1,115 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import inspect + +import pytest + +import ftrack_api +import ftrack_api.structure.id + + +@pytest.fixture(scope='session') +def structure(): + '''Return structure.''' + return ftrack_api.structure.id.IdStructure(prefix='path') + + +# Note: When it is possible to use indirect=True on just a few arguments, the +# called functions here can change to standard fixtures. +# https://github.com/pytest-dev/pytest/issues/579 + +def file_component(container=None): + '''Return file component.''' + session = ftrack_api.Session() + + entity = session.create('FileComponent', { + 'id': 'f6cd40cb-d1c0-469f-a2d5-10369be8a724', + 'name': '0001', + 'file_type': '.png', + 'container': container + }) + + return entity + + +def sequence_component(padding=0): + '''Return sequence component with *padding*.''' + session = ftrack_api.Session() + + entity = session.create('SequenceComponent', { + 'id': 'ff17edad-2129-483b-8b59-d1a654c8497b', + 'name': 'sequence_component', + 'file_type': '.png', + 'padding': padding + }) + + return entity + + +def container_component(): + '''Return container component.''' + session = ftrack_api.Session() + + entity = session.create('ContainerComponent', { + 'id': '03ab9967-f86c-4b55-8252-cd187d0c244a', + 'name': 'container_component' + }) + + return entity + + +def unsupported_entity(): + '''Return an unsupported entity.''' + session = ftrack_api.Session() + + entity = session.create('User', { + 'username': 'martin' + }) + + return entity + + +@pytest.mark.parametrize('entity, context, expected', [ + ( + file_component(), {}, + 'path/f/6/c/d/40cb-d1c0-469f-a2d5-10369be8a724.png' + ), + ( + file_component(container_component()), {}, + 'path/0/3/a/b/9967-f86c-4b55-8252-cd187d0c244a/' + 'f6cd40cb-d1c0-469f-a2d5-10369be8a724.png' + ), + ( + file_component(sequence_component()), {}, + 'path/f/f/1/7/edad-2129-483b-8b59-d1a654c8497b/file.0001.png' + ), + ( + sequence_component(padding=0), {}, + 'path/f/f/1/7/edad-2129-483b-8b59-d1a654c8497b/file.%d.png' + ), + ( + sequence_component(padding=4), {}, + 'path/f/f/1/7/edad-2129-483b-8b59-d1a654c8497b/file.%04d.png' + ), + ( + container_component(), {}, + 'path/0/3/a/b/9967-f86c-4b55-8252-cd187d0c244a' + ), + (unsupported_entity(), {}, NotImplementedError) +], ids=[ + 'file-component', + 'file-component-in-container', + 'file-component-in-sequence', + 'unpadded-sequence-component', + 'padded-sequence-component', + 'container-component', + 'unsupported-entity' +]) +def test_get_resource_identifier(structure, entity, context, expected): + '''Get resource identifier.''' + if inspect.isclass(expected) and issubclass(expected, Exception): + with pytest.raises(expected): + structure.get_resource_identifier(entity, context) + else: + assert structure.get_resource_identifier(entity, context) == expected diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_origin.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_origin.py new file mode 100644 index 0000000000..e294e04a70 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_origin.py @@ -0,0 +1,33 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import inspect + +import pytest +import mock + +import ftrack_api.structure.origin + + +@pytest.fixture(scope='session') +def structure(): + '''Return structure.''' + return ftrack_api.structure.origin.OriginStructure() + + +@pytest.mark.parametrize('entity, context, expected', [ + (mock.Mock(), {'source_resource_identifier': 'identifier'}, 'identifier'), + (mock.Mock(), {}, ValueError), + (mock.Mock(), None, ValueError) +], ids=[ + 'valid-context', + 'invalid-context', + 'unspecified-context' +]) +def test_get_resource_identifier(structure, entity, context, expected): + '''Get resource identifier.''' + if inspect.isclass(expected) and issubclass(expected, Exception): + with pytest.raises(expected): + structure.get_resource_identifier(entity, context) + else: + assert structure.get_resource_identifier(entity, context) == expected diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_standard.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_standard.py new file mode 100644 index 0000000000..dd72f8ec3f --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/structure/test_standard.py @@ -0,0 +1,309 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import uuid + +import pytest + +import ftrack_api +import ftrack_api.structure.standard + + +@pytest.fixture(scope='session') +def new_project(request): + '''Return new empty project.''' + session = ftrack_api.Session() + + project_schema = session.query('ProjectSchema').first() + project_name = 'python_api_test_{0}'.format(uuid.uuid1().hex) + project = session.create('Project', { + 'name': project_name, + 'full_name': project_name + '_full', + 'project_schema': project_schema + }) + + session.commit() + + def cleanup(): + '''Remove created entity.''' + session.delete(project) + session.commit() + + request.addfinalizer(cleanup) + + return project + + +def new_container_component(): + '''Return container component.''' + session = ftrack_api.Session() + + entity = session.create('ContainerComponent', { + 'name': 'container_component' + }) + + return entity + + +def new_sequence_component(): + '''Return sequence component.''' + session = ftrack_api.Session() + + entity = session.create_component( + '/tmp/foo/%04d.jpg [1-10]', location=None, data={'name': 'baz'} + ) + + return entity + + +def new_file_component(name='foo', container=None): + '''Return file component with *name* and *container*.''' + if container: + session = container.session + else: + session = ftrack_api.Session() + + entity = session.create('FileComponent', { + 'name': name, + 'file_type': '.png', + 'container': container + }) + + return entity + + +# Reusable fixtures. +file_component = new_file_component() +container_component = new_container_component() +sequence_component = new_sequence_component() + + +# Note: to improve test performance the same project is reused throughout the +# tests. This means that all hierarchical names must be unique, otherwise an +# IntegrityError will be raised on the server. + +@pytest.mark.parametrize( + 'component, hierarchy, expected, structure, asset_name', + [ + ( + file_component, + [], + '{project_name}/my_new_asset/v001/foo.png', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + file_component, + [], + '{project_name}/foobar/my_new_asset/v001/foo.png', + ftrack_api.structure.standard.StandardStructure( + project_versions_prefix='foobar' + ), + 'my_new_asset' + ), + ( + file_component, + ['baz1', 'bar'], + '{project_name}/baz1/bar/my_new_asset/v001/foo.png', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + sequence_component, + ['baz2', 'bar'], + '{project_name}/baz2/bar/my_new_asset/v001/baz.%04d.jpg', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + sequence_component['members'][3], + ['baz3', 'bar'], + '{project_name}/baz3/bar/my_new_asset/v001/baz.0004.jpg', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + container_component, + ['baz4', 'bar'], + '{project_name}/baz4/bar/my_new_asset/v001/container_component', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + new_file_component(container=container_component), + ['baz5', 'bar'], + ( + '{project_name}/baz5/bar/my_new_asset/v001/container_component/' + 'foo.png' + ), + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + file_component, + [u'björn'], + '{project_name}/bjorn/my_new_asset/v001/foo.png', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + file_component, + [u'björn!'], + '{project_name}/bjorn_/my_new_asset/v001/foo.png', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + new_file_component(name=u'fää'), + [], + '{project_name}/my_new_asset/v001/faa.png', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + new_file_component(name=u'fo/o'), + [], + '{project_name}/my_new_asset/v001/fo_o.png', + ftrack_api.structure.standard.StandardStructure(), + 'my_new_asset' + ), + ( + file_component, + [], + '{project_name}/aao/v001/foo.png', + ftrack_api.structure.standard.StandardStructure(), + u'åäö' + ), + ( + file_component, + [], + '{project_name}/my_ne____w_asset/v001/foo.png', + ftrack_api.structure.standard.StandardStructure(), + u'my_ne!!!!w_asset' + ), + ( + file_component, + [u'björn2'], + u'{project_name}/björn2/my_new_asset/v001/foo.png', + ftrack_api.structure.standard.StandardStructure( + illegal_character_substitute=None + ), + 'my_new_asset' + ), + ( + file_component, + [u'bj!rn'], + '{project_name}/bj^rn/my_new_asset/v001/foo.png', + ftrack_api.structure.standard.StandardStructure( + illegal_character_substitute='^' + ), + 'my_new_asset' + ) + ], ids=[ + 'file_component_on_project', + 'file_component_on_project_with_prefix', + 'file_component_with_hierarchy', + 'sequence_component', + 'sequence_component_member', + 'container_component', + 'container_component_member', + 'slugify_non_ascii_hierarchy', + 'slugify_illegal_hierarchy', + 'slugify_non_ascii_component_name', + 'slugify_illegal_component_name', + 'slugify_non_ascii_asset_name', + 'slugify_illegal_asset_name', + 'slugify_none', + 'slugify_other_character' + ] +) +def test_get_resource_identifier( + component, hierarchy, expected, structure, asset_name, new_project +): + '''Get resource identifier.''' + session = component.session + + # Create structure, asset and version. + context_id = new_project['id'] + for name in hierarchy: + context_id = session.create('Folder', { + 'name': name, + 'project_id': new_project['id'], + 'parent_id': context_id + })['id'] + + asset = session.create( + 'Asset', {'name': asset_name, 'context_id': context_id} + ) + version = session.create('AssetVersion', {'asset': asset}) + + # Update component with version. + if component['container']: + component['container']['version'] = version + else: + component['version'] = version + + session.commit() + + assert structure.get_resource_identifier(component) == expected.format( + project_name=new_project['name'] + ) + + +def test_unsupported_entity(user): + '''Fail to get resource identifier for unsupported entity.''' + structure = ftrack_api.structure.standard.StandardStructure() + with pytest.raises(NotImplementedError): + structure.get_resource_identifier(user) + + +def test_component_without_version_relation(new_project): + '''Get an identifer for component without a version relation.''' + session = new_project.session + + asset = session.create( + 'Asset', {'name': 'foo', 'context_id': new_project['id']} + ) + version = session.create('AssetVersion', {'asset': asset}) + + session.commit() + + file_component = new_file_component() + file_component['version_id'] = version['id'] + + structure = ftrack_api.structure.standard.StandardStructure() + structure.get_resource_identifier(file_component) + + +def test_component_without_committed_version_relation(): + '''Fail to get an identifer for component without a committed version.''' + file_component = new_file_component() + session = file_component.session + version = session.create('AssetVersion', {}) + + file_component['version'] = version + + structure = ftrack_api.structure.standard.StandardStructure() + + with pytest.raises(ftrack_api.exception.StructureError): + structure.get_resource_identifier(file_component) + + +@pytest.mark.xfail( + raises=ftrack_api.exception.ServerError, + reason='Due to user permission errors.' +) +def test_component_without_committed_asset_relation(): + '''Fail to get an identifer for component without a committed asset.''' + file_component = new_file_component() + session = file_component.session + version = session.create('AssetVersion', {}) + + file_component['version'] = version + + session.commit() + + structure = ftrack_api.structure.standard.StandardStructure() + + with pytest.raises(ftrack_api.exception.StructureError): + structure.get_resource_identifier(file_component) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_attribute.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_attribute.py new file mode 100644 index 0000000000..555adb2d89 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_attribute.py @@ -0,0 +1,146 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import pytest + +import ftrack_api.attribute +import ftrack_api.exception + + +@pytest.mark.parametrize('attributes', [ + [], + [ftrack_api.attribute.Attribute('test')] +], ids=[ + 'no initial attributes', + 'with initial attributes' +]) +def test_initialise_attributes_collection(attributes): + '''Initialise attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes(attributes) + assert sorted(list(attribute_collection)) == sorted(attributes) + + +def test_add_attribute_to_attributes_collection(): + '''Add valid attribute to attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes() + attribute = ftrack_api.attribute.Attribute('test') + + assert attribute_collection.keys() == [] + attribute_collection.add(attribute) + assert attribute_collection.keys() == ['test'] + + +def test_add_duplicate_attribute_to_attributes_collection(): + '''Fail to add attribute with duplicate name to attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes() + attribute = ftrack_api.attribute.Attribute('test') + + attribute_collection.add(attribute) + with pytest.raises(ftrack_api.exception.NotUniqueError): + attribute_collection.add(attribute) + + +def test_remove_attribute_from_attributes_collection(): + '''Remove attribute from attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes() + attribute = ftrack_api.attribute.Attribute('test') + + attribute_collection.add(attribute) + assert len(attribute_collection) == 1 + + attribute_collection.remove(attribute) + assert len(attribute_collection) == 0 + + +def test_remove_missing_attribute_from_attributes_collection(): + '''Fail to remove attribute not present in attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes() + attribute = ftrack_api.attribute.Attribute('test') + + with pytest.raises(KeyError): + attribute_collection.remove(attribute) + + +def test_get_attribute_from_attributes_collection(): + '''Get attribute from attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes() + attribute = ftrack_api.attribute.Attribute('test') + attribute_collection.add(attribute) + + retrieved_attribute = attribute_collection.get('test') + + assert retrieved_attribute is attribute + + +def test_get_missing_attribute_from_attributes_collection(): + '''Get attribute not present in attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes() + assert attribute_collection.get('test') is None + + +@pytest.mark.parametrize('attributes, expected', [ + ([], []), + ([ftrack_api.attribute.Attribute('test')], ['test']) +], ids=[ + 'no initial attributes', + 'with initial attributes' +]) +def test_attribute_collection_keys(attributes, expected): + '''Retrieve keys for attribute collection.''' + attribute_collection = ftrack_api.attribute.Attributes(attributes) + assert sorted(attribute_collection.keys()) == sorted(expected) + + +@pytest.mark.parametrize('attribute, expected', [ + (None, False), + (ftrack_api.attribute.Attribute('b'), True), + (ftrack_api.attribute.Attribute('c'), False) +], ids=[ + 'none attribute', + 'present attribute', + 'missing attribute' +]) +def test_attributes_collection_contains(attribute, expected): + '''Check presence in attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes([ + ftrack_api.attribute.Attribute('a'), + ftrack_api.attribute.Attribute('b') + ]) + + assert (attribute in attribute_collection) is expected + + +@pytest.mark.parametrize('attributes, expected', [ + ([], 0), + ([ftrack_api.attribute.Attribute('test')], 1), + ( + [ + ftrack_api.attribute.Attribute('a'), + ftrack_api.attribute.Attribute('b') + ], + 2 + ) +], ids=[ + 'no attributes', + 'single attribute', + 'multiple attributes' +]) +def test_attributes_collection_count(attributes, expected): + '''Count attributes in attributes collection.''' + attribute_collection = ftrack_api.attribute.Attributes(attributes) + assert len(attribute_collection) == expected + + +def test_iterate_over_attributes_collection(): + '''Iterate over attributes collection.''' + attributes = [ + ftrack_api.attribute.Attribute('a'), + ftrack_api.attribute.Attribute('b') + ] + + attribute_collection = ftrack_api.attribute.Attributes(attributes) + for attribute in attribute_collection: + attributes.remove(attribute) + + assert len(attributes) == 0 + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_cache.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_cache.py new file mode 100644 index 0000000000..7915737253 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_cache.py @@ -0,0 +1,416 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import os +import uuid +import tempfile + +import pytest + +import ftrack_api.cache + + +@pytest.fixture(params=['proxy', 'layered', 'memory', 'file', 'serialised']) +def cache(request): + '''Return cache.''' + if request.param == 'proxy': + cache = ftrack_api.cache.ProxyCache( + ftrack_api.cache.MemoryCache() + ) + + elif request.param == 'layered': + cache = ftrack_api.cache.LayeredCache( + [ftrack_api.cache.MemoryCache()] + ) + + elif request.param == 'memory': + cache = ftrack_api.cache.MemoryCache() + + elif request.param == 'file': + cache_path = os.path.join( + tempfile.gettempdir(), '{0}.dbm'.format(uuid.uuid4().hex) + ) + + cache = ftrack_api.cache.FileCache(cache_path) + + def cleanup(): + '''Cleanup.''' + try: + os.remove(cache_path) + except OSError: + # BSD DB (Mac OSX) implementation of the interface will append + # a .db extension. + os.remove(cache_path + '.db') + + request.addfinalizer(cleanup) + + elif request.param == 'serialised': + cache = ftrack_api.cache.SerialisedCache( + ftrack_api.cache.MemoryCache(), + encode=lambda value: value, + decode=lambda value: value + ) + + else: + raise ValueError( + 'Unrecognised cache fixture type {0!r}'.format(request.param) + ) + + return cache + + + +class Class(object): + '''Class for testing.''' + + def method(self, key): + '''Method for testing.''' + + +def function(mutable, x, y=2): + '''Function for testing.''' + mutable['called'] = True + return {'result': x + y} + + +def assert_memoised_call( + memoiser, function, expected, args=None, kw=None, memoised=True +): + '''Assert *function* call via *memoiser* was *memoised*.''' + mapping = {'called': False} + if args is not None: + args = (mapping,) + args + else: + args = (mapping,) + + result = memoiser.call(function, args, kw) + + assert result == expected + assert mapping['called'] is not memoised + + +def test_get(cache): + '''Retrieve item from cache.''' + cache.set('key', 'value') + assert cache.get('key') == 'value' + + +def test_get_missing_key(cache): + '''Fail to retrieve missing item from cache.''' + with pytest.raises(KeyError): + cache.get('key') + + +def test_set(cache): + '''Set item in cache.''' + with pytest.raises(KeyError): + cache.get('key') + + cache.set('key', 'value') + assert cache.get('key') == 'value' + + +def test_remove(cache): + '''Remove item from cache.''' + cache.set('key', 'value') + cache.remove('key') + + with pytest.raises(KeyError): + cache.get('key') + + +def test_remove_missing_key(cache): + '''Fail to remove missing key.''' + with pytest.raises(KeyError): + cache.remove('key') + + +def test_keys(cache): + '''Retrieve keys of items in cache.''' + assert cache.keys() == [] + cache.set('a', 'a_value') + cache.set('b', 'b_value') + cache.set('c', 'c_value') + assert sorted(cache.keys()) == sorted(['a', 'b', 'c']) + + +def test_clear(cache): + '''Remove items from cache.''' + cache.set('a', 'a_value') + cache.set('b', 'b_value') + cache.set('c', 'c_value') + + assert cache.keys() + cache.clear() + + assert not cache.keys() + + +def test_clear_using_pattern(cache): + '''Remove items that match pattern from cache.''' + cache.set('matching_key', 'value') + cache.set('another_matching_key', 'value') + cache.set('key_not_matching', 'value') + + assert cache.keys() + cache.clear(pattern='.*matching_key$') + + assert cache.keys() == ['key_not_matching'] + + +def test_clear_encountering_missing_key(cache, mocker): + '''Clear missing key.''' + # Force reporting keys that are not actually valid for test purposes. + mocker.patch.object(cache, 'keys', lambda: ['missing']) + assert cache.keys() == ['missing'] + + # Should not error even though key not valid. + cache.clear() + + # The key was not successfully removed so should still be present. + assert cache.keys() == ['missing'] + + +def test_layered_cache_propagates_value_on_get(): + '''Layered cache propagates value on get.''' + caches = [ + ftrack_api.cache.MemoryCache(), + ftrack_api.cache.MemoryCache(), + ftrack_api.cache.MemoryCache() + ] + + cache = ftrack_api.cache.LayeredCache(caches) + + # Set item on second level cache only. + caches[1].set('key', 'value') + + # Retrieving key via layered cache should propagate it automatically to + # higher level caches only. + assert cache.get('key') == 'value' + assert caches[0].get('key') == 'value' + + with pytest.raises(KeyError): + caches[2].get('key') + + +def test_layered_cache_remove_at_depth(): + '''Remove key that only exists at depth in LayeredCache.''' + caches = [ + ftrack_api.cache.MemoryCache(), + ftrack_api.cache.MemoryCache() + ] + + cache = ftrack_api.cache.LayeredCache(caches) + + # Set item on second level cache only. + caches[1].set('key', 'value') + + # Removing key that only exists at depth should not raise key error. + cache.remove('key') + + # Ensure key was removed. + assert not cache.keys() + + +def test_expand_references(): + '''Test that references are expanded from serialized cache.''' + + cache_path = os.path.join( + tempfile.gettempdir(), '{0}.dbm'.format(uuid.uuid4().hex) + ) + + def make_cache(session, cache_path): + '''Create a serialised file cache.''' + serialized_file_cache = ftrack_api.cache.SerialisedCache( + ftrack_api.cache.FileCache(cache_path), + encode=session.encode, + decode=session.decode + ) + + return serialized_file_cache + + # Populate the serialized file cache. + session = ftrack_api.Session( + cache=lambda session, cache_path=cache_path:make_cache( + session, cache_path + ) + ) + + expanded_results = dict() + + query_string = 'select asset.parent from AssetVersion where asset is_not None limit 10' + + for sequence in session.query(query_string): + asset = sequence.get('asset') + + expanded_results.setdefault( + asset.get('id'), asset.get('parent') + ) + + # Fetch the data from cache. + new_session = ftrack_api.Session( + cache=lambda session, cache_path=cache_path:make_cache( + session, cache_path + ) + ) + + + new_session_two = ftrack_api.Session( + cache=lambda session, cache_path=cache_path:make_cache( + session, cache_path + ) + ) + + + # Make sure references are merged. + for sequence in new_session.query(query_string): + asset = sequence.get('asset') + + assert ( + asset.get('parent') == expanded_results[asset.get('id')] + ) + + # Use for fetching directly using get. + assert ( + new_session_two.get(asset.entity_type, asset.get('id')).get('parent') == + expanded_results[asset.get('id')] + ) + + + +@pytest.mark.parametrize('items, key', [ + (({},), '{}'), + (({}, {}), '{}{}') +], ids=[ + 'single object', + 'multiple objects' +]) +def test_string_key_maker_key(items, key): + '''Generate key using string key maker.''' + key_maker = ftrack_api.cache.StringKeyMaker() + assert key_maker.key(*items) == key + + +@pytest.mark.parametrize('items, key', [ + ( + ({},), + '\x01\x01' + ), + ( + ({'a': 'b'}, [1, 2]), + '\x01' + '\x80\x02U\x01a.' '\x02' '\x80\x02U\x01b.' + '\x01' + '\x00' + '\x03' + '\x80\x02K\x01.' '\x00' '\x80\x02K\x02.' + '\x03' + ), + ( + (function,), + '\x04function\x00unit.test_cache' + ), + ( + (Class,), + '\x04Class\x00unit.test_cache' + ), + ( + (Class.method,), + '\x04method\x00Class\x00unit.test_cache' + ), + ( + (callable,), + '\x04callable' + ) +], ids=[ + 'single mapping', + 'multiple objects', + 'function', + 'class', + 'method', + 'builtin' +]) +def test_object_key_maker_key(items, key): + '''Generate key using string key maker.''' + key_maker = ftrack_api.cache.ObjectKeyMaker() + assert key_maker.key(*items) == key + + +def test_memoised_call(): + '''Call memoised function.''' + memoiser = ftrack_api.cache.Memoiser() + + # Initial call should not be memoised so function is executed. + assert_memoised_call( + memoiser, function, args=(1,), expected={'result': 3}, memoised=False + ) + + # Identical call should be memoised so function is not executed again. + assert_memoised_call( + memoiser, function, args=(1,), expected={'result': 3}, memoised=True + ) + + # Differing call is not memoised so function is executed. + assert_memoised_call( + memoiser, function, args=(3,), expected={'result': 5}, memoised=False + ) + + +def test_memoised_call_variations(): + '''Call memoised function with identical arguments using variable format.''' + memoiser = ftrack_api.cache.Memoiser() + expected = {'result': 3} + + # Call function once to ensure is memoised. + assert_memoised_call( + memoiser, function, args=(1,), expected=expected, memoised=False + ) + + # Each of the following calls should equate to the same key and make + # use of the memoised value. + for args, kw in [ + ((), {'x': 1}), + ((), {'x': 1, 'y': 2}), + ((1,), {'y': 2}), + ((1,), {}) + ]: + assert_memoised_call( + memoiser, function, args=args, kw=kw, expected=expected + ) + + # The following calls should all be treated as new variations and so + # not use any memoised value. + assert_memoised_call( + memoiser, function, kw={'x': 2}, expected={'result': 4}, memoised=False + ) + assert_memoised_call( + memoiser, function, kw={'x': 3, 'y': 2}, expected={'result': 5}, + memoised=False + ) + assert_memoised_call( + memoiser, function, args=(4, ), kw={'y': 2}, expected={'result': 6}, + memoised=False + ) + assert_memoised_call( + memoiser, function, args=(5, ), expected={'result': 7}, memoised=False + ) + + +def test_memoised_mutable_return_value(): + '''Avoid side effects for returned mutable arguments when memoising.''' + memoiser = ftrack_api.cache.Memoiser() + arguments = ({'called': False}, 1) + + result_a = memoiser.call(function, arguments) + assert result_a == {'result': 3} + assert arguments[0]['called'] + + # Modify mutable externally and check that stored memoised value is + # unchanged. + del result_a['result'] + + arguments[0]['called'] = False + result_b = memoiser.call(function, arguments) + + assert result_b == {'result': 3} + assert not arguments[0]['called'] diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_collection.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_collection.py new file mode 100644 index 0000000000..15c3e5cf39 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_collection.py @@ -0,0 +1,574 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import copy +import uuid + +import mock +import pytest + +import ftrack_api.collection +import ftrack_api.symbol +import ftrack_api.inspection +import ftrack_api.exception +import ftrack_api.operation + + +def create_mock_entity(session): + '''Return new mock entity for *session*.''' + entity = mock.MagicMock() + entity.session = session + entity.primary_key_attributes = ['id'] + entity['id'] = str(uuid.uuid4()) + return entity + + +@pytest.fixture +def mock_entity(session): + '''Return mock entity.''' + return create_mock_entity(session) + + +@pytest.fixture +def mock_entities(session): + '''Return list of two mock entities.''' + return [ + create_mock_entity(session), + create_mock_entity(session) + ] + + +@pytest.fixture +def mock_attribute(): + '''Return mock attribute.''' + attribute = mock.MagicMock() + attribute.name = 'test' + return attribute + + +def test_collection_initialisation_does_not_modify_entity_state( + mock_entity, mock_attribute, mock_entities +): + '''Initialising collection does not modify entity state.''' + ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + + assert ftrack_api.inspection.state(mock_entity) is ftrack_api.symbol.NOT_SET + + +def test_immutable_collection_initialisation( + mock_entity, mock_attribute, mock_entities +): + '''Initialise immutable collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities, mutable=False + ) + + assert list(collection) == mock_entities + assert collection.mutable is False + + +def test_collection_shallow_copy( + mock_entity, mock_attribute, mock_entities, session +): + '''Shallow copying collection should avoid indirect mutation.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + + with mock_entity.session.operation_recording(False): + collection_copy = copy.copy(collection) + new_entity = create_mock_entity(session) + collection_copy.append(new_entity) + + assert list(collection) == mock_entities + assert list(collection_copy) == mock_entities + [new_entity] + + +def test_collection_insert( + mock_entity, mock_attribute, mock_entities, session +): + '''Insert a value into collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + + new_entity = create_mock_entity(session) + collection.insert(0, new_entity) + assert list(collection) == [new_entity] + mock_entities + + +def test_collection_insert_duplicate( + mock_entity, mock_attribute, mock_entities +): + '''Fail to insert a duplicate value into collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + + with pytest.raises(ftrack_api.exception.DuplicateItemInCollectionError): + collection.insert(0, mock_entities[1]) + + +def test_immutable_collection_insert( + mock_entity, mock_attribute, mock_entities, session +): + '''Fail to insert a value into immutable collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities, mutable=False + ) + + with pytest.raises(ftrack_api.exception.ImmutableCollectionError): + collection.insert(0, create_mock_entity(session)) + + +def test_collection_set_item( + mock_entity, mock_attribute, mock_entities, session +): + '''Set item at index in collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + + new_entity = create_mock_entity(session) + collection[0] = new_entity + assert list(collection) == [new_entity, mock_entities[1]] + + +def test_collection_re_set_item( + mock_entity, mock_attribute, mock_entities +): + '''Re-set value at exact same index in collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + + collection[0] = mock_entities[0] + assert list(collection) == mock_entities + + +def test_collection_set_duplicate_item( + mock_entity, mock_attribute, mock_entities +): + '''Fail to set a duplicate value into collection at different index.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + + with pytest.raises(ftrack_api.exception.DuplicateItemInCollectionError): + collection[0] = mock_entities[1] + + +def test_immutable_collection_set_item( + mock_entity, mock_attribute, mock_entities +): + '''Fail to set item at index in immutable collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities, mutable=False + ) + + with pytest.raises(ftrack_api.exception.ImmutableCollectionError): + collection[0] = mock_entities[0] + + +def test_collection_delete_item( + mock_entity, mock_attribute, mock_entities +): + '''Remove item at index from collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + del collection[0] + assert list(collection) == [mock_entities[1]] + + +def test_collection_delete_item_at_invalid_index( + mock_entity, mock_attribute, mock_entities +): + '''Fail to remove item at missing index from immutable collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + + with pytest.raises(IndexError): + del collection[4] + + +def test_immutable_collection_delete_item( + mock_entity, mock_attribute, mock_entities +): + '''Fail to remove item at index from immutable collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities, mutable=False + ) + + with pytest.raises(ftrack_api.exception.ImmutableCollectionError): + del collection[0] + + +def test_collection_count( + mock_entity, mock_attribute, mock_entities, session +): + '''Count items in collection.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + assert len(collection) == 2 + + collection.append(create_mock_entity(session)) + assert len(collection) == 3 + + del collection[0] + assert len(collection) == 2 + + +@pytest.mark.parametrize('other, expected', [ + ([], False), + ([1, 2], True), + ([1, 2, 3], False), + ([1], False) +], ids=[ + 'empty', + 'same', + 'additional', + 'missing' +]) +def test_collection_equal(mocker, mock_entity, mock_attribute, other, expected): + '''Determine collection equality against another collection.''' + # Temporarily override determination of entity identity so that it works + # against simple scalar values for purpose of test. + mocker.patch.object( + ftrack_api.inspection, 'identity', lambda entity: str(entity) + ) + + collection_a = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=[1, 2] + ) + + collection_b = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=other + ) + assert (collection_a == collection_b) is expected + + +def test_collection_not_equal_to_non_collection( + mocker, mock_entity, mock_attribute +): + '''Collection not equal to a non-collection.''' + # Temporarily override determination of entity identity so that it works + # against simple scalar values for purpose of test. + mocker.patch.object( + ftrack_api.inspection, 'identity', lambda entity: str(entity) + ) + + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=[1, 2] + ) + + assert (collection != {}) is True + + +def test_collection_notify_on_modification( + mock_entity, mock_attribute, mock_entities, session +): + '''Record UpdateEntityOperation on collection modification.''' + collection = ftrack_api.collection.Collection( + mock_entity, mock_attribute, data=mock_entities + ) + assert len(session.recorded_operations) == 0 + + collection.append(create_mock_entity(session)) + assert len(session.recorded_operations) == 1 + operation = session.recorded_operations.pop() + assert isinstance(operation, ftrack_api.operation.UpdateEntityOperation) + assert operation.new_value == collection + + +def test_mapped_collection_proxy_shallow_copy(new_project, unique_name): + '''Shallow copying mapped collection proxy avoids indirect mutation.''' + metadata = new_project['metadata'] + + with new_project.session.operation_recording(False): + metadata_copy = copy.copy(metadata) + metadata_copy[unique_name] = True + + assert unique_name not in metadata + assert unique_name in metadata_copy + + +def test_mapped_collection_proxy_mutable_property(new_project): + '''Mapped collection mutable property maps to underlying collection.''' + metadata = new_project['metadata'] + + assert metadata.mutable is True + assert metadata.collection.mutable is True + + metadata.mutable = False + assert metadata.collection.mutable is False + + +def test_mapped_collection_proxy_attribute_property( + new_project, mock_attribute +): + '''Mapped collection attribute property maps to underlying collection.''' + metadata = new_project['metadata'] + + assert metadata.attribute is metadata.collection.attribute + + metadata.attribute = mock_attribute + assert metadata.collection.attribute is mock_attribute + + +def test_mapped_collection_proxy_get_item(new_project, unique_name): + '''Retrieve item in mapped collection proxy.''' + session = new_project.session + + # Prepare data. + metadata = new_project['metadata'] + value = 'value' + metadata[unique_name] = value + session.commit() + + # Check in clean session retrieval of value. + session.reset() + retrieved = session.get(*ftrack_api.inspection.identity(new_project)) + + assert retrieved is not new_project + assert retrieved['metadata'].keys() == [unique_name] + assert retrieved['metadata'][unique_name] == value + + +def test_mapped_collection_proxy_set_item(new_project, unique_name): + '''Set new item in mapped collection proxy.''' + session = new_project.session + + metadata = new_project['metadata'] + assert unique_name not in metadata + + value = 'value' + metadata[unique_name] = value + assert metadata[unique_name] == value + + # Check change persisted correctly. + session.commit() + session.reset() + retrieved = session.get(*ftrack_api.inspection.identity(new_project)) + + assert retrieved is not new_project + assert retrieved['metadata'].keys() == [unique_name] + assert retrieved['metadata'][unique_name] == value + + +def test_mapped_collection_proxy_update_item(new_project, unique_name): + '''Update existing item in mapped collection proxy.''' + session = new_project.session + + # Prepare a pre-existing value. + metadata = new_project['metadata'] + value = 'value' + metadata[unique_name] = value + session.commit() + + # Set new value. + new_value = 'new_value' + metadata[unique_name] = new_value + + # Confirm change persisted correctly. + session.commit() + session.reset() + retrieved = session.get(*ftrack_api.inspection.identity(new_project)) + + assert retrieved is not new_project + assert retrieved['metadata'].keys() == [unique_name] + assert retrieved['metadata'][unique_name] == new_value + + +def test_mapped_collection_proxy_delete_item(new_project, unique_name): + '''Remove existing item from mapped collection proxy.''' + session = new_project.session + + # Prepare a pre-existing value to remove. + metadata = new_project['metadata'] + value = 'value' + metadata[unique_name] = value + session.commit() + + # Now remove value. + del new_project['metadata'][unique_name] + assert unique_name not in new_project['metadata'] + + # Confirm change persisted correctly. + session.commit() + session.reset() + retrieved = session.get(*ftrack_api.inspection.identity(new_project)) + + assert retrieved is not new_project + assert retrieved['metadata'].keys() == [] + assert unique_name not in retrieved['metadata'] + + +def test_mapped_collection_proxy_delete_missing_item(new_project, unique_name): + '''Fail to remove item for missing key from mapped collection proxy.''' + metadata = new_project['metadata'] + assert unique_name not in metadata + with pytest.raises(KeyError): + del metadata[unique_name] + + +def test_mapped_collection_proxy_iterate_keys(new_project, unique_name): + '''Iterate over keys in mapped collection proxy.''' + metadata = new_project['metadata'] + metadata.update({ + 'a': 'value-a', + 'b': 'value-b', + 'c': 'value-c' + }) + + # Commit here as otherwise cleanup operation will fail because transaction + # will include updating metadata to refer to a deleted entity. + new_project.session.commit() + + iterated = set() + for key in metadata: + iterated.add(key) + + assert iterated == set(['a', 'b', 'c']) + + +def test_mapped_collection_proxy_count(new_project, unique_name): + '''Count items in mapped collection proxy.''' + metadata = new_project['metadata'] + metadata.update({ + 'a': 'value-a', + 'b': 'value-b', + 'c': 'value-c' + }) + + # Commit here as otherwise cleanup operation will fail because transaction + # will include updating metadata to refer to a deleted entity. + new_project.session.commit() + + assert len(metadata) == 3 + + +def test_mapped_collection_on_create(session, unique_name, project): + '''Test that it is possible to set relational attributes on create''' + metadata = { + 'a': 'value-a', + 'b': 'value-b', + 'c': 'value-c' + } + + task_id = session.create( + 'Task', { + 'name': unique_name, + 'parent': project, + 'metadata': metadata, + + } + ).get('id') + + session.commit() + + # Reset the session and check that we have the expected + # values. + session.reset() + + task = session.get( + 'Task', task_id + ) + + for key, value in metadata.items(): + assert value == task['metadata'][key] + + +def test_collection_refresh(new_asset_version, new_component): + '''Test collection reload.''' + session_two = ftrack_api.Session(auto_connect_event_hub=False) + + query_string = 'select components from AssetVersion where id is "{0}"'.format( + new_asset_version.get('id') + ) + + # Fetch the new asset version in a new session. + new_asset_version_two = session_two.query( + query_string + ).one() + + # Modify our asset version + new_asset_version.get('components').append( + new_component + ) + + new_asset_version.session.commit() + + # Query the same asset version again and make sure we get the newly + # populated data. + session_two.query( + query_string + ).all() + + assert ( + new_asset_version.get('components') == new_asset_version_two.get('components') + ) + + # Make a local change to our asset version + new_asset_version_two.get('components').pop() + + # Query the same asset version again and make sure our local changes + # are not overwritten. + + session_two.query( + query_string + ).all() + + assert len(new_asset_version_two.get('components')) == 0 + + +def test_mapped_collection_reload(new_asset_version): + '''Test mapped collection reload.''' + session_two = ftrack_api.Session(auto_connect_event_hub=False) + + query_string = 'select metadata from AssetVersion where id is "{0}"'.format( + new_asset_version.get('id') + ) + + # Fetch the new asset version in a new session. + new_asset_version_two = session_two.query( + query_string + ).one() + + # Modify our asset version + new_asset_version['metadata']['test'] = str(uuid.uuid4()) + + new_asset_version.session.commit() + + # Query the same asset version again and make sure we get the newly + # populated data. + session_two.query( + query_string + ).all() + + assert ( + new_asset_version['metadata']['test'] == new_asset_version_two['metadata']['test'] + ) + + local_data = str(uuid.uuid4()) + + new_asset_version_two['metadata']['test'] = local_data + + # Modify our asset version again + new_asset_version['metadata']['test'] = str(uuid.uuid4()) + + new_asset_version.session.commit() + + # Query the same asset version again and make sure our local changes + # are not overwritten. + session_two.query( + query_string + ).all() + + assert ( + new_asset_version_two['metadata']['test'] == local_data + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_custom_attribute.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_custom_attribute.py new file mode 100644 index 0000000000..7a9b0fadaa --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_custom_attribute.py @@ -0,0 +1,251 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import uuid + +import pytest + +import ftrack_api + +@pytest.fixture( + params=[ + 'AssetVersion', 'Shot', 'AssetVersionList', 'TypedContextList', 'User', + 'Asset' + ] +) +def new_entity_and_custom_attribute(request, session): + '''Return tuple with new entity, custom attribute name and value.''' + if request.param == 'AssetVersion': + entity = session.create( + request.param, { + 'asset': session.query('Asset').first() + } + ) + return (entity, 'versiontest', 123) + + elif request.param == 'Shot': + sequence = session.query('Sequence').first() + entity = session.create( + request.param, { + 'parent_id': sequence['id'], + 'project_id': sequence['project_id'], + 'name': str(uuid.uuid1()) + } + ) + return (entity, 'fstart', 1005) + + elif request.param == 'Asset': + shot = session.query('Shot').first() + entity = session.create( + request.param, { + 'context_id': shot['project_id'], + 'name': str(uuid.uuid1()) + } + ) + return (entity, 'htest', 1005) + + elif request.param in ('AssetVersionList', 'TypedContextList'): + entity = session.create( + request.param, { + 'project_id': session.query('Project').first()['id'], + 'category_id': session.query('ListCategory').first()['id'], + 'name': str(uuid.uuid1()) + } + ) + return (entity, 'listbool', True) + + elif request.param == 'User': + entity = session.create( + request.param, { + 'first_name': 'Custom attribute test', + 'last_name': 'Custom attribute test', + 'username': str(uuid.uuid1()) + } + ) + return (entity, 'teststring', 'foo') + + +@pytest.mark.parametrize( + 'entity_type, entity_model_name, custom_attribute_name', + [ + ('Task', 'task', 'customNumber'), + ('AssetVersion', 'assetversion', 'NumberField') + ], + ids=[ + 'task', + 'asset_version' + ] +) +def test_read_set_custom_attribute( + session, entity_type, entity_model_name, custom_attribute_name +): + '''Retrieve custom attribute value set on instance.''' + custom_attribute_value = session.query( + 'CustomAttributeValue where configuration.key is ' + '{custom_attribute_name}' + .format( + custom_attribute_name=custom_attribute_name + ) + ).first() + + entity = session.query( + 'select custom_attributes from {entity_type} where id is ' + '{entity_id}'.format( + entity_type=entity_type, + entity_id=custom_attribute_value['entity_id'], + ) + ).first() + + assert custom_attribute_value + + assert entity['id'] == entity['custom_attributes'].collection.entity['id'] + assert entity is entity['custom_attributes'].collection.entity + assert ( + entity['custom_attributes'][custom_attribute_name] == + custom_attribute_value['value'] + ) + + assert custom_attribute_name in entity['custom_attributes'].keys() + + +@pytest.mark.parametrize( + 'entity_type, custom_attribute_name', + [ + ('Task', 'customNumber'), + ('Shot', 'fstart'), + ( + 'AssetVersion', 'NumberField' + ) + ], + ids=[ + 'task', + 'shot', + 'asset_version' + ] +) +def test_write_set_custom_attribute_value( + session, entity_type, custom_attribute_name +): + '''Overwrite existing instance level custom attribute value.''' + entity = session.query( + 'select custom_attributes from {entity_type} where ' + 'custom_attributes.configuration.key is {custom_attribute_name}'.format( + entity_type=entity_type, + custom_attribute_name=custom_attribute_name + ) + ).first() + + entity['custom_attributes'][custom_attribute_name] = 42 + + assert entity['custom_attributes'][custom_attribute_name] == 42 + + session.commit() + + +@pytest.mark.parametrize( + 'entity_type, custom_attribute_name', + [ + ('Task', 'fstart'), + ('Shot', 'Not existing'), + ('AssetVersion', 'fstart') + ], + ids=[ + 'task', + 'shot', + 'asset_version' + ] +) +def test_read_custom_attribute_that_does_not_exist( + session, entity_type, custom_attribute_name +): + '''Fail to read value from a custom attribute that does not exist.''' + entity = session.query( + 'select custom_attributes from {entity_type}'.format( + entity_type=entity_type + ) + ).first() + + with pytest.raises(KeyError): + entity['custom_attributes'][custom_attribute_name] + + +@pytest.mark.parametrize( + 'entity_type, custom_attribute_name', + [ + ('Task', 'fstart'), + ('Shot', 'Not existing'), + ('AssetVersion', 'fstart') + ], + ids=[ + 'task', + 'shot', + 'asset_version' + ] +) +def test_write_custom_attribute_that_does_not_exist( + session, entity_type, custom_attribute_name +): + '''Fail to write a value to a custom attribute that does not exist.''' + entity = session.query( + 'select custom_attributes from {entity_type}'.format( + entity_type=entity_type + ) + ).first() + + with pytest.raises(KeyError): + entity['custom_attributes'][custom_attribute_name] = 42 + + +def test_set_custom_attribute_on_new_but_persisted_version( + session, new_asset_version +): + '''Set custom attribute on new persisted version.''' + new_asset_version['custom_attributes']['versiontest'] = 5 + session.commit() + + +@pytest.mark.xfail( + raises=ftrack_api.exception.ServerError, + reason='Due to user permission errors.' +) +def test_batch_create_entity_and_custom_attributes( + new_entity_and_custom_attribute +): + '''Write custom attribute value and entity in the same batch.''' + entity, name, value = new_entity_and_custom_attribute + session = entity.session + entity['custom_attributes'][name] = value + + assert entity['custom_attributes'][name] == value + session.commit() + + assert entity['custom_attributes'][name] == value + + +def test_refresh_custom_attribute(new_asset_version): + '''Test custom attribute refresh.''' + session_two = ftrack_api.Session() + + query_string = 'select custom_attributes from AssetVersion where id is "{0}"'.format( + new_asset_version.get('id') + ) + + asset_version_two = session_two.query( + query_string + ).first() + + new_asset_version['custom_attributes']['versiontest'] = 42 + + new_asset_version.session.commit() + + asset_version_two = session_two.query( + query_string + ).first() + + assert ( + new_asset_version['custom_attributes']['versiontest'] == + asset_version_two['custom_attributes']['versiontest'] + ) + + + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_data.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_data.py new file mode 100644 index 0000000000..c53dda9630 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_data.py @@ -0,0 +1,129 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import os +import tempfile + +import pytest + +import ftrack_api.data + + +@pytest.fixture() +def content(): + '''Return initial content.''' + return 'test data' + + +@pytest.fixture(params=['file', 'file_wrapper', 'string']) +def data(request, content): + '''Return cache.''' + + if request.param == 'string': + data_object = ftrack_api.data.String(content) + + elif request.param == 'file': + file_handle, path = tempfile.mkstemp() + file_object = os.fdopen(file_handle, 'r+') + file_object.write(content) + file_object.flush() + file_object.close() + + data_object = ftrack_api.data.File(path, 'r+') + + def cleanup(): + '''Cleanup.''' + data_object.close() + os.remove(path) + + request.addfinalizer(cleanup) + + elif request.param == 'file_wrapper': + file_handle, path = tempfile.mkstemp() + file_object = os.fdopen(file_handle, 'r+') + file_object.write(content) + file_object.seek(0) + + data_object = ftrack_api.data.FileWrapper(file_object) + + def cleanup(): + '''Cleanup.''' + data_object.close() + os.remove(path) + + request.addfinalizer(cleanup) + + else: + raise ValueError('Unrecognised parameter: {0}'.format(request.param)) + + return data_object + + +def test_read(data, content): + '''Return content from current position up to *limit*.''' + assert data.read(5) == content[:5] + assert data.read() == content[5:] + + +def test_write(data, content): + '''Write content at current position.''' + assert data.read() == content + data.write('more test data') + data.seek(0) + assert data.read() == content + 'more test data' + + +def test_flush(data): + '''Flush buffers ensuring data written.''' + # TODO: Implement better test than just calling function. + data.flush() + + +def test_seek(data, content): + '''Move internal pointer to *position*.''' + data.seek(5) + assert data.read() == content[5:] + + +def test_tell(data): + '''Return current position of internal pointer.''' + assert data.tell() == 0 + data.seek(5) + assert data.tell() == 5 + + +def test_close(data): + '''Flush buffers and prevent further access.''' + data.close() + with pytest.raises(ValueError) as error: + data.read() + + assert 'I/O operation on closed file' in str(error.value) + + +class Dummy(ftrack_api.data.Data): + '''Dummy string.''' + + def read(self, limit=None): + '''Return content from current position up to *limit*.''' + + def write(self, content): + '''Write content at current position.''' + + +def test_unsupported_tell(): + '''Fail when tell unsupported.''' + data = Dummy() + with pytest.raises(NotImplementedError) as error: + data.tell() + + assert 'Tell not supported' in str(error.value) + + +def test_unsupported_seek(): + '''Fail when seek unsupported.''' + data = Dummy() + with pytest.raises(NotImplementedError) as error: + data.seek(5) + + assert 'Seek not supported' in str(error.value) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_formatter.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_formatter.py new file mode 100644 index 0000000000..ae565cb3f5 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_formatter.py @@ -0,0 +1,70 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import termcolor + +import ftrack_api.formatter + + +def colored(text, *args, **kwargs): + '''Pass through so there are no escape sequences in output.''' + return text + + +def test_format(user, mocker): + '''Return formatted representation of entity.''' + mocker.patch.object(termcolor, 'colored', colored) + + result = ftrack_api.formatter.format(user) + + # Cannot test entire string as too variable so check for key text. + assert result.startswith('User\n') + assert ' username: jenkins' in result + assert ' email: ' in result + + +def test_format_using_custom_formatters(user): + '''Return formatted representation of entity using custom formatters.''' + result = ftrack_api.formatter.format( + user, formatters={ + 'header': lambda text: '*{0}*'.format(text), + 'label': lambda text: '-{0}'.format(text) + } + ) + + # Cannot test entire string as too variable so check for key text. + assert result.startswith('*User*\n') + assert ' -username: jenkins' in result + assert ' -email: ' in result + + +def test_format_filtering(new_user, mocker): + '''Return formatted representation using custom filter.''' + mocker.patch.object(termcolor, 'colored', colored) + + with new_user.session.auto_populating(False): + result = ftrack_api.formatter.format( + new_user, + attribute_filter=ftrack_api.formatter.FILTER['ignore_unset'] + ) + + # Cannot test entire string as too variable so check for key text. + assert result.startswith('User\n') + assert ' username: {0}'.format(new_user['username']) in result + assert ' email: ' not in result + + +def test_format_recursive(user, mocker): + '''Return formatted recursive representation.''' + mocker.patch.object(termcolor, 'colored', colored) + + user.session.populate(user, 'timelogs.user') + + with user.session.auto_populating(False): + result = ftrack_api.formatter.format(user, recursive=True) + + # Cannot test entire string as too variable so check for key text. + assert result.startswith('User\n') + assert ' username: jenkins' + assert ' timelogs: Timelog' in result + assert ' user: User{...}' in result diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_inspection.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_inspection.py new file mode 100644 index 0000000000..57b44613a8 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_inspection.py @@ -0,0 +1,101 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2014 ftrack + +import ftrack_api.inspection +import ftrack_api.symbol + + +def test_identity(user): + '''Retrieve identity of *user*.''' + identity = ftrack_api.inspection.identity(user) + assert identity[0] == 'User' + assert identity[1] == ['d07ae5d0-66e1-11e1-b5e9-f23c91df25eb'] + + +def test_primary_key(user): + '''Retrieve primary key of *user*.''' + primary_key = ftrack_api.inspection.primary_key(user) + assert primary_key == { + 'id': 'd07ae5d0-66e1-11e1-b5e9-f23c91df25eb' + } + + +def test_created_entity_state(session, unique_name): + '''Created entity has CREATED state.''' + new_user = session.create('User', {'username': unique_name}) + assert ftrack_api.inspection.state(new_user) is ftrack_api.symbol.CREATED + + # Even after a modification the state should remain as CREATED. + new_user['username'] = 'changed' + assert ftrack_api.inspection.state(new_user) is ftrack_api.symbol.CREATED + + +def test_retrieved_entity_state(user): + '''Retrieved entity has NOT_SET state.''' + assert ftrack_api.inspection.state(user) is ftrack_api.symbol.NOT_SET + + +def test_modified_entity_state(user): + '''Modified entity has MODIFIED state.''' + user['username'] = 'changed' + assert ftrack_api.inspection.state(user) is ftrack_api.symbol.MODIFIED + + +def test_deleted_entity_state(session, user): + '''Deleted entity has DELETED state.''' + session.delete(user) + assert ftrack_api.inspection.state(user) is ftrack_api.symbol.DELETED + + +def test_post_commit_entity_state(session, unique_name): + '''Entity has NOT_SET state post commit.''' + new_user = session.create('User', {'username': unique_name}) + assert ftrack_api.inspection.state(new_user) is ftrack_api.symbol.CREATED + + session.commit() + + assert ftrack_api.inspection.state(new_user) is ftrack_api.symbol.NOT_SET + + +def test_states(session, unique_name, user): + '''Determine correct states for multiple entities.''' + # NOT_SET + user_a = session.create('User', {'username': unique_name}) + session.commit() + + # CREATED + user_b = session.create('User', {'username': unique_name}) + user_b['username'] = 'changed' + + # MODIFIED + user_c = user + user_c['username'] = 'changed' + + # DELETED + user_d = session.create('User', {'username': unique_name}) + session.delete(user_d) + + # Assert states. + states = ftrack_api.inspection.states([user_a, user_b, user_c, user_d]) + + assert states == [ + ftrack_api.symbol.NOT_SET, + ftrack_api.symbol.CREATED, + ftrack_api.symbol.MODIFIED, + ftrack_api.symbol.DELETED + ] + + +def test_states_for_no_entities(): + '''Return empty list of states when no entities passed.''' + states = ftrack_api.inspection.states([]) + assert states == [] + + +def test_skip_operations_for_non_inspected_entities(session, unique_name): + '''Skip operations for non inspected entities.''' + user_a = session.create('User', {'username': unique_name + '-1'}) + user_b = session.create('User', {'username': unique_name + '-2'}) + + states = ftrack_api.inspection.states([user_a]) + assert states == [ftrack_api.symbol.CREATED] diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_operation.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_operation.py new file mode 100644 index 0000000000..702bfae355 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_operation.py @@ -0,0 +1,79 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api.operation + + +def test_operations_initialise(): + '''Initialise empty operations stack.''' + operations = ftrack_api.operation.Operations() + assert len(operations) == 0 + + +def test_operations_push(): + '''Push new operation onto stack.''' + operations = ftrack_api.operation.Operations() + assert len(operations) == 0 + + operation = ftrack_api.operation.Operation() + operations.push(operation) + assert list(operations)[-1] is operation + + +def test_operations_pop(): + '''Pop and return operation from stack.''' + operations = ftrack_api.operation.Operations() + assert len(operations) == 0 + + operations.push(ftrack_api.operation.Operation()) + operations.push(ftrack_api.operation.Operation()) + operation = ftrack_api.operation.Operation() + operations.push(operation) + + assert len(operations) == 3 + popped = operations.pop() + assert popped is operation + assert len(operations) == 2 + + +def test_operations_count(): + '''Count operations in stack.''' + operations = ftrack_api.operation.Operations() + assert len(operations) == 0 + + operations.push(ftrack_api.operation.Operation()) + assert len(operations) == 1 + + operations.pop() + assert len(operations) == 0 + + +def test_operations_clear(): + '''Clear operations stack.''' + operations = ftrack_api.operation.Operations() + operations.push(ftrack_api.operation.Operation()) + operations.push(ftrack_api.operation.Operation()) + operations.push(ftrack_api.operation.Operation()) + assert len(operations) == 3 + + operations.clear() + assert len(operations) == 0 + + +def test_operations_iter(): + '''Iterate over operations stack.''' + operations = ftrack_api.operation.Operations() + operation_a = ftrack_api.operation.Operation() + operation_b = ftrack_api.operation.Operation() + operation_c = ftrack_api.operation.Operation() + + operations.push(operation_a) + operations.push(operation_b) + operations.push(operation_c) + + assert len(operations) == 3 + for operation, expected in zip( + operations, [operation_a, operation_b, operation_c] + ): + assert operation is expected + diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_package.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_package.py new file mode 100644 index 0000000000..247b496d96 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_package.py @@ -0,0 +1,48 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import ftrack_api + + +class Class(object): + '''Class.''' + + +class Mixin(object): + '''Mixin.''' + + def method(self): + '''Method.''' + return True + + +def test_mixin(): + '''Mixin class to instance.''' + instance_a = Class() + instance_b = Class() + + assert not hasattr(instance_a, 'method') + assert not hasattr(instance_b, 'method') + + ftrack_api.mixin(instance_a, Mixin) + + assert hasattr(instance_a, 'method') + assert instance_a.method() is True + assert not hasattr(instance_b, 'method') + + +def test_mixin_same_class_multiple_times(): + '''Mixin class to instance multiple times.''' + instance = Class() + assert not hasattr(instance, 'method') + assert len(instance.__class__.mro()) == 2 + + ftrack_api.mixin(instance, Mixin) + assert hasattr(instance, 'method') + assert instance.method() is True + assert len(instance.__class__.mro()) == 4 + + ftrack_api.mixin(instance, Mixin) + assert hasattr(instance, 'method') + assert instance.method() is True + assert len(instance.__class__.mro()) == 4 diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_plugin.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_plugin.py new file mode 100644 index 0000000000..252c813a9b --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_plugin.py @@ -0,0 +1,192 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import os +import textwrap +import logging +import re + +import pytest + +import ftrack_api.plugin + + +@pytest.fixture() +def valid_plugin(temporary_path): + '''Return path to directory containing a valid plugin.''' + with open(os.path.join(temporary_path, 'plugin.py'), 'w') as file_object: + file_object.write(textwrap.dedent(''' + def register(*args, **kw): + print "Registered", args, kw + ''')) + + return temporary_path + + +@pytest.fixture() +def python_non_plugin(temporary_path): + '''Return path to directory containing Python file that is non plugin.''' + with open(os.path.join(temporary_path, 'non.py'), 'w') as file_object: + file_object.write(textwrap.dedent(''' + print "Not a plugin" + + def not_called(): + print "Not called" + ''')) + + return temporary_path + + +@pytest.fixture() +def non_plugin(temporary_path): + '''Return path to directory containing file that is non plugin.''' + with open(os.path.join(temporary_path, 'non.txt'), 'w') as file_object: + file_object.write('Never seen') + + return temporary_path + + +@pytest.fixture() +def broken_plugin(temporary_path): + '''Return path to directory containing broken plugin.''' + with open(os.path.join(temporary_path, 'broken.py'), 'w') as file_object: + file_object.write('syntax error') + + return temporary_path + + +@pytest.fixture() +def plugin(request, temporary_path): + '''Return path containing a plugin with requested specification.''' + specification = request.param + output = re.sub('(\w+)=\w+', '"\g<1>={}".format(\g<1>)', specification) + output = re.sub('\*args', 'args', output) + output = re.sub('\*\*kwargs', 'sorted(kwargs.items())', output) + + with open(os.path.join(temporary_path, 'plugin.py'), 'w') as file_object: + content = textwrap.dedent(''' + def register({}): + print {} + '''.format(specification, output)) + file_object.write(content) + + return temporary_path + + +def test_discover_empty_paths(capsys): + '''Discover no plugins when paths are empty.''' + ftrack_api.plugin.discover([' ']) + output, error = capsys.readouterr() + assert not output + assert not error + + +def test_discover_valid_plugin(valid_plugin, capsys): + '''Discover valid plugin.''' + ftrack_api.plugin.discover([valid_plugin], (1, 2), {'3': 4}) + output, error = capsys.readouterr() + assert 'Registered (1, 2) {\'3\': 4}' in output + + +def test_discover_python_non_plugin(python_non_plugin, capsys): + '''Discover Python non plugin.''' + ftrack_api.plugin.discover([python_non_plugin]) + output, error = capsys.readouterr() + assert 'Not a plugin' in output + assert 'Not called' not in output + + +def test_discover_non_plugin(non_plugin, capsys): + '''Discover non plugin.''' + ftrack_api.plugin.discover([non_plugin]) + output, error = capsys.readouterr() + assert not output + assert not error + + +def test_discover_broken_plugin(broken_plugin, caplog): + '''Discover broken plugin.''' + ftrack_api.plugin.discover([broken_plugin]) + + records = caplog.records() + assert len(records) == 1 + assert records[0].levelno is logging.WARNING + assert 'Failed to load plugin' in records[0].message + + +@pytest.mark.parametrize( + 'plugin, positional, keyword, expected', + [ + ( + 'a, b=False, c=False, d=False', + (1, 2), {'c': True, 'd': True, 'e': True}, + '1 b=2 c=True d=True' + ), + ( + '*args', + (1, 2), {'b': True, 'c': False}, + '(1, 2)' + ), + ( + '**kwargs', + tuple(), {'b': True, 'c': False}, + '[(\'b\', True), (\'c\', False)]' + ), + ( + 'a=False, b=False', + (True,), {'b': True}, + 'a=True b=True' + ), + ( + 'a, c=False, *args', + (1, 2, 3, 4), {}, + '1 c=2 (3, 4)' + ), + ( + 'a, c=False, **kwargs', + tuple(), {'a': 1, 'b': 2, 'c': 3, 'd': 4}, + '1 c=3 [(\'b\', 2), (\'d\', 4)]' + ), + ], + indirect=['plugin'], + ids=[ + 'mixed-explicit', + 'variable-args-only', + 'variable-kwargs-only', + 'keyword-from-positional', + 'trailing-variable-args', + 'trailing-keyword-args' + ] +) +def test_discover_plugin_with_specific_signature( + plugin, positional, keyword, expected, capsys +): + '''Discover plugin passing only supported arguments.''' + ftrack_api.plugin.discover( + [plugin], positional, keyword + ) + output, error = capsys.readouterr() + assert expected in output + + +def test_discover_plugin_varying_signatures(temporary_path, capsys): + '''Discover multiple plugins with varying signatures.''' + with open(os.path.join(temporary_path, 'plugin_a.py'), 'w') as file_object: + file_object.write(textwrap.dedent(''' + def register(a): + print (a,) + ''')) + + with open(os.path.join(temporary_path, 'plugin_b.py'), 'w') as file_object: + file_object.write(textwrap.dedent(''' + def register(a, b=False): + print (a,), {'b': b} + ''')) + + ftrack_api.plugin.discover( + [temporary_path], (True,), {'b': True} + ) + + output, error = capsys.readouterr() + assert '(True,)'in output + assert '(True,) {\'b\': True}' in output diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_query.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_query.py new file mode 100644 index 0000000000..f8e3f9dec3 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_query.py @@ -0,0 +1,164 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import math + +import pytest + +import ftrack_api +import ftrack_api.query +import ftrack_api.exception + + +def test_index(session): + '''Index into query result.''' + results = session.query('User') + assert isinstance(results[2], session.types['User']) + + +def test_len(session): + '''Return count of results using len.''' + results = session.query('User where username is jenkins') + assert len(results) == 1 + + +def test_all(session): + '''Return all results using convenience method.''' + results = session.query('User').all() + assert isinstance(results, list) + assert len(results) + + +def test_implicit_iteration(session): + '''Implicitly iterate through query result.''' + results = session.query('User') + assert isinstance(results, ftrack_api.query.QueryResult) + + records = [] + for record in results: + records.append(record) + + assert len(records) == len(results) + + +def test_one(session): + '''Return single result using convenience method.''' + user = session.query('User where username is jenkins').one() + assert user['username'] == 'jenkins' + + +def test_one_fails_for_no_results(session): + '''Fail to fetch single result when no results available.''' + with pytest.raises(ftrack_api.exception.NoResultFoundError): + session.query('User where username is does_not_exist').one() + + +def test_one_fails_for_multiple_results(session): + '''Fail to fetch single result when multiple results available.''' + with pytest.raises(ftrack_api.exception.MultipleResultsFoundError): + session.query('User').one() + + +def test_one_with_existing_limit(session): + '''Fail to return single result when existing limit in expression.''' + with pytest.raises(ValueError): + session.query('User where username is jenkins limit 0').one() + + +def test_one_with_existing_offset(session): + '''Fail to return single result when existing offset in expression.''' + with pytest.raises(ValueError): + session.query('User where username is jenkins offset 2').one() + + +def test_one_with_prefetched_data(session): + '''Return single result ignoring prefetched data.''' + query = session.query('User where username is jenkins') + query.all() + + user = query.one() + assert user['username'] == 'jenkins' + + +def test_first(session): + '''Return first result using convenience method.''' + users = session.query('User').all() + + user = session.query('User').first() + assert user == users[0] + + +def test_first_returns_none_when_no_results(session): + '''Return None when no results available.''' + user = session.query('User where username is does_not_exist').first() + assert user is None + + +def test_first_with_existing_limit(session): + '''Fail to return first result when existing limit in expression.''' + with pytest.raises(ValueError): + session.query('User where username is jenkins limit 0').first() + + +def test_first_with_existing_offset(session): + '''Return first result whilst respecting custom offset.''' + users = session.query('User').all() + + user = session.query('User offset 2').first() + assert user == users[2] + + +def test_first_with_prefetched_data(session): + '''Return first result ignoring prefetched data.''' + query = session.query('User where username is jenkins') + query.all() + + user = query.first() + assert user['username'] == 'jenkins' + + +def test_paging(session, mocker): + '''Page through results.''' + mocker.patch.object(session, 'call', wraps=session.call) + + page_size = 5 + query = session.query('User limit 50', page_size=page_size) + records = query.all() + + assert session.call.call_count == ( + math.ceil(len(records) / float(page_size)) + ) + + +def test_paging_respects_offset_and_limit(session, mocker): + '''Page through results respecting offset and limit.''' + users = session.query('User').all() + + mocker.patch.object(session, 'call', wraps=session.call) + + page_size = 6 + query = session.query('User offset 2 limit 8', page_size=page_size) + records = query.all() + + assert session.call.call_count == 2 + assert len(records) == 8 + assert records == users[2:10] + + +def test_paging_respects_limit_smaller_than_page_size(session, mocker): + '''Use initial limit when less than page size.''' + mocker.patch.object(session, 'call', wraps=session.call) + + page_size = 100 + query = session.query('User limit 10', page_size=page_size) + records = query.all() + + assert session.call.call_count == 1 + session.call.assert_called_once_with( + [{ + 'action': 'query', + 'expression': 'select id from User offset 0 limit 10' + }] + ) + + assert len(records) == 10 \ No newline at end of file diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_session.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_session.py new file mode 100644 index 0000000000..5087efcc08 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_session.py @@ -0,0 +1,1519 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import os +import tempfile +import functools +import uuid +import textwrap +import datetime +import json +import random + +import pytest +import mock +import arrow +import requests + +import ftrack_api +import ftrack_api.cache +import ftrack_api.inspection +import ftrack_api.symbol +import ftrack_api.exception +import ftrack_api.session +import ftrack_api.collection + + +@pytest.fixture(params=['memory', 'persisted']) +def cache(request): + '''Return cache.''' + if request.param == 'memory': + cache = None # There is already a default Memory cache present. + elif request.param == 'persisted': + cache_path = os.path.join( + tempfile.gettempdir(), '{0}.dbm'.format(uuid.uuid4().hex) + ) + + cache = lambda session: ftrack_api.cache.SerialisedCache( + ftrack_api.cache.FileCache(cache_path), + encode=functools.partial( + session.encode, entity_attribute_strategy='persisted_only' + ), + decode=session.decode + ) + + def cleanup(): + '''Cleanup.''' + try: + os.remove(cache_path) + except OSError: + # BSD DB (Mac OSX) implementation of the interface will append + # a .db extension. + os.remove(cache_path + '.db') + + request.addfinalizer(cleanup) + + return cache + + +@pytest.fixture() +def temporary_invalid_schema_cache(request): + '''Return schema cache path to invalid schema cache file.''' + schema_cache_path = os.path.join( + tempfile.gettempdir(), + 'ftrack_api_schema_cache_test_{0}.json'.format(uuid.uuid4().hex) + ) + + with open(schema_cache_path, 'w') as file_: + file_.write('${invalid json}') + + def cleanup(): + '''Cleanup.''' + os.remove(schema_cache_path) + + request.addfinalizer(cleanup) + + return schema_cache_path + + +@pytest.fixture() +def temporary_valid_schema_cache(request, mocked_schemas): + '''Return schema cache path to valid schema cache file.''' + schema_cache_path = os.path.join( + tempfile.gettempdir(), + 'ftrack_api_schema_cache_test_{0}.json'.format(uuid.uuid4().hex) + ) + + with open(schema_cache_path, 'w') as file_: + json.dump(mocked_schemas, file_, indent=4) + + def cleanup(): + '''Cleanup.''' + os.remove(schema_cache_path) + + request.addfinalizer(cleanup) + + return schema_cache_path + + +class SelectiveCache(ftrack_api.cache.ProxyCache): + '''Proxy cache that should not cache newly created entities.''' + + def set(self, key, value): + '''Set *value* for *key*.''' + if isinstance(value, ftrack_api.entity.base.Entity): + if ( + ftrack_api.inspection.state(value) + is ftrack_api.symbol.CREATED + ): + return + + super(SelectiveCache, self).set(key, value) + + +def test_get_entity(session, user): + '''Retrieve an entity by type and id.''' + matching = session.get(*ftrack_api.inspection.identity(user)) + assert matching == user + + +def test_get_non_existant_entity(session): + '''Retrieve a non-existant entity by type and id.''' + matching = session.get('User', 'non-existant-id') + assert matching is None + + +def test_get_entity_of_invalid_type(session): + '''Fail to retrieve an entity using an invalid type.''' + with pytest.raises(KeyError): + session.get('InvalidType', 'id') + + +def test_create(session): + '''Create entity.''' + user = session.create('User', {'username': 'martin'}) + with session.auto_populating(False): + assert user['id'] is not ftrack_api.symbol.NOT_SET + assert user['username'] == 'martin' + assert user['email'] is ftrack_api.symbol.NOT_SET + + +def test_create_using_only_defaults(session): + '''Create entity using defaults only.''' + user = session.create('User') + with session.auto_populating(False): + assert user['id'] is not ftrack_api.symbol.NOT_SET + assert user['username'] is ftrack_api.symbol.NOT_SET + + +def test_create_using_server_side_defaults(session): + '''Create entity using server side defaults.''' + user = session.create('User') + with session.auto_populating(False): + assert user['id'] is not ftrack_api.symbol.NOT_SET + assert user['username'] is ftrack_api.symbol.NOT_SET + + session.commit() + assert user['username'] is not ftrack_api.symbol.NOT_SET + + +def test_create_overriding_defaults(session): + '''Create entity overriding defaults.''' + uid = str(uuid.uuid4()) + user = session.create('User', {'id': uid}) + with session.auto_populating(False): + assert user['id'] == uid + + +def test_create_with_reference(session): + '''Create entity with a reference to another.''' + status = session.query('Status')[0] + task = session.create('Task', {'status': status}) + assert task['status'] is status + + +def test_ensure_new_entity(session, unique_name): + '''Ensure entity, creating first.''' + entity = session.ensure('User', {'username': unique_name}) + assert entity['username'] == unique_name + + +def test_ensure_entity_with_non_string_data_types(session): + '''Ensure entity against non-string data types, creating first.''' + datetime = arrow.get() + + task = session.query('Task').first() + user = session.query( + 'User where username is {}'.format(session.api_user) + ).first() + + first = session.ensure( + 'Timelog', + { + 'start': datetime, + 'duration': 10, + 'user_id': user['id'], + 'context_id': task['id'] + } + ) + + with mock.patch.object(session, 'create') as mocked: + session.ensure( + 'Timelog', + { + 'start': datetime, + 'duration': 10, + 'user_id': user['id'], + 'context_id': task['id'] + } + ) + assert not mocked.called + + assert first['start'] == datetime + assert first['duration'] == 10 + + +def test_ensure_entity_with_identifying_keys(session, unique_name): + '''Ensure entity, checking using keys subset and then creating.''' + entity = session.ensure( + 'User', {'username': unique_name, 'email': 'test@example.com'}, + identifying_keys=['username'] + ) + assert entity['username'] == unique_name + + +def test_ensure_entity_with_invalid_identifying_keys(session, unique_name): + '''Fail to ensure entity when identifying key missing from data.''' + with pytest.raises(KeyError): + session.ensure( + 'User', {'username': unique_name, 'email': 'test@example.com'}, + identifying_keys=['invalid'] + ) + + +def test_ensure_entity_with_missing_identifying_keys(session): + '''Fail to ensure entity when no identifying keys determined.''' + with pytest.raises(ValueError): + session.ensure('User', {}) + + +def test_ensure_existing_entity(session, unique_name): + '''Ensure existing entity.''' + entity = session.ensure('User', {'first_name': unique_name}) + + # Second call should not commit any new entity, just retrieve the existing. + with mock.patch.object(session, 'create') as mocked: + retrieved = session.ensure('User', {'first_name': unique_name}) + assert not mocked.called + assert retrieved == entity + + +def test_ensure_update_existing_entity(session, unique_name): + '''Ensure and update existing entity.''' + entity = session.ensure( + 'User', {'first_name': unique_name, 'email': 'anon@example.com'} + ) + assert entity['email'] == 'anon@example.com' + + # Second call should commit updates. + retrieved = session.ensure( + 'User', {'first_name': unique_name, 'email': 'test@example.com'}, + identifying_keys=['first_name'] + ) + assert retrieved == entity + assert retrieved['email'] == 'test@example.com' + + +def test_reconstruct_entity(session): + '''Reconstruct entity.''' + uid = str(uuid.uuid4()) + data = { + 'id': uid, + 'username': 'martin', + 'email': 'martin@example.com' + } + user = session.create('User', data, reconstructing=True) + + for attribute in user.attributes: + # No local attributes should be set. + assert attribute.get_local_value(user) is ftrack_api.symbol.NOT_SET + + # Only remote attributes that had explicit values should be set. + value = attribute.get_remote_value(user) + if attribute.name in data: + assert value == data[attribute.name] + else: + assert value is ftrack_api.symbol.NOT_SET + + +def test_reconstruct_entity_does_not_apply_defaults(session): + '''Reconstruct entity does not apply defaults.''' + # Note: Use private method to avoid merge which requires id be set. + user = session._create('User', {}, reconstructing=True) + with session.auto_populating(False): + assert user['id'] is ftrack_api.symbol.NOT_SET + + +def test_reconstruct_empty_entity(session): + '''Reconstruct empty entity.''' + # Note: Use private method to avoid merge which requires id be set. + user = session._create('User', {}, reconstructing=True) + + for attribute in user.attributes: + # No local attributes should be set. + assert attribute.get_local_value(user) is ftrack_api.symbol.NOT_SET + + # No remote attributes should be set. + assert attribute.get_remote_value(user) is ftrack_api.symbol.NOT_SET + + +def test_delete_operation_ordering(session, unique_name): + '''Delete entities in valid order.''' + # Construct entities. + project_schema = session.query('ProjectSchema').first() + project = session.create('Project', { + 'name': unique_name, + 'full_name': unique_name, + 'project_schema': project_schema + }) + + sequence = session.create('Sequence', { + 'name': unique_name, + 'parent': project + }) + + session.commit() + + # Delete in order that should succeed. + session.delete(sequence) + session.delete(project) + + session.commit() + + +def test_create_then_delete_operation_ordering(session, unique_name): + '''Create and delete entity in one transaction.''' + entity = session.create('User', {'username': unique_name}) + session.delete(entity) + session.commit() + + +def test_create_and_modify_to_have_required_attribute(session, unique_name): + '''Create and modify entity to have required attribute in transaction.''' + entity = session.create('Scope', {}) + other = session.create('Scope', {'name': unique_name}) + entity['name'] = '{0}2'.format(unique_name) + session.commit() + + +def test_ignore_in_create_entity_payload_values_set_to_not_set( + mocker, unique_name, session +): + '''Ignore in commit, created entity data set to NOT_SET''' + mocked = mocker.patch.object(session, 'call') + + # Should ignore 'email' attribute in payload. + new_user = session.create( + 'User', {'username': unique_name, 'email': 'test'} + ) + new_user['email'] = ftrack_api.symbol.NOT_SET + session.commit() + payloads = mocked.call_args[0][0] + assert len(payloads) == 1 + + +def test_ignore_operation_that_modifies_attribute_to_not_set( + mocker, session, user +): + '''Ignore in commit, operation that sets attribute value to NOT_SET''' + mocked = mocker.patch.object(session, 'call') + + # Should result in no call to server. + user['email'] = ftrack_api.symbol.NOT_SET + session.commit() + + assert not mocked.called + + +def test_operation_optimisation_on_commit(session, mocker): + '''Optimise operations on commit.''' + mocked = mocker.patch.object(session, 'call') + + user_a = session.create('User', {'username': 'bob'}) + user_a['username'] = 'foo' + user_a['email'] = 'bob@example.com' + + user_b = session.create('User', {'username': 'martin'}) + user_b['email'] = 'martin@ftrack.com' + + user_a['email'] = 'bob@example.com' + user_a['first_name'] = 'Bob' + + user_c = session.create('User', {'username': 'neverexist'}) + user_c['email'] = 'ignore@example.com' + session.delete(user_c) + + user_a_entity_key = ftrack_api.inspection.primary_key(user_a).values() + user_b_entity_key = ftrack_api.inspection.primary_key(user_b).values() + + session.commit() + + # The above operations should have translated into three payloads to call + # (two creates and one update). + payloads = mocked.call_args[0][0] + assert len(payloads) == 3 + + assert payloads[0]['action'] == 'create' + assert payloads[0]['entity_key'] == user_a_entity_key + assert set(payloads[0]['entity_data'].keys()) == set([ + '__entity_type__', 'id', 'resource_type', 'username' + ]) + + assert payloads[1]['action'] == 'create' + assert payloads[1]['entity_key'] == user_b_entity_key + assert set(payloads[1]['entity_data'].keys()) == set([ + '__entity_type__', 'id', 'resource_type', 'username', 'email' + ]) + + assert payloads[2]['action'] == 'update' + assert payloads[2]['entity_key'] == user_a_entity_key + assert set(payloads[2]['entity_data'].keys()) == set([ + '__entity_type__', 'email', 'first_name' + ]) + + +def test_state_collection(session, unique_name, user): + '''Session state collection holds correct entities.''' + # NOT_SET + user_a = session.create('User', {'username': unique_name}) + session.commit() + + # CREATED + user_b = session.create('User', {'username': unique_name}) + user_b['username'] = 'changed' + + # MODIFIED + user_c = user + user_c['username'] = 'changed' + + # DELETED + user_d = session.create('User', {'username': unique_name}) + session.delete(user_d) + + assert session.created == [user_b] + assert session.modified == [user_c] + assert session.deleted == [user_d] + + +def test_get_entity_with_composite_primary_key(session, new_project): + '''Retrieve entity that uses a composite primary key.''' + entity = session.create('Metadata', { + 'key': 'key', 'value': 'value', + 'parent_type': new_project.entity_type, + 'parent_id': new_project['id'] + }) + + session.commit() + + # Avoid cache. + new_session = ftrack_api.Session() + retrieved_entity = new_session.get( + 'Metadata', ftrack_api.inspection.primary_key(entity).values() + ) + + assert retrieved_entity == entity + + +def test_get_entity_with_incomplete_composite_primary_key(session, new_project): + '''Fail to retrieve entity using incomplete composite primary key.''' + entity = session.create('Metadata', { + 'key': 'key', 'value': 'value', + 'parent_type': new_project.entity_type, + 'parent_id': new_project['id'] + }) + + session.commit() + + # Avoid cache. + new_session = ftrack_api.Session() + with pytest.raises(ValueError): + new_session.get( + 'Metadata', ftrack_api.inspection.primary_key(entity).values()[0] + ) + + +def test_populate_entity(session, new_user): + '''Populate entity that uses single primary key.''' + with session.auto_populating(False): + assert new_user['email'] is ftrack_api.symbol.NOT_SET + + session.populate(new_user, 'email') + assert new_user['email'] is not ftrack_api.symbol.NOT_SET + + +def test_populate_entities(session, unique_name): + '''Populate multiple entities that use single primary key.''' + users = [] + for index in range(3): + users.append( + session.create( + 'User', {'username': '{0}-{1}'.format(unique_name, index)} + ) + ) + + session.commit() + + with session.auto_populating(False): + for user in users: + assert user['email'] is ftrack_api.symbol.NOT_SET + + session.populate(users, 'email') + + for user in users: + assert user['email'] is not ftrack_api.symbol.NOT_SET + + +def test_populate_entity_with_composite_primary_key(session, new_project): + '''Populate entity that uses a composite primary key.''' + entity = session.create('Metadata', { + 'key': 'key', 'value': 'value', + 'parent_type': new_project.entity_type, + 'parent_id': new_project['id'] + }) + + session.commit() + + # Avoid cache. + new_session = ftrack_api.Session() + retrieved_entity = new_session.get( + 'Metadata', ftrack_api.inspection.primary_key(entity).values() + ) + + # Manually change already populated remote value so can test it gets reset + # on populate call. + retrieved_entity.attributes.get('value').set_remote_value( + retrieved_entity, 'changed' + ) + + new_session.populate(retrieved_entity, 'value') + assert retrieved_entity['value'] == 'value' + + +@pytest.mark.parametrize('server_information, compatible', [ + ({}, False), + ({'version': '3.3.11'}, True), + ({'version': '3.3.12'}, True), + ({'version': '3.4'}, True), + ({'version': '3.4.1'}, True), + ({'version': '3.5.16'}, True), + ({'version': '3.3.10'}, False) +], ids=[ + 'No information', + 'Valid current version', + 'Valid higher version', + 'Valid higher version', + 'Valid higher version', + 'Valid higher version', + 'Invalid lower version' +]) +def test_check_server_compatibility( + server_information, compatible, session +): + '''Check server compatibility.''' + with mock.patch.dict( + session._server_information, server_information, clear=True + ): + if compatible: + session.check_server_compatibility() + else: + with pytest.raises(ftrack_api.exception.ServerCompatibilityError): + session.check_server_compatibility() + + +def test_encode_entity_using_all_attributes_strategy(mocked_schema_session): + '''Encode entity using "all" entity_attribute_strategy.''' + new_bar = mocked_schema_session.create( + 'Bar', + { + 'name': 'myBar', + 'id': 'bar_unique_id' + } + ) + + new_foo = mocked_schema_session.create( + 'Foo', + { + 'id': 'a_unique_id', + 'string': 'abc', + 'integer': 42, + 'number': 12345678.9, + 'boolean': False, + 'date': arrow.get('2015-11-18 15:24:09'), + 'bars': [new_bar] + } + ) + + encoded = mocked_schema_session.encode( + new_foo, entity_attribute_strategy='all' + ) + + assert encoded == textwrap.dedent(''' + {"__entity_type__": "Foo", + "bars": [{"__entity_type__": "Bar", "id": "bar_unique_id"}], + "boolean": false, + "date": {"__type__": "datetime", "value": "2015-11-18T15:24:09+00:00"}, + "id": "a_unique_id", + "integer": 42, + "number": 12345678.9, + "string": "abc"} + ''').replace('\n', '') + + +def test_encode_entity_using_only_set_attributes_strategy( + mocked_schema_session +): + '''Encode entity using "set_only" entity_attribute_strategy.''' + new_foo = mocked_schema_session.create( + 'Foo', + { + 'id': 'a_unique_id', + 'string': 'abc', + 'integer': 42 + } + ) + + encoded = mocked_schema_session.encode( + new_foo, entity_attribute_strategy='set_only' + ) + + assert encoded == textwrap.dedent(''' + {"__entity_type__": "Foo", + "id": "a_unique_id", + "integer": 42, + "string": "abc"} + ''').replace('\n', '') + + +def test_encode_computed_attribute_using_persisted_only_attributes_strategy( + mocked_schema_session +): + '''Encode computed attribute, "persisted_only" entity_attribute_strategy.''' + new_bar = mocked_schema_session._create( + 'Bar', + { + 'name': 'myBar', + 'id': 'bar_unique_id', + 'computed_value': 'FOO' + }, + reconstructing=True + ) + + encoded = mocked_schema_session.encode( + new_bar, entity_attribute_strategy='persisted_only' + ) + + assert encoded == textwrap.dedent(''' + {"__entity_type__": "Bar", + "id": "bar_unique_id", + "name": "myBar"} + ''').replace('\n', '') + + +def test_encode_entity_using_only_modified_attributes_strategy( + mocked_schema_session +): + '''Encode entity using "modified_only" entity_attribute_strategy.''' + new_foo = mocked_schema_session._create( + 'Foo', + { + 'id': 'a_unique_id', + 'string': 'abc', + 'integer': 42 + }, + reconstructing=True + ) + + new_foo['string'] = 'Modified' + + encoded = mocked_schema_session.encode( + new_foo, entity_attribute_strategy='modified_only' + ) + + assert encoded == textwrap.dedent(''' + {"__entity_type__": "Foo", + "id": "a_unique_id", + "string": "Modified"} + ''').replace('\n', '') + + +def test_encode_entity_using_invalid_strategy(session, new_task): + '''Fail to encode entity using invalid strategy.''' + with pytest.raises(ValueError): + session.encode(new_task, entity_attribute_strategy='invalid') + + +def test_encode_operation_payload(session): + '''Encode operation payload.''' + sequence_component = session.create_component( + "/path/to/sequence.%d.jpg [1]", location=None + ) + file_component = sequence_component["members"][0] + + encoded = session.encode([ + ftrack_api.session.OperationPayload({ + 'action': 'create', + 'entity_data': { + '__entity_type__': u'FileComponent', + u'container': sequence_component, + 'id': file_component['id'] + }, + 'entity_key': [file_component['id']], + 'entity_type': u'FileComponent' + }), + ftrack_api.session.OperationPayload({ + 'action': 'update', + 'entity_data': { + '__entity_type__': u'SequenceComponent', + u'members': ftrack_api.collection.Collection( + sequence_component, + sequence_component.attributes.get('members'), + data=[file_component] + ) + }, + 'entity_key': [sequence_component['id']], + 'entity_type': u'SequenceComponent' + }) + ]) + + expected = textwrap.dedent(''' + [{{"action": "create", + "entity_data": {{"__entity_type__": "FileComponent", + "container": {{"__entity_type__": "SequenceComponent", + "id": "{0[id]}"}}, + "id": "{1[id]}"}}, + "entity_key": ["{1[id]}"], + "entity_type": "FileComponent"}}, + {{"action": "update", + "entity_data": {{"__entity_type__": "SequenceComponent", + "members": [{{"__entity_type__": "FileComponent", "id": "{1[id]}"}}]}}, + "entity_key": ["{0[id]}"], + "entity_type": "SequenceComponent"}}] + '''.format(sequence_component, file_component)).replace('\n', '') + + assert encoded == expected + + +def test_decode_partial_entity( + session, new_task +): + '''Decode partially encoded entity.''' + encoded = session.encode( + new_task, entity_attribute_strategy='set_only' + ) + + entity = session.decode(encoded) + + assert entity == new_task + assert entity is not new_task + + +def test_reset(mocker): + '''Reset session.''' + plugin_path = os.path.abspath( + os.path.join(os.path.dirname(__file__), '..', 'fixture', 'plugin') + ) + session = ftrack_api.Session(plugin_paths=[plugin_path]) + + assert hasattr(session.types.get('User'), 'stub') + location = session.query('Location where name is "test.location"').one() + assert location.accessor is not ftrack_api.symbol.NOT_SET + + mocked_close = mocker.patch.object(session._request, 'close') + mocked_fetch = mocker.patch.object(session, '_load_schemas') + + session.reset() + + # Assert custom entity type maintained. + assert hasattr(session.types.get('User'), 'stub') + + # Assert location plugin re-configured. + location = session.query('Location where name is "test.location"').one() + assert location.accessor is not ftrack_api.symbol.NOT_SET + + # Assert connection not closed and no schema fetch issued. + assert not mocked_close.called + assert not mocked_fetch.called + + +def test_rollback_scalar_attribute_change(session, new_user): + '''Rollback scalar attribute change via session.''' + assert not session.recorded_operations + current_first_name = new_user['first_name'] + + new_user['first_name'] = 'NewName' + assert new_user['first_name'] == 'NewName' + assert session.recorded_operations + + session.rollback() + + assert not session.recorded_operations + assert new_user['first_name'] == current_first_name + + +def test_rollback_collection_attribute_change(session, new_user): + '''Rollback collection attribute change via session.''' + assert not session.recorded_operations + current_timelogs = new_user['timelogs'] + assert list(current_timelogs) == [] + + timelog = session.create('Timelog', {}) + new_user['timelogs'].append(timelog) + assert list(new_user['timelogs']) == [timelog] + assert session.recorded_operations + + session.rollback() + + assert not session.recorded_operations + assert list(new_user['timelogs']) == [] + + +def test_rollback_entity_creation(session): + '''Rollback entity creation via session.''' + assert not session.recorded_operations + + new_user = session.create('User') + assert session.recorded_operations + assert new_user in session.created + + session.rollback() + + assert not session.recorded_operations + assert new_user not in session.created + assert new_user not in session._local_cache.values() + + +def test_rollback_entity_deletion(session, new_user): + '''Rollback entity deletion via session.''' + assert not session.recorded_operations + + session.delete(new_user) + assert session.recorded_operations + assert new_user in session.deleted + + session.rollback() + assert not session.recorded_operations + assert new_user not in session.deleted + assert new_user in session._local_cache.values() + + +# Caching +# ------------------------------------------------------------------------------ + + +def test_get_entity_bypassing_cache(session, user, mocker): + '''Retrieve an entity by type and id bypassing cache.''' + mocker.patch.object(session, 'call', wraps=session.call) + + session.cache.remove( + session.cache_key_maker.key(ftrack_api.inspection.identity(user)) + ) + + matching = session.get(*ftrack_api.inspection.identity(user)) + + # Check a different instance returned. + assert matching is not user + + # Check instances have the same identity. + assert matching == user + + # Check cache was bypassed and server was called. + assert session.call.called + + +def test_get_entity_from_cache(cache, task, mocker): + '''Retrieve an entity by type and id from cache.''' + session = ftrack_api.Session(cache=cache) + + # Prepare cache. + session.merge(task) + + # Disable server calls. + mocker.patch.object(session, 'call') + + # Retrieve entity from cache. + entity = session.get(*ftrack_api.inspection.identity(task)) + + assert entity is not None, 'Failed to retrieve entity from cache.' + assert entity == task + assert entity is not task + + # Check that no call was made to server. + assert not session.call.called + + +def test_get_entity_tree_from_cache(cache, new_project_tree, mocker): + '''Retrieve an entity tree from cache.''' + session = ftrack_api.Session(cache=cache) + + # Prepare cache. + # TODO: Maybe cache should be prepopulated for a better check here. + session.query( + 'select children, children.children, children.children.children, ' + 'children.children.children.assignments, ' + 'children.children.children.assignments.resource ' + 'from Project where id is "{0}"' + .format(new_project_tree['id']) + ).one() + + # Disable server calls. + mocker.patch.object(session, 'call') + + # Retrieve entity from cache. + entity = session.get(*ftrack_api.inspection.identity(new_project_tree)) + + assert entity is not None, 'Failed to retrieve entity from cache.' + assert entity == new_project_tree + assert entity is not new_project_tree + + # Check tree. + with session.auto_populating(False): + for sequence in entity['children']: + for shot in sequence['children']: + for task in shot['children']: + assignments = task['assignments'] + for assignment in assignments: + resource = assignment['resource'] + + assert resource is not ftrack_api.symbol.NOT_SET + + # Check that no call was made to server. + assert not session.call.called + + +def test_get_metadata_from_cache(session, mocker, cache, new_task): + '''Retrieve an entity along with its metadata from cache.''' + new_task['metadata']['key'] = 'value' + session.commit() + + fresh_session = ftrack_api.Session(cache=cache) + + # Prepare cache. + fresh_session.query( + 'select metadata.key, metadata.value from ' + 'Task where id is "{0}"' + .format(new_task['id']) + ).all() + + # Disable server calls. + mocker.patch.object(fresh_session, 'call') + + # Retrieve entity from cache. + entity = fresh_session.get(*ftrack_api.inspection.identity(new_task)) + + assert entity is not None, 'Failed to retrieve entity from cache.' + assert entity == new_task + assert entity is not new_task + + # Check metadata cached correctly. + with fresh_session.auto_populating(False): + metadata = entity['metadata'] + assert metadata['key'] == 'value' + + assert not fresh_session.call.called + + +def test_merge_circular_reference(cache, temporary_file): + '''Merge circular reference into cache.''' + session = ftrack_api.Session(cache=cache) + # The following will test the condition as a FileComponent will be created + # with corresponding ComponentLocation. The server will return the file + # component data with the component location embedded. The component + # location will in turn have an embedded reference to the file component. + # If the merge does not prioritise the primary keys of the instance then + # any cache that relies on using the identity of the file component will + # fail. + component = session.create_component(path=temporary_file) + assert component + + +def test_create_with_selective_cache(session): + '''Create entity does not store entity in selective cache.''' + cache = ftrack_api.cache.MemoryCache() + session.cache.caches.append(SelectiveCache(cache)) + try: + user = session.create('User', {'username': 'martin'}) + cache_key = session.cache_key_maker.key( + ftrack_api.inspection.identity(user) + ) + + with pytest.raises(KeyError): + cache.get(cache_key) + + finally: + session.cache.caches.pop() + + +def test_correct_file_type_on_sequence_component(session): + '''Create sequence component with correct file type.''' + path = '/path/to/image/sequence.%04d.dpx [1-10]' + sequence_component = session.create_component(path) + + assert sequence_component['file_type'] == '.dpx' + + +def test_read_schemas_from_cache( + session, temporary_valid_schema_cache +): + '''Read valid content from schema cache.''' + expected_hash = 'a98d0627b5e33966e43e1cb89b082db7' + + schemas, hash_ = session._read_schemas_from_cache( + temporary_valid_schema_cache + ) + + assert expected_hash == hash_ + + +def test_fail_to_read_schemas_from_invalid_cache( + session, temporary_invalid_schema_cache +): + '''Fail to read invalid content from schema cache.''' + with pytest.raises(ValueError): + session._read_schemas_from_cache( + temporary_invalid_schema_cache + ) + + +def test_write_schemas_to_cache( + session, temporary_valid_schema_cache +): + '''Write valid content to schema cache.''' + expected_hash = 'a98d0627b5e33966e43e1cb89b082db7' + schemas, _ = session._read_schemas_from_cache(temporary_valid_schema_cache) + + session._write_schemas_to_cache(schemas, temporary_valid_schema_cache) + + schemas, hash_ = session._read_schemas_from_cache( + temporary_valid_schema_cache + ) + + assert expected_hash == hash_ + + +def test_fail_to_write_invalid_schemas_to_cache( + session, temporary_valid_schema_cache +): + '''Fail to write invalid content to schema cache.''' + # Datetime not serialisable by default. + invalid_content = datetime.datetime.now() + + with pytest.raises(TypeError): + session._write_schemas_to_cache( + invalid_content, temporary_valid_schema_cache + ) + + +def test_load_schemas_from_valid_cache( + mocker, session, temporary_valid_schema_cache, mocked_schemas +): + '''Load schemas from cache.''' + expected_schemas = session._load_schemas(temporary_valid_schema_cache) + + mocked = mocker.patch.object(session, 'call') + schemas = session._load_schemas(temporary_valid_schema_cache) + + assert schemas == expected_schemas + assert not mocked.called + + +def test_load_schemas_from_server_when_cache_invalid( + mocker, session, temporary_invalid_schema_cache +): + '''Load schemas from server when cache invalid.''' + mocked = mocker.patch.object(session, 'call', wraps=session.call) + + session._load_schemas(temporary_invalid_schema_cache) + assert mocked.called + + +def test_load_schemas_from_server_when_cache_outdated( + mocker, session, temporary_valid_schema_cache +): + '''Load schemas from server when cache outdated.''' + schemas, _ = session._read_schemas_from_cache(temporary_valid_schema_cache) + schemas.append({ + 'id': 'NewTest' + }) + session._write_schemas_to_cache(schemas, temporary_valid_schema_cache) + + mocked = mocker.patch.object(session, 'call', wraps=session.call) + session._load_schemas(temporary_valid_schema_cache) + + assert mocked.called + + +def test_load_schemas_from_server_not_reporting_schema_hash( + mocker, session, temporary_valid_schema_cache +): + '''Load schemas from server when server does not report schema hash.''' + mocked_write = mocker.patch.object( + session, '_write_schemas_to_cache', + wraps=session._write_schemas_to_cache + ) + + server_information = session._server_information.copy() + server_information.pop('schema_hash') + mocker.patch.object( + session, '_server_information', new=server_information + ) + + session._load_schemas(temporary_valid_schema_cache) + + # Cache still written even if hash not reported. + assert mocked_write.called + + mocked = mocker.patch.object(session, 'call', wraps=session.call) + session._load_schemas(temporary_valid_schema_cache) + + # No hash reported by server so cache should have been bypassed. + assert mocked.called + + +def test_load_schemas_bypassing_cache( + mocker, session, temporary_valid_schema_cache +): + '''Load schemas bypassing cache when set to False.''' + with mocker.patch.object(session, 'call', wraps=session.call): + + session._load_schemas(temporary_valid_schema_cache) + assert session.call.call_count == 1 + + session._load_schemas(False) + assert session.call.call_count == 2 + + +def test_get_tasks_widget_url(session): + '''Tasks widget URL returns valid HTTP status.''' + url = session.get_widget_url('tasks') + response = requests.get(url) + response.raise_for_status() + + +def test_get_info_widget_url(session, task): + '''Info widget URL for *task* returns valid HTTP status.''' + url = session.get_widget_url('info', entity=task, theme='light') + response = requests.get(url) + response.raise_for_status() + + +def test_encode_media_from_path(session, video_path): + '''Encode media based on a file path.''' + job = session.encode_media(video_path) + + assert job.entity_type == 'Job' + + job_data = json.loads(job['data']) + assert 'output' in job_data + assert 'source_component_id' in job_data + assert 'keep_original' in job_data and job_data['keep_original'] is False + assert len(job_data['output']) + assert 'component_id' in job_data['output'][0] + assert 'format' in job_data['output'][0] + + +def test_encode_media_from_component(session, video_path): + '''Encode media based on a component.''' + location = session.query('Location where name is "ftrack.server"').one() + component = session.create_component( + video_path, + location=location + ) + session.commit() + + job = session.encode_media(component) + + assert job.entity_type == 'Job' + + job_data = json.loads(job['data']) + assert 'keep_original' in job_data and job_data['keep_original'] is True + + +def test_create_sequence_component_with_size(session, temporary_sequence): + '''Create a sequence component and verify that is has a size.''' + location = session.query('Location where name is "ftrack.server"').one() + component = session.create_component( + temporary_sequence + ) + + assert component['size'] > 0 + + +def test_plugin_arguments(mocker): + '''Pass plugin arguments to plugin discovery mechanism.''' + mock = mocker.patch( + 'ftrack_api.plugin.discover' + ) + session = ftrack_api.Session( + plugin_paths=[], plugin_arguments={"test": "value"} + ) + assert mock.called + mock.assert_called_once_with([], [session], {"test": "value"}) + +def test_remote_reset(session, new_user): + '''Reset user api key.''' + key_1 = session.reset_remote( + 'api_key', entity=new_user + ) + + key_2 = session.reset_remote( + 'api_key', entity=new_user + ) + + + assert key_1 != key_2 + + +@pytest.mark.parametrize('attribute', [ + ('id',), + ('email',) + +], ids=[ + 'Fail resetting primary key', + 'Fail resetting attribute without default value', +]) +def test_fail_remote_reset(session, user, attribute): + '''Fail trying to rest invalid attributes.''' + + with pytest.raises(ftrack_api.exception.ServerError): + session.reset_remote( + attribute, user + ) + + +def test_close(session): + '''Close session.''' + assert session.closed is False + session.close() + assert session.closed is True + + +def test_close_already_closed_session(session): + '''Close session that is already closed.''' + session.close() + assert session.closed is True + session.close() + assert session.closed is True + + +def test_server_call_after_close(session): + '''Fail to issue calls to server after session closed.''' + session.close() + assert session.closed is True + + with pytest.raises(ftrack_api.exception.ConnectionClosedError): + session.query('User').first() + + +def test_context_manager(session): + '''Use session as context manager.''' + with session: + assert session.closed is False + + assert session.closed is True + + +def test_delayed_job(session): + '''Test the delayed_job action''' + + with pytest.raises(ValueError): + session.delayed_job( + 'DUMMY_JOB' + ) + + +@pytest.mark.skip(reason='No configured ldap server.') +def test_delayed_job_ldap_sync(session): + '''Test the a delayed_job ldap sync action''' + result = session.delayed_job( + ftrack_api.symbol.JOB_SYNC_USERS_LDAP + ) + + assert isinstance( + result, ftrack_api.entity.job.Job + ) + + +def test_query_nested_custom_attributes(session, new_asset_version): + '''Query custom attributes nested and update a value and query again. + + This test will query custom attributes via 2 relations, then update the + value in one API session and read it back in another to verify that it gets + the new value. + + ''' + session_one = session + session_two = ftrack_api.Session( + auto_connect_event_hub=False + ) + + # Read the version via a relation in both sessions. + def get_versions(sessions): + versions = [] + for _session in sessions: + asset = _session.query( + 'select versions.custom_attributes from Asset where id is "{0}"'.format( + new_asset_version.get('asset_id') + ) + ).first() + + for version in asset['versions']: + if version.get('id') == new_asset_version.get('id'): + versions.append(version) + + return versions + + # Get version from both sessions. + versions = get_versions((session_one, session_two)) + + # Read attribute for both sessions. + for version in versions: + version['custom_attributes']['versiontest'] + + # Set attribute on session_one. + versions[0]['custom_attributes']['versiontest'] = random.randint( + 0, 99999 + ) + + session.commit() + + # Read version from server for session_two. + session_two_version = get_versions((session_two, ))[0] + + # Verify that value in session 2 is the same as set and committed in + # session 1. + assert ( + session_two_version['custom_attributes']['versiontest'] == + versions[0]['custom_attributes']['versiontest'] + ) + + +def test_query_nested(session): + '''Query components nested and update a value and query again. + + This test will query components via 2 relations, then update the + value in one API session and read it back in another to verify that it gets + the new value. + + ''' + session_one = session + session_two = ftrack_api.Session( + auto_connect_event_hub=False + ) + + query = ( + 'select versions.components.name from Asset where id is ' + '"12939d0c-6766-11e1-8104-f23c91df25eb"' + ) + + def get_version(session): + '''Return the test version from *session*.''' + asset = session.query(query).first() + asset_version = None + for version in asset['versions']: + if version['version'] == 8: + asset_version = version + break + + return asset_version + + asset_version = get_version(session_one) + asset_version2 = get_version(session_two) + + # This assert is not needed, but reading the collections are to ensure they + # are inflated. + assert ( + asset_version2['components'][0]['name'] == + asset_version['components'][0]['name'] + ) + + asset_version['components'][0]['name'] = str(uuid.uuid4()) + + session.commit() + + asset_version2 = get_version(session_two) + + assert ( + asset_version['components'][0]['name'] == + asset_version2['components'][0]['name'] + ) + + +def test_merge_iterations(session, mocker, project): + '''Ensure merge does not happen to many times when querying.''' + mocker.spy(session, '_merge') + + session.query( + 'select status from Task where project_id is {} limit 10'.format( + project['id'] + ) + ).all() + + assert session._merge.call_count < 75 + + +@pytest.mark.parametrize( + 'get_versions', + [ + lambda component, asset_version, asset: component['version']['asset']['versions'], + lambda component, asset_version, asset: asset_version['asset']['versions'], + lambda component, asset_version, asset: asset['versions'], + ], + ids=[ + 'from_component', + 'from_asset_version', + 'from_asset', + ] +) +def test_query_nested2(session, get_versions): + '''Query version.asset.versions from component and then add new version. + + This test will query versions via multiple relations and ensure a new + version appears when added to a different session and then is queried + again. + + ''' + session_one = session + session_two = ftrack_api.Session( + auto_connect_event_hub=False + ) + + # Get a random component that is linked to a version and asset. + component_id = session_two.query( + 'FileComponent where version.asset_id != None' + ).first()['id'] + + query = ( + 'select version.asset.versions from Component where id is "{}"'.format( + component_id + ) + ) + + component = session_one.query(query).one() + asset_version = component['version'] + asset = component['version']['asset'] + versions = component['version']['asset']['versions'] + length = len(versions) + + session_two.create('AssetVersion', { + 'asset_id': asset['id'] + }) + + session_two.commit() + + component = session_one.query(query).one() + versions = get_versions(component, asset_version, asset) + new_length = len(versions) + + assert length + 1 == new_length + + +def test_session_ready_reset_events(mocker): + '''Session ready and reset events.''' + plugin_path = os.path.abspath( + os.path.join(os.path.dirname(__file__), '..', 'fixture', 'plugin') + ) + session = ftrack_api.Session(plugin_paths=[plugin_path]) + + assert session._test_called_events['ftrack.api.session.ready'] is 1 + assert session._test_called_events['ftrack.api.session.reset'] is 0 + + session.reset() + assert session._test_called_events['ftrack.api.session.ready'] is 1 + assert session._test_called_events['ftrack.api.session.reset'] is 1 + + +def test_entity_reference(mocker, session): + '''Return entity reference that uniquely identifies entity.''' + mock_entity = mocker.Mock(entity_type="MockEntityType") + mock_auto_populating = mocker.patch.object(session, "auto_populating") + mock_primary_key = mocker.patch( + "ftrack_api.inspection.primary_key", return_value={"id": "mock-id"} + ) + + reference = session.entity_reference(mock_entity) + + assert reference == { + "__entity_type__": "MockEntityType", + "id": "mock-id" + } + + mock_auto_populating.assert_called_once_with(False) + mock_primary_key.assert_called_once_with(mock_entity) + + +def test__entity_reference(mocker, session): + '''Act as alias to entity_reference.''' + mock_entity = mocker.Mock(entity_type="MockEntityType") + mock_entity_reference = mocker.patch.object(session, "entity_reference") + mocker.patch("warnings.warn") + + session._entity_reference(mock_entity) + + mock_entity_reference.assert_called_once_with(mock_entity) + + +def test__entity_reference_issues_deprecation_warning(mocker, session): + '''Issue deprecation warning for usage of _entity_reference.''' + mocker.patch.object(session, "entity_reference") + mock_warn = mocker.patch("warnings.warn") + + session._entity_reference({}) + + mock_warn.assert_called_once_with( + ( + "Session._entity_reference is now available as public method " + "Session.entity_reference. The private method will be removed " + "in version 2.0." + ), + PendingDeprecationWarning + ) diff --git a/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_timer.py b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_timer.py new file mode 100644 index 0000000000..cf8b014ee5 --- /dev/null +++ b/openpype/modules/ftrack/python2_vendor/ftrack-python-api/test/unit/test_timer.py @@ -0,0 +1,74 @@ +# :coding: utf-8 +# :copyright: Copyright (c) 2015 ftrack + +import pytest +import ftrack_api.exception + + +def test_manually_create_multiple_timers_with_error(session, new_user): + '''Fail to create a second timer.''' + session.create('Timer', { + 'user': new_user + }) + + session.commit() + + with pytest.raises(ftrack_api.exception.ServerError): + session.create('Timer', { + 'user': new_user + }) + + session.commit() + + session.reset() + + +def test_create_multiple_timers_with_error(session, new_user): + '''Fail to create a second timer.''' + new_user.start_timer() + + with pytest.raises(ftrack_api.exception.NotUniqueError): + new_user.start_timer() + + session.reset() + + +def test_start_and_stop_a_timer(session, new_user, new_task): + '''Start a new timer and stop it to create a timelog.''' + new_user.start_timer(new_task) + + new_user.stop_timer() + + timelog = session.query( + 'Timelog where context_id = "{0}"'.format(new_task['id']) + ).one() + + assert timelog['user_id'] == new_user['id'], 'User id is correct.' + assert timelog['context_id'] == new_task['id'], 'Task id is correct.' + + +def test_start_a_timer_when_timer_is_running(session, new_user, new_task): + '''Start a timer when an existing timer is already running.''' + new_user.start_timer(new_task) + + # Create the second timer without context. + new_user.start_timer(force=True) + + # There should be only one existing timelog for this user. + timelogs = session.query( + 'Timelog where user_id = "{0}"'.format(new_user['id']) + ).all() + assert len(timelogs) == 1, 'One timelog exists.' + + timelog = session.query( + 'Timer where user_id = "{0}"'.format(new_user['id']) + ).one() + + # Make sure running timer has no context. + assert timelog['context_id'] is None, 'Timer does not have a context.' + + +def test_stop_timer_without_timer_running(session, new_user): + '''Stop a timer when no timer is running.''' + with pytest.raises(ftrack_api.exception.NoResultFoundError): + new_user.stop_timer() diff --git a/openpype/modules/default_modules/ftrack/scripts/sub_event_processor.py b/openpype/modules/ftrack/scripts/sub_event_processor.py similarity index 100% rename from openpype/modules/default_modules/ftrack/scripts/sub_event_processor.py rename to openpype/modules/ftrack/scripts/sub_event_processor.py diff --git a/openpype/modules/default_modules/ftrack/scripts/sub_event_status.py b/openpype/modules/ftrack/scripts/sub_event_status.py similarity index 100% rename from openpype/modules/default_modules/ftrack/scripts/sub_event_status.py rename to openpype/modules/ftrack/scripts/sub_event_status.py diff --git a/openpype/modules/default_modules/ftrack/scripts/sub_event_storer.py b/openpype/modules/ftrack/scripts/sub_event_storer.py similarity index 100% rename from openpype/modules/default_modules/ftrack/scripts/sub_event_storer.py rename to openpype/modules/ftrack/scripts/sub_event_storer.py diff --git a/openpype/modules/default_modules/ftrack/scripts/sub_legacy_server.py b/openpype/modules/ftrack/scripts/sub_legacy_server.py similarity index 100% rename from openpype/modules/default_modules/ftrack/scripts/sub_legacy_server.py rename to openpype/modules/ftrack/scripts/sub_legacy_server.py diff --git a/openpype/modules/default_modules/ftrack/scripts/sub_user_server.py b/openpype/modules/ftrack/scripts/sub_user_server.py similarity index 100% rename from openpype/modules/default_modules/ftrack/scripts/sub_user_server.py rename to openpype/modules/ftrack/scripts/sub_user_server.py diff --git a/openpype/modules/default_modules/ftrack/tray/__init__.py b/openpype/modules/ftrack/tray/__init__.py similarity index 100% rename from openpype/modules/default_modules/ftrack/tray/__init__.py rename to openpype/modules/ftrack/tray/__init__.py diff --git a/openpype/modules/default_modules/ftrack/tray/ftrack_tray.py b/openpype/modules/ftrack/tray/ftrack_tray.py similarity index 100% rename from openpype/modules/default_modules/ftrack/tray/ftrack_tray.py rename to openpype/modules/ftrack/tray/ftrack_tray.py diff --git a/openpype/modules/default_modules/ftrack/tray/login_dialog.py b/openpype/modules/ftrack/tray/login_dialog.py similarity index 100% rename from openpype/modules/default_modules/ftrack/tray/login_dialog.py rename to openpype/modules/ftrack/tray/login_dialog.py diff --git a/openpype/modules/default_modules/ftrack/tray/login_tools.py b/openpype/modules/ftrack/tray/login_tools.py similarity index 100% rename from openpype/modules/default_modules/ftrack/tray/login_tools.py rename to openpype/modules/ftrack/tray/login_tools.py diff --git a/openpype/modules/interfaces.py b/openpype/modules/interfaces.py index 7c301c15b4..13cbea690b 100644 --- a/openpype/modules/interfaces.py +++ b/openpype/modules/interfaces.py @@ -122,6 +122,7 @@ class ITrayAction(ITrayModule): admin_action = False _admin_submenu = None + _action_item = None @property @abstractmethod @@ -149,6 +150,7 @@ class ITrayAction(ITrayModule): tray_menu.addAction(action) action.triggered.connect(self.on_action_trigger) + self._action_item = action def tray_start(self): return diff --git a/openpype/modules/log_viewer/tray/widgets.py b/openpype/modules/log_viewer/tray/widgets.py index 5a67780413..ff77405de5 100644 --- a/openpype/modules/log_viewer/tray/widgets.py +++ b/openpype/modules/log_viewer/tray/widgets.py @@ -1,5 +1,5 @@ from Qt import QtCore, QtWidgets -from avalon.vendor import qtawesome +import qtawesome from .models import LogModel, LogsFilterProxy diff --git a/openpype/modules/default_modules/royal_render/__init__.py b/openpype/modules/royalrender/__init__.py similarity index 100% rename from openpype/modules/default_modules/royal_render/__init__.py rename to openpype/modules/royalrender/__init__.py diff --git a/openpype/modules/default_modules/royal_render/api.py b/openpype/modules/royalrender/api.py similarity index 100% rename from openpype/modules/default_modules/royal_render/api.py rename to openpype/modules/royalrender/api.py diff --git a/openpype/modules/default_modules/royal_render/plugins/publish/collect_default_rr_path.py b/openpype/modules/royalrender/plugins/publish/collect_default_rr_path.py similarity index 100% rename from openpype/modules/default_modules/royal_render/plugins/publish/collect_default_rr_path.py rename to openpype/modules/royalrender/plugins/publish/collect_default_rr_path.py diff --git a/openpype/modules/default_modules/royal_render/plugins/publish/collect_rr_path_from_instance.py b/openpype/modules/royalrender/plugins/publish/collect_rr_path_from_instance.py similarity index 100% rename from openpype/modules/default_modules/royal_render/plugins/publish/collect_rr_path_from_instance.py rename to openpype/modules/royalrender/plugins/publish/collect_rr_path_from_instance.py diff --git a/openpype/modules/default_modules/royal_render/plugins/publish/collect_sequences_from_job.py b/openpype/modules/royalrender/plugins/publish/collect_sequences_from_job.py similarity index 95% rename from openpype/modules/default_modules/royal_render/plugins/publish/collect_sequences_from_job.py rename to openpype/modules/royalrender/plugins/publish/collect_sequences_from_job.py index b389b022cf..4d216c1c0a 100644 --- a/openpype/modules/default_modules/royal_render/plugins/publish/collect_sequences_from_job.py +++ b/openpype/modules/royalrender/plugins/publish/collect_sequences_from_job.py @@ -77,8 +77,19 @@ class CollectSequencesFromJob(pyblish.api.ContextPlugin): order = pyblish.api.CollectorOrder targets = ["rr_control"] label = "Collect Rendered Frames" + review = True def process(self, context): + + self.review = ( + context.data + ["project_settings"] + ["royalrender"] + ["publish"] + ["CollectSequencesFromJob"] + ["review"] + ) + if os.environ.get("OPENPYPE_PUBLISH_DATA"): self.log.debug(os.environ.get("OPENPYPE_PUBLISH_DATA")) paths = os.environ["OPENPYPE_PUBLISH_DATA"].split(os.pathsep) @@ -150,7 +161,8 @@ class CollectSequencesFromJob(pyblish.api.ContextPlugin): families.append("render") if "ftrack" not in families: families.append("ftrack") - if "review" not in families: + if "review" not in families and self.review: + self.log.info("attaching review") families.append("review") for collection in collections: diff --git a/openpype/modules/default_modules/royal_render/royal_render_module.py b/openpype/modules/royalrender/royal_render_module.py similarity index 100% rename from openpype/modules/default_modules/royal_render/royal_render_module.py rename to openpype/modules/royalrender/royal_render_module.py diff --git a/openpype/modules/default_modules/royal_render/rr_job.py b/openpype/modules/royalrender/rr_job.py similarity index 100% rename from openpype/modules/default_modules/royal_render/rr_job.py rename to openpype/modules/royalrender/rr_job.py diff --git a/openpype/modules/default_modules/royal_render/rr_root/README.md b/openpype/modules/royalrender/rr_root/README.md similarity index 100% rename from openpype/modules/default_modules/royal_render/rr_root/README.md rename to openpype/modules/royalrender/rr_root/README.md diff --git a/openpype/modules/default_modules/royal_render/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py b/openpype/modules/royalrender/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py similarity index 91% rename from openpype/modules/default_modules/royal_render/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py rename to openpype/modules/royalrender/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py index 7fedb51410..82a79daf3b 100644 --- a/openpype/modules/default_modules/royal_render/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py +++ b/openpype/modules/royalrender/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py @@ -20,7 +20,7 @@ class OpenPypeContextSelector: def __init__(self): self.job = rr.getJob() - self.context = None + self.context = {} self.openpype_executable = "openpype_gui" if platform.system().lower() == "windows": @@ -136,7 +136,7 @@ class OpenPypeContextSelector: def run_publish(self): """Run publish process.""" - env = {'AVALON_PROJECT': str(self.context.get("project")), + env = {"AVALON_PROJECT": str(self.context.get("project")), "AVALON_ASSET": str(self.context.get("asset")), "AVALON_TASK": str(self.context.get("task")), "AVALON_APP_NAME": str(self.context.get("app_name"))} @@ -179,4 +179,18 @@ class OpenPypeContextSelector: print("running selector") selector = OpenPypeContextSelector() + +# try to set context from environment +selector.context["project"] = os.getenv("AVALON_PROJECT") +selector.context["asset"] = os.getenv("AVALON_ASSET") +selector.context["task"] = os.getenv("AVALON_TASK") +selector.context["app_name"] = os.getenv("AVALON_APP_NAME") + +# if anything inside is None, scratch the whole thing and +# ask user for context. +for _, v in selector.context.items(): + if not v: + selector.context = {} + break + selector.process_job() diff --git a/openpype/modules/slack/plugins/publish/collect_slack_family.py b/openpype/modules/slack/plugins/publish/collect_slack_family.py index 2110c0703b..6c965b04cd 100644 --- a/openpype/modules/slack/plugins/publish/collect_slack_family.py +++ b/openpype/modules/slack/plugins/publish/collect_slack_family.py @@ -20,18 +20,23 @@ class CollectSlackFamilies(pyblish.api.InstancePlugin): def process(self, instance): task_name = io.Session.get("AVALON_TASK") family = self.main_family_from_instance(instance) - key_values = { "families": family, "tasks": task_name, "hosts": instance.data["anatomyData"]["app"], + "subsets": instance.data["subset"] } profile = filter_profiles(self.profiles, key_values, logger=self.log) + if not profile: + self.log.info("No profile found, notification won't be send") + return + # make slack publishable if profile: + self.log.info("Found profile: {}".format(profile)) if instance.data.get('families'): instance.data['families'].append('slack') else: diff --git a/openpype/modules/slack/plugins/publish/integrate_slack_api.py b/openpype/modules/slack/plugins/publish/integrate_slack_api.py index 5d014382a3..018a7594bb 100644 --- a/openpype/modules/slack/plugins/publish/integrate_slack_api.py +++ b/openpype/modules/slack/plugins/publish/integrate_slack_api.py @@ -60,6 +60,9 @@ class IntegrateSlackAPI(pyblish.api.InstancePlugin): message, publish_files) + if not msg_id: + return + msg = { "type": "slack", "msg_id": msg_id, @@ -118,7 +121,7 @@ class IntegrateSlackAPI(pyblish.api.InstancePlugin): def _get_thumbnail_path(self, instance): """Returns abs url for thumbnail if present in instance repres""" published_path = None - for repre in instance.data['representations']: + for repre in instance.data.get("representations", []): if repre.get('thumbnail') or "thumbnail" in repre.get('tags', []): if os.path.exists(repre["published_path"]): published_path = repre["published_path"] @@ -128,7 +131,7 @@ class IntegrateSlackAPI(pyblish.api.InstancePlugin): def _get_review_path(self, instance): """Returns abs url for review if present in instance repres""" published_path = None - for repre in instance.data['representations']: + for repre in instance.data.get("representations", []): tags = repre.get('tags', []) if (repre.get("review") or "review" in tags @@ -177,6 +180,8 @@ class IntegrateSlackAPI(pyblish.api.InstancePlugin): error_str = self._enrich_error(str(e), channel) self.log.warning("Error happened: {}".format(error_str)) + return None, [] + def _python3_call(self, token, channel, message, publish_files): from slack_sdk import WebClient from slack_sdk.errors import SlackApiError @@ -206,6 +211,8 @@ class IntegrateSlackAPI(pyblish.api.InstancePlugin): error_str = self._enrich_error(str(e.response["error"]), channel) self.log.warning("Error happened {}".format(error_str)) + return None, [] + def _enrich_error(self, error_str, channel): """Enhance known errors with more helpful notations.""" if 'not_in_channel' in error_str: diff --git a/openpype/modules/default_modules/sync_server/README.md b/openpype/modules/sync_server/README.md similarity index 100% rename from openpype/modules/default_modules/sync_server/README.md rename to openpype/modules/sync_server/README.md diff --git a/openpype/modules/default_modules/sync_server/__init__.py b/openpype/modules/sync_server/__init__.py similarity index 100% rename from openpype/modules/default_modules/sync_server/__init__.py rename to openpype/modules/sync_server/__init__.py diff --git a/openpype/modules/sync_server/providers/__init__.py b/openpype/modules/sync_server/providers/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/openpype/modules/default_modules/sync_server/providers/abstract_provider.py b/openpype/modules/sync_server/providers/abstract_provider.py similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/abstract_provider.py rename to openpype/modules/sync_server/providers/abstract_provider.py diff --git a/openpype/modules/default_modules/sync_server/providers/dropbox.py b/openpype/modules/sync_server/providers/dropbox.py similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/dropbox.py rename to openpype/modules/sync_server/providers/dropbox.py diff --git a/openpype/modules/default_modules/sync_server/providers/gdrive.py b/openpype/modules/sync_server/providers/gdrive.py similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/gdrive.py rename to openpype/modules/sync_server/providers/gdrive.py diff --git a/openpype/modules/default_modules/sync_server/providers/lib.py b/openpype/modules/sync_server/providers/lib.py similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/lib.py rename to openpype/modules/sync_server/providers/lib.py diff --git a/openpype/modules/default_modules/sync_server/providers/local_drive.py b/openpype/modules/sync_server/providers/local_drive.py similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/local_drive.py rename to openpype/modules/sync_server/providers/local_drive.py diff --git a/openpype/modules/default_modules/sync_server/providers/resources/dropbox.png b/openpype/modules/sync_server/providers/resources/dropbox.png similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/resources/dropbox.png rename to openpype/modules/sync_server/providers/resources/dropbox.png diff --git a/openpype/modules/default_modules/sync_server/providers/resources/folder.png b/openpype/modules/sync_server/providers/resources/folder.png similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/resources/folder.png rename to openpype/modules/sync_server/providers/resources/folder.png diff --git a/openpype/modules/default_modules/sync_server/providers/resources/gdrive.png b/openpype/modules/sync_server/providers/resources/gdrive.png similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/resources/gdrive.png rename to openpype/modules/sync_server/providers/resources/gdrive.png diff --git a/openpype/modules/default_modules/sync_server/providers/resources/local_drive.png b/openpype/modules/sync_server/providers/resources/local_drive.png similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/resources/local_drive.png rename to openpype/modules/sync_server/providers/resources/local_drive.png diff --git a/openpype/modules/default_modules/sync_server/providers/resources/sftp.png b/openpype/modules/sync_server/providers/resources/sftp.png similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/resources/sftp.png rename to openpype/modules/sync_server/providers/resources/sftp.png diff --git a/openpype/modules/default_modules/sync_server/providers/resources/studio.png b/openpype/modules/sync_server/providers/resources/studio.png similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/resources/studio.png rename to openpype/modules/sync_server/providers/resources/studio.png diff --git a/openpype/modules/default_modules/sync_server/providers/sftp.py b/openpype/modules/sync_server/providers/sftp.py similarity index 100% rename from openpype/modules/default_modules/sync_server/providers/sftp.py rename to openpype/modules/sync_server/providers/sftp.py diff --git a/openpype/modules/default_modules/sync_server/resources/paused.png b/openpype/modules/sync_server/resources/paused.png similarity index 100% rename from openpype/modules/default_modules/sync_server/resources/paused.png rename to openpype/modules/sync_server/resources/paused.png diff --git a/openpype/modules/default_modules/sync_server/resources/refresh.png b/openpype/modules/sync_server/resources/refresh.png similarity index 100% rename from openpype/modules/default_modules/sync_server/resources/refresh.png rename to openpype/modules/sync_server/resources/refresh.png diff --git a/openpype/modules/default_modules/sync_server/resources/synced.png b/openpype/modules/sync_server/resources/synced.png similarity index 100% rename from openpype/modules/default_modules/sync_server/resources/synced.png rename to openpype/modules/sync_server/resources/synced.png diff --git a/openpype/modules/default_modules/sync_server/sync_server.py b/openpype/modules/sync_server/sync_server.py similarity index 100% rename from openpype/modules/default_modules/sync_server/sync_server.py rename to openpype/modules/sync_server/sync_server.py diff --git a/openpype/modules/default_modules/sync_server/sync_server_module.py b/openpype/modules/sync_server/sync_server_module.py similarity index 100% rename from openpype/modules/default_modules/sync_server/sync_server_module.py rename to openpype/modules/sync_server/sync_server_module.py diff --git a/openpype/modules/default_modules/sync_server/tray/app.py b/openpype/modules/sync_server/tray/app.py similarity index 100% rename from openpype/modules/default_modules/sync_server/tray/app.py rename to openpype/modules/sync_server/tray/app.py diff --git a/openpype/modules/default_modules/sync_server/tray/delegates.py b/openpype/modules/sync_server/tray/delegates.py similarity index 100% rename from openpype/modules/default_modules/sync_server/tray/delegates.py rename to openpype/modules/sync_server/tray/delegates.py diff --git a/openpype/modules/default_modules/sync_server/tray/lib.py b/openpype/modules/sync_server/tray/lib.py similarity index 100% rename from openpype/modules/default_modules/sync_server/tray/lib.py rename to openpype/modules/sync_server/tray/lib.py diff --git a/openpype/modules/default_modules/sync_server/tray/models.py b/openpype/modules/sync_server/tray/models.py similarity index 99% rename from openpype/modules/default_modules/sync_server/tray/models.py rename to openpype/modules/sync_server/tray/models.py index 80f41992cb..7241cc3472 100644 --- a/openpype/modules/default_modules/sync_server/tray/models.py +++ b/openpype/modules/sync_server/tray/models.py @@ -4,9 +4,9 @@ from bson.objectid import ObjectId from Qt import QtCore from Qt.QtCore import Qt +import qtawesome from openpype.tools.utils.delegates import pretty_timestamp -from avalon.vendor import qtawesome from openpype.lib import PypeLogger from openpype.api import get_local_site_id diff --git a/openpype/modules/default_modules/sync_server/tray/widgets.py b/openpype/modules/sync_server/tray/widgets.py similarity index 99% rename from openpype/modules/default_modules/sync_server/tray/widgets.py rename to openpype/modules/sync_server/tray/widgets.py index 18487b3d11..6aae9562cf 100644 --- a/openpype/modules/default_modules/sync_server/tray/widgets.py +++ b/openpype/modules/sync_server/tray/widgets.py @@ -5,6 +5,7 @@ from functools import partial from Qt import QtWidgets, QtCore, QtGui from Qt.QtCore import Qt +import qtawesome from openpype.tools.settings import style @@ -12,7 +13,6 @@ from openpype.api import get_local_site_id from openpype.lib import PypeLogger from openpype.tools.utils.delegates import pretty_timestamp -from avalon.vendor import qtawesome from .models import ( SyncRepresentationSummaryModel, diff --git a/openpype/modules/default_modules/sync_server/utils.py b/openpype/modules/sync_server/utils.py similarity index 100% rename from openpype/modules/default_modules/sync_server/utils.py rename to openpype/modules/sync_server/utils.py diff --git a/openpype/modules/traypublish_action.py b/openpype/modules/traypublish_action.py new file mode 100644 index 0000000000..39163b8eb8 --- /dev/null +++ b/openpype/modules/traypublish_action.py @@ -0,0 +1,49 @@ +import os +from openpype.lib import get_openpype_execute_args +from openpype.lib.execute import run_detached_process +from openpype.modules import OpenPypeModule +from openpype_interfaces import ITrayAction + + +class TrayPublishAction(OpenPypeModule, ITrayAction): + label = "New Publish (beta)" + name = "traypublish_tool" + + def initialize(self, modules_settings): + import openpype + self.enabled = True + self.publish_paths = [ + os.path.join( + openpype.PACKAGE_DIR, + "hosts", + "traypublisher", + "plugins", + "publish" + ) + ] + self._experimental_tools = None + + def tray_init(self): + from openpype.tools.experimental_tools import ExperimentalTools + + self._experimental_tools = ExperimentalTools() + + def tray_menu(self, *args, **kwargs): + super(TrayPublishAction, self).tray_menu(*args, **kwargs) + traypublisher = self._experimental_tools.get("traypublisher") + visible = False + if traypublisher and traypublisher.enabled: + visible = True + self._action_item.setVisible(visible) + + def on_action_trigger(self): + self.run_traypublisher() + + def connect_with_modules(self, enabled_modules): + """Collect publish paths from other modules.""" + publish_paths = self.manager.collect_plugin_paths()["publish"] + self.publish_paths.extend(publish_paths) + + def run_traypublisher(self): + args = get_openpype_execute_args("traypublisher") + run_detached_process(args) diff --git a/openpype/pipeline/__init__.py b/openpype/pipeline/__init__.py index e968df4011..26970e4edc 100644 --- a/openpype/pipeline/__init__.py +++ b/openpype/pipeline/__init__.py @@ -4,11 +4,39 @@ from .create import ( BaseCreator, Creator, AutoCreator, - CreatedInstance + CreatedInstance, + + CreatorError, + + LegacyCreator, + legacy_create, +) + +from .load import ( + HeroVersionType, + IncompatibleLoaderError, + LoaderPlugin, + SubsetLoaderPlugin, + + discover_loader_plugins, + register_loader_plugin, + deregister_loader_plugin_path, + register_loader_plugin_path, + deregister_loader_plugin, + + load_container, + remove_container, + update_container, + switch_container, + + loaders_from_representation, + get_representation_path, + get_repres_contexts, ) from .publish import ( PublishValidationError, + PublishXmlValidationError, KnownPublishError, OpenPypePyblishPluginMixin ) @@ -17,12 +45,42 @@ from .publish import ( __all__ = ( "attribute_definitions", + # --- Create --- "BaseCreator", "Creator", "AutoCreator", "CreatedInstance", + "CreatorError", + + # - legacy creation + "LegacyCreator", + "legacy_create", + + # --- Load --- + "HeroVersionType", + "IncompatibleLoaderError", + "LoaderPlugin", + "SubsetLoaderPlugin", + + "discover_loader_plugins", + "register_loader_plugin", + "deregister_loader_plugin_path", + "register_loader_plugin_path", + "deregister_loader_plugin", + + "load_container", + "remove_container", + "update_container", + "switch_container", + + "loaders_from_representation", + "get_representation_path", + "get_repres_contexts", + + # --- Publish --- "PublishValidationError", + "PublishXmlValidationError", "KnownPublishError", "OpenPypePyblishPluginMixin" ) diff --git a/openpype/pipeline/create/README.md b/openpype/pipeline/create/README.md index 9eef7c72a7..02b64e52ea 100644 --- a/openpype/pipeline/create/README.md +++ b/openpype/pipeline/create/README.md @@ -14,7 +14,7 @@ Except creating and removing instances are all changes not automatically propaga ## CreatedInstance -Product of creation is "instance" which holds basic data defying it. Core data are `creator_identifier`, `family` and `subset`. Other data can be keys used to fill subset name or metadata modifying publishing process of the instance (more described later). All instances have `id` which holds constant `pyblish.avalon.instance` and `uuid` which is identifier of the instance. +Product of creation is "instance" which holds basic data defying it. Core data are `creator_identifier`, `family` and `subset`. Other data can be keys used to fill subset name or metadata modifying publishing process of the instance (more described later). All instances have `id` which holds constant `pyblish.avalon.instance` and `instance_id` which is identifier of the instance. Family tells how should be instance processed and subset what name will published item have. - There are cases when subset is not fully filled during creation and may change during publishing. That is in most of cases caused because instance is related to other instance or instance data do not represent final product. @@ -26,7 +26,7 @@ Family tells how should be instance processed and subset what name will publishe ## Identifier that this data represents instance for publishing (automatically assigned) "id": "pyblish.avalon.instance", ## Identifier of this specific instance (automatically assigned) - "uuid": , + "instance_id": , ## Instance family (used from Creator) "family": , diff --git a/openpype/pipeline/create/__init__.py b/openpype/pipeline/create/__init__.py index 948b719851..9571f56b8f 100644 --- a/openpype/pipeline/create/__init__.py +++ b/openpype/pipeline/create/__init__.py @@ -14,6 +14,11 @@ from .context import ( CreateContext ) +from .legacy_create import ( + LegacyCreator, + legacy_create, +) + __all__ = ( "SUBSET_NAME_ALLOWED_SYMBOLS", @@ -25,5 +30,8 @@ __all__ = ( "AutoCreator", "CreatedInstance", - "CreateContext" + "CreateContext", + + "LegacyCreator", + "legacy_create", ) diff --git a/openpype/pipeline/create/context.py b/openpype/pipeline/create/context.py index 4454d31d83..c2757a4502 100644 --- a/openpype/pipeline/create/context.py +++ b/openpype/pipeline/create/context.py @@ -361,7 +361,7 @@ class CreatedInstance: # their individual children but not on their own __immutable_keys = ( "id", - "uuid", + "instance_id", "family", "creator_identifier", "creator_attributes", @@ -399,15 +399,6 @@ class CreatedInstance: self._data["active"] = data.get("active", True) self._data["creator_identifier"] = creator.identifier - # QUESTION handle version of instance here or in creator? - version = None - if not new: - version = data.get("version") - - if version is None: - version = 1 - self._data["version"] = version - # Pop from source data all keys that are defined in `_data` before # this moment and through their values away # - they should be the same and if are not then should not change @@ -434,8 +425,8 @@ class CreatedInstance: if data: self._data.update(data) - if not self._data.get("uuid"): - self._data["uuid"] = str(uuid4()) + if not self._data.get("instance_id"): + self._data["instance_id"] = str(uuid4()) self._asset_is_valid = self.has_set_asset self._task_is_valid = self.has_set_task @@ -551,7 +542,7 @@ class CreatedInstance: @property def id(self): """Instance identifier.""" - return self._data["uuid"] + return self._data["instance_id"] @property def data(self): @@ -1014,12 +1005,14 @@ class CreateContext: if not instances: return - task_names_by_asset_name = collections.defaultdict(set) + task_names_by_asset_name = {} for instance in instances: task_name = instance.get("task") asset_name = instance.get("asset") - if asset_name and task_name: - task_names_by_asset_name[asset_name].add(task_name) + if asset_name: + task_names_by_asset_name[asset_name] = set() + if task_name: + task_names_by_asset_name[asset_name].add(task_name) asset_names = [ asset_name diff --git a/openpype/pipeline/create/legacy_create.py b/openpype/pipeline/create/legacy_create.py new file mode 100644 index 0000000000..cf6629047e --- /dev/null +++ b/openpype/pipeline/create/legacy_create.py @@ -0,0 +1,157 @@ +"""Create workflow moved from avalon-core repository. + +Renamed classes and functions +- 'Creator' -> 'LegacyCreator' +- 'create' -> 'legacy_create' +""" + +import logging +import collections + +from openpype.lib import get_subset_name + + +class LegacyCreator(object): + """Determine how assets are created""" + label = None + family = None + defaults = None + maintain_selection = True + + dynamic_subset_keys = [] + + log = logging.getLogger("LegacyCreator") + log.propagate = True + + def __init__(self, name, asset, options=None, data=None): + self.name = name # For backwards compatibility + self.options = options + + # Default data + self.data = collections.OrderedDict() + self.data["id"] = "pyblish.avalon.instance" + self.data["family"] = self.family + self.data["asset"] = asset + self.data["subset"] = name + self.data["active"] = True + + self.data.update(data or {}) + + def process(self): + pass + + @classmethod + def get_dynamic_data( + cls, variant, task_name, asset_id, project_name, host_name + ): + """Return dynamic data for current Creator plugin. + + By default return keys from `dynamic_subset_keys` attribute as mapping + to keep formatted template unchanged. + + ``` + dynamic_subset_keys = ["my_key"] + --- + output = { + "my_key": "{my_key}" + } + ``` + + Dynamic keys may override default Creator keys (family, task, asset, + ...) but do it wisely if you need. + + All of keys will be converted into 3 variants unchanged, capitalized + and all upper letters. Because of that are all keys lowered. + + This method can be modified to prefill some values just keep in mind it + is class method. + + Returns: + dict: Fill data for subset name template. + """ + dynamic_data = {} + for key in cls.dynamic_subset_keys: + key = key.lower() + dynamic_data[key] = "{" + key + "}" + return dynamic_data + + @classmethod + def get_subset_name( + cls, variant, task_name, asset_id, project_name, host_name=None + ): + """Return subset name created with entered arguments. + + Logic extracted from Creator tool. This method should give ability + to get subset name without the tool. + + TODO: Maybe change `variant` variable. + + By default is output concatenated family with user text. + + Args: + variant (str): What is entered by user in creator tool. + task_name (str): Context's task name. + asset_id (ObjectId): Mongo ID of context's asset. + project_name (str): Context's project name. + host_name (str): Name of host. + + Returns: + str: Formatted subset name with entered arguments. Should match + config's logic. + """ + + dynamic_data = cls.get_dynamic_data( + variant, task_name, asset_id, project_name, host_name + ) + + return get_subset_name( + cls.family, + variant, + task_name, + asset_id, + project_name, + host_name, + dynamic_data=dynamic_data + ) + + +def legacy_create(Creator, name, asset, options=None, data=None): + """Create a new instance + + Associate nodes with a subset and family. These nodes are later + validated, according to their `family`, and integrated into the + shared environment, relative their `subset`. + + Data relative each family, along with default data, are imprinted + into the resulting objectSet. This data is later used by extractors + and finally asset browsers to help identify the origin of the asset. + + Arguments: + Creator (Creator): Class of creator + name (str): Name of subset + asset (str): Name of asset + options (dict, optional): Additional options from GUI + data (dict, optional): Additional data from GUI + + Raises: + NameError on `subset` already exists + KeyError on invalid dynamic property + RuntimeError on host error + + Returns: + Name of instance + + """ + from avalon.api import registered_host + host = registered_host() + plugin = Creator(name, asset, options, data) + + if plugin.maintain_selection is True: + with host.maintained_selection(): + print("Running %s with maintained selection" % plugin) + instance = plugin.process() + return instance + + print("Running %s" % plugin) + instance = plugin.process() + return instance diff --git a/openpype/pipeline/lib/__init__.py b/openpype/pipeline/lib/__init__.py index ed38889c66..f762c4205d 100644 --- a/openpype/pipeline/lib/__init__.py +++ b/openpype/pipeline/lib/__init__.py @@ -1,8 +1,3 @@ -from .events import ( - BaseEvent, - BeforeWorkfileSave -) - from .attribute_definitions import ( AbtractAttrDef, @@ -20,9 +15,6 @@ from .attribute_definitions import ( __all__ = ( - "BaseEvent", - "BeforeWorkfileSave", - "AbtractAttrDef", "UIDef", diff --git a/openpype/pipeline/lib/events.py b/openpype/pipeline/lib/events.py deleted file mode 100644 index 05dea20e8c..0000000000 --- a/openpype/pipeline/lib/events.py +++ /dev/null @@ -1,51 +0,0 @@ -"""Events holding data about specific event.""" - - -# Inherit from 'object' for Python 2 hosts -class BaseEvent(object): - """Base event object. - - Can be used to anything because data are not much specific. Only required - argument is topic which defines why event is happening and may be used for - filtering. - - Arg: - topic (str): Identifier of event. - data (Any): Data specific for event. Dictionary is recommended. - """ - _data = {} - - def __init__(self, topic, data=None): - self._topic = topic - if data is None: - data = {} - self._data = data - - @property - def data(self): - return self._data - - @property - def topic(self): - return self._topic - - @classmethod - def emit(cls, *args, **kwargs): - """Create object of event and emit. - - Args: - Same args as '__init__' expects which may be class specific. - """ - from avalon import pipeline - - obj = cls(*args, **kwargs) - pipeline.emit(obj.topic, [obj]) - return obj - - -class BeforeWorkfileSave(BaseEvent): - """Before workfile changes event data.""" - def __init__(self, filename, workdir): - super(BeforeWorkfileSave, self).__init__("before.workfile.save") - self.filename = filename - self.workdir_path = workdir diff --git a/openpype/pipeline/load/__init__.py b/openpype/pipeline/load/__init__.py new file mode 100644 index 0000000000..6e7612d4c1 --- /dev/null +++ b/openpype/pipeline/load/__init__.py @@ -0,0 +1,78 @@ +from .utils import ( + HeroVersionType, + IncompatibleLoaderError, + + get_repres_contexts, + get_subset_contexts, + get_representation_context, + + load_with_repre_context, + load_with_subset_context, + load_with_subset_contexts, + + load_container, + remove_container, + update_container, + switch_container, + + get_loader_identifier, + + get_representation_path_from_context, + get_representation_path, + + is_compatible_loader, + + loaders_from_repre_context, + loaders_from_representation, +) + +from .plugins import ( + LoaderPlugin, + SubsetLoaderPlugin, + + discover_loader_plugins, + register_loader_plugin, + deregister_loader_plugin_path, + register_loader_plugin_path, + deregister_loader_plugin, +) + + +__all__ = ( + # utils.py + "HeroVersionType", + "IncompatibleLoaderError", + + "get_repres_contexts", + "get_subset_contexts", + "get_representation_context", + + "load_with_repre_context", + "load_with_subset_context", + "load_with_subset_contexts", + + "load_container", + "remove_container", + "update_container", + "switch_container", + + "get_loader_identifier", + + "get_representation_path_from_context", + "get_representation_path", + + "is_compatible_loader", + + "loaders_from_repre_context", + "loaders_from_representation", + + # plugins.py + "LoaderPlugin", + "SubsetLoaderPlugin", + + "discover_loader_plugins", + "register_loader_plugin", + "deregister_loader_plugin_path", + "register_loader_plugin_path", + "deregister_loader_plugin", +) diff --git a/openpype/pipeline/load/plugins.py b/openpype/pipeline/load/plugins.py new file mode 100644 index 0000000000..601ad3b258 --- /dev/null +++ b/openpype/pipeline/load/plugins.py @@ -0,0 +1,130 @@ +import logging + +from .utils import get_representation_path_from_context + + +class LoaderPlugin(list): + """Load representation into host application + + Arguments: + context (dict): avalon-core:context-1.0 + name (str, optional): Use pre-defined name + namespace (str, optional): Use pre-defined namespace + + .. versionadded:: 4.0 + This class was introduced + + """ + + families = list() + representations = list() + order = 0 + is_multiple_contexts_compatible = False + + options = [] + + log = logging.getLogger("SubsetLoader") + log.propagate = True + + def __init__(self, context): + self.fname = self.filepath_from_context(context) + + @classmethod + def get_representations(cls): + return cls.representations + + def filepath_from_context(self, context): + return get_representation_path_from_context(context) + + def load(self, context, name=None, namespace=None, options=None): + """Load asset via database + + Arguments: + context (dict): Full parenthood of representation to load + name (str, optional): Use pre-defined name + namespace (str, optional): Use pre-defined namespace + options (dict, optional): Additional settings dictionary + + """ + raise NotImplementedError("Loader.load() must be " + "implemented by subclass") + + def update(self, container, representation): + """Update `container` to `representation` + + Arguments: + container (avalon-core:container-1.0): Container to update, + from `host.ls()`. + representation (dict): Update the container to this representation. + + """ + raise NotImplementedError("Loader.update() must be " + "implemented by subclass") + + def remove(self, container): + """Remove a container + + Arguments: + container (avalon-core:container-1.0): Container to remove, + from `host.ls()`. + + Returns: + bool: Whether the container was deleted + + """ + + raise NotImplementedError("Loader.remove() must be " + "implemented by subclass") + + @classmethod + def get_options(cls, contexts): + """ + Returns static (cls) options or could collect from 'contexts'. + + Args: + contexts (list): of repre or subset contexts + Returns: + (list) + """ + return cls.options or [] + + +class SubsetLoaderPlugin(LoaderPlugin): + """Load subset into host application + Arguments: + context (dict): avalon-core:context-1.0 + name (str, optional): Use pre-defined name + namespace (str, optional): Use pre-defined namespace + """ + + def __init__(self, context): + pass + + +def discover_loader_plugins(): + import avalon.api + + return avalon.api.discover(LoaderPlugin) + + +def register_loader_plugin(plugin): + import avalon.api + + return avalon.api.register_plugin(LoaderPlugin, plugin) + + +def deregister_loader_plugin_path(path): + import avalon.api + + avalon.api.deregister_plugin_path(LoaderPlugin, path) + + +def register_loader_plugin_path(path): + import avalon.api + + return avalon.api.register_plugin_path(LoaderPlugin, path) + + +def deregister_loader_plugin(plugin): + import avalon.api + avalon.api.deregister_plugin(LoaderPlugin, plugin) diff --git a/openpype/pipeline/load/utils.py b/openpype/pipeline/load/utils.py new file mode 100644 index 0000000000..ae47cb9ce9 --- /dev/null +++ b/openpype/pipeline/load/utils.py @@ -0,0 +1,706 @@ +import os +import platform +import copy +import getpass +import logging +import inspect +import numbers + +import six + +from avalon import io, schema +from avalon.api import Session, registered_root + +from openpype.lib import Anatomy + +log = logging.getLogger(__name__) + + +class HeroVersionType(object): + def __init__(self, version): + assert isinstance(version, numbers.Integral), ( + "Version is not an integer. \"{}\" {}".format( + version, str(type(version)) + ) + ) + self.version = version + + def __str__(self): + return str(self.version) + + def __int__(self): + return int(self.version) + + def __format__(self, format_spec): + return self.version.__format__(format_spec) + + +class IncompatibleLoaderError(ValueError): + """Error when Loader is incompatible with a representation.""" + pass + + +def get_repres_contexts(representation_ids, dbcon=None): + """Return parenthood context for representation. + + Args: + representation_ids (list): The representation ids. + dbcon (AvalonMongoDB): Mongo connection object. `avalon.io` used when + not entered. + + Returns: + dict: The full representation context by representation id. + keys are repre_id, value is dictionary with full: + asset_doc + version_doc + subset_doc + repre_doc + + """ + if not dbcon: + dbcon = io + + contexts = {} + if not representation_ids: + return contexts + + _representation_ids = [] + for repre_id in representation_ids: + if isinstance(repre_id, six.string_types): + repre_id = io.ObjectId(repre_id) + _representation_ids.append(repre_id) + + repre_docs = dbcon.find({ + "type": "representation", + "_id": {"$in": _representation_ids} + }) + repre_docs_by_id = {} + version_ids = set() + for repre_doc in repre_docs: + version_ids.add(repre_doc["parent"]) + repre_docs_by_id[repre_doc["_id"]] = repre_doc + + version_docs = dbcon.find({ + "type": {"$in": ["version", "hero_version"]}, + "_id": {"$in": list(version_ids)} + }) + + version_docs_by_id = {} + hero_version_docs = [] + versions_for_hero = set() + subset_ids = set() + for version_doc in version_docs: + if version_doc["type"] == "hero_version": + hero_version_docs.append(version_doc) + versions_for_hero.add(version_doc["version_id"]) + version_docs_by_id[version_doc["_id"]] = version_doc + subset_ids.add(version_doc["parent"]) + + if versions_for_hero: + _version_docs = dbcon.find({ + "type": "version", + "_id": {"$in": list(versions_for_hero)} + }) + _version_data_by_id = { + version_doc["_id"]: version_doc["data"] + for version_doc in _version_docs + } + + for hero_version_doc in hero_version_docs: + hero_version_id = hero_version_doc["_id"] + version_id = hero_version_doc["version_id"] + version_data = copy.deepcopy(_version_data_by_id[version_id]) + version_docs_by_id[hero_version_id]["data"] = version_data + + subset_docs = dbcon.find({ + "type": "subset", + "_id": {"$in": list(subset_ids)} + }) + subset_docs_by_id = {} + asset_ids = set() + for subset_doc in subset_docs: + subset_docs_by_id[subset_doc["_id"]] = subset_doc + asset_ids.add(subset_doc["parent"]) + + asset_docs = dbcon.find({ + "type": "asset", + "_id": {"$in": list(asset_ids)} + }) + asset_docs_by_id = { + asset_doc["_id"]: asset_doc + for asset_doc in asset_docs + } + + project_doc = dbcon.find_one({"type": "project"}) + + for repre_id, repre_doc in repre_docs_by_id.items(): + version_doc = version_docs_by_id[repre_doc["parent"]] + subset_doc = subset_docs_by_id[version_doc["parent"]] + asset_doc = asset_docs_by_id[subset_doc["parent"]] + context = { + "project": { + "name": project_doc["name"], + "code": project_doc["data"].get("code") + }, + "asset": asset_doc, + "subset": subset_doc, + "version": version_doc, + "representation": repre_doc, + } + contexts[repre_id] = context + + return contexts + + +def get_subset_contexts(subset_ids, dbcon=None): + """Return parenthood context for subset. + + Provides context on subset granularity - less detail than + 'get_repre_contexts'. + Args: + subset_ids (list): The subset ids. + dbcon (AvalonMongoDB): Mongo connection object. `avalon.io` used when + not entered. + Returns: + dict: The full representation context by representation id. + """ + if not dbcon: + dbcon = io + + contexts = {} + if not subset_ids: + return contexts + + _subset_ids = set() + for subset_id in subset_ids: + if isinstance(subset_id, six.string_types): + subset_id = io.ObjectId(subset_id) + _subset_ids.add(subset_id) + + subset_docs = dbcon.find({ + "type": "subset", + "_id": {"$in": list(_subset_ids)} + }) + subset_docs_by_id = {} + asset_ids = set() + for subset_doc in subset_docs: + subset_docs_by_id[subset_doc["_id"]] = subset_doc + asset_ids.add(subset_doc["parent"]) + + asset_docs = dbcon.find({ + "type": "asset", + "_id": {"$in": list(asset_ids)} + }) + asset_docs_by_id = { + asset_doc["_id"]: asset_doc + for asset_doc in asset_docs + } + + project_doc = dbcon.find_one({"type": "project"}) + + for subset_id, subset_doc in subset_docs_by_id.items(): + asset_doc = asset_docs_by_id[subset_doc["parent"]] + context = { + "project": { + "name": project_doc["name"], + "code": project_doc["data"].get("code") + }, + "asset": asset_doc, + "subset": subset_doc + } + contexts[subset_id] = context + + return contexts + + +def get_representation_context(representation): + """Return parenthood context for representation. + + Args: + representation (str or io.ObjectId or dict): The representation id + or full representation as returned by the database. + + Returns: + dict: The full representation context. + + """ + + assert representation is not None, "This is a bug" + + if isinstance(representation, (six.string_types, io.ObjectId)): + representation = io.find_one( + {"_id": io.ObjectId(str(representation))}) + + version, subset, asset, project = io.parenthood(representation) + + assert all([representation, version, subset, asset, project]), ( + "This is a bug" + ) + + context = { + "project": { + "name": project["name"], + "code": project["data"].get("code", '') + }, + "asset": asset, + "subset": subset, + "version": version, + "representation": representation, + } + + return context + + +def load_with_repre_context( + Loader, repre_context, namespace=None, name=None, options=None, **kwargs +): + + # Ensure the Loader is compatible for the representation + if not is_compatible_loader(Loader, repre_context): + raise IncompatibleLoaderError( + "Loader {} is incompatible with {}".format( + Loader.__name__, repre_context["subset"]["name"] + ) + ) + + # Ensure options is a dictionary when no explicit options provided + if options is None: + options = kwargs.get("data", dict()) # "data" for backward compat + + assert isinstance(options, dict), "Options must be a dictionary" + + # Fallback to subset when name is None + if name is None: + name = repre_context["subset"]["name"] + + log.info( + "Running '%s' on '%s'" % ( + Loader.__name__, repre_context["asset"]["name"] + ) + ) + + loader = Loader(repre_context) + return loader.load(repre_context, name, namespace, options) + + +def load_with_subset_context( + Loader, subset_context, namespace=None, name=None, options=None, **kwargs +): + + # Ensure options is a dictionary when no explicit options provided + if options is None: + options = kwargs.get("data", dict()) # "data" for backward compat + + assert isinstance(options, dict), "Options must be a dictionary" + + # Fallback to subset when name is None + if name is None: + name = subset_context["subset"]["name"] + + log.info( + "Running '%s' on '%s'" % ( + Loader.__name__, subset_context["asset"]["name"] + ) + ) + + loader = Loader(subset_context) + return loader.load(subset_context, name, namespace, options) + + +def load_with_subset_contexts( + Loader, subset_contexts, namespace=None, name=None, options=None, **kwargs +): + + # Ensure options is a dictionary when no explicit options provided + if options is None: + options = kwargs.get("data", dict()) # "data" for backward compat + + assert isinstance(options, dict), "Options must be a dictionary" + + # Fallback to subset when name is None + joined_subset_names = " | ".join( + context["subset"]["name"] + for context in subset_contexts + ) + if name is None: + name = joined_subset_names + + log.info( + "Running '{}' on '{}'".format(Loader.__name__, joined_subset_names) + ) + + loader = Loader(subset_contexts) + return loader.load(subset_contexts, name, namespace, options) + + +def load_container( + Loader, representation, namespace=None, name=None, options=None, **kwargs +): + """Use Loader to load a representation. + + Args: + Loader (Loader): The loader class to trigger. + representation (str or io.ObjectId or dict): The representation id + or full representation as returned by the database. + namespace (str, Optional): The namespace to assign. Defaults to None. + name (str, Optional): The name to assign. Defaults to subset name. + options (dict, Optional): Additional options to pass on to the loader. + + Returns: + The return of the `loader.load()` method. + + Raises: + IncompatibleLoaderError: When the loader is not compatible with + the representation. + + """ + + context = get_representation_context(representation) + return load_with_repre_context( + Loader, + context, + namespace=namespace, + name=name, + options=options, + **kwargs + ) + + +def get_loader_identifier(loader): + """Loader identifier from loader plugin or object. + + Identifier should be stored to container for future management. + """ + if not inspect.isclass(loader): + loader = loader.__class__ + return loader.__name__ + + +def _get_container_loader(container): + """Return the Loader corresponding to the container""" + from .plugins import discover_loader_plugins + + loader = container["loader"] + for Plugin in discover_loader_plugins(): + # TODO: Ensure the loader is valid + if get_loader_identifier(Plugin) == loader: + return Plugin + return None + + +def remove_container(container): + """Remove a container""" + + Loader = _get_container_loader(container) + if not Loader: + raise RuntimeError("Can't remove container. See log for details.") + + loader = Loader(get_representation_context(container["representation"])) + return loader.remove(container) + + +def update_container(container, version=-1): + """Update a container""" + + # Compute the different version from 'representation' + current_representation = io.find_one({ + "_id": io.ObjectId(container["representation"]) + }) + + assert current_representation is not None, "This is a bug" + + current_version, subset, asset, project = io.parenthood( + current_representation) + + if version == -1: + new_version = io.find_one({ + "type": "version", + "parent": subset["_id"] + }, sort=[("name", -1)]) + else: + if isinstance(version, HeroVersionType): + version_query = { + "parent": subset["_id"], + "type": "hero_version" + } + else: + version_query = { + "parent": subset["_id"], + "type": "version", + "name": version + } + new_version = io.find_one(version_query) + + assert new_version is not None, "This is a bug" + + new_representation = io.find_one({ + "type": "representation", + "parent": new_version["_id"], + "name": current_representation["name"] + }) + + assert new_representation is not None, "Representation wasn't found" + + path = get_representation_path(new_representation) + assert os.path.exists(path), "Path {} doesn't exist".format(path) + + # Run update on the Loader for this container + Loader = _get_container_loader(container) + if not Loader: + raise RuntimeError("Can't update container. See log for details.") + + loader = Loader(get_representation_context(container["representation"])) + return loader.update(container, new_representation) + + +def switch_container(container, representation, loader_plugin=None): + """Switch a container to representation + + Args: + container (dict): container information + representation (dict): representation data from document + + Returns: + function call + """ + + # Get the Loader for this container + if loader_plugin is None: + loader_plugin = _get_container_loader(container) + + if not loader_plugin: + raise RuntimeError("Can't switch container. See log for details.") + + if not hasattr(loader_plugin, "switch"): + # Backwards compatibility (classes without switch support + # might be better to just have "switch" raise NotImplementedError + # on the base class of Loader\ + raise RuntimeError("Loader '{}' does not support 'switch'".format( + loader_plugin.label + )) + + # Get the new representation to switch to + new_representation = io.find_one({ + "type": "representation", + "_id": representation["_id"], + }) + + new_context = get_representation_context(new_representation) + if not is_compatible_loader(loader_plugin, new_context): + raise AssertionError("Must be compatible Loader") + + loader = loader_plugin(new_context) + + return loader.switch(container, new_representation) + + +def get_representation_path_from_context(context): + """Preparation wrapper using only context as a argument""" + representation = context['representation'] + project_doc = context.get("project") + root = None + session_project = Session.get("AVALON_PROJECT") + if project_doc and project_doc["name"] != session_project: + anatomy = Anatomy(project_doc["name"]) + root = anatomy.roots_obj + + return get_representation_path(representation, root) + + +def get_representation_path(representation, root=None, dbcon=None): + """Get filename from representation document + + There are three ways of getting the path from representation which are + tried in following sequence until successful. + 1. Get template from representation['data']['template'] and data from + representation['context']. Then format template with the data. + 2. Get template from project['config'] and format it with default data set + 3. Get representation['data']['path'] and use it directly + + Args: + representation(dict): representation document from the database + + Returns: + str: fullpath of the representation + + """ + + from openpype.lib import StringTemplate + + if dbcon is None: + dbcon = io + + if root is None: + root = registered_root() + + def path_from_represenation(): + try: + template = representation["data"]["template"] + except KeyError: + return None + + try: + context = representation["context"] + context["root"] = root + template_obj = StringTemplate(template) + path = str(template_obj.format(context)) + # Force replacing backslashes with forward slashed if not on + # windows + if platform.system().lower() != "windows": + path = path.replace("\\", "/") + except KeyError: + # Template references unavailable data + return None + + if not path: + return path + + normalized_path = os.path.normpath(path) + if os.path.exists(normalized_path): + return normalized_path + return path + + def path_from_config(): + try: + version_, subset, asset, project = dbcon.parenthood(representation) + except ValueError: + log.debug( + "Representation %s wasn't found in database, " + "like a bug" % representation["name"] + ) + return None + + try: + template = project["config"]["template"]["publish"] + except KeyError: + log.debug( + "No template in project %s, " + "likely a bug" % project["name"] + ) + return None + + # default list() in get would not discover missing parents on asset + parents = asset.get("data", {}).get("parents") + if parents is not None: + hierarchy = "/".join(parents) + + # Cannot fail, required members only + data = { + "root": root, + "project": { + "name": project["name"], + "code": project.get("data", {}).get("code") + }, + "asset": asset["name"], + "silo": asset.get("silo"), + "hierarchy": hierarchy, + "subset": subset["name"], + "version": version_["name"], + "representation": representation["name"], + "family": representation.get("context", {}).get("family"), + "user": dbcon.Session.get("AVALON_USER", getpass.getuser()), + "app": dbcon.Session.get("AVALON_APP", ""), + "task": dbcon.Session.get("AVALON_TASK", "") + } + + try: + template_obj = StringTemplate(template) + path = str(template_obj.format(data)) + # Force replacing backslashes with forward slashed if not on + # windows + if platform.system().lower() != "windows": + path = path.replace("\\", "/") + + except KeyError as e: + log.debug("Template references unavailable data: %s" % e) + return None + + normalized_path = os.path.normpath(path) + if os.path.exists(normalized_path): + return normalized_path + return path + + def path_from_data(): + if "path" not in representation["data"]: + return None + + path = representation["data"]["path"] + # Force replacing backslashes with forward slashed if not on + # windows + if platform.system().lower() != "windows": + path = path.replace("\\", "/") + + if os.path.exists(path): + return os.path.normpath(path) + + dir_path, file_name = os.path.split(path) + if not os.path.exists(dir_path): + return + + base_name, ext = os.path.splitext(file_name) + file_name_items = None + if "#" in base_name: + file_name_items = [part for part in base_name.split("#") if part] + elif "%" in base_name: + file_name_items = base_name.split("%") + + if not file_name_items: + return + + filename_start = file_name_items[0] + + for _file in os.listdir(dir_path): + if _file.startswith(filename_start) and _file.endswith(ext): + return os.path.normpath(path) + + return ( + path_from_represenation() or + path_from_config() or + path_from_data() + ) + + +def is_compatible_loader(Loader, context): + """Return whether a loader is compatible with a context. + + This checks the version's families and the representation for the given + Loader. + + Returns: + bool + + """ + maj_version, _ = schema.get_schema_version(context["subset"]["schema"]) + if maj_version < 3: + families = context["version"]["data"].get("families", []) + else: + families = context["subset"]["data"]["families"] + + representation = context["representation"] + has_family = ( + "*" in Loader.families or any( + family in Loader.families for family in families + ) + ) + representations = Loader.get_representations() + has_representation = ( + "*" in representations or representation["name"] in representations + ) + return has_family and has_representation + + +def loaders_from_repre_context(loaders, repre_context): + """Return compatible loaders for by representaiton's context.""" + + return [ + loader + for loader in loaders + if is_compatible_loader(loader, repre_context) + ] + + +def loaders_from_representation(loaders, representation): + """Return all compatible loaders for a representation.""" + + context = get_representation_context(representation) + return loaders_from_repre_context(loaders, context) diff --git a/openpype/pipeline/publish/__init__.py b/openpype/pipeline/publish/__init__.py index ca958816fe..c2729a46ce 100644 --- a/openpype/pipeline/publish/__init__.py +++ b/openpype/pipeline/publish/__init__.py @@ -1,20 +1,26 @@ from .publish_plugins import ( PublishValidationError, + PublishXmlValidationError, KnownPublishError, - OpenPypePyblishPluginMixin + OpenPypePyblishPluginMixin, ) from .lib import ( DiscoverResult, - publish_plugins_discover + publish_plugins_discover, + load_help_content_from_plugin, + load_help_content_from_filepath, ) __all__ = ( "PublishValidationError", + "PublishXmlValidationError", "KnownPublishError", "OpenPypePyblishPluginMixin", "DiscoverResult", - "publish_plugins_discover" + "publish_plugins_discover", + "load_help_content_from_plugin", + "load_help_content_from_filepath", ) diff --git a/openpype/pipeline/publish/lib.py b/openpype/pipeline/publish/lib.py index d3e4ec8a02..739b2c8806 100644 --- a/openpype/pipeline/publish/lib.py +++ b/openpype/pipeline/publish/lib.py @@ -1,6 +1,8 @@ import os import sys import types +import inspect +import xml.etree.ElementTree import six import pyblish.plugin @@ -28,6 +30,60 @@ class DiscoverResult: self.plugins[item] = value +class HelpContent: + def __init__(self, title, description, detail=None): + self.title = title + self.description = description + self.detail = detail + + +def load_help_content_from_filepath(filepath): + """Load help content from xml file. + Xml file may containt errors and warnings. + """ + errors = {} + warnings = {} + output = { + "errors": errors, + "warnings": warnings + } + if not os.path.exists(filepath): + return output + tree = xml.etree.ElementTree.parse(filepath) + root = tree.getroot() + for child in root: + child_id = child.attrib.get("id") + if child_id is None: + continue + + # Make sure ID is string + child_id = str(child_id) + + title = child.find("title").text + description = child.find("description").text + detail_node = child.find("detail") + detail = None + if detail_node is not None: + detail = detail_node.text + if child.tag == "error": + errors[child_id] = HelpContent(title, description, detail) + elif child.tag == "warning": + warnings[child_id] = HelpContent(title, description, detail) + return output + + +def load_help_content_from_plugin(plugin): + cls = plugin + if not inspect.isclass(plugin): + cls = plugin.__class__ + plugin_filepath = inspect.getfile(cls) + plugin_dir = os.path.dirname(plugin_filepath) + basename = os.path.splitext(os.path.basename(plugin_filepath))[0] + filename = basename + ".xml" + filepath = os.path.join(plugin_dir, "help", filename) + return load_help_content_from_filepath(filepath) + + def publish_plugins_discover(paths=None): """Find and return available pyblish plug-ins diff --git a/openpype/pipeline/publish/publish_plugins.py b/openpype/pipeline/publish/publish_plugins.py index b60b9f43a7..bce64ec709 100644 --- a/openpype/pipeline/publish/publish_plugins.py +++ b/openpype/pipeline/publish/publish_plugins.py @@ -1,3 +1,6 @@ +from .lib import load_help_content_from_plugin + + class PublishValidationError(Exception): """Validation error happened during publishing. @@ -12,13 +15,34 @@ class PublishValidationError(Exception): description(str): Detailed description of an error. It is possible to use Markdown syntax. """ - def __init__(self, message, title=None, description=None): + def __init__(self, message, title=None, description=None, detail=None): self.message = message self.title = title or "< Missing title >" self.description = description or message + self.detail = detail super(PublishValidationError, self).__init__(message) +class PublishXmlValidationError(PublishValidationError): + def __init__( + self, plugin, message, key=None, formatting_data=None + ): + if key is None: + key = "main" + + if not formatting_data: + formatting_data = {} + result = load_help_content_from_plugin(plugin) + content_obj = result["errors"][key] + description = content_obj.description.format(**formatting_data) + detail = content_obj.detail + if detail: + detail = detail.format(**formatting_data) + super(PublishXmlValidationError, self).__init__( + message, content_obj.title, description, detail + ) + + class KnownPublishError(Exception): """Publishing crashed because of known error. diff --git a/openpype/plugin.py b/openpype/plugin.py index 45c9a08209..3569936dac 100644 --- a/openpype/plugin.py +++ b/openpype/plugin.py @@ -3,79 +3,12 @@ import os import pyblish.api import avalon.api -from openpype.lib import get_subset_name - ValidatePipelineOrder = pyblish.api.ValidatorOrder + 0.05 ValidateContentsOrder = pyblish.api.ValidatorOrder + 0.1 ValidateSceneOrder = pyblish.api.ValidatorOrder + 0.2 ValidateMeshOrder = pyblish.api.ValidatorOrder + 0.3 -class PypeCreatorMixin: - """Helper to override avalon's default class methods. - - Mixin class must be used as first in inheritance order to override methods. - """ - dynamic_subset_keys = [] - - @classmethod - def get_dynamic_data( - cls, variant, task_name, asset_id, project_name, host_name - ): - """Return dynamic data for current Creator plugin. - - By default return keys from `dynamic_subset_keys` attribute as mapping - to keep formatted template unchanged. - - ``` - dynamic_subset_keys = ["my_key"] - --- - output = { - "my_key": "{my_key}" - } - ``` - - Dynamic keys may override default Creator keys (family, task, asset, - ...) but do it wisely if you need. - - All of keys will be converted into 3 variants unchanged, capitalized - and all upper letters. Because of that are all keys lowered. - - This method can be modified to prefill some values just keep in mind it - is class method. - - Returns: - dict: Fill data for subset name template. - """ - dynamic_data = {} - for key in cls.dynamic_subset_keys: - key = key.lower() - dynamic_data[key] = "{" + key + "}" - return dynamic_data - - @classmethod - def get_subset_name( - cls, variant, task_name, asset_id, project_name, host_name=None - ): - dynamic_data = cls.get_dynamic_data( - variant, task_name, asset_id, project_name, host_name - ) - - return get_subset_name( - cls.family, - variant, - task_name, - asset_id, - project_name, - host_name, - dynamic_data=dynamic_data - ) - - -class Creator(PypeCreatorMixin, avalon.api.Creator): - pass - - class ContextPlugin(pyblish.api.ContextPlugin): def process(cls, *args, **kwargs): super(ContextPlugin, cls).process(cls, *args, **kwargs) diff --git a/openpype/plugins/load/add_site.py b/openpype/plugins/load/add_site.py index 09448d553c..95001691e2 100644 --- a/openpype/plugins/load/add_site.py +++ b/openpype/plugins/load/add_site.py @@ -1,8 +1,8 @@ -from avalon import api from openpype.modules import ModulesManager +from openpype.pipeline import load -class AddSyncSite(api.Loader): +class AddSyncSite(load.LoaderPlugin): """Add sync site to representation""" representations = ["*"] families = ["*"] diff --git a/openpype/plugins/load/copy_file.py b/openpype/plugins/load/copy_file.py index eaf5853035..60db094cfb 100644 --- a/openpype/plugins/load/copy_file.py +++ b/openpype/plugins/load/copy_file.py @@ -1,7 +1,8 @@ -from avalon import api, style +from openpype.style import get_default_entity_icon_color +from openpype.pipeline import load -class CopyFile(api.Loader): +class CopyFile(load.LoaderPlugin): """Copy the published file to be pasted at the desired location""" representations = ["*"] @@ -10,7 +11,7 @@ class CopyFile(api.Loader): label = "Copy File" order = 10 icon = "copy" - color = style.colors.default + color = get_default_entity_icon_color() def load(self, context, name=None, namespace=None, data=None): self.log.info("Added copy to clipboard: {0}".format(self.fname)) diff --git a/openpype/plugins/load/copy_file_path.py b/openpype/plugins/load/copy_file_path.py index 2041c79f6d..565d8d1ff1 100644 --- a/openpype/plugins/load/copy_file_path.py +++ b/openpype/plugins/load/copy_file_path.py @@ -1,9 +1,9 @@ import os -from avalon import api +from openpype.pipeline import load -class CopyFilePath(api.Loader): +class CopyFilePath(load.LoaderPlugin): """Copy published file path to clipboard""" representations = ["*"] families = ["*"] diff --git a/openpype/plugins/load/delete_old_versions.py b/openpype/plugins/load/delete_old_versions.py index b2f2c88975..692acdec02 100644 --- a/openpype/plugins/load/delete_old_versions.py +++ b/openpype/plugins/load/delete_old_versions.py @@ -5,16 +5,17 @@ import uuid import clique from pymongo import UpdateOne import ftrack_api +import qargparse from Qt import QtWidgets, QtCore -from avalon import api, style -from avalon.vendor import qargparse from avalon.api import AvalonMongoDB -import avalon.pipeline +from openpype import style +from openpype.pipeline import load +from openpype.lib import StringTemplate from openpype.api import Anatomy -class DeleteOldVersions(api.SubsetLoader): +class DeleteOldVersions(load.SubsetLoaderPlugin): """Deletes specific number of old version""" is_multiple_contexts_compatible = True @@ -89,16 +90,12 @@ class DeleteOldVersions(api.SubsetLoader): try: context = representation["context"] context["root"] = anatomy.roots - path = avalon.pipeline.format_template_with_optional_keys( - context, template - ) + path = str(StringTemplate.format_template(template, context)) if "frame" in context: context["frame"] = self.sequence_splitter - sequence_path = os.path.normpath( - avalon.pipeline.format_template_with_optional_keys( - context, template - ) - ) + sequence_path = os.path.normpath(str( + StringTemplate.format_template(template, context) + )) except KeyError: # Template references unavailable data diff --git a/openpype/plugins/load/delivery.py b/openpype/plugins/load/delivery.py index 1037d6dc16..04080053e3 100644 --- a/openpype/plugins/load/delivery.py +++ b/openpype/plugins/load/delivery.py @@ -3,9 +3,9 @@ from collections import defaultdict from Qt import QtWidgets, QtCore, QtGui -from avalon import api from avalon.api import AvalonMongoDB +from openpype.pipeline import load from openpype.api import Anatomy, config from openpype import resources, style @@ -20,7 +20,7 @@ from openpype.lib.delivery import ( ) -class Delivery(api.SubsetLoader): +class Delivery(load.SubsetLoaderPlugin): """Export selected versions to folder structure from Template""" is_multiple_contexts_compatible = True diff --git a/openpype/plugins/load/open_djv.py b/openpype/plugins/load/open_djv.py index 4b0e8411c8..273c77c93f 100644 --- a/openpype/plugins/load/open_djv.py +++ b/openpype/plugins/load/open_djv.py @@ -1,6 +1,6 @@ import os -from avalon import api from openpype.api import ApplicationManager +from openpype.pipeline import load def existing_djv_path(): @@ -13,7 +13,8 @@ def existing_djv_path(): return djv_list -class OpenInDJV(api.Loader): + +class OpenInDJV(load.LoaderPlugin): """Open Image Sequence with system default""" djv_list = existing_djv_path() diff --git a/openpype/plugins/load/open_file.py b/openpype/plugins/load/open_file.py index 4133a64eb3..f21cd07c7f 100644 --- a/openpype/plugins/load/open_file.py +++ b/openpype/plugins/load/open_file.py @@ -2,7 +2,7 @@ import sys import os import subprocess -from avalon import api +from openpype.pipeline import load def open(filepath): @@ -15,7 +15,7 @@ def open(filepath): subprocess.call(('xdg-open', filepath)) -class Openfile(api.Loader): +class Openfile(load.LoaderPlugin): """Open Image Sequence with system default""" families = ["render2d"] diff --git a/openpype/plugins/load/remove_site.py b/openpype/plugins/load/remove_site.py index aedb5d1f2f..adffec9986 100644 --- a/openpype/plugins/load/remove_site.py +++ b/openpype/plugins/load/remove_site.py @@ -1,8 +1,8 @@ -from avalon import api from openpype.modules import ModulesManager +from openpype.pipeline import load -class RemoveSyncSite(api.Loader): +class RemoveSyncSite(load.LoaderPlugin): """Remove sync site and its files on representation""" representations = ["*"] families = ["*"] diff --git a/openpype/plugins/publish/collect_anatomy_context_data.py b/openpype/plugins/publish/collect_anatomy_context_data.py index b0474b93ce..bd8d9e50c4 100644 --- a/openpype/plugins/publish/collect_anatomy_context_data.py +++ b/openpype/plugins/publish/collect_anatomy_context_data.py @@ -44,42 +44,18 @@ class CollectAnatomyContextData(pyblish.api.ContextPlugin): label = "Collect Anatomy Context Data" def process(self, context): - - task_name = api.Session["AVALON_TASK"] - project_entity = context.data["projectEntity"] - asset_entity = context.data["assetEntity"] - - asset_tasks = asset_entity["data"]["tasks"] - task_type = asset_tasks.get(task_name, {}).get("type") - - project_task_types = project_entity["config"]["tasks"] - task_code = project_task_types.get(task_type, {}).get("short_name") - - asset_parents = asset_entity["data"]["parents"] - hierarchy = "/".join(asset_parents) - - parent_name = project_entity["name"] - if asset_parents: - parent_name = asset_parents[-1] - context_data = { "project": { "name": project_entity["name"], "code": project_entity["data"].get("code") }, - "asset": asset_entity["name"], - "parent": parent_name, - "hierarchy": hierarchy, - "task": { - "name": task_name, - "type": task_type, - "short": task_code, - }, "username": context.data["user"], "app": context.data["hostName"] } + context.data["anatomyData"] = context_data + # add system general settings anatomy data system_general_data = get_system_general_anatomy_data() context_data.update(system_general_data) @@ -87,7 +63,33 @@ class CollectAnatomyContextData(pyblish.api.ContextPlugin): datetime_data = context.data.get("datetimeData") or {} context_data.update(datetime_data) - context.data["anatomyData"] = context_data + asset_entity = context.data.get("assetEntity") + if asset_entity: + task_name = api.Session["AVALON_TASK"] + + asset_tasks = asset_entity["data"]["tasks"] + task_type = asset_tasks.get(task_name, {}).get("type") + + project_task_types = project_entity["config"]["tasks"] + task_code = project_task_types.get(task_type, {}).get("short_name") + + asset_parents = asset_entity["data"]["parents"] + hierarchy = "/".join(asset_parents) + + parent_name = project_entity["name"] + if asset_parents: + parent_name = asset_parents[-1] + + context_data.update({ + "asset": asset_entity["name"], + "parent": parent_name, + "hierarchy": hierarchy, + "task": { + "name": task_name, + "type": task_type, + "short": task_code, + } + }) self.log.info("Global anatomy Data collected") self.log.debug(json.dumps(context_data, indent=4)) diff --git a/openpype/plugins/publish/collect_anatomy_instance_data.py b/openpype/plugins/publish/collect_anatomy_instance_data.py index 74b556e28a..42836e796b 100644 --- a/openpype/plugins/publish/collect_anatomy_instance_data.py +++ b/openpype/plugins/publish/collect_anatomy_instance_data.py @@ -52,7 +52,7 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): def fill_missing_asset_docs(self, context): self.log.debug("Qeurying asset documents for instances.") - context_asset_doc = context.data["assetEntity"] + context_asset_doc = context.data.get("assetEntity") instances_with_missing_asset_doc = collections.defaultdict(list) for instance in context: @@ -69,7 +69,7 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): # Check if asset name is the same as what is in context # - they may be different, e.g. in NukeStudio - if context_asset_doc["name"] == _asset_name: + if context_asset_doc and context_asset_doc["name"] == _asset_name: instance.data["assetEntity"] = context_asset_doc else: @@ -212,7 +212,7 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): self.log.debug("Storing anatomy data to instance data.") project_doc = context.data["projectEntity"] - context_asset_doc = context.data["assetEntity"] + context_asset_doc = context.data.get("assetEntity") project_task_types = project_doc["config"]["tasks"] @@ -240,7 +240,13 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): # Hiearchy asset_doc = instance.data.get("assetEntity") - if asset_doc and asset_doc["_id"] != context_asset_doc["_id"]: + if ( + asset_doc + and ( + not context_asset_doc + or asset_doc["_id"] != context_asset_doc["_id"] + ) + ): parents = asset_doc["data"].get("parents") or list() parent_name = project_doc["name"] if parents: diff --git a/openpype/plugins/publish/collect_avalon_entities.py b/openpype/plugins/publish/collect_avalon_entities.py index a6120d42fe..c099a2cf75 100644 --- a/openpype/plugins/publish/collect_avalon_entities.py +++ b/openpype/plugins/publish/collect_avalon_entities.py @@ -33,6 +33,11 @@ class CollectAvalonEntities(pyblish.api.ContextPlugin): ).format(project_name) self.log.debug("Collected Project \"{}\"".format(project_entity)) + context.data["projectEntity"] = project_entity + + if not asset_name: + self.log.info("Context is not set. Can't collect global data.") + return asset_entity = io.find_one({ "type": "asset", "name": asset_name, @@ -44,7 +49,6 @@ class CollectAvalonEntities(pyblish.api.ContextPlugin): self.log.debug("Collected Asset \"{}\"".format(asset_entity)) - context.data["projectEntity"] = project_entity context.data["assetEntity"] = asset_entity data = asset_entity['data'] diff --git a/openpype/plugins/publish/collect_time.py b/openpype/plugins/publish/collect_time.py index e0adc7dfc3..7a005cc9cb 100644 --- a/openpype/plugins/publish/collect_time.py +++ b/openpype/plugins/publish/collect_time.py @@ -1,12 +1,12 @@ import pyblish.api -from avalon import api +from openpype.lib import get_formatted_current_time class CollectTime(pyblish.api.ContextPlugin): """Store global time at the time of publish""" label = "Collect Current Time" - order = pyblish.api.CollectorOrder + order = pyblish.api.CollectorOrder - 0.499 def process(self, context): - context.data["time"] = api.time() + context.data["time"] = get_formatted_current_time() diff --git a/openpype/plugins/publish/extract_burnin.py b/openpype/plugins/publish/extract_burnin.py index 7ff1b24689..b2ca8850b6 100644 --- a/openpype/plugins/publish/extract_burnin.py +++ b/openpype/plugins/publish/extract_burnin.py @@ -478,6 +478,12 @@ class ExtractBurnin(openpype.api.Extractor): "frame_end_handle": frame_end_handle } + # use explicit username for webpublishes as rewriting + # OPENPYPE_USERNAME might have side effects + webpublish_user_name = os.environ.get("WEBPUBLISH_OPENPYPE_USERNAME") + if webpublish_user_name: + burnin_data["username"] = webpublish_user_name + self.log.debug( "Basic burnin_data: {}".format(json.dumps(burnin_data, indent=4)) ) diff --git a/openpype/plugins/publish/extract_jpeg_exr.py b/openpype/plugins/publish/extract_jpeg_exr.py index d80b7bb9c3..468ed96199 100644 --- a/openpype/plugins/publish/extract_jpeg_exr.py +++ b/openpype/plugins/publish/extract_jpeg_exr.py @@ -34,7 +34,12 @@ class ExtractJpegEXR(pyblish.api.InstancePlugin): self.log.info("subset {}".format(instance.data['subset'])) # skip crypto passes. - if 'crypto' in instance.data['subset']: + # TODO: This is just a quick fix and has its own side-effects - it is + # affecting every subset name with `crypto` in its name. + # This must be solved properly, maybe using tags on + # representation that can be determined much earlier and + # with better precision. + if 'crypto' in instance.data['subset'].lower(): self.log.info("Skipping crypto passes.") return diff --git a/openpype/plugins/publish/extract_review.py b/openpype/plugins/publish/extract_review.py index 5f286a53e6..cbe1924408 100644 --- a/openpype/plugins/publish/extract_review.py +++ b/openpype/plugins/publish/extract_review.py @@ -13,13 +13,12 @@ import pyblish.api import openpype.api from openpype.lib import ( get_ffmpeg_tool_path, - ffprobe_streams, + get_ffprobe_streams, path_to_subprocess_arg, should_convert_for_ffmpeg, convert_for_ffmpeg, - get_transcode_temp_directory, get_transcode_temp_directory ) import speedcopy @@ -104,9 +103,10 @@ class ExtractReview(pyblish.api.InstancePlugin): self.log.debug("Matching profile: \"{}\"".format(json.dumps(profile))) + subset_name = instance.data.get("subset") instance_families = self.families_from_instance(instance) - filtered_outputs = self.filter_outputs_by_families( - profile, instance_families + filtered_outputs = self.filter_output_defs( + profile, subset_name, instance_families ) # Store `filename_suffix` to save arguments profile_outputs = [] @@ -972,16 +972,12 @@ class ExtractReview(pyblish.api.InstancePlugin): def get_letterbox_filters( self, letter_box_def, - input_res_ratio, - output_res_ratio, - pixel_aspect, - scale_factor_by_width, - scale_factor_by_height + output_width, + output_height ): output = [] ratio = letter_box_def["ratio"] - state = letter_box_def["state"] fill_color = letter_box_def["fill_color"] f_red, f_green, f_blue, f_alpha = fill_color fill_color_hex = "{0:0>2X}{1:0>2X}{2:0>2X}".format( @@ -997,75 +993,129 @@ class ExtractReview(pyblish.api.InstancePlugin): ) line_color_alpha = float(l_alpha) / 255 - if input_res_ratio == output_res_ratio: - ratio /= pixel_aspect - elif input_res_ratio < output_res_ratio: - ratio /= scale_factor_by_width - else: - ratio /= scale_factor_by_height + # test ratios and define if pillar or letter boxes + output_ratio = float(output_width) / float(output_height) + self.log.debug("Output ratio: {} LetterBox ratio: {}".format( + output_ratio, ratio + )) + pillar = output_ratio > ratio + need_mask = format(output_ratio, ".3f") != format(ratio, ".3f") + if not need_mask: + return [] - if state == "letterbox": + if not pillar: if fill_color_alpha > 0: top_box = ( - "drawbox=0:0:iw:round((ih-(iw*(1/{})))/2):t=fill:c={}@{}" - ).format(ratio, fill_color_hex, fill_color_alpha) + "drawbox=0:0:{width}" + ":round(({height}-({width}/{ratio}))/2)" + ":t=fill:c={color}@{alpha}" + ).format( + width=output_width, + height=output_height, + ratio=ratio, + color=fill_color_hex, + alpha=fill_color_alpha + ) bottom_box = ( - "drawbox=0:ih-round((ih-(iw*(1/{0})))/2)" - ":iw:round((ih-(iw*(1/{0})))/2):t=fill:c={1}@{2}" - ).format(ratio, fill_color_hex, fill_color_alpha) - + "drawbox=0" + ":{height}-round(({height}-({width}/{ratio}))/2)" + ":{width}" + ":round(({height}-({width}/{ratio}))/2)" + ":t=fill:c={color}@{alpha}" + ).format( + width=output_width, + height=output_height, + ratio=ratio, + color=fill_color_hex, + alpha=fill_color_alpha + ) output.extend([top_box, bottom_box]) if line_color_alpha > 0 and line_thickness > 0: top_line = ( - "drawbox=0:round((ih-(iw*(1/{0})))/2)-{1}:iw:{1}:" - "t=fill:c={2}@{3}" + "drawbox=0" + ":round(({height}-({width}/{ratio}))/2)-{l_thick}" + ":{width}:{l_thick}:t=fill:c={l_color}@{l_alpha}" ).format( - ratio, line_thickness, line_color_hex, line_color_alpha + width=output_width, + height=output_height, + ratio=ratio, + l_thick=line_thickness, + l_color=line_color_hex, + l_alpha=line_color_alpha ) bottom_line = ( - "drawbox=0:ih-round((ih-(iw*(1/{})))/2)" - ":iw:{}:t=fill:c={}@{}" + "drawbox=0" + ":{height}-round(({height}-({width}/{ratio}))/2)" + ":{width}:{l_thick}:t=fill:c={l_color}@{l_alpha}" ).format( - ratio, line_thickness, line_color_hex, line_color_alpha + width=output_width, + height=output_height, + ratio=ratio, + l_thick=line_thickness, + l_color=line_color_hex, + l_alpha=line_color_alpha ) output.extend([top_line, bottom_line]) - elif state == "pillar": + else: if fill_color_alpha > 0: left_box = ( - "drawbox=0:0:round((iw-(ih*{}))/2):ih:t=fill:c={}@{}" - ).format(ratio, fill_color_hex, fill_color_alpha) + "drawbox=0:0" + ":round(({width}-({height}*{ratio}))/2)" + ":{height}" + ":t=fill:c={color}@{alpha}" + ).format( + width=output_width, + height=output_height, + ratio=ratio, + color=fill_color_hex, + alpha=fill_color_alpha + ) right_box = ( - "drawbox=iw-round((iw-(ih*{0}))/2))" - ":0:round((iw-(ih*{0}))/2):ih:t=fill:c={1}@{2}" - ).format(ratio, fill_color_hex, fill_color_alpha) - + "drawbox=" + "{width}-round(({width}-({height}*{ratio}))/2)" + ":0" + ":round(({width}-({height}*{ratio}))/2)" + ":{height}" + ":t=fill:c={color}@{alpha}" + ).format( + width=output_width, + height=output_height, + ratio=ratio, + color=fill_color_hex, + alpha=fill_color_alpha + ) output.extend([left_box, right_box]) if line_color_alpha > 0 and line_thickness > 0: left_line = ( - "drawbox=round((iw-(ih*{}))/2):0:{}:ih:t=fill:c={}@{}" + "drawbox=round(({width}-({height}*{ratio}))/2)" + ":0:{l_thick}:{height}:t=fill:c={l_color}@{l_alpha}" ).format( - ratio, line_thickness, line_color_hex, line_color_alpha + width=output_width, + height=output_height, + ratio=ratio, + l_thick=line_thickness, + l_color=line_color_hex, + l_alpha=line_color_alpha ) right_line = ( - "drawbox=iw-round((iw-(ih*{}))/2))" - ":0:{}:ih:t=fill:c={}@{}" + "drawbox={width}-round(({width}-({height}*{ratio}))/2)" + ":0:{l_thick}:{height}:t=fill:c={l_color}@{l_alpha}" ).format( - ratio, line_thickness, line_color_hex, line_color_alpha + width=output_width, + height=output_height, + ratio=ratio, + l_thick=line_thickness, + l_color=line_color_hex, + l_alpha=line_color_alpha ) - output.extend([left_line, right_line]) - else: - raise ValueError( - "Letterbox state \"{}\" is not recognized".format(state) - ) - return output def rescaling_filters(self, temp_data, output_def, new_repre): @@ -1079,10 +1129,24 @@ class ExtractReview(pyblish.api.InstancePlugin): """ filters = [] + # if reformat input video file is already reforamted from upstream + reformat_in_baking = bool("reformated" in new_repre["tags"]) + self.log.debug("reformat_in_baking: `{}`".format(reformat_in_baking)) + + # Get instance data + pixel_aspect = temp_data["pixel_aspect"] + + if reformat_in_baking: + self.log.debug(( + "Using resolution from input. It is already " + "reformated from upstream process" + )) + pixel_aspect = 1 + # NOTE Skipped using instance's resolution full_input_path_single_file = temp_data["full_input_path_single_file"] try: - streams = ffprobe_streams( + streams = get_ffprobe_streams( full_input_path_single_file, self.log ) except Exception as exc: @@ -1096,12 +1160,26 @@ class ExtractReview(pyblish.api.InstancePlugin): # - there may be a better way (checking `codec_type`?) input_width = None input_height = None + output_width = None + output_height = None for stream in streams: if "width" in stream and "height" in stream: input_width = int(stream["width"]) input_height = int(stream["height"]) break + # Get instance data + pixel_aspect = temp_data["pixel_aspect"] + + if reformat_in_baking: + self.log.debug(( + "Using resolution from input. It is already " + "reformated from upstream process" + )) + pixel_aspect = 1 + output_width = input_width + output_height = input_height + # Raise exception of any stream didn't define input resolution if input_width is None: raise AssertionError(( @@ -1110,8 +1188,8 @@ class ExtractReview(pyblish.api.InstancePlugin): # NOTE Setting only one of `width` or `heigth` is not allowed # - settings value can't have None but has value of 0 - output_width = output_def.get("width") or None - output_height = output_def.get("height") or None + output_width = output_def.get("width") or output_width or None + output_height = output_def.get("height") or output_height or None # Overscal color overscan_color_value = "black" @@ -1141,12 +1219,6 @@ class ExtractReview(pyblish.api.InstancePlugin): output_width = input_width output_height = input_height - letter_box_def = output_def["letter_box"] - letter_box_enabled = letter_box_def["enabled"] - - # Get instance data - pixel_aspect = temp_data["pixel_aspect"] - # Make sure input width and height is not an odd number input_width_is_odd = bool(input_width % 2 != 0) input_height_is_odd = bool(input_height % 2 != 0) @@ -1205,6 +1277,9 @@ class ExtractReview(pyblish.api.InstancePlugin): "Output resolution is {}x{}".format(output_width, output_height) ) + letter_box_def = output_def["letter_box"] + letter_box_enabled = letter_box_def["enabled"] + # Skip processing if resolution is same as input's and letterbox is # not set if ( @@ -1248,25 +1323,6 @@ class ExtractReview(pyblish.api.InstancePlugin): "scale_factor_by_height: `{}`".format(scale_factor_by_height) ) - # letter_box - if letter_box_enabled: - filters.extend([ - "scale={}x{}:flags=lanczos".format( - output_width, output_height - ), - "setsar=1" - ]) - filters.extend( - self.get_letterbox_filters( - letter_box_def, - input_res_ratio, - output_res_ratio, - pixel_aspect, - scale_factor_by_width, - scale_factor_by_height - ) - ) - # scaling none square pixels and 1920 width if ( input_height != output_height @@ -1305,6 +1361,16 @@ class ExtractReview(pyblish.api.InstancePlugin): "setsar=1" ]) + # letter_box + if letter_box_enabled: + filters.extend( + self.get_letterbox_filters( + letter_box_def, + output_width, + output_height + ) + ) + new_repre["resolutionWidth"] = output_width new_repre["resolutionHeight"] = output_height @@ -1586,7 +1652,7 @@ class ExtractReview(pyblish.api.InstancePlugin): return True return False - def filter_outputs_by_families(self, profile, families): + def filter_output_defs(self, profile, subset_name, families): """Return outputs matching input instance families. Output definitions without families filter are marked as valid. @@ -1619,6 +1685,24 @@ class ExtractReview(pyblish.api.InstancePlugin): if not self.families_filter_validation(families, families_filters): continue + # Subsets name filters + subset_filters = [ + subset_filter + for subset_filter in output_filters.get("subsets", []) + # Skip empty strings + if subset_filter + ] + if subset_name and subset_filters: + match = False + for subset_filter in subset_filters: + compiled = re.compile(subset_filter) + if compiled.search(subset_name): + match = True + break + + if not match: + continue + filtered_outputs[filename_suffix] = output_def return filtered_outputs diff --git a/openpype/plugins/publish/extract_review_slate.py b/openpype/plugins/publish/extract_review_slate.py index 7002168cdb..505ae75169 100644 --- a/openpype/plugins/publish/extract_review_slate.py +++ b/openpype/plugins/publish/extract_review_slate.py @@ -1,7 +1,14 @@ import os import openpype.api -import openpype.lib import pyblish +from openpype.lib import ( + path_to_subprocess_arg, + get_ffmpeg_tool_path, + get_ffprobe_data, + get_ffprobe_streams, + get_ffmpeg_codec_args, + get_ffmpeg_format_args, +) class ExtractReviewSlate(openpype.api.Extractor): @@ -14,7 +21,7 @@ class ExtractReviewSlate(openpype.api.Extractor): families = ["slate", "review"] match = pyblish.api.Subset - hosts = ["nuke", "maya", "shell"] + hosts = ["nuke", "shell"] optional = True def process(self, instance): @@ -24,9 +31,9 @@ class ExtractReviewSlate(openpype.api.Extractor): suffix = "_slate" slate_path = inst_data.get("slateFrame") - ffmpeg_path = openpype.lib.get_ffmpeg_tool_path("ffmpeg") + ffmpeg_path = get_ffmpeg_tool_path("ffmpeg") - slate_streams = openpype.lib.ffprobe_streams(slate_path, self.log) + slate_streams = get_ffprobe_streams(slate_path, self.log) # Try to find first stream with defined 'width' and 'height' # - this is to avoid order of streams where audio can be as first # - there may be a better way (checking `codec_type`?)+ @@ -59,13 +66,44 @@ class ExtractReviewSlate(openpype.api.Extractor): if "slate-frame" not in p_tags: continue + # get repre file + stagingdir = repre["stagingDir"] + input_file = "{0}".format(repre["files"]) + input_path = os.path.join( + os.path.normpath(stagingdir), repre["files"]) + self.log.debug("__ input_path: {}".format(input_path)) + + video_streams = get_ffprobe_streams( + input_path, self.log + ) + + # Try to find first stream with defined 'width' and 'height' + # - this is to avoid order of streams where audio can be as first + # - there may be a better way (checking `codec_type`?) + input_width = None + input_height = None + for stream in video_streams: + if "width" in stream and "height" in stream: + input_width = int(stream["width"]) + input_height = int(stream["height"]) + break + + # Raise exception of any stream didn't define input resolution + if input_width is None: + raise AssertionError(( + "FFprobe couldn't read resolution from input file: \"{}\"" + ).format(input_path)) + # values are set in ExtractReview if use_legacy_code: to_width = inst_data["reviewToWidth"] to_height = inst_data["reviewToHeight"] else: - to_width = repre["resolutionWidth"] - to_height = repre["resolutionHeight"] + to_width = input_width + to_height = input_height + + self.log.debug("to_width: `{}`".format(to_width)) + self.log.debug("to_height: `{}`".format(to_height)) # defining image ratios resolution_ratio = ( @@ -94,15 +132,9 @@ class ExtractReviewSlate(openpype.api.Extractor): _remove_at_end = [] - stagingdir = repre["stagingDir"] - input_file = "{0}".format(repre["files"]) - ext = os.path.splitext(input_file)[1] output_file = input_file.replace(ext, "") + suffix + ext - input_path = os.path.join( - os.path.normpath(stagingdir), repre["files"]) - self.log.debug("__ input_path: {}".format(input_path)) _remove_at_end.append(input_path) output_path = os.path.join( @@ -118,7 +150,7 @@ class ExtractReviewSlate(openpype.api.Extractor): else: input_args.extend(repre["outputDef"].get('input', [])) input_args.append("-loop 1 -i {}".format( - openpype.lib.path_to_subprocess_arg(slate_path) + path_to_subprocess_arg(slate_path) )) input_args.extend([ "-r {}".format(fps), @@ -132,7 +164,7 @@ class ExtractReviewSlate(openpype.api.Extractor): output_args.extend(repre["_profile"].get('output', [])) else: # Codecs are copied from source for whole input - codec_args = self.codec_args(repre) + codec_args = self._get_codec_args(repre) output_args.extend(codec_args) # make sure colors are correct @@ -191,12 +223,12 @@ class ExtractReviewSlate(openpype.api.Extractor): slate_v_path = slate_path.replace(".png", ext) output_args.append( - openpype.lib.path_to_subprocess_arg(slate_v_path) + path_to_subprocess_arg(slate_v_path) ) _remove_at_end.append(slate_v_path) slate_args = [ - openpype.lib.path_to_subprocess_arg(ffmpeg_path), + path_to_subprocess_arg(ffmpeg_path), " ".join(input_args), " ".join(output_args) ] @@ -306,7 +338,7 @@ class ExtractReviewSlate(openpype.api.Extractor): return vf_back - def codec_args(self, repre): + def _get_codec_args(self, repre): """Detect possible codec arguments from representation.""" codec_args = [] @@ -320,7 +352,7 @@ class ExtractReviewSlate(openpype.api.Extractor): try: # Get information about input file via ffprobe tool - streams = openpype.lib.ffprobe_streams(full_input_path, self.log) + ffprobe_data = get_ffprobe_data(full_input_path, self.log) except Exception: self.log.warning( "Could not get codec data from input.", @@ -328,29 +360,14 @@ class ExtractReviewSlate(openpype.api.Extractor): ) return codec_args - # Try to find first stream that is not an audio - no_audio_stream = None - for stream in streams: - if stream.get("codec_type") != "audio": - no_audio_stream = stream - break + source_ffmpeg_cmd = repre.get("ffmpeg_cmd") + codec_args.extend( + get_ffmpeg_format_args(ffprobe_data, source_ffmpeg_cmd) + ) + codec_args.extend( + get_ffmpeg_codec_args( + ffprobe_data, source_ffmpeg_cmd, logger=self.log + ) + ) - if no_audio_stream is None: - self.log.warning(( - "Couldn't find stream that is not an audio from file \"{}\"" - ).format(full_input_path)) - return codec_args - - codec_name = no_audio_stream.get("codec_name") - if codec_name: - codec_args.append("-codec:v {}".format(codec_name)) - - profile_name = no_audio_stream.get("profile") - if profile_name: - profile_name = profile_name.replace(" ", "_").lower() - codec_args.append("-profile:v {}".format(profile_name)) - - pix_fmt = no_audio_stream.get("pix_fmt") - if pix_fmt: - codec_args.append("-pix_fmt {}".format(pix_fmt)) return codec_args diff --git a/openpype/plugins/publish/integrate_hero_version.py b/openpype/plugins/publish/integrate_hero_version.py index ec836954e8..60245314f4 100644 --- a/openpype/plugins/publish/integrate_hero_version.py +++ b/openpype/plugins/publish/integrate_hero_version.py @@ -7,7 +7,7 @@ import shutil from pymongo import InsertOne, ReplaceOne import pyblish.api from avalon import api, io, schema -from avalon.vendor import filelink +from openpype.lib import create_hard_link class IntegrateHeroVersion(pyblish.api.InstancePlugin): @@ -518,7 +518,7 @@ class IntegrateHeroVersion(pyblish.api.InstancePlugin): # First try hardlink and copy if paths are cross drive try: - filelink.create(src_path, dst_path, filelink.HARDLINK) + create_hard_link(src_path, dst_path) # Return when successful return diff --git a/openpype/plugins/publish/integrate_new.py b/openpype/plugins/publish/integrate_new.py index 3d48fb92ee..e8dab089af 100644 --- a/openpype/plugins/publish/integrate_new.py +++ b/openpype/plugins/publish/integrate_new.py @@ -13,12 +13,14 @@ from pymongo import DeleteOne, InsertOne import pyblish.api from avalon import io from avalon.api import format_template_with_optional_keys -from avalon.vendor import filelink import openpype.api from datetime import datetime # from pype.modules import ModulesManager from openpype.lib.profiles_filtering import filter_profiles -from openpype.lib import prepare_template_data +from openpype.lib import ( + prepare_template_data, + create_hard_link +) # this is needed until speedcopy for linux is fixed if sys.platform == "win32": @@ -148,7 +150,10 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin): project_entity = instance.data["projectEntity"] - context_asset_name = context.data["assetEntity"]["name"] + context_asset_name = None + context_asset_doc = context.data.get("assetEntity") + if context_asset_doc: + context_asset_name = context_asset_doc["name"] asset_name = instance.data["asset"] asset_entity = instance.data.get("assetEntity") @@ -189,11 +194,15 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin): "short": task_code } - else: + elif "task" in anatomy_data: # Just set 'task_name' variable to context task task_name = anatomy_data["task"]["name"] task_type = anatomy_data["task"]["type"] + else: + task_name = None + task_type = None + # Fill family in anatomy data anatomy_data["family"] = instance.data.get("family") @@ -478,6 +487,8 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin): if index_frame_start is not None: dst_padding_exp = "%0{}d".format(frame_start_padding) dst_padding = dst_padding_exp % (index_frame_start + frame_number) # noqa: E501 + elif repre.get("udim"): + dst_padding = int(i) dst = "{0}{1}{2}".format( dst_head, @@ -725,7 +736,7 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin): self.log.critical("An unexpected error occurred.") six.reraise(*sys.exc_info()) - filelink.create(src, dst, filelink.HARDLINK) + create_hard_link(src, dst) def get_subset(self, asset, instance): subset_name = instance.data["subset"] @@ -811,8 +822,12 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin): # - is there a chance that task name is not filled in anatomy # data? # - should we use context task in that case? - task_name = instance.data["anatomyData"]["task"]["name"] - task_type = instance.data["anatomyData"]["task"]["type"] + anatomy_data = instance.data["anatomyData"] + task_name = None + task_type = None + if "task" in anatomy_data: + task_name = anatomy_data["task"]["name"] + task_type = anatomy_data["task"]["type"] filtering_criteria = { "families": instance.data["family"], "hosts": instance.context.data["hostName"], diff --git a/openpype/plugins/publish/validate_aseset_docs.py b/openpype/plugins/publish/validate_aseset_docs.py new file mode 100644 index 0000000000..eed75cdf8a --- /dev/null +++ b/openpype/plugins/publish/validate_aseset_docs.py @@ -0,0 +1,31 @@ +import pyblish.api +from openpype.pipeline import PublishValidationError + + +class ValidateContainers(pyblish.api.InstancePlugin): + """Validate existence of asset asset documents on instances. + + Without asset document it is not possible to publish the instance. + + If context has set asset document the validation is skipped. + + Plugin was added because there are cases when context asset is not defined + e.g. in tray publisher. + """ + + label = "Validate Asset docs" + order = pyblish.api.ValidatorOrder + + def process(self, instance): + context_asset_doc = instance.context.data.get("assetEntity") + if context_asset_doc: + return + + if instance.data.get("assetEntity"): + self.log.info("Instance have set asset document in it's data.") + + else: + raise PublishValidationError(( + "Instance \"{}\" don't have set asset" + " document which is needed for publishing." + ).format(instance.data["name"])) diff --git a/openpype/pype_commands.py b/openpype/pype_commands.py index 47f5e7fcc0..c05eece2be 100644 --- a/openpype/pype_commands.py +++ b/openpype/pype_commands.py @@ -80,6 +80,11 @@ class PypeCommands: from openpype.tools import standalonepublish standalonepublish.main() + @staticmethod + def launch_traypublisher(): + from openpype.tools import traypublisher + traypublisher.main() + @staticmethod def publish(paths, targets=None, gui=False): """Start headless publishing. @@ -363,7 +368,7 @@ class PypeCommands: pass def run_tests(self, folder, mark, pyargs, - test_data_folder, persist, app_variant): + test_data_folder, persist, app_variant, timeout): """ Runs tests from 'folder' @@ -401,6 +406,9 @@ class PypeCommands: if app_variant: args.extend(["--app_variant", app_variant]) + if timeout: + args.extend(["--timeout", timeout]) + print("run_tests args: {}".format(args)) import pytest pytest.main(args) diff --git a/openpype/resources/images/spinner-200.svg b/openpype/resources/images/spinner-200.svg new file mode 100644 index 0000000000..73d8ae2890 --- /dev/null +++ b/openpype/resources/images/spinner-200.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/openpype/scripts/fusion_switch_shot.py b/openpype/scripts/fusion_switch_shot.py new file mode 100644 index 0000000000..6db8ff36a8 --- /dev/null +++ b/openpype/scripts/fusion_switch_shot.py @@ -0,0 +1,240 @@ +import os +import re +import sys +import logging + +# Pipeline imports +from avalon import api, io +import avalon.fusion + +# Config imports +import openpype.lib as pype +import openpype.hosts.fusion.lib as fusion_lib + +from openpype.lib.avalon_context import get_workdir_from_session + +log = logging.getLogger("Update Slap Comp") + +self = sys.modules[__name__] +self._project = None + + +def _format_version_folder(folder): + """Format a version folder based on the filepath + + Assumption here is made that, if the path does not exists the folder + will be "v001" + + Args: + folder: file path to a folder + + Returns: + str: new version folder name + """ + + new_version = 1 + if os.path.isdir(folder): + re_version = re.compile("v\d+$") + versions = [i for i in os.listdir(folder) if os.path.isdir(i) + and re_version.match(i)] + if versions: + # ensure the "v" is not included + new_version = int(max(versions)[1:]) + 1 + + version_folder = "v{:03d}".format(new_version) + + return version_folder + + +def _get_fusion_instance(): + fusion = getattr(sys.modules["__main__"], "fusion", None) + if fusion is None: + try: + # Support for FuScript.exe, BlackmagicFusion module for py2 only + import BlackmagicFusion as bmf + fusion = bmf.scriptapp("Fusion") + except ImportError: + raise RuntimeError("Could not find a Fusion instance") + return fusion + + +def _format_filepath(session): + + project = session["AVALON_PROJECT"] + asset = session["AVALON_ASSET"] + + # Save updated slap comp + work_path = get_workdir_from_session(session) + walk_to_dir = os.path.join(work_path, "scenes", "slapcomp") + slapcomp_dir = os.path.abspath(walk_to_dir) + + # Ensure destination exists + if not os.path.isdir(slapcomp_dir): + log.warning("Folder did not exist, creating folder structure") + os.makedirs(slapcomp_dir) + + # Compute output path + new_filename = "{}_{}_slapcomp_v001.comp".format(project, asset) + new_filepath = os.path.join(slapcomp_dir, new_filename) + + # Create new unqiue filepath + if os.path.exists(new_filepath): + new_filepath = pype.version_up(new_filepath) + + return new_filepath + + +def _update_savers(comp, session): + """Update all savers of the current comp to ensure the output is correct + + Args: + comp (object): current comp instance + session (dict): the current Avalon session + + Returns: + None + """ + + new_work = get_workdir_from_session(session) + renders = os.path.join(new_work, "renders") + version_folder = _format_version_folder(renders) + renders_version = os.path.join(renders, version_folder) + + comp.Print("New renders to: %s\n" % renders) + + with avalon.fusion.comp_lock_and_undo_chunk(comp): + savers = comp.GetToolList(False, "Saver").values() + for saver in savers: + filepath = saver.GetAttrs("TOOLST_Clip_Name")[1.0] + filename = os.path.basename(filepath) + new_path = os.path.join(renders_version, filename) + saver["Clip"] = new_path + + +def update_frame_range(comp, representations): + """Update the frame range of the comp and render length + + The start and end frame are based on the lowest start frame and the highest + end frame + + Args: + comp (object): current focused comp + representations (list) collection of dicts + + Returns: + None + + """ + + version_ids = [r["parent"] for r in representations] + versions = io.find({"type": "version", "_id": {"$in": version_ids}}) + versions = list(versions) + + start = min(v["data"]["frameStart"] for v in versions) + end = max(v["data"]["frameEnd"] for v in versions) + + fusion_lib.update_frame_range(start, end, comp=comp) + + +def switch(asset_name, filepath=None, new=True): + """Switch the current containers of the file to the other asset (shot) + + Args: + filepath (str): file path of the comp file + asset_name (str): name of the asset (shot) + new (bool): Save updated comp under a different name + + Returns: + comp path (str): new filepath of the updated comp + + """ + + # If filepath provided, ensure it is valid absolute path + if filepath is not None: + if not os.path.isabs(filepath): + filepath = os.path.abspath(filepath) + + assert os.path.exists(filepath), "%s must exist " % filepath + + # Assert asset name exists + # It is better to do this here then to wait till switch_shot does it + asset = io.find_one({"type": "asset", "name": asset_name}) + assert asset, "Could not find '%s' in the database" % asset_name + + # Get current project + self._project = io.find_one({ + "type": "project", + "name": api.Session["AVALON_PROJECT"] + }) + + # Go to comp + if not filepath: + current_comp = avalon.fusion.get_current_comp() + assert current_comp is not None, "Could not find current comp" + else: + fusion = _get_fusion_instance() + current_comp = fusion.LoadComp(filepath, quiet=True) + assert current_comp is not None, "Fusion could not load '%s'" % filepath + + host = api.registered_host() + containers = list(host.ls()) + assert containers, "Nothing to update" + + representations = [] + for container in containers: + try: + representation = fusion_lib.switch_item(container, + asset_name=asset_name) + representations.append(representation) + except Exception as e: + current_comp.Print("Error in switching! %s\n" % e.message) + + message = "Switched %i Loaders of the %i\n" % (len(representations), + len(containers)) + current_comp.Print(message) + + # Build the session to switch to + switch_to_session = api.Session.copy() + switch_to_session["AVALON_ASSET"] = asset['name'] + + if new: + comp_path = _format_filepath(switch_to_session) + + # Update savers output based on new session + _update_savers(current_comp, switch_to_session) + else: + comp_path = pype.version_up(filepath) + + current_comp.Print(comp_path) + + current_comp.Print("\nUpdating frame range") + update_frame_range(current_comp, representations) + + current_comp.Save(comp_path) + + return comp_path + + +if __name__ == '__main__': + + import argparse + + parser = argparse.ArgumentParser(description="Switch to a shot within an" + "existing comp file") + + parser.add_argument("--file_path", + type=str, + default=True, + help="File path of the comp to use") + + parser.add_argument("--asset_name", + type=str, + default=True, + help="Name of the asset (shot) to switch") + + args, unknown = parser.parse_args() + + api.install(avalon.fusion) + switch(args.asset_name, args.file_path) + + sys.exit(0) diff --git a/openpype/scripts/otio_burnin.py b/openpype/scripts/otio_burnin.py index abf69645b7..1f57891b84 100644 --- a/openpype/scripts/otio_burnin.py +++ b/openpype/scripts/otio_burnin.py @@ -5,11 +5,17 @@ import subprocess import platform import json import opentimelineio_contrib.adapters.ffmpeg_burnins as ffmpeg_burnins -import openpype.lib + +from openpype.lib import ( + get_ffmpeg_tool_path, + get_ffmpeg_codec_args, + get_ffmpeg_format_args, + convert_ffprobe_fps_value, +) -ffmpeg_path = openpype.lib.get_ffmpeg_tool_path("ffmpeg") -ffprobe_path = openpype.lib.get_ffmpeg_tool_path("ffprobe") +ffmpeg_path = get_ffmpeg_tool_path("ffmpeg") +ffprobe_path = get_ffmpeg_tool_path("ffprobe") FFMPEG = ( @@ -50,176 +56,6 @@ def _get_ffprobe_data(source): return json.loads(out) -def get_fps(str_value): - if str_value == "0/0": - print("WARNING: Source has \"r_frame_rate\" value set to \"0/0\".") - return "Unknown" - - items = str_value.split("/") - if len(items) == 1: - fps = float(items[0]) - - elif len(items) == 2: - fps = float(items[0]) / float(items[1]) - - # Check if fps is integer or float number - if int(fps) == fps: - fps = int(fps) - - return str(fps) - - -def _prores_codec_args(stream_data, source_ffmpeg_cmd): - output = [] - - tags = stream_data.get("tags") or {} - encoder = tags.get("encoder") or "" - if encoder.endswith("prores_ks"): - codec_name = "prores_ks" - - elif encoder.endswith("prores_aw"): - codec_name = "prores_aw" - - else: - codec_name = "prores" - - output.extend(["-codec:v", codec_name]) - - pix_fmt = stream_data.get("pix_fmt") - if pix_fmt: - output.extend(["-pix_fmt", pix_fmt]) - - # Rest of arguments is prores_kw specific - if codec_name == "prores_ks": - codec_tag_to_profile_map = { - "apco": "proxy", - "apcs": "lt", - "apcn": "standard", - "apch": "hq", - "ap4h": "4444", - "ap4x": "4444xq" - } - codec_tag_str = stream_data.get("codec_tag_string") - if codec_tag_str: - profile = codec_tag_to_profile_map.get(codec_tag_str) - if profile: - output.extend(["-profile:v", profile]) - - return output - - -def _h264_codec_args(stream_data, source_ffmpeg_cmd): - output = ["-codec:v", "h264"] - - # Use arguments from source if are available source arguments - if source_ffmpeg_cmd: - copy_args = ( - "-crf", - "-b:v", "-vb", - "-minrate", "-minrate:", - "-maxrate", "-maxrate:", - "-bufsize", "-bufsize:" - ) - args = source_ffmpeg_cmd.split(" ") - for idx, arg in enumerate(args): - if arg in copy_args: - output.extend([arg, args[idx + 1]]) - - pix_fmt = stream_data.get("pix_fmt") - if pix_fmt: - output.extend(["-pix_fmt", pix_fmt]) - - output.extend(["-intra"]) - output.extend(["-g", "1"]) - - return output - - -def _dnxhd_codec_args(stream_data, source_ffmpeg_cmd): - output = ["-codec:v", "dnxhd"] - - # Use source profile (profiles in metadata are not usable in args directly) - profile = stream_data.get("profile") or "" - # Lower profile and replace space with underscore - cleaned_profile = profile.lower().replace(" ", "_") - dnx_profiles = { - "dnxhd", - "dnxhr_lb", - "dnxhr_sq", - "dnxhr_hq", - "dnxhr_hqx", - "dnxhr_444" - } - if cleaned_profile in dnx_profiles: - output.extend(["-profile:v", cleaned_profile]) - - pix_fmt = stream_data.get("pix_fmt") - if pix_fmt: - output.extend(["-pix_fmt", pix_fmt]) - - # Use arguments from source if are available source arguments - if source_ffmpeg_cmd: - copy_args = ( - "-b:v", "-vb", - ) - args = source_ffmpeg_cmd.split(" ") - for idx, arg in enumerate(args): - if arg in copy_args: - output.extend([arg, args[idx + 1]]) - - output.extend(["-g", "1"]) - return output - - -def _mxf_format_args(ffprobe_data, source_ffmpeg_cmd): - input_format = ffprobe_data["format"] - format_tags = input_format.get("tags") or {} - product_name = format_tags.get("product_name") or "" - output = [] - if "opatom" in product_name.lower(): - output.extend(["-f", "mxf_opatom"]) - return output - - -def get_format_args(ffprobe_data, source_ffmpeg_cmd): - input_format = ffprobe_data.get("format") or {} - if input_format.get("format_name") == "mxf": - return _mxf_format_args(ffprobe_data, source_ffmpeg_cmd) - return [] - - -def get_codec_args(ffprobe_data, source_ffmpeg_cmd): - stream_data = ffprobe_data["streams"][0] - codec_name = stream_data.get("codec_name") - # Codec "prores" - if codec_name == "prores": - return _prores_codec_args(stream_data, source_ffmpeg_cmd) - - # Codec "h264" - if codec_name == "h264": - return _h264_codec_args(stream_data, source_ffmpeg_cmd) - - # Coded DNxHD - if codec_name == "dnxhd": - return _dnxhd_codec_args(stream_data, source_ffmpeg_cmd) - - output = [] - if codec_name: - output.extend(["-codec:v", codec_name]) - - bit_rate = stream_data.get("bit_rate") - if bit_rate: - output.extend(["-b:v", bit_rate]) - - pix_fmt = stream_data.get("pix_fmt") - if pix_fmt: - output.extend(["-pix_fmt", pix_fmt]) - - output.extend(["-g", "1"]) - - return output - - class ModifiedBurnins(ffmpeg_burnins.Burnins): ''' This is modification of OTIO FFmpeg Burnin adapter. @@ -610,7 +446,9 @@ def burnins_from_data( data["resolution_height"] = stream.get("height", MISSING_KEY_VALUE) if "fps" not in data: - data["fps"] = get_fps(stream.get("r_frame_rate", "0/0")) + data["fps"] = convert_ffprobe_fps_value( + stream.get("r_frame_rate", "0/0") + ) # Check frame start and add expression if is available if frame_start is not None: @@ -721,10 +559,10 @@ def burnins_from_data( else: ffmpeg_args.extend( - get_format_args(burnin.ffprobe_data, source_ffmpeg_cmd) + get_ffmpeg_format_args(burnin.ffprobe_data, source_ffmpeg_cmd) ) ffmpeg_args.extend( - get_codec_args(burnin.ffprobe_data, source_ffmpeg_cmd) + get_ffmpeg_codec_args(burnin.ffprobe_data, source_ffmpeg_cmd) ) # Use arguments from source if are available source arguments if source_ffmpeg_cmd: diff --git a/openpype/settings/defaults/project_anatomy/imageio.json b/openpype/settings/defaults/project_anatomy/imageio.json index 4a1496fe1a..1c86509155 100644 --- a/openpype/settings/defaults/project_anatomy/imageio.json +++ b/openpype/settings/defaults/project_anatomy/imageio.json @@ -177,6 +177,17 @@ } }, "maya": { + "colorManagementPreference_v2": { + "enabled": true, + "configFilePath": { + "windows": [], + "darwin": [], + "linux": [] + }, + "renderSpace": "ACEScg", + "viewName": "ACES 1.0 SDR-video", + "displayName": "sRGB" + }, "colorManagementPreference": { "configFilePath": { "windows": [], diff --git a/openpype/settings/defaults/project_settings/deadline.json b/openpype/settings/defaults/project_settings/deadline.json index 7aff6d0b30..5bb0a4022e 100644 --- a/openpype/settings/defaults/project_settings/deadline.json +++ b/openpype/settings/defaults/project_settings/deadline.json @@ -46,7 +46,7 @@ "enabled": true, "optional": false, "active": true, - "tile_assembler_plugin": "oiio", + "tile_assembler_plugin": "OpenPypeTileAssembler", "use_published": true, "asset_dependencies": true, "group": "none", diff --git a/openpype/settings/defaults/project_settings/flame.json b/openpype/settings/defaults/project_settings/flame.json index b601f9bcba..ef9c2b1041 100644 --- a/openpype/settings/defaults/project_settings/flame.json +++ b/openpype/settings/defaults/project_settings/flame.json @@ -2,7 +2,8 @@ "create": { "CreateShotClip": { "hierarchy": "{folder}/{sequence}", - "clipRename": true, + "useShotName": true, + "clipRename": false, "clipName": "{sequence}{shot}", "segmentIndex": true, "countFrom": 10, @@ -26,6 +27,7 @@ "ext": "exr", "xml_preset_file": "OpenEXR (16-bit fp DWAA).xml", "xml_preset_dir": "", + "export_type": "File Sequence", "colorspace_out": "ACES - ACEScg", "representation_add_range": true, "representation_tags": [] diff --git a/openpype/settings/defaults/project_settings/global.json b/openpype/settings/defaults/project_settings/global.json index f08bee8b2d..30a71b044a 100644 --- a/openpype/settings/defaults/project_settings/global.json +++ b/openpype/settings/defaults/project_settings/global.json @@ -87,7 +87,8 @@ "render", "review", "ftrack" - ] + ], + "subsets": [] }, "overscan_crop": "", "overscan_color": [ @@ -107,7 +108,6 @@ "letter_box": { "enabled": false, "ratio": 0.0, - "state": "letterbox", "fill_color": [ 0, 0, diff --git a/openpype/settings/defaults/project_settings/maya.json b/openpype/settings/defaults/project_settings/maya.json index 24e8e4a29b..74ecf502d1 100644 --- a/openpype/settings/defaults/project_settings/maya.json +++ b/openpype/settings/defaults/project_settings/maya.json @@ -502,6 +502,12 @@ } } }, + "ExtractMayaSceneRaw": { + "enabled": true, + "add_for_families": [ + "layout" + ] + }, "ExtractCameraAlembic": { "enabled": true, "optional": true, @@ -589,6 +595,12 @@ 12, 255 ], + "vrayscene_layer": [ + 255, + 150, + 12, + 255 + ], "yeticache": [ 99, 206, diff --git a/openpype/settings/defaults/project_settings/nuke.json b/openpype/settings/defaults/project_settings/nuke.json index 5a819e6904..6992fb6e3e 100644 --- a/openpype/settings/defaults/project_settings/nuke.json +++ b/openpype/settings/defaults/project_settings/nuke.json @@ -116,13 +116,42 @@ "baking": { "filter": { "task_types": [], - "families": [] + "families": [], + "sebsets": [] }, "extension": "mov", "viewer_process_override": "", "bake_viewer_process": true, "bake_viewer_input_process": true, - "add_tags": [] + "add_tags": [], + "reformat_node_add": false, + "reformat_node_config": [ + { + "type": "string", + "name": "type", + "value": "to format" + }, + { + "type": "string", + "name": "format", + "value": "HD_1080" + }, + { + "type": "string", + "name": "filter", + "value": "Lanczos6" + }, + { + "type": "bool", + "name": "black_outside", + "value": true + }, + { + "type": "bool", + "name": "pbb", + "value": false + } + ] } } }, diff --git a/openpype/settings/defaults/project_settings/photoshop.json b/openpype/settings/defaults/project_settings/photoshop.json index f095986ee6..118b9c721e 100644 --- a/openpype/settings/defaults/project_settings/photoshop.json +++ b/openpype/settings/defaults/project_settings/photoshop.json @@ -28,6 +28,7 @@ ] }, "ExtractReview": { + "make_image_sequence": false, "jpg_options": { "tags": [] }, @@ -43,4 +44,4 @@ "create_first_version": false, "custom_templates": [] } -} \ No newline at end of file +} diff --git a/openpype/settings/defaults/project_settings/royalrender.json b/openpype/settings/defaults/project_settings/royalrender.json new file mode 100644 index 0000000000..be267b11d8 --- /dev/null +++ b/openpype/settings/defaults/project_settings/royalrender.json @@ -0,0 +1,7 @@ +{ + "publish": { + "CollectSequencesFromJob": { + "review": true + } + } +} \ No newline at end of file diff --git a/openpype/settings/defaults/project_settings/slack.json b/openpype/settings/defaults/project_settings/slack.json index 2d10bd173d..d77b8c2208 100644 --- a/openpype/settings/defaults/project_settings/slack.json +++ b/openpype/settings/defaults/project_settings/slack.json @@ -10,6 +10,7 @@ "hosts": [], "task_types": [], "tasks": [], + "subsets": [], "channel_messages": [] } ] diff --git a/openpype/settings/defaults/system_settings/applications.json b/openpype/settings/defaults/system_settings/applications.json index 912e2d9924..0fb99a2608 100644 --- a/openpype/settings/defaults/system_settings/applications.json +++ b/openpype/settings/defaults/system_settings/applications.json @@ -93,7 +93,7 @@ } }, "__dynamic_keys_labels__": { - "2022": "2022 (Testing Only)" + "2022": "2022" } } }, @@ -135,7 +135,7 @@ "OPENPYPE_WIRETAP_TOOLS": "/opt/Autodesk/wiretap/tools/2021" } }, - "2021.1": { + "2021_1": { "use_python_2": true, "executables": { "windows": [], @@ -159,7 +159,7 @@ }, "__dynamic_keys_labels__": { "2021": "2021", - "2021.1": "2021.1" + "2021_1": "2021.1" } } }, diff --git a/openpype/settings/entities/dict_conditional.py b/openpype/settings/entities/dict_conditional.py index 963fd406ed..19f326aea7 100644 --- a/openpype/settings/entities/dict_conditional.py +++ b/openpype/settings/entities/dict_conditional.py @@ -584,8 +584,9 @@ class DictConditionalEntity(ItemEntity): self.enum_entity.update_default_value(enum_value) for children_by_key in self.non_gui_children.values(): + value_copy = copy.deepcopy(value) for key, child_obj in children_by_key.items(): - child_value = value.get(key, NOT_SET) + child_value = value_copy.get(key, NOT_SET) child_obj.update_default_value(child_value) def update_studio_value(self, value): @@ -620,8 +621,9 @@ class DictConditionalEntity(ItemEntity): self.enum_entity.update_studio_value(enum_value) for children_by_key in self.non_gui_children.values(): + value_copy = copy.deepcopy(value) for key, child_obj in children_by_key.items(): - child_value = value.get(key, NOT_SET) + child_value = value_copy.get(key, NOT_SET) child_obj.update_studio_value(child_value) def update_project_value(self, value): @@ -656,8 +658,9 @@ class DictConditionalEntity(ItemEntity): self.enum_entity.update_project_value(enum_value) for children_by_key in self.non_gui_children.values(): + value_copy = copy.deepcopy(value) for key, child_obj in children_by_key.items(): - child_value = value.get(key, NOT_SET) + child_value = value_copy.get(key, NOT_SET) child_obj.update_project_value(child_value) def _discard_changes(self, on_change_trigger): diff --git a/openpype/settings/entities/schemas/projects_schema/schema_main.json b/openpype/settings/entities/schemas/projects_schema/schema_main.json index 8a2ad451ee..8e4eba86ef 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_main.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_main.json @@ -66,6 +66,10 @@ "type": "schema", "name": "schema_project_deadline" }, + { + "type": "schema", + "name": "schema_project_royalrender" + }, { "type": "schema", "name": "schema_project_slack" 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 788b1d8575..e6097a2b14 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json @@ -103,7 +103,7 @@ "DraftTileAssembler": "Draft Tile Assembler" }, { - "oiio": "Open Image IO" + "OpenPypeTileAssembler": "Open Image IO" } ] }, diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_flame.json b/openpype/settings/entities/schemas/projects_schema/schema_project_flame.json index 9ef05fa832..1f30b45981 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_project_flame.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_flame.json @@ -28,6 +28,11 @@ "key": "hierarchy", "label": "Shot parent hierarchy" }, + { + "type": "boolean", + "key": "useShotName", + "label": "Use Shot Name" + }, { "type": "boolean", "key": "clipRename", @@ -166,6 +171,24 @@ "label": "XML preset folder (optional)", "type": "text" }, + { + "key": "export_type", + "label": "Eport clip type", + "type": "enum", + "default": "File Sequence", + "enum_items": [ + { + "Movie": "Movie" + }, + { + "File Sequence": "File Sequence" + }, + { + "Sequence Publish": "Sequence Publish" + } + ] + + }, { "key": "colorspace_out", "label": "Output color (imageio)", diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_photoshop.json b/openpype/settings/entities/schemas/projects_schema/schema_project_photoshop.json index f54aa847b5..b499ccc4be 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_project_photoshop.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_photoshop.json @@ -164,6 +164,11 @@ "key": "ExtractReview", "label": "Extract Review", "children": [ + { + "type": "boolean", + "key": "make_image_sequence", + "label": "Makes an image sequence instead of a flatten image" + }, { "type": "dict", "collapsible": false, diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_royalrender.json b/openpype/settings/entities/schemas/projects_schema/schema_project_royalrender.json new file mode 100644 index 0000000000..cabb4747d5 --- /dev/null +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_royalrender.json @@ -0,0 +1,34 @@ +{ + "type": "dict", + "key": "royalrender", + "label": "Royal Render", + "collapsible": true, + "is_file": true, + "children": [ + { + "type": "dict", + "collapsible": true, + "key": "publish", + "label": "Publish plugins", + "children": [ + { + "type": "label", + "label": "Collectors" + }, + { + "type": "dict", + "collapsible": true, + "key": "CollectSequencesFromJob", + "label": "Collect Sequences from the Job", + "children": [ + { + "type": "boolean", + "key": "review", + "label": "Generate reviews from sequences" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_slack.json b/openpype/settings/entities/schemas/projects_schema/schema_project_slack.json index 4e82c991e7..14814d8b01 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_project_slack.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_slack.json @@ -69,6 +69,12 @@ "type": "list", "object_type": "text" }, + { + "key": "subsets", + "label": "Subset names", + "type": "list", + "object_type": "text" + }, { "type": "separator" }, diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_imageio.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_imageio.json index e000adacb0..2867332d82 100644 --- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_imageio.json +++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_imageio.json @@ -377,11 +377,47 @@ "type": "dict", "label": "Maya", "children": [ + { + "key": "colorManagementPreference_v2", + "type": "dict", + "label": "Color Management Preference v2 (Maya 2022+)", + "collapsible": true, + "checkbox_key": "enabled", + "children": [ + { + "type": "boolean", + "key": "enabled", + "label": "Use Color Management Preference v2" + }, + { + "type": "path", + "key": "configFilePath", + "label": "OCIO Config File Path", + "multiplatform": true, + "multipath": true + }, + { + "type": "text", + "key": "renderSpace", + "label": "Rendering Space" + }, + { + "type": "text", + "key": "displayName", + "label": "Display" + }, + { + "type": "text", + "key": "viewName", + "label": "View" + } + ] + }, { "key": "colorManagementPreference", "type": "dict", - "label": "Color Managment Preference", - "collapsible": false, + "label": "Color Management Preference (legacy)", + "collapsible": true, "children": [ { "type": "path", @@ -401,7 +437,7 @@ "label": "Viewer Transform" } ] - } + } ] }, { @@ -421,7 +457,7 @@ { "type": "text", "key": "colourPolicy", - "label": "Colour Policy" + "label": "Colour Policy (name or path)" }, { "type": "text", diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_publish.json index e608e9ff63..12043d4205 100644 --- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_publish.json +++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_publish.json @@ -291,6 +291,15 @@ "label": "Families", "type": "list", "object_type": "text" + }, + { + "type": "separator" + }, + { + "key": "subsets", + "label": "Subsets", + "type": "list", + "object_type": "text" } ] }, @@ -366,19 +375,6 @@ "minimum": 0, "maximum": 10000 }, - { - "key": "state", - "label": "Type", - "type": "enum", - "enum_items": [ - { - "letterbox": "Letterbox" - }, - { - "pillar": "Pillar" - } - ] - }, { "type": "color", "label": "Fill Color", diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_load.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_load.json index 7c87644817..6b2315abc0 100644 --- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_load.json +++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_load.json @@ -75,6 +75,11 @@ "label": "Vray Proxy:", "key": "vrayproxy" }, + { + "type": "color", + "label": "Vray Scene:", + "key": "vrayscene_layer" + }, { "type": "color", "label": "Yeti Cache:", 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 bf7b8a22e7..5c17e3db2c 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 @@ -547,6 +547,30 @@ "type": "schema", "name": "schema_maya_capture" }, + { + "type": "dict", + "collapsible": true, + "key": "ExtractMayaSceneRaw", + "label": "Maya Scene (Raw)", + "checkbox_key": "enabled", + "children": [ + { + "type": "boolean", + "key": "enabled", + "label": "Enabled" + }, + { + "type": "label", + "label": "Add loaded instances to those published families:" + }, + { + "key": "add_for_families", + "label": "Families", + "type": "list", + "object_type": "text" + } + ] + }, { "type": "dict", "collapsible": true, diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_nuke_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_nuke_publish.json index 39390f355a..1636a8d700 100644 --- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_nuke_publish.json +++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_nuke_publish.json @@ -195,6 +195,12 @@ "label": "Families", "type": "list", "object_type": "text" + }, + { + "key": "sebsets", + "label": "Subsets", + "type": "list", + "object_type": "text" } ] }, @@ -226,6 +232,121 @@ "label": "Add additional tags to representations", "type": "list", "object_type": "text" + }, + { + "type": "separator" + }, + { + "type": "boolean", + "key": "reformat_node_add", + "label": "Add Reformat Node", + "default": false + }, + { + "type": "collapsible-wrap", + "label": "Reformat Node Knobs", + "collapsible": true, + "collapsed": false, + "children": [ + { + "type": "list", + "key": "reformat_node_config", + "object_type": { + "type": "dict-conditional", + "enum_key": "type", + "enum_label": "Type", + "enum_children": [ + { + "key": "string", + "label": "String", + "children": [ + { + "type": "text", + "key": "name", + "label": "Name" + }, + { + "type": "text", + "key": "value", + "label": "Value" + } + ] + }, + { + "key": "bool", + "label": "Boolean", + "children": [ + { + "type": "text", + "key": "name", + "label": "Name" + }, + { + "type": "boolean", + "key": "value", + "label": "Value" + } + ] + }, + { + "key": "number", + "label": "Number", + "children": [ + { + "type": "text", + "key": "name", + "label": "Name" + }, + { + "type": "list-strict", + "key": "value", + "label": "Value", + "object_types": [ + { + "type": "number", + "key": "number", + "default": 1, + "decimal": 4 + } + ] + } + + ] + }, + { + "key": "list_numbers", + "label": "2 Numbers", + "children": [ + { + "type": "text", + "key": "name", + "label": "Name" + }, + { + "type": "list-strict", + "key": "value", + "label": "Value", + "object_types": [ + { + "type": "number", + "key": "x", + "default": 1, + "decimal": 4 + }, + { + "type": "number", + "key": "y", + "default": 1, + "decimal": 4 + } + ] + } + ] + } + ] + } + } + ] } ] } diff --git a/openpype/settings/handlers.py b/openpype/settings/handlers.py index 9f2b46d758..2109b53b09 100644 --- a/openpype/settings/handlers.py +++ b/openpype/settings/handlers.py @@ -694,7 +694,7 @@ class MongoSettingsHandler(SettingsHandler): return self.collection.find_one( {"type": self._version_order_key}, projection - ) + ) or {} def _check_version_order(self): """This method will work only in OpenPype process. diff --git a/openpype/style/__init__.py b/openpype/style/__init__.py index ea88b342ee..b2a1a4ce6c 100644 --- a/openpype/style/__init__.py +++ b/openpype/style/__init__.py @@ -7,13 +7,19 @@ from openpype import resources from .color_defs import parse_color - -_STYLESHEET_CACHE = None -_FONT_IDS = None - current_dir = os.path.dirname(os.path.abspath(__file__)) +class _Cache: + stylesheet = None + font_ids = None + + tools_icon_color = None + default_entity_icon_color = None + disabled_entity_icon_color = None + deprecated_entity_font_color = None + + def get_style_image_path(image_name): # All filenames are lowered image_name = image_name.lower() @@ -125,21 +131,19 @@ def _load_font(): """Load and register fonts into Qt application.""" from Qt import QtGui - global _FONT_IDS - # Check if font ids are still loaded - if _FONT_IDS is not None: - for font_id in tuple(_FONT_IDS): + if _Cache.font_ids is not None: + for font_id in tuple(_Cache.font_ids): font_families = QtGui.QFontDatabase.applicationFontFamilies( font_id ) # Reset font if font id is not available if not font_families: - _FONT_IDS = None + _Cache.font_ids = None break - if _FONT_IDS is None: - _FONT_IDS = [] + if _Cache.font_ids is None: + _Cache.font_ids = [] fonts_dirpath = os.path.join(current_dir, "fonts") font_dirs = [] font_dirs.append(os.path.join(fonts_dirpath, "Noto_Sans")) @@ -157,7 +161,7 @@ def _load_font(): continue full_path = os.path.join(font_dir, filename) font_id = QtGui.QFontDatabase.addApplicationFont(full_path) - _FONT_IDS.append(font_id) + _Cache.font_ids.append(font_id) font_families = QtGui.QFontDatabase.applicationFontFamilies( font_id ) @@ -167,11 +171,11 @@ def _load_font(): def load_stylesheet(): """Load and return OpenPype Qt stylesheet.""" - global _STYLESHEET_CACHE - if _STYLESHEET_CACHE is None: - _STYLESHEET_CACHE = _load_stylesheet() + + if _Cache.stylesheet is None: + _Cache.stylesheet = _load_stylesheet() _load_font() - return _STYLESHEET_CACHE + return _Cache.stylesheet def get_app_icon_path(): @@ -182,3 +186,63 @@ def get_app_icon_path(): def app_icon_path(): # Backwards compatibility return get_app_icon_path() + + +def get_default_tools_icon_color(): + """Default color used in tool icons. + + Color must be possible to parse using QColor. + + Returns: + str: Color as a string. + """ + if _Cache.tools_icon_color is None: + color_data = get_colors_data() + _Cache.tools_icon_color = color_data["icon-tools"] + return _Cache.tools_icon_color + + +def get_default_entity_icon_color(): + """Default color of entities icons. + + Color must be possible to parse using QColor. + + Returns: + str: Color as a string. + """ + if _Cache.default_entity_icon_color is None: + color_data = get_colors_data() + _Cache.default_entity_icon_color = color_data["icon-entity-default"] + return _Cache.default_entity_icon_color + + +def get_disabled_entity_icon_color(): + """Default color of entities icons. + + TODO: Find more suitable function name. + + Color must be possible to parse using QColor. + + Returns: + str: Color as a string. + """ + if _Cache.disabled_entity_icon_color is None: + color_data = get_colors_data() + _Cache.disabled_entity_icon_color = color_data["icon-entity-disabled"] + return _Cache.disabled_entity_icon_color + + +def get_deprecated_entity_font_color(): + """Font color for deprecated entities. + + Color must be possible to parse using QColor. + + Returns: + str: Color as a string. + """ + if _Cache.deprecated_entity_font_color is None: + color_data = get_colors_data() + _Cache.deprecated_entity_font_color = ( + color_data["font-entity-deprecated"] + ) + return _Cache.deprecated_entity_font_color diff --git a/openpype/style/data.json b/openpype/style/data.json index b8ccef8bbd..a76a77015b 100644 --- a/openpype/style/data.json +++ b/openpype/style/data.json @@ -56,6 +56,12 @@ "delete-btn-bg": "rgb(201, 54, 54)", "delete-btn-bg-disabled": "rgba(201, 54, 54, 64)", + "icon-tools": "#ffffff", + "icon-alert-tools": "#AA5050", + "icon-entity-default": "#bfccd6", + "icon-entity-disabled": "#808080", + "font-entity-deprecated": "#666666", + "tab-widget": { "bg": "#21252B", "bg-selected": "#434a56", diff --git a/openpype/style/style.css b/openpype/style/style.css index c96e87aa02..df83600973 100644 --- a/openpype/style/style.css +++ b/openpype/style/style.css @@ -836,6 +836,19 @@ QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { } /* New Create/Publish UI */ +#CreateDialogHelpButton { + background: rgba(255, 255, 255, 31); + border-top-right-radius: 0; + border-bottom-right-radius: 0; + font-size: 10pt; + font-weight: bold; + padding: 3px 3px 3px 3px; +} + +#CreateDialogHelpButton:hover { + background: rgba(255, 255, 255, 63); +} + #PublishLogConsole { font-family: "Noto Sans Mono"; } @@ -1261,6 +1274,18 @@ QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { background: {color:restart-btn-bg}; } +/* Tray publisher */ +#ChooseProjectLabel { + font-size: 15pt; + font-weight: 750; +} +#ChooseProjectFrame { + border-radius: 10px; +} +#ChooseProjectView { + background: transparent; +} + /* Globally used names */ #Separator { background: {color:bg-menu-separator}; diff --git a/openpype/tests/test_avalon_plugin_presets.py b/openpype/tests/test_avalon_plugin_presets.py index ec21385d23..f1b1a94713 100644 --- a/openpype/tests/test_avalon_plugin_presets.py +++ b/openpype/tests/test_avalon_plugin_presets.py @@ -1,8 +1,9 @@ import avalon.api as api import openpype +from openpype.pipeline import LegacyCreator -class MyTestCreator(api.Creator): +class MyTestCreator(LegacyCreator): my_test_property = "A" @@ -26,8 +27,8 @@ def test_avalon_plugin_presets(monkeypatch, printer): openpype.install() api.register_host(Test()) - api.register_plugin(api.Creator, MyTestCreator) - plugins = api.discover(api.Creator) + api.register_plugin(LegacyCreator, MyTestCreator) + plugins = api.discover(LegacyCreator) printer("Test if we got our test plugin") assert MyTestCreator in plugins for p in plugins: diff --git a/openpype/tests/test_lib_restructuralization.py b/openpype/tests/test_lib_restructuralization.py index d0461e55fb..94080e550d 100644 --- a/openpype/tests/test_lib_restructuralization.py +++ b/openpype/tests/test_lib_restructuralization.py @@ -24,7 +24,7 @@ def test_backward_compatibility(printer): from openpype.lib import get_hierarchy from openpype.lib import get_linked_assets from openpype.lib import get_latest_version - from openpype.lib import ffprobe_streams + from openpype.lib import get_ffprobe_streams from openpype.hosts.fusion.lib import switch_item diff --git a/openpype/tools/adobe_webserver/app.py b/openpype/tools/adobe_webserver/app.py new file mode 100644 index 0000000000..b79d6c6c60 --- /dev/null +++ b/openpype/tools/adobe_webserver/app.py @@ -0,0 +1,237 @@ +"""This Webserver tool is python 3 specific. + +Don't import directly to avalon.tools or implementation of Python 2 hosts +would break. +""" +import os +import logging +import urllib +import threading +import asyncio +import socket + +from aiohttp import web + +from wsrpc_aiohttp import ( + WSRPCClient +) + +from avalon import api + +log = logging.getLogger(__name__) + + +class WebServerTool: + """ + Basic POC implementation of asychronic websocket RPC server. + Uses class in external_app_1.py to mimic implementation for single + external application. + 'test_client' folder contains two test implementations of client + """ + _instance = None + + def __init__(self): + WebServerTool._instance = self + + self.client = None + self.handlers = {} + self.on_stop_callbacks = [] + + port = None + host_name = "localhost" + websocket_url = os.getenv("WEBSOCKET_URL") + if websocket_url: + parsed = urllib.parse.urlparse(websocket_url) + port = parsed.port + host_name = parsed.netloc.split(":")[0] + if not port: + port = 8098 # fallback + + self.port = port + self.host_name = host_name + + self.app = web.Application() + + # add route with multiple methods for single "external app" + self.webserver_thread = WebServerThread(self, self.port) + + def add_route(self, *args, **kwargs): + self.app.router.add_route(*args, **kwargs) + + def add_static(self, *args, **kwargs): + self.app.router.add_static(*args, **kwargs) + + def start_server(self): + if self.webserver_thread and not self.webserver_thread.is_alive(): + self.webserver_thread.start() + + def stop_server(self): + self.stop() + + async def send_context_change(self, host): + """ + Calls running webserver to inform about context change + + Used when new PS/AE should be triggered, + but one already running, without + this publish would point to old context. + """ + client = WSRPCClient(os.getenv("WEBSOCKET_URL"), + loop=asyncio.get_event_loop()) + await client.connect() + + project = api.Session["AVALON_PROJECT"] + asset = api.Session["AVALON_ASSET"] + task = api.Session["AVALON_TASK"] + log.info("Sending context change to {}-{}-{}".format(project, + asset, + task)) + + await client.call('{}.set_context'.format(host), + project=project, asset=asset, task=task) + await client.close() + + def port_occupied(self, host_name, port): + """ + Check if 'url' is already occupied. + + This could mean, that app is already running and we are trying open it + again. In that case, use existing running webserver. + Check here is easier than capturing exception from thread. + """ + sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + result = True + try: + sock.bind((host_name, port)) + result = False + except: + print("Port is in use") + + return result + + def call(self, func): + log.debug("websocket.call {}".format(func)) + future = asyncio.run_coroutine_threadsafe( + func, + self.webserver_thread.loop + ) + result = future.result() + return result + + @staticmethod + def get_instance(): + if WebServerTool._instance is None: + WebServerTool() + return WebServerTool._instance + + @property + def is_running(self): + if not self.webserver_thread: + return False + return self.webserver_thread.is_running + + def stop(self): + if not self.is_running: + return + try: + log.debug("Stopping websocket server") + self.webserver_thread.is_running = False + self.webserver_thread.stop() + except Exception: + log.warning( + "Error has happened during Killing websocket server", + exc_info=True + ) + + def thread_stopped(self): + for callback in self.on_stop_callbacks: + callback() + + +class WebServerThread(threading.Thread): + """ Listener for websocket rpc requests. + + It would be probably better to "attach" this to main thread (as for + example Harmony needs to run something on main thread), but currently + it creates separate thread and separate asyncio event loop + """ + def __init__(self, module, port): + super(WebServerThread, self).__init__() + + self.is_running = False + self.port = port + self.module = module + self.loop = None + self.runner = None + self.site = None + self.tasks = [] + + def run(self): + self.is_running = True + + try: + log.info("Starting web server") + self.loop = asyncio.new_event_loop() # create new loop for thread + asyncio.set_event_loop(self.loop) + + self.loop.run_until_complete(self.start_server()) + + websocket_url = "ws://localhost:{}/ws".format(self.port) + + log.debug( + "Running Websocket server on URL: \"{}\"".format(websocket_url) + ) + + asyncio.ensure_future(self.check_shutdown(), loop=self.loop) + self.loop.run_forever() + except Exception: + self.is_running = False + log.warning( + "Websocket Server service has failed", exc_info=True + ) + raise + finally: + self.loop.close() # optional + + self.is_running = False + self.module.thread_stopped() + log.info("Websocket server stopped") + + async def start_server(self): + """ Starts runner and TCPsite """ + self.runner = web.AppRunner(self.module.app) + await self.runner.setup() + self.site = web.TCPSite(self.runner, 'localhost', self.port) + await self.site.start() + + def stop(self): + """Sets is_running flag to false, 'check_shutdown' shuts server down""" + self.is_running = False + + async def check_shutdown(self): + """ Future that is running and checks if server should be running + periodically. + """ + while self.is_running: + while self.tasks: + task = self.tasks.pop(0) + log.debug("waiting for task {}".format(task)) + await task + log.debug("returned value {}".format(task.result)) + + await asyncio.sleep(0.5) + + log.debug("Starting shutdown") + await self.site.stop() + log.debug("Site stopped") + await self.runner.cleanup() + log.debug("Runner stopped") + tasks = [task for task in asyncio.all_tasks() if + task is not asyncio.current_task()] + list(map(lambda task: task.cancel(), tasks)) # cancel all the tasks + results = await asyncio.gather(*tasks, return_exceptions=True) + log.debug(f'Finished awaiting cancelled tasks, results: {results}...') + await self.loop.shutdown_asyncgens() + # to really make sure everything else has time to stop + await asyncio.sleep(0.07) + self.loop.stop() diff --git a/openpype/tools/adobe_webserver/readme.txt b/openpype/tools/adobe_webserver/readme.txt new file mode 100644 index 0000000000..06cf140fc4 --- /dev/null +++ b/openpype/tools/adobe_webserver/readme.txt @@ -0,0 +1,12 @@ +Adobe webserver +--------------- +Aiohttp (Asyncio) based websocket server used for communication with host +applications, currently only for Adobe (but could be used for any non python +DCC which has websocket client). + +This webserver is started in spawned Python process that opens DCC during +its launch, waits for connection from DCC and handles communication going +forward. Server is closed before Python process is killed. + +(Different from `openpype/modules/webserver` as that one is running in Tray, +this one is running in spawn Python process.) \ No newline at end of file diff --git a/openpype/tools/assetcreator/__init__.py b/openpype/tools/assetcreator/__init__.py deleted file mode 100644 index 3b88ebe984..0000000000 --- a/openpype/tools/assetcreator/__init__.py +++ /dev/null @@ -1,10 +0,0 @@ - -from .app import ( - show, - cli -) - -__all__ = [ - "show", - "cli", -] diff --git a/openpype/tools/assetcreator/__main__.py b/openpype/tools/assetcreator/__main__.py deleted file mode 100644 index d77bc585c5..0000000000 --- a/openpype/tools/assetcreator/__main__.py +++ /dev/null @@ -1,5 +0,0 @@ -from . import cli - -if __name__ == '__main__': - import sys - sys.exit(cli(sys.argv[1:])) diff --git a/openpype/tools/assetcreator/app.py b/openpype/tools/assetcreator/app.py deleted file mode 100644 index 1d332d647e..0000000000 --- a/openpype/tools/assetcreator/app.py +++ /dev/null @@ -1,652 +0,0 @@ -import os -import sys -from subprocess import Popen - -import ftrack_api -from Qt import QtWidgets, QtCore -from openpype.api import get_current_project_settings -from openpype.tools.utils.lib import qt_app_context -from avalon import io, api, style, schema -from . import widget, model - -module = sys.modules[__name__] -module.window = None - - -class Window(QtWidgets.QDialog): - """Asset creator interface - - """ - - def __init__(self, parent=None, context=None): - super(Window, self).__init__(parent) - self.context = context - project_name = io.active_project() - self.setWindowTitle("Asset creator ({0})".format(project_name)) - self.setFocusPolicy(QtCore.Qt.StrongFocus) - self.setAttribute(QtCore.Qt.WA_DeleteOnClose) - - # Validators - self.valid_parent = False - - self.session = None - - # assets widget - assets_widget = QtWidgets.QWidget() - assets_widget.setContentsMargins(0, 0, 0, 0) - assets_layout = QtWidgets.QVBoxLayout(assets_widget) - assets = widget.AssetWidget() - assets.view.setSelectionMode(assets.view.ExtendedSelection) - assets_layout.addWidget(assets) - - # Outlink - label_outlink = QtWidgets.QLabel("Outlink:") - input_outlink = QtWidgets.QLineEdit() - input_outlink.setReadOnly(True) - input_outlink.setStyleSheet("background-color: #333333;") - checkbox_outlink = QtWidgets.QCheckBox("Use outlink") - # Parent - label_parent = QtWidgets.QLabel("*Parent:") - input_parent = QtWidgets.QLineEdit() - input_parent.setReadOnly(True) - input_parent.setStyleSheet("background-color: #333333;") - - # Name - label_name = QtWidgets.QLabel("*Name:") - input_name = QtWidgets.QLineEdit() - input_name.setPlaceholderText("") - - # Asset Build - label_assetbuild = QtWidgets.QLabel("Asset Build:") - combo_assetbuilt = QtWidgets.QComboBox() - - # Task template - label_task_template = QtWidgets.QLabel("Task template:") - combo_task_template = QtWidgets.QComboBox() - - # Info widget - info_widget = QtWidgets.QWidget() - info_widget.setContentsMargins(10, 10, 10, 10) - info_layout = QtWidgets.QVBoxLayout(info_widget) - - # Inputs widget - inputs_widget = QtWidgets.QWidget() - inputs_widget.setContentsMargins(0, 0, 0, 0) - - inputs_layout = QtWidgets.QFormLayout(inputs_widget) - inputs_layout.addRow(label_outlink, input_outlink) - inputs_layout.addRow(None, checkbox_outlink) - inputs_layout.addRow(label_parent, input_parent) - inputs_layout.addRow(label_name, input_name) - inputs_layout.addRow(label_assetbuild, combo_assetbuilt) - inputs_layout.addRow(label_task_template, combo_task_template) - - # Add button - btns_widget = QtWidgets.QWidget() - btns_widget.setContentsMargins(0, 0, 0, 0) - btn_layout = QtWidgets.QHBoxLayout(btns_widget) - btn_create_asset = QtWidgets.QPushButton("Create asset") - btn_create_asset.setToolTip( - "Creates all necessary components for asset" - ) - checkbox_app = None - if self.context is not None: - checkbox_app = QtWidgets.QCheckBox("Open {}".format( - self.context.capitalize()) - ) - btn_layout.addWidget(checkbox_app) - btn_layout.addWidget(btn_create_asset) - - task_view = QtWidgets.QTreeView() - task_view.setIndentation(0) - task_model = model.TasksModel() - task_view.setModel(task_model) - - info_layout.addWidget(inputs_widget) - info_layout.addWidget(task_view) - info_layout.addWidget(btns_widget) - - # Body - body = QtWidgets.QSplitter() - body.setContentsMargins(0, 0, 0, 0) - body.setSizePolicy(QtWidgets.QSizePolicy.Expanding, - QtWidgets.QSizePolicy.Expanding) - body.setOrientation(QtCore.Qt.Horizontal) - body.addWidget(assets_widget) - body.addWidget(info_widget) - body.setStretchFactor(0, 100) - body.setStretchFactor(1, 150) - - # statusbar - message = QtWidgets.QLabel() - message.setFixedHeight(20) - - statusbar = QtWidgets.QWidget() - layout = QtWidgets.QHBoxLayout(statusbar) - layout.setContentsMargins(0, 0, 0, 0) - layout.addWidget(message) - - layout = QtWidgets.QVBoxLayout(self) - layout.addWidget(body) - layout.addWidget(statusbar) - - self.data = { - "label": { - "message": message, - }, - "view": { - "tasks": task_view - }, - "model": { - "assets": assets, - "tasks": task_model - }, - "inputs": { - "outlink": input_outlink, - "outlink_cb": checkbox_outlink, - "parent": input_parent, - "name": input_name, - "assetbuild": combo_assetbuilt, - "tasktemplate": combo_task_template, - "open_app": checkbox_app - }, - "buttons": { - "create_asset": btn_create_asset - } - } - - # signals - btn_create_asset.clicked.connect(self.create_asset) - assets.selection_changed.connect(self.on_asset_changed) - input_name.textChanged.connect(self.on_asset_name_change) - checkbox_outlink.toggled.connect(self.on_outlink_checkbox_change) - combo_task_template.currentTextChanged.connect( - self.on_task_template_changed - ) - if self.context is not None: - checkbox_app.toggled.connect(self.on_app_checkbox_change) - # on start - self.on_start() - - self.resize(600, 500) - - self.echo("Connected to project: {0}".format(project_name)) - - def open_app(self): - if self.context == 'maya': - Popen("maya") - else: - message = QtWidgets.QMessageBox(self) - message.setWindowTitle("App is not set") - message.setIcon(QtWidgets.QMessageBox.Critical) - message.show() - - def on_start(self): - project_name = io.Session['AVALON_PROJECT'] - project_query = 'Project where full_name is "{}"'.format(project_name) - if self.session is None: - session = ftrack_api.Session() - self.session = session - else: - session = self.session - ft_project = session.query(project_query).one() - schema_name = ft_project['project_schema']['name'] - # Load config - schemas_items = get_current_project_settings().get('ftrack', {}).get( - 'project_schemas', {} - ) - # Get info if it is silo project - self.silos = io.distinct("silo") - if self.silos and None in self.silos: - self.silos = None - - key = "default" - if schema_name in schemas_items: - key = schema_name - - self.config_data = schemas_items[key] - - # set outlink - input_outlink = self.data['inputs']['outlink'] - checkbox_outlink = self.data['inputs']['outlink_cb'] - outlink_text = io.Session.get('AVALON_ASSET', '') - checkbox_outlink.setChecked(True) - if outlink_text == '': - outlink_text = '< No context >' - checkbox_outlink.setChecked(False) - checkbox_outlink.hide() - input_outlink.setText(outlink_text) - - # load asset build types - self.load_assetbuild_types() - - # Load task templates - self.load_task_templates() - self.data["model"]["assets"].refresh() - self.on_asset_changed() - - def create_asset(self): - name_input = self.data['inputs']['name'] - name = name_input.text() - test_name = name.replace(' ', '') - error_message = None - message = QtWidgets.QMessageBox(self) - message.setWindowTitle("Some errors have occurred") - message.setIcon(QtWidgets.QMessageBox.Critical) - # TODO: show error messages on any error - if self.valid_parent is not True and test_name == '': - error_message = "Name is not set and Parent is not selected" - elif self.valid_parent is not True: - error_message = "Parent is not selected" - elif test_name == '': - error_message = "Name is not set" - - if error_message is not None: - message.setText(error_message) - message.show() - return - - test_name_exists = io.find({ - 'type': 'asset', - 'name': name - }) - existing_assets = [x for x in test_name_exists] - if len(existing_assets) > 0: - message.setText("Entered Asset name is occupied") - message.show() - return - - checkbox_app = self.data['inputs']['open_app'] - if checkbox_app is not None and checkbox_app.isChecked() is True: - task_view = self.data["view"]["tasks"] - task_model = self.data["model"]["tasks"] - try: - index = task_view.selectedIndexes()[0] - task_name = task_model.itemData(index)[0] - except Exception: - message.setText("Please select task") - message.show() - return - - # Get ftrack session - if self.session is None: - session = ftrack_api.Session() - self.session = session - else: - session = self.session - - # Get Ftrack project entity - project_name = io.Session['AVALON_PROJECT'] - project_query = 'Project where full_name is "{}"'.format(project_name) - try: - ft_project = session.query(project_query).one() - except Exception: - message.setText("Ftrack project was not found") - message.show() - return - - # Get Ftrack entity of parent - ft_parent = None - assets_model = self.data["model"]["assets"] - selected = assets_model.get_selected_assets() - parent = io.find_one({"_id": selected[0], "type": "asset"}) - asset_id = parent.get('data', {}).get('ftrackId', None) - asset_entity_type = parent.get('data', {}).get('entityType', None) - asset_query = '{} where id is "{}"' - if asset_id is not None and asset_entity_type is not None: - try: - ft_parent = session.query(asset_query.format( - asset_entity_type, asset_id) - ).one() - except Exception: - ft_parent = None - - if ft_parent is None: - ft_parent = self.get_ftrack_asset(parent, ft_project) - - if ft_parent is None: - message.setText("Parent's Ftrack entity was not found") - message.show() - return - - asset_build_combo = self.data['inputs']['assetbuild'] - asset_type_name = asset_build_combo.currentText() - asset_type_query = 'Type where name is "{}"'.format(asset_type_name) - try: - asset_type = session.query(asset_type_query).one() - except Exception: - message.setText("Selected Asset Build type does not exists") - message.show() - return - - for children in ft_parent['children']: - if children['name'] == name: - message.setText("Entered Asset name is occupied") - message.show() - return - - task_template_combo = self.data['inputs']['tasktemplate'] - task_template = task_template_combo.currentText() - tasks = [] - for template in self.config_data['task_templates']: - if template['name'] == task_template: - tasks = template['task_types'] - break - - available_task_types = [] - task_types = ft_project['project_schema']['_task_type_schema'] - for task_type in task_types['types']: - available_task_types.append(task_type['name']) - - not_possible_tasks = [] - for task in tasks: - if task not in available_task_types: - not_possible_tasks.append(task) - - if len(not_possible_tasks) != 0: - message.setText(( - "These Task types weren't found" - " in Ftrack project schema:\n{}").format( - ', '.join(not_possible_tasks)) - ) - message.show() - return - - # Create asset build - asset_build_data = { - 'name': name, - 'project_id': ft_project['id'], - 'parent_id': ft_parent['id'], - 'type': asset_type - } - - new_entity = session.create('AssetBuild', asset_build_data) - - task_data = { - 'project_id': ft_project['id'], - 'parent_id': new_entity['id'] - } - - for task in tasks: - type = session.query('Type where name is "{}"'.format(task)).one() - - task_data['type_id'] = type['id'] - task_data['name'] = task - session.create('Task', task_data) - - av_project = io.find_one({'type': 'project'}) - - hiearchy_items = [] - hiearchy_items.extend(self.get_avalon_parent(parent)) - hiearchy_items.append(parent['name']) - - hierarchy = os.path.sep.join(hiearchy_items) - new_asset_data = { - 'ftrackId': new_entity['id'], - 'entityType': new_entity.entity_type, - 'visualParent': parent['_id'], - 'tasks': tasks, - 'parents': hiearchy_items, - 'hierarchy': hierarchy - } - new_asset_info = { - 'parent': av_project['_id'], - 'name': name, - 'schema': "openpype:asset-3.0", - 'type': 'asset', - 'data': new_asset_data - } - - # Backwards compatibility (add silo from parent if is silo project) - if self.silos: - new_asset_info["silo"] = parent["silo"] - - try: - schema.validate(new_asset_info) - except Exception: - message.setText(( - 'Asset information are not valid' - ' to create asset in avalon database' - )) - message.show() - session.rollback() - return - io.insert_one(new_asset_info) - session.commit() - - outlink_cb = self.data['inputs']['outlink_cb'] - if outlink_cb.isChecked() is True: - outlink_input = self.data['inputs']['outlink'] - outlink_name = outlink_input.text() - outlink_asset = io.find_one({ - 'type': 'asset', - 'name': outlink_name - }) - outlink_ft_id = outlink_asset.get('data', {}).get('ftrackId', None) - outlink_entity_type = outlink_asset.get( - 'data', {} - ).get('entityType', None) - if outlink_ft_id is not None and outlink_entity_type is not None: - try: - outlink_entity = session.query(asset_query.format()).one() - except Exception: - outlink_entity = None - - if outlink_entity is None: - outlink_entity = self.get_ftrack_asset( - outlink_asset, ft_project - ) - - if outlink_entity is None: - message.setText("Outlink's Ftrack entity was not found") - message.show() - return - - link_data = { - 'from_id': new_entity['id'], - 'to_id': outlink_entity['id'] - } - session.create('TypedContextLink', link_data) - session.commit() - - if checkbox_app is not None and checkbox_app.isChecked() is True: - origin_asset = api.Session.get('AVALON_ASSET', None) - origin_task = api.Session.get('AVALON_TASK', None) - asset_name = name - task_view = self.data["view"]["tasks"] - task_model = self.data["model"]["tasks"] - try: - index = task_view.selectedIndexes()[0] - except Exception: - message.setText("No task is selected. App won't be launched") - message.show() - return - task_name = task_model.itemData(index)[0] - try: - api.update_current_task(task=task_name, asset=asset_name) - self.open_app() - - finally: - if origin_task is not None and origin_asset is not None: - api.update_current_task( - task=origin_task, asset=origin_asset - ) - - message.setWindowTitle("Asset Created") - message.setText("Asset Created successfully") - message.setIcon(QtWidgets.QMessageBox.Information) - message.show() - - def get_ftrack_asset(self, asset, ft_project): - parenthood = [] - parenthood.extend(self.get_avalon_parent(asset)) - parenthood.append(asset['name']) - parenthood = list(reversed(parenthood)) - output_entity = None - ft_entity = ft_project - index = len(parenthood) - 1 - while True: - name = parenthood[index] - found = False - for children in ft_entity['children']: - if children['name'] == name: - ft_entity = children - found = True - break - if found is False: - return None - if index == 0: - output_entity = ft_entity - break - index -= 1 - - return output_entity - - def get_avalon_parent(self, entity): - parent_id = entity['data']['visualParent'] - parents = [] - if parent_id is not None: - parent = io.find_one({'_id': parent_id}) - parents.extend(self.get_avalon_parent(parent)) - parents.append(parent['name']) - return parents - - def echo(self, message): - widget = self.data["label"]["message"] - widget.setText(str(message)) - - QtCore.QTimer.singleShot(5000, lambda: widget.setText("")) - - print(message) - - def load_task_templates(self): - templates = self.config_data.get('task_templates', []) - all_names = [] - for template in templates: - all_names.append(template['name']) - - tt_combobox = self.data['inputs']['tasktemplate'] - tt_combobox.clear() - tt_combobox.addItems(all_names) - - def load_assetbuild_types(self): - types = [] - schemas = self.config_data.get('schemas', []) - for _schema in schemas: - if _schema['object_type'] == 'Asset Build': - types = _schema['task_types'] - break - ab_combobox = self.data['inputs']['assetbuild'] - ab_combobox.clear() - ab_combobox.addItems(types) - - def on_app_checkbox_change(self): - task_model = self.data['model']['tasks'] - app_checkbox = self.data['inputs']['open_app'] - if app_checkbox.isChecked() is True: - task_model.selectable = True - else: - task_model.selectable = False - - def on_outlink_checkbox_change(self): - checkbox_outlink = self.data['inputs']['outlink_cb'] - outlink_input = self.data['inputs']['outlink'] - if checkbox_outlink.isChecked() is True: - outlink_text = io.Session['AVALON_ASSET'] - else: - outlink_text = '< Outlinks won\'t be set >' - - outlink_input.setText(outlink_text) - - def on_task_template_changed(self): - combobox = self.data['inputs']['tasktemplate'] - task_model = self.data['model']['tasks'] - name = combobox.currentText() - tasks = [] - for template in self.config_data['task_templates']: - if template['name'] == name: - tasks = template['task_types'] - break - task_model.set_tasks(tasks) - - def on_asset_changed(self): - """Callback on asset selection changed - - This updates the task view. - - """ - assets_model = self.data["model"]["assets"] - parent_input = self.data['inputs']['parent'] - selected = assets_model.get_selected_assets() - - self.valid_parent = False - if len(selected) > 1: - parent_input.setText('< Please select only one asset! >') - elif len(selected) == 1: - if isinstance(selected[0], io.ObjectId): - self.valid_parent = True - asset = io.find_one({"_id": selected[0], "type": "asset"}) - parent_input.setText(asset['name']) - else: - parent_input.setText('< Selected invalid parent(silo) >') - else: - parent_input.setText('< Nothing is selected >') - - self.creatability_check() - - def on_asset_name_change(self): - self.creatability_check() - - def creatability_check(self): - name_input = self.data['inputs']['name'] - name = str(name_input.text()).strip() - creatable = False - if name and self.valid_parent: - creatable = True - - self.data["buttons"]["create_asset"].setEnabled(creatable) - - - -def show(parent=None, debug=False, context=None): - """Display Loader GUI - - Arguments: - debug (bool, optional): Run loader in debug-mode, - defaults to False - - """ - - try: - module.window.close() - del module.window - except (RuntimeError, AttributeError): - pass - - if debug is True: - io.install() - - with qt_app_context(): - window = Window(parent, context) - window.setStyleSheet(style.load_stylesheet()) - window.show() - - module.window = window - - -def cli(args): - import argparse - parser = argparse.ArgumentParser() - parser.add_argument("project") - parser.add_argument("asset") - - args = parser.parse_args(args) - project = args.project - asset = args.asset - io.install() - - api.Session["AVALON_PROJECT"] = project - if asset != '': - api.Session["AVALON_ASSET"] = asset - - show() diff --git a/openpype/tools/assetcreator/model.py b/openpype/tools/assetcreator/model.py deleted file mode 100644 index f84541ca2a..0000000000 --- a/openpype/tools/assetcreator/model.py +++ /dev/null @@ -1,310 +0,0 @@ -import re -import logging - -from Qt import QtCore, QtWidgets -from avalon.vendor import qtawesome -from avalon import io -from avalon import style - -log = logging.getLogger(__name__) - - -class Item(dict): - """An item that can be represented in a tree view using `TreeModel`. - - The item can store data just like a regular dictionary. - - >>> data = {"name": "John", "score": 10} - >>> item = Item(data) - >>> assert item["name"] == "John" - - """ - - def __init__(self, data=None): - super(Item, self).__init__() - - self._children = list() - self._parent = None - - if data is not None: - assert isinstance(data, dict) - self.update(data) - - def childCount(self): - return len(self._children) - - def child(self, row): - - if row >= len(self._children): - log.warning("Invalid row as child: {0}".format(row)) - return - - return self._children[row] - - def children(self): - return self._children - - def parent(self): - return self._parent - - def row(self): - """ - Returns: - int: Index of this item under parent""" - if self._parent is not None: - siblings = self.parent().children() - return siblings.index(self) - - def add_child(self, child): - """Add a child to this item""" - child._parent = self - self._children.append(child) - - -class TreeModel(QtCore.QAbstractItemModel): - - Columns = list() - ItemRole = QtCore.Qt.UserRole + 1 - - def __init__(self, parent=None): - super(TreeModel, self).__init__(parent) - self._root_item = Item() - - def rowCount(self, parent): - if parent.isValid(): - item = parent.internalPointer() - else: - item = self._root_item - - return item.childCount() - - def columnCount(self, parent): - return len(self.Columns) - - def data(self, index, role): - - if not index.isValid(): - return None - - if role == QtCore.Qt.DisplayRole or role == QtCore.Qt.EditRole: - - item = index.internalPointer() - column = index.column() - - key = self.Columns[column] - return item.get(key, None) - - if role == self.ItemRole: - return index.internalPointer() - - def setData(self, index, value, role=QtCore.Qt.EditRole): - """Change the data on the items. - - Returns: - bool: Whether the edit was successful - """ - - if index.isValid(): - if role == QtCore.Qt.EditRole: - - item = index.internalPointer() - column = index.column() - key = self.Columns[column] - item[key] = value - - # passing `list()` for PyQt5 (see PYSIDE-462) - self.dataChanged.emit(index, index, list()) - - # must return true if successful - return True - - return False - - def setColumns(self, keys): - assert isinstance(keys, (list, tuple)) - self.Columns = keys - - def headerData(self, section, orientation, role): - - if role == QtCore.Qt.DisplayRole: - if section < len(self.Columns): - return self.Columns[section] - - super(TreeModel, self).headerData(section, orientation, role) - - def flags(self, index): - flags = QtCore.Qt.ItemIsEnabled - - item = index.internalPointer() - if item.get("enabled", True): - flags |= QtCore.Qt.ItemIsSelectable - - return flags - - def parent(self, index): - - item = index.internalPointer() - parent_item = item.parent() - - # If it has no parents we return invalid - if parent_item == self._root_item or not parent_item: - return QtCore.QModelIndex() - - return self.createIndex(parent_item.row(), 0, parent_item) - - def index(self, row, column, parent): - """Return index for row/column under parent""" - - if not parent.isValid(): - parent_item = self._root_item - else: - parent_item = parent.internalPointer() - - child_item = parent_item.child(row) - if child_item: - return self.createIndex(row, column, child_item) - else: - return QtCore.QModelIndex() - - def add_child(self, item, parent=None): - if parent is None: - parent = self._root_item - - parent.add_child(item) - - def column_name(self, column): - """Return column key by index""" - - if column < len(self.Columns): - return self.Columns[column] - - def clear(self): - self.beginResetModel() - self._root_item = Item() - self.endResetModel() - - -class TasksModel(TreeModel): - """A model listing the tasks combined for a list of assets""" - - Columns = ["Tasks"] - - def __init__(self): - super(TasksModel, self).__init__() - self._num_assets = 0 - self._icons = { - "__default__": qtawesome.icon("fa.male", - color=style.colors.default), - "__no_task__": qtawesome.icon("fa.exclamation-circle", - color=style.colors.mid) - } - - self._get_task_icons() - - def _get_task_icons(self): - # Get the project configured icons from database - project = io.find_one({"type": "project"}) - tasks = project["config"].get("tasks", []) - for task in tasks: - icon_name = task.get("icon", None) - if icon_name: - icon = qtawesome.icon("fa.{}".format(icon_name), - color=style.colors.default) - self._icons[task["name"]] = icon - - def set_tasks(self, tasks): - """Set assets to track by their database id - - Arguments: - asset_ids (list): List of asset ids. - - """ - - self.clear() - - # let cleared task view if no tasks are available - if len(tasks) == 0: - return - - self.beginResetModel() - - icon = self._icons["__default__"] - for task in tasks: - item = Item({ - "Tasks": task, - "icon": icon - }) - - self.add_child(item) - - self.endResetModel() - - def flags(self, index): - return QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable - - def headerData(self, section, orientation, role): - - # Override header for count column to show amount of assets - # it is listing the tasks for - if role == QtCore.Qt.DisplayRole: - if orientation == QtCore.Qt.Horizontal: - if section == 1: # count column - return "count ({0})".format(self._num_assets) - - return super(TasksModel, self).headerData(section, orientation, role) - - def data(self, index, role): - - if not index.isValid(): - return - - # Add icon to the first column - if role == QtCore.Qt.DecorationRole: - if index.column() == 0: - return index.internalPointer()["icon"] - - return super(TasksModel, self).data(index, role) - - -class DeselectableTreeView(QtWidgets.QTreeView): - """A tree view that deselects on clicking on an empty area in the view""" - - def mousePressEvent(self, event): - - index = self.indexAt(event.pos()) - if not index.isValid(): - # clear the selection - self.clearSelection() - # clear the current index - self.setCurrentIndex(QtCore.QModelIndex()) - - QtWidgets.QTreeView.mousePressEvent(self, event) - - -class RecursiveSortFilterProxyModel(QtCore.QSortFilterProxyModel): - """Filters to the regex if any of the children matches allow parent""" - def filterAcceptsRow(self, row, parent): - - regex = self.filterRegExp() - if not regex.isEmpty(): - pattern = regex.pattern() - model = self.sourceModel() - source_index = model.index(row, self.filterKeyColumn(), parent) - if source_index.isValid(): - - # Check current index itself - key = model.data(source_index, self.filterRole()) - if re.search(pattern, key, re.IGNORECASE): - return True - - # Check children - rows = model.rowCount(source_index) - for i in range(rows): - if self.filterAcceptsRow(i, source_index): - return True - - # Otherwise filter it - return False - - return super(RecursiveSortFilterProxyModel, - self).filterAcceptsRow(row, parent) diff --git a/openpype/tools/assetcreator/widget.py b/openpype/tools/assetcreator/widget.py deleted file mode 100644 index fd0f438e68..0000000000 --- a/openpype/tools/assetcreator/widget.py +++ /dev/null @@ -1,448 +0,0 @@ -import logging -import contextlib -import collections - -from avalon.vendor import qtawesome -from Qt import QtWidgets, QtCore, QtGui -from avalon import style, io - -from .model import ( - TreeModel, - Item, - RecursiveSortFilterProxyModel, - DeselectableTreeView -) - -log = logging.getLogger(__name__) - - -def _iter_model_rows(model, - column, - include_root=False): - """Iterate over all row indices in a model""" - indices = [QtCore.QModelIndex()] # start iteration at root - - for index in indices: - - # Add children to the iterations - child_rows = model.rowCount(index) - for child_row in range(child_rows): - child_index = model.index(child_row, column, index) - indices.append(child_index) - - if not include_root and not index.isValid(): - continue - - yield index - - -@contextlib.contextmanager -def preserve_expanded_rows(tree_view, - column=0, - role=QtCore.Qt.DisplayRole): - """Preserves expanded row in QTreeView by column's data role. - - This function is created to maintain the expand vs collapse status of - the model items. When refresh is triggered the items which are expanded - will stay expanded and vice versa. - - Arguments: - tree_view (QWidgets.QTreeView): the tree view which is - nested in the application - column (int): the column to retrieve the data from - role (int): the role which dictates what will be returned - - Returns: - None - - """ - - model = tree_view.model() - - expanded = set() - - for index in _iter_model_rows(model, - column=column, - include_root=False): - if tree_view.isExpanded(index): - value = index.data(role) - expanded.add(value) - - try: - yield - finally: - if not expanded: - return - - for index in _iter_model_rows(model, - column=column, - include_root=False): - value = index.data(role) - state = value in expanded - if state: - tree_view.expand(index) - else: - tree_view.collapse(index) - - -@contextlib.contextmanager -def preserve_selection(tree_view, - column=0, - role=QtCore.Qt.DisplayRole, - current_index=True): - """Preserves row selection in QTreeView by column's data role. - - This function is created to maintain the selection status of - the model items. When refresh is triggered the items which are expanded - will stay expanded and vice versa. - - tree_view (QWidgets.QTreeView): the tree view nested in the application - column (int): the column to retrieve the data from - role (int): the role which dictates what will be returned - - Returns: - None - - """ - - model = tree_view.model() - selection_model = tree_view.selectionModel() - flags = selection_model.Select | selection_model.Rows - - if current_index: - current_index_value = tree_view.currentIndex().data(role) - else: - current_index_value = None - - selected_rows = selection_model.selectedRows() - if not selected_rows: - yield - return - - selected = set(row.data(role) for row in selected_rows) - try: - yield - finally: - if not selected: - return - - # Go through all indices, select the ones with similar data - for index in _iter_model_rows(model, - column=column, - include_root=False): - - value = index.data(role) - state = value in selected - if state: - tree_view.scrollTo(index) # Ensure item is visible - selection_model.select(index, flags) - - if current_index_value and value == current_index_value: - tree_view.setCurrentIndex(index) - - -class AssetModel(TreeModel): - """A model listing assets in the silo in the active project. - - The assets are displayed in a treeview, they are visually parented by - a `visualParent` field in the database containing an `_id` to a parent - asset. - - """ - - Columns = ["label"] - Name = 0 - Deprecated = 2 - ObjectId = 3 - - DocumentRole = QtCore.Qt.UserRole + 2 - ObjectIdRole = QtCore.Qt.UserRole + 3 - - def __init__(self, parent=None): - super(AssetModel, self).__init__(parent=parent) - self.refresh() - - def _add_hierarchy(self, assets, parent=None, silos=None): - """Add the assets that are related to the parent as children items. - - This method does *not* query the database. These instead are queried - in a single batch upfront as an optimization to reduce database - queries. Resulting in up to 10x speed increase. - - Args: - assets (dict): All assets in the currently active silo stored - by key/value - - Returns: - None - - """ - if silos: - # WARNING: Silo item "_id" is set to silo value - # mainly because GUI issue with preserve selection and expanded row - # and because of easier hierarchy parenting (in "assets") - for silo in silos: - item = Item({ - "_id": silo, - "name": silo, - "label": silo, - "type": "silo" - }) - self.add_child(item, parent=parent) - self._add_hierarchy(assets, parent=item) - - parent_id = parent["_id"] if parent else None - current_assets = assets.get(parent_id, list()) - - for asset in current_assets: - # get label from data, otherwise use name - data = asset.get("data", {}) - label = data.get("label", asset["name"]) - tags = data.get("tags", []) - - # store for the asset for optimization - deprecated = "deprecated" in tags - - item = Item({ - "_id": asset["_id"], - "name": asset["name"], - "label": label, - "type": asset["type"], - "tags": ", ".join(tags), - "deprecated": deprecated, - "_document": asset - }) - self.add_child(item, parent=parent) - - # Add asset's children recursively if it has children - if asset["_id"] in assets: - self._add_hierarchy(assets, parent=item) - - def refresh(self): - """Refresh the data for the model.""" - - self.clear() - self.beginResetModel() - - # Get all assets in current silo sorted by name - db_assets = io.find({"type": "asset"}).sort("name", 1) - silos = db_assets.distinct("silo") or None - # if any silo is set to None then it's expected it should not be used - if silos and None in silos: - silos = None - - # Group the assets by their visual parent's id - assets_by_parent = collections.defaultdict(list) - for asset in db_assets: - parent_id = ( - asset.get("data", {}).get("visualParent") or - asset.get("silo") - ) - assets_by_parent[parent_id].append(asset) - - # Build the hierarchical tree items recursively - self._add_hierarchy( - assets_by_parent, - parent=None, - silos=silos - ) - - self.endResetModel() - - def flags(self, index): - return QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable - - def data(self, index, role): - - if not index.isValid(): - return - - item = index.internalPointer() - if role == QtCore.Qt.DecorationRole: # icon - - column = index.column() - if column == self.Name: - - # Allow a custom icon and custom icon color to be defined - data = item.get("_document", {}).get("data", {}) - icon = data.get("icon", None) - if icon is None and item.get("type") == "silo": - icon = "database" - color = data.get("color", style.colors.default) - - if icon is None: - # Use default icons if no custom one is specified. - # If it has children show a full folder, otherwise - # show an open folder - has_children = self.rowCount(index) > 0 - icon = "folder" if has_children else "folder-o" - - # Make the color darker when the asset is deprecated - if item.get("deprecated", False): - color = QtGui.QColor(color).darker(250) - - try: - key = "fa.{0}".format(icon) # font-awesome key - icon = qtawesome.icon(key, color=color) - return icon - except Exception as exception: - # Log an error message instead of erroring out completely - # when the icon couldn't be created (e.g. invalid name) - log.error(exception) - - return - - if role == QtCore.Qt.ForegroundRole: # font color - if "deprecated" in item.get("tags", []): - return QtGui.QColor(style.colors.light).darker(250) - - if role == self.ObjectIdRole: - return item.get("_id", None) - - if role == self.DocumentRole: - return item.get("_document", None) - - return super(AssetModel, self).data(index, role) - - -class AssetWidget(QtWidgets.QWidget): - """A Widget to display a tree of assets with filter - - To list the assets of the active project: - >>> # widget = AssetWidget() - >>> # widget.refresh() - >>> # widget.show() - - """ - - assets_refreshed = QtCore.Signal() # on model refresh - selection_changed = QtCore.Signal() # on view selection change - current_changed = QtCore.Signal() # on view current index change - - def __init__(self, parent=None): - super(AssetWidget, self).__init__(parent=parent) - self.setContentsMargins(0, 0, 0, 0) - - layout = QtWidgets.QVBoxLayout(self) - layout.setContentsMargins(0, 0, 0, 0) - layout.setSpacing(4) - - # Tree View - model = AssetModel(self) - proxy = RecursiveSortFilterProxyModel() - proxy.setSourceModel(model) - proxy.setFilterCaseSensitivity(QtCore.Qt.CaseInsensitive) - - view = DeselectableTreeView() - view.setIndentation(15) - view.setContextMenuPolicy(QtCore.Qt.CustomContextMenu) - view.setHeaderHidden(True) - view.setModel(proxy) - - # Header - header = QtWidgets.QHBoxLayout() - - icon = qtawesome.icon("fa.refresh", color=style.colors.light) - refresh = QtWidgets.QPushButton(icon, "") - refresh.setToolTip("Refresh items") - - filter = QtWidgets.QLineEdit() - filter.textChanged.connect(proxy.setFilterFixedString) - filter.setPlaceholderText("Filter assets..") - - header.addWidget(filter) - header.addWidget(refresh) - - # Layout - layout.addLayout(header) - layout.addWidget(view) - - # Signals/Slots - selection = view.selectionModel() - selection.selectionChanged.connect(self.selection_changed) - selection.currentChanged.connect(self.current_changed) - refresh.clicked.connect(self.refresh) - - self.refreshButton = refresh - self.model = model - self.proxy = proxy - self.view = view - - def _refresh_model(self): - with preserve_expanded_rows( - self.view, column=0, role=self.model.ObjectIdRole - ): - with preserve_selection( - self.view, column=0, role=self.model.ObjectIdRole - ): - self.model.refresh() - - self.assets_refreshed.emit() - - def refresh(self): - self._refresh_model() - - def get_active_asset(self): - """Return the asset id the current asset.""" - current = self.view.currentIndex() - return current.data(self.model.ItemRole) - - def get_active_index(self): - return self.view.currentIndex() - - def get_selected_assets(self): - """Return the assets' ids that are selected.""" - selection = self.view.selectionModel() - rows = selection.selectedRows() - return [row.data(self.model.ObjectIdRole) for row in rows] - - def select_assets(self, assets, expand=True, key="name"): - """Select assets by name. - - Args: - assets (list): List of asset names - expand (bool): Whether to also expand to the asset in the view - - Returns: - None - - """ - # TODO: Instead of individual selection optimize for many assets - - if not isinstance(assets, (tuple, list)): - assets = [assets] - assert isinstance( - assets, (tuple, list) - ), "Assets must be list or tuple" - - # convert to list - tuple cant be modified - assets = list(assets) - - # Clear selection - selection_model = self.view.selectionModel() - selection_model.clearSelection() - - # Select - mode = selection_model.Select | selection_model.Rows - for index in iter_model_rows( - self.proxy, column=0, include_root=False - ): - # stop iteration if there are no assets to process - if not assets: - break - - value = index.data(self.model.ItemRole).get(key) - if value not in assets: - continue - - # Remove processed asset - assets.pop(assets.index(value)) - - selection_model.select(index, mode) - - if expand: - # Expand parent index - self.view.expand(self.proxy.parent(index)) - - # Set the currently active index - self.view.setCurrentIndex(index) diff --git a/openpype/tools/creator/model.py b/openpype/tools/creator/model.py index 6907e8f0aa..ef61c6e0f0 100644 --- a/openpype/tools/creator/model.py +++ b/openpype/tools/creator/model.py @@ -2,6 +2,7 @@ import uuid from Qt import QtGui, QtCore from avalon import api +from openpype.pipeline import LegacyCreator from . constants import ( FAMILY_ROLE, @@ -21,7 +22,7 @@ class CreatorsModel(QtGui.QStandardItemModel): self._creators_by_id = {} items = [] - creators = api.discover(api.Creator) + creators = api.discover(LegacyCreator) for creator in creators: item_id = str(uuid.uuid4()) self._creators_by_id[item_id] = creator diff --git a/openpype/tools/creator/widgets.py b/openpype/tools/creator/widgets.py index 9dd435c1cc..43df08496b 100644 --- a/openpype/tools/creator/widgets.py +++ b/openpype/tools/creator/widgets.py @@ -3,9 +3,8 @@ import inspect from Qt import QtWidgets, QtCore, QtGui -from avalon.vendor import qtawesome +import qtawesome -from openpype import style from openpype.pipeline.create import SUBSET_NAME_ALLOWED_SYMBOLS from openpype.tools.utils import ErrorMessageBox diff --git a/openpype/tools/creator/window.py b/openpype/tools/creator/window.py index f1d0849dfe..51cc66e715 100644 --- a/openpype/tools/creator/window.py +++ b/openpype/tools/creator/window.py @@ -9,7 +9,12 @@ from avalon import api, io from openpype import style from openpype.api import get_current_project_settings from openpype.tools.utils.lib import qt_app_context -from openpype.pipeline.create import SUBSET_NAME_ALLOWED_SYMBOLS +from openpype.pipeline.create import ( + SUBSET_NAME_ALLOWED_SYMBOLS, + legacy_create, + CreatorError, + LegacyCreator, +) from .model import CreatorsModel from .widgets import ( @@ -422,7 +427,7 @@ class CreatorWindow(QtWidgets.QDialog): error_info = None try: - api.create( + legacy_create( creator_plugin, subset_name, asset_name, @@ -430,7 +435,7 @@ class CreatorWindow(QtWidgets.QDialog): data={"variant": variant} ) - except api.CreatorError as exc: + except CreatorError as exc: self.echo("Creator error: {}".format(str(exc))) error_info = (str(exc), None) @@ -486,7 +491,7 @@ def show(debug=False, parent=None): if debug: from avalon import mock for creator in mock.creators: - api.register_plugin(api.Creator, creator) + api.register_plugin(LegacyCreator, creator) import traceback sys.excepthook = lambda typ, val, tb: traceback.print_last() diff --git a/openpype/tools/experimental_tools/dialog.py b/openpype/tools/experimental_tools/dialog.py index 295afbe68d..0099492207 100644 --- a/openpype/tools/experimental_tools/dialog.py +++ b/openpype/tools/experimental_tools/dialog.py @@ -82,7 +82,7 @@ class ExperimentalToolsDialog(QtWidgets.QDialog): tool_btns_layout.addWidget(tool_btns_label, 0) experimental_tools = ExperimentalTools( - parent=parent, filter_hosts=True + parent_widget=parent, refresh=False ) # Main layout @@ -116,7 +116,8 @@ class ExperimentalToolsDialog(QtWidgets.QDialog): self._experimental_tools.refresh_availability() buttons_to_remove = set(self._buttons_by_tool_identifier.keys()) - for idx, tool in enumerate(self._experimental_tools.tools): + tools = self._experimental_tools.get_tools_for_host() + for idx, tool in enumerate(tools): identifier = tool.identifier if identifier in buttons_to_remove: buttons_to_remove.remove(identifier) diff --git a/openpype/tools/experimental_tools/tools_def.py b/openpype/tools/experimental_tools/tools_def.py index 316359c0f3..fa2971dc1d 100644 --- a/openpype/tools/experimental_tools/tools_def.py +++ b/openpype/tools/experimental_tools/tools_def.py @@ -5,7 +5,32 @@ from openpype.settings import get_local_settings LOCAL_EXPERIMENTAL_KEY = "experimental_tools" -class ExperimentalTool: +class ExperimentalTool(object): + """Definition of experimental tool. + + Definition is used in local settings. + + Args: + identifier (str): String identifier of tool (unique). + label (str): Label shown in UI. + """ + def __init__(self, identifier, label, tooltip): + self.identifier = identifier + self.label = label + self.tooltip = tooltip + self._enabled = True + + @property + def enabled(self): + """Is tool enabled and button is clickable.""" + return self._enabled + + def set_enabled(self, enabled=True): + """Change if tool is enabled.""" + self._enabled = enabled + + +class ExperimentalHostTool(ExperimentalTool): """Definition of experimental tool. Definition is used in local settings and in experimental tools dialog. @@ -19,12 +44,10 @@ class ExperimentalTool: Some tools may not be available in all hosts. """ def __init__( - self, identifier, label, callback, tooltip, hosts_filter=None + self, identifier, label, tooltip, callback, hosts_filter=None ): - self.identifier = identifier - self.label = label + super(ExperimentalHostTool, self).__init__(identifier, label, tooltip) self.callback = callback - self.tooltip = tooltip self.hosts_filter = hosts_filter self._enabled = True @@ -33,18 +56,9 @@ class ExperimentalTool: return host_name in self.hosts_filter return True - @property - def enabled(self): - """Is tool enabled and button is clickable.""" - return self._enabled - - def set_enabled(self, enabled=True): - """Change if tool is enabled.""" - self._enabled = enabled - - def execute(self): + def execute(self, *args, **kwargs): """Trigger registered callback.""" - self.callback() + self.callback(*args, **kwargs) class ExperimentalTools: @@ -53,57 +67,36 @@ class ExperimentalTools: To add/remove experimental tool just add/remove tool to `experimental_tools` variable in __init__ function. - Args: - parent (QtWidgets.QWidget): Parent widget for tools. - host_name (str): Name of host in which context we're now. Environment - value 'AVALON_APP' is used when not passed. - filter_hosts (bool): Should filter tools. By default is set to 'True' - when 'host_name' is passed. Is always set to 'False' if 'host_name' - is not defined. + --- Example tool (callback will just print on click) --- + def example_callback(*args): + print("Triggered tool") + + experimental_tools = [ + ExperimentalHostTool( + "example", + "Example experimental tool", + example_callback, + "Example tool tooltip." + ) + ] + --- """ - def __init__(self, parent=None, host_name=None, filter_hosts=None): + def __init__(self, parent_widget=None, refresh=True): # Definition of experimental tools experimental_tools = [ - ExperimentalTool( + ExperimentalHostTool( "publisher", "New publisher", - self._show_publisher, - "Combined creation and publishing into one tool." + "Combined creation and publishing into one tool.", + self._show_publisher + ), + ExperimentalTool( + "traypublisher", + "New Standalone Publisher", + "Standalone publisher using new publisher. Requires restart" ) ] - # --- Example tool (callback will just print on click) --- - # def example_callback(*args): - # print("Triggered tool") - # - # experimental_tools = [ - # ExperimentalTool( - # "example", - # "Example experimental tool", - # example_callback, - # "Example tool tooltip." - # ) - # ] - - # Try to get host name from env variable `AVALON_APP` - if not host_name: - host_name = os.environ.get("AVALON_APP") - - # Decide if filtering by host name should happen - if filter_hosts is None: - filter_hosts = host_name is not None - - if filter_hosts and not host_name: - filter_hosts = False - - # Filter tools by host name - if filter_hosts: - experimental_tools = [ - tool - for tool in experimental_tools - if tool.is_available_for_host(host_name) - ] - # Store tools by identifier tools_by_identifier = {} for tool in experimental_tools: @@ -115,10 +108,13 @@ class ExperimentalTools: self._tools_by_identifier = tools_by_identifier self._tools = experimental_tools - self._parent_widget = parent + self._parent_widget = parent_widget self._publisher_tool = None + if refresh: + self.refresh_availability() + @property def tools(self): """Tools in list. @@ -139,6 +135,22 @@ class ExperimentalTools: """ return self._tools_by_identifier + def get(self, tool_identifier): + """Get tool by identifier.""" + return self.tools_by_identifier.get(tool_identifier) + + def get_tools_for_host(self, host_name=None): + if not host_name: + host_name = os.environ.get("AVALON_APP") + tools = [] + for tool in self.tools: + if ( + isinstance(tool, ExperimentalHostTool) + and tool.is_available_for_host(host_name) + ): + tools.append(tool) + return tools + def refresh_availability(self): """Reload local settings and check if any tool changed ability.""" local_settings = get_local_settings() diff --git a/openpype/tools/launcher/lib.py b/openpype/tools/launcher/lib.py index 4d678b96ae..68c759f295 100644 --- a/openpype/tools/launcher/lib.py +++ b/openpype/tools/launcher/lib.py @@ -15,85 +15,14 @@ provides a bridge between the file-based project inventory and configuration. """ import os -from Qt import QtGui, QtCore -from avalon.vendor import qtawesome +from Qt import QtGui +import qtawesome from openpype.api import resources ICON_CACHE = {} NOT_FOUND = type("NotFound", (object, ), {}) -class ProjectHandler(QtCore.QObject): - """Handler of project model and current project in Launcher tool. - - Helps to organize two separate widgets handling current project selection. - - It is easier to trigger project change callbacks from one place than from - multiple different places without proper handling or sequence changes. - - Args: - dbcon(AvalonMongoDB): Mongo connection with Session. - model(ProjectModel): Object of projects model which is shared across - all widgets using projects. Arg dbcon should be used as source for - the model. - """ - # Project list will be refreshed each 10000 msecs - # - this is not part of helper implementation but should be used by widgets - # that may require reshing of projects - refresh_interval = 10000 - - # Signal emitted when project has changed - project_changed = QtCore.Signal(str) - projects_refreshed = QtCore.Signal() - timer_timeout = QtCore.Signal() - - def __init__(self, dbcon, model): - super(ProjectHandler, self).__init__() - self._active = False - # Store project model for usage - self.model = model - # Store dbcon - self.dbcon = dbcon - - self.current_project = dbcon.Session.get("AVALON_PROJECT") - - refresh_timer = QtCore.QTimer() - refresh_timer.setInterval(self.refresh_interval) - refresh_timer.timeout.connect(self._on_timeout) - - self.refresh_timer = refresh_timer - - def _on_timeout(self): - if self._active: - self.timer_timeout.emit() - self.refresh_model() - - def set_active(self, active): - self._active = active - - def start_timer(self, trigger=False): - self.refresh_timer.start() - if trigger: - self._on_timeout() - - def stop_timer(self): - self.refresh_timer.stop() - - def set_project(self, project_name): - # Change current project of this handler - self.current_project = project_name - # Change session project to take effect for other widgets using the - # dbcon object. - self.dbcon.Session["AVALON_PROJECT"] = project_name - - # Trigger change signal when everything is updated to new project - self.project_changed.emit(project_name) - - def refresh_model(self): - self.model.refresh() - self.projects_refreshed.emit() - - def get_action_icon(action): icon_name = action.icon if not icon_name: diff --git a/openpype/tools/launcher/models.py b/openpype/tools/launcher/models.py index ecee8b1575..85d553fca4 100644 --- a/openpype/tools/launcher/models.py +++ b/openpype/tools/launcher/models.py @@ -1,8 +1,33 @@ +import re import uuid import copy import logging import collections +import time + import appdirs +from Qt import QtCore, QtGui +import qtawesome +from avalon import api +from openpype.lib import JSONSettingRegistry +from openpype.lib.applications import ( + CUSTOM_LAUNCH_APP_GROUPS, + ApplicationManager +) +from openpype.tools.utils.lib import ( + DynamicQThread, + get_project_icon, +) +from openpype.tools.utils.assets_widget import ( + AssetModel, + ASSET_NAME_ROLE +) +from openpype.tools.utils.tasks_widget import ( + TasksModel, + TasksProxyModel, + TASK_TYPE_ROLE, + TASK_ASSIGNEE_ROLE +) from . import lib from .constants import ( @@ -13,17 +38,13 @@ from .constants import ( FORCE_NOT_OPEN_WORKFILE_ROLE ) from .actions import ApplicationAction -from Qt import QtCore, QtGui -from avalon.vendor import qtawesome -from avalon import api -from openpype.lib import JSONSettingRegistry -from openpype.lib.applications import ( - CUSTOM_LAUNCH_APP_GROUPS, - ApplicationManager -) log = logging.getLogger(__name__) +# Must be different than roles in default asset model +ASSET_TASK_TYPES_ROLE = QtCore.Qt.UserRole + 10 +ASSET_ASSIGNEE_ROLE = QtCore.Qt.UserRole + 11 + class ActionModel(QtGui.QStandardItemModel): def __init__(self, dbcon, parent=None): @@ -330,21 +351,494 @@ class ActionModel(QtGui.QStandardItemModel): return compare_data +class LauncherModel(QtCore.QObject): + # Refresh interval of projects + refresh_interval = 10000 + + # Signals + # Current project has changed + project_changed = QtCore.Signal(str) + # Filters has changed (any) + filters_changed = QtCore.Signal() + + # Projects were refreshed + projects_refreshed = QtCore.Signal() + + # Signals ONLY for assets model! + # - other objects should listen to asset model signals + # Asset refresh started + assets_refresh_started = QtCore.Signal() + # Assets refresh finished + assets_refreshed = QtCore.Signal() + + # Refresh timer timeout + # - give ability to tell parent window that this timer still runs + timer_timeout = QtCore.Signal() + + # Duplication from AssetsModel with "data.tasks" + _asset_projection = { + "name": 1, + "parent": 1, + "data.visualParent": 1, + "data.label": 1, + "data.icon": 1, + "data.color": 1, + "data.tasks": 1 + } + + def __init__(self, dbcon): + super(LauncherModel, self).__init__() + # Refresh timer + # - should affect only projects + refresh_timer = QtCore.QTimer() + refresh_timer.setInterval(self.refresh_interval) + refresh_timer.timeout.connect(self._on_timeout) + + self._refresh_timer = refresh_timer + + # Launcher is active + self._active = False + + # Global data + self._dbcon = dbcon + # Available project names + self._project_names = set() + self._project_docs_by_name = {} + + # Context data + self._asset_docs = [] + self._asset_docs_by_id = {} + self._asset_filter_data_by_id = {} + self._assignees = set() + self._task_types = set() + + # Filters + self._asset_name_filter = "" + self._assignee_filters = set() + self._task_type_filters = set() + + # Last project for which were assets queried + self._last_project_name = None + # Asset refresh thread is running + self._refreshing_assets = False + # Asset refresh thread + self._asset_refresh_thread = None + + def _on_timeout(self): + """Refresh timer timeout.""" + if self._active: + self.timer_timeout.emit() + self.refresh_projects() + + def set_active(self, active): + """Window change active state.""" + self._active = active + + def start_refresh_timer(self, trigger=False): + """Start refresh timer.""" + self._refresh_timer.start() + if trigger: + self._on_timeout() + + def stop_refresh_timer(self): + """Stop refresh timer.""" + self._refresh_timer.stop() + + @property + def project_name(self): + """Current project name.""" + return self._dbcon.Session.get("AVALON_PROJECT") + + @property + def refreshing_assets(self): + """Refreshing thread is running.""" + return self._refreshing_assets + + @property + def asset_docs(self): + """Access to asset docs.""" + return self._asset_docs + + @property + def project_names(self): + """Available project names.""" + return self._project_names + + def get_project_doc(self, project_name): + return self._project_docs_by_name.get(project_name) + + @property + def asset_filter_data_by_id(self): + """Prepared filter data by asset id.""" + return self._asset_filter_data_by_id + + @property + def assignees(self): + """All assignees for all assets in current project.""" + return self._assignees + + @property + def task_types(self): + """All task types for all assets in current project. + + TODO: This could be maybe taken from project document where are all + task types... + """ + return self._task_types + + @property + def task_type_filters(self): + """Currently set task type filters.""" + return self._task_type_filters + + @property + def assignee_filters(self): + """Currently set assignee filters.""" + return self._assignee_filters + + @property + def asset_name_filter(self): + """Asset name filter (can be used as regex filter).""" + return self._asset_name_filter + + def get_asset_doc(self, asset_id): + """Get single asset document by id.""" + return self._asset_docs_by_id.get(asset_id) + + def set_project_name(self, project_name): + """Change project name and refresh asset documents.""" + if project_name == self.project_name: + return + self._dbcon.Session["AVALON_PROJECT"] = project_name + self.project_changed.emit(project_name) + + self.refresh_assets(force=True) + + def refresh(self): + """Trigger refresh of whole model.""" + self.refresh_projects() + self.refresh_assets(force=False) + + def refresh_projects(self): + """Refresh projects.""" + current_project = self.project_name + project_names = set() + project_docs_by_name = {} + for project_doc in self._dbcon.projects(only_active=True): + project_name = project_doc["name"] + project_names.add(project_name) + project_docs_by_name[project_name] = project_doc + + self._project_docs_by_name = project_docs_by_name + self._project_names = project_names + self.projects_refreshed.emit() + if ( + current_project is not None + and current_project not in project_names + ): + self.set_project_name(None) + + def _set_asset_docs(self, asset_docs=None): + """Set asset documents and all related data. + + Method extract and prepare data needed for assets and tasks widget and + prepare filtering data. + """ + if asset_docs is None: + asset_docs = [] + + all_task_types = set() + all_assignees = set() + asset_docs_by_id = {} + asset_filter_data_by_id = {} + for asset_doc in asset_docs: + task_types = set() + assignees = set() + asset_id = asset_doc["_id"] + asset_docs_by_id[asset_id] = asset_doc + asset_tasks = asset_doc.get("data", {}).get("tasks") + asset_filter_data_by_id[asset_id] = { + "assignees": assignees, + "task_types": task_types + } + if not asset_tasks: + continue + + for task_data in asset_tasks.values(): + task_assignees = set() + _task_assignees = task_data.get("assignees") + if _task_assignees: + for assignee in _task_assignees: + task_assignees.add(assignee["username"]) + + task_type = task_data.get("type") + if task_assignees: + assignees |= set(task_assignees) + if task_type: + task_types.add(task_type) + + all_task_types |= task_types + all_assignees |= assignees + + self._asset_docs_by_id = asset_docs_by_id + self._asset_docs = asset_docs + self._asset_filter_data_by_id = asset_filter_data_by_id + self._assignees = all_assignees + self._task_types = all_task_types + + self.assets_refreshed.emit() + + def set_task_type_filter(self, task_types): + """Change task type filter. + + Args: + task_types (set): Set of task types that should be visible. + Pass empty set to turn filter off. + """ + self._task_type_filters = task_types + self.filters_changed.emit() + + def set_assignee_filter(self, assignees): + """Change assignees filter. + + Args: + assignees (set): Set of assignees that should be visible. + Pass empty set to turn filter off. + """ + self._assignee_filters = assignees + self.filters_changed.emit() + + def set_asset_name_filter(self, text_filter): + """Change asset name filter. + + Args: + text_filter (str): Asset name filter. Pass empty string to + turn filter off. + """ + self._asset_name_filter = text_filter + self.filters_changed.emit() + + def refresh_assets(self, force=True): + """Refresh assets.""" + self.assets_refresh_started.emit() + + if self.project_name is None: + self._set_asset_docs() + return + + if ( + not force + and self._last_project_name == self.project_name + ): + return + + self._stop_fetch_thread() + + self._refreshing_assets = True + self._last_project_name = self.project_name + self._asset_refresh_thread = DynamicQThread(self._refresh_assets) + self._asset_refresh_thread.start() + + def _stop_fetch_thread(self): + self._refreshing_assets = False + if self._asset_refresh_thread is not None: + while self._asset_refresh_thread.isRunning(): + # TODO this is blocking UI should be done in a different way + time.sleep(0.01) + self._asset_refresh_thread = None + + def _refresh_assets(self): + asset_docs = list(self._dbcon.find( + {"type": "asset"}, + self._asset_projection + )) + if not self._refreshing_assets: + return + self._refreshing_assets = False + self._set_asset_docs(asset_docs) + + +class LauncherTasksProxyModel(TasksProxyModel): + """Tasks proxy model with more filtering. + + TODO: + This can be (with few modifications) used in default tasks widget too. + """ + def __init__(self, launcher_model, *args, **kwargs): + self._launcher_model = launcher_model + super(LauncherTasksProxyModel, self).__init__(*args, **kwargs) + + launcher_model.filters_changed.connect(self._on_filter_change) + + self._task_types_filter = set() + self._assignee_filter = set() + + def _on_filter_change(self): + self._task_types_filter = self._launcher_model.task_type_filters + self._assignee_filter = self._launcher_model.assignee_filters + self.invalidateFilter() + + def filterAcceptsRow(self, row, parent): + if not self._task_types_filter and not self._assignee_filter: + return True + + model = self.sourceModel() + source_index = model.index(row, self.filterKeyColumn(), parent) + if not source_index.isValid(): + return False + + # Check current index itself + if self._task_types_filter: + task_type = model.data(source_index, TASK_TYPE_ROLE) + if task_type not in self._task_types_filter: + return False + + if self._assignee_filter: + assignee = model.data(source_index, TASK_ASSIGNEE_ROLE) + if not self._assignee_filter.intersection(assignee): + return False + return True + + +class LauncherTaskModel(TasksModel): + def __init__(self, launcher_model, *args, **kwargs): + self._launcher_model = launcher_model + super(LauncherTaskModel, self).__init__(*args, **kwargs) + + def _refresh_project_doc(self): + self._project_doc = self._launcher_model.get_project_doc( + self._launcher_model.project_name + ) + + def set_asset_id(self, asset_id): + asset_doc = None + if self._context_is_valid(): + asset_doc = self._launcher_model.get_asset_doc(asset_id) + self._set_asset(asset_doc) + + +class AssetRecursiveSortFilterModel(QtCore.QSortFilterProxyModel): + def __init__(self, launcher_model, *args, **kwargs): + self._launcher_model = launcher_model + + super(AssetRecursiveSortFilterModel, self).__init__(*args, **kwargs) + + launcher_model.filters_changed.connect(self._on_filter_change) + self._name_filter = "" + self._task_types_filter = set() + self._assignee_filter = set() + + def _on_filter_change(self): + self._name_filter = self._launcher_model.asset_name_filter + self._task_types_filter = self._launcher_model.task_type_filters + self._assignee_filter = self._launcher_model.assignee_filters + self.invalidateFilter() + + def filterAcceptsRow(self, row, parent): + if ( + not self._name_filter + and not self._task_types_filter + and not self._assignee_filter + ): + return True + + model = self.sourceModel() + source_index = model.index(row, self.filterKeyColumn(), parent) + if not source_index.isValid(): + return False + + # Check current index itself + valid = True + if self._name_filter: + name = model.data(source_index, ASSET_NAME_ROLE) + if ( + name is None + or not re.search(self._name_filter, name, re.IGNORECASE) + ): + valid = False + + if valid and self._task_types_filter: + task_types = model.data(source_index, ASSET_TASK_TYPES_ROLE) + if not self._task_types_filter.intersection(task_types): + valid = False + + if valid and self._assignee_filter: + assignee = model.data(source_index, ASSET_ASSIGNEE_ROLE) + if not self._assignee_filter.intersection(assignee): + valid = False + + if valid: + return True + + # Check children + rows = model.rowCount(source_index) + for child_row in range(rows): + if self.filterAcceptsRow(child_row, source_index): + return True + return False + + +class LauncherAssetsModel(AssetModel): + def __init__(self, launcher_model, dbcon, parent=None): + self._launcher_model = launcher_model + # Make sure that variable is available (even if is in AssetModel) + self._last_project_name = None + + super(LauncherAssetsModel, self).__init__(dbcon, parent) + + launcher_model.project_changed.connect(self._on_project_change) + launcher_model.assets_refresh_started.connect( + self._on_launcher_refresh_start + ) + launcher_model.assets_refreshed.connect(self._on_launcher_refresh) + + def _on_launcher_refresh_start(self): + self._refreshing = True + project_name = self._launcher_model.project_name + if self._last_project_name != project_name: + self._clear_items() + self._last_project_name = project_name + + def _on_launcher_refresh(self): + self._fill_assets(self._launcher_model.asset_docs) + self._refreshing = False + self.refreshed.emit(bool(self._items_by_asset_id)) + + def _fill_assets(self, *args, **kwargs): + super(LauncherAssetsModel, self)._fill_assets(*args, **kwargs) + asset_filter_data_by_id = self._launcher_model.asset_filter_data_by_id + for asset_id, item in self._items_by_asset_id.items(): + filter_data = asset_filter_data_by_id.get(asset_id) + + assignees = filter_data["assignees"] + task_types = filter_data["task_types"] + + item.setData(assignees, ASSET_ASSIGNEE_ROLE) + item.setData(task_types, ASSET_TASK_TYPES_ROLE) + + def _on_project_change(self): + self._clear_items() + + def refresh(self, *args, **kwargs): + raise ValueError("This is a bug!") + + def stop_refresh(self, *args, **kwargs): + raise ValueError("This is a bug!") + + class ProjectModel(QtGui.QStandardItemModel): """List of projects""" - def __init__(self, dbcon, parent=None): + def __init__(self, launcher_model, parent=None): super(ProjectModel, self).__init__(parent=parent) - self.dbcon = dbcon - self.project_icon = qtawesome.icon("fa.map", color="white") + self._launcher_model = launcher_model self._project_names = set() - def refresh(self): - project_names = set() - for project_doc in self.get_projects(): - project_names.add(project_doc["name"]) + launcher_model.projects_refreshed.connect(self._on_refresh) + def _on_refresh(self): + project_names = set(self._launcher_model.project_names) origin_project_names = set(self._project_names) self._project_names = project_names @@ -383,11 +877,11 @@ class ProjectModel(QtGui.QStandardItemModel): for row in reversed(sorted(row_counts.keys())): items = [] for project_name in row_counts[row]: - item = QtGui.QStandardItem(self.project_icon, project_name) + project_doc = self._launcher_model.get_project_doc( + project_name + ) + icon = get_project_icon(project_doc) + item = QtGui.QStandardItem(icon, project_name) items.append(item) self.invisibleRootItem().insertRows(row, items) - - def get_projects(self): - return sorted(self.dbcon.projects(only_active=True), - key=lambda x: x["name"]) diff --git a/openpype/tools/launcher/widgets.py b/openpype/tools/launcher/widgets.py index 5dad41c349..62599664fe 100644 --- a/openpype/tools/launcher/widgets.py +++ b/openpype/tools/launcher/widgets.py @@ -2,13 +2,23 @@ import copy import time import collections from Qt import QtWidgets, QtCore, QtGui -from avalon.vendor import qtawesome +import qtawesome + +from openpype.tools.flickcharm import FlickCharm +from openpype.tools.utils.assets_widget import SingleSelectAssetsWidget +from openpype.tools.utils.tasks_widget import TasksWidget from .delegates import ActionDelegate from . import lib +from .models import ( + ActionModel, + ProjectModel, + LauncherAssetsModel, + AssetRecursiveSortFilterModel, + LauncherTaskModel, + LauncherTasksProxyModel +) from .actions import ApplicationAction -from .models import ActionModel -from openpype.tools.flickcharm import FlickCharm from .constants import ( ACTION_ROLE, GROUP_ROLE, @@ -22,15 +32,15 @@ from .constants import ( class ProjectBar(QtWidgets.QWidget): - def __init__(self, project_handler, parent=None): + def __init__(self, launcher_model, parent=None): super(ProjectBar, self).__init__(parent) project_combobox = QtWidgets.QComboBox(self) # Change delegate so stylysheets are applied project_delegate = QtWidgets.QStyledItemDelegate(project_combobox) project_combobox.setItemDelegate(project_delegate) - - project_combobox.setModel(project_handler.model) + model = ProjectModel(launcher_model) + project_combobox.setModel(model) project_combobox.setRootModelIndex(QtCore.QModelIndex()) layout = QtWidgets.QHBoxLayout(self) @@ -42,16 +52,17 @@ class ProjectBar(QtWidgets.QWidget): QtWidgets.QSizePolicy.Maximum ) - self.project_handler = project_handler + self._launcher_model = launcher_model self.project_delegate = project_delegate self.project_combobox = project_combobox + self._model = model # Signals self.project_combobox.currentIndexChanged.connect(self.on_index_change) - project_handler.project_changed.connect(self._on_project_change) + launcher_model.project_changed.connect(self._on_project_change) # Set current project by default if it's set. - project_name = project_handler.current_project + project_name = launcher_model.project_name if project_name: self.set_project(project_name) @@ -67,7 +78,7 @@ class ProjectBar(QtWidgets.QWidget): index = self.project_combobox.findText(project_name) if index < 0: # Try refresh combobox model - self.project_handler.refresh_model() + self._launcher_model.refresh_projects() index = self.project_combobox.findText(project_name) if index >= 0: @@ -78,7 +89,70 @@ class ProjectBar(QtWidgets.QWidget): return project_name = self.get_current_project() - self.project_handler.set_project(project_name) + self._launcher_model.set_project_name(project_name) + + +class LauncherTaskWidget(TasksWidget): + def __init__(self, launcher_model, *args, **kwargs): + self._launcher_model = launcher_model + + super(LauncherTaskWidget, self).__init__(*args, **kwargs) + + def _create_source_model(self): + return LauncherTaskModel(self._launcher_model, self._dbcon) + + def _create_proxy_model(self, source_model): + proxy = LauncherTasksProxyModel(self._launcher_model) + proxy.setSourceModel(source_model) + return proxy + + +class LauncherAssetsWidget(SingleSelectAssetsWidget): + def __init__(self, launcher_model, *args, **kwargs): + self._launcher_model = launcher_model + + super(LauncherAssetsWidget, self).__init__(*args, **kwargs) + + launcher_model.assets_refresh_started.connect(self._on_refresh_start) + + self.set_current_asset_btn_visibility(False) + + def _on_refresh_start(self): + self._set_loading_state(loading=True, empty=True) + self.refresh_triggered.emit() + + @property + def refreshing(self): + return self._model.refreshing + + def refresh(self): + self._launcher_model.refresh_assets(force=True) + + def stop_refresh(self): + raise ValueError("bug stop_refresh called") + + def _refresh_model(self, clear=False): + raise ValueError("bug _refresh_model called") + + def _create_source_model(self): + model = LauncherAssetsModel(self._launcher_model, self.dbcon) + model.refreshed.connect(self._on_model_refresh) + return model + + def _create_proxy_model(self, source_model): + proxy = AssetRecursiveSortFilterModel(self._launcher_model) + proxy.setSourceModel(source_model) + proxy.setFilterCaseSensitivity(QtCore.Qt.CaseInsensitive) + proxy.setSortCaseSensitivity(QtCore.Qt.CaseInsensitive) + return proxy + + def _on_model_refresh(self, has_item): + self._proxy.sort(0) + self._set_loading_state(loading=False, empty=not has_item) + self.refreshed.emit() + + def _on_filter_text_change(self, new_text): + self._launcher_model.set_asset_name_filter(new_text) class ActionBar(QtWidgets.QWidget): @@ -86,10 +160,10 @@ class ActionBar(QtWidgets.QWidget): action_clicked = QtCore.Signal(object) - def __init__(self, project_handler, dbcon, parent=None): + def __init__(self, launcher_model, dbcon, parent=None): super(ActionBar, self).__init__(parent) - self.project_handler = project_handler + self._launcher_model = launcher_model self.dbcon = dbcon view = QtWidgets.QListView(self) @@ -136,7 +210,7 @@ class ActionBar(QtWidgets.QWidget): self.set_row_height(1) - project_handler.projects_refreshed.connect(self._on_projects_refresh) + launcher_model.projects_refreshed.connect(self._on_projects_refresh) view.clicked.connect(self.on_clicked) view.customContextMenuRequested.connect(self.on_context_menu) @@ -182,8 +256,8 @@ class ActionBar(QtWidgets.QWidget): self.update() def _start_animation(self, index): - # Offset refresh timeout - self.project_handler.start_timer() + # Offset refresh timout + self._launcher_model.start_refresh_timer() action_id = index.data(ACTION_ID_ROLE) item = self.model.items_by_id.get(action_id) if item: @@ -250,8 +324,8 @@ class ActionBar(QtWidgets.QWidget): self.action_clicked.emit(action) return - # Offset refresh timeout - self.project_handler.start_timer() + # Offset refresh timout + self._launcher_model.start_refresh_timer() actions = index.data(ACTION_ROLE) diff --git a/openpype/tools/launcher/window.py b/openpype/tools/launcher/window.py index a8f65894f2..d80b3eabf0 100644 --- a/openpype/tools/launcher/window.py +++ b/openpype/tools/launcher/window.py @@ -8,17 +8,19 @@ from avalon.api import AvalonMongoDB from openpype import style from openpype.api import resources -from openpype.tools.utils.assets_widget import SingleSelectAssetsWidget -from openpype.tools.utils.tasks_widget import TasksWidget - -from avalon.vendor import qtawesome -from .models import ProjectModel -from .lib import get_action_label, ProjectHandler +import qtawesome +from .models import ( + LauncherModel, + ProjectModel +) +from .lib import get_action_label from .widgets import ( ProjectBar, ActionBar, ActionHistory, - SlidePageWidget + SlidePageWidget, + LauncherAssetsWidget, + LauncherTaskWidget ) from openpype.tools.flickcharm import FlickCharm @@ -89,15 +91,15 @@ class ProjectIconView(QtWidgets.QListView): class ProjectsPanel(QtWidgets.QWidget): """Projects Page""" - def __init__(self, project_handler, parent=None): + def __init__(self, launcher_model, parent=None): super(ProjectsPanel, self).__init__(parent=parent) view = ProjectIconView(parent=self) view.setSelectionMode(QtWidgets.QListView.NoSelection) flick = FlickCharm(parent=self) flick.activateOn(view) - - view.setModel(project_handler.model) + model = ProjectModel(launcher_model) + view.setModel(model) layout = QtWidgets.QVBoxLayout(self) layout.setContentsMargins(0, 0, 0, 0) @@ -105,13 +107,14 @@ class ProjectsPanel(QtWidgets.QWidget): view.clicked.connect(self.on_clicked) + self._model = model self.view = view - self.project_handler = project_handler + self._launcher_model = launcher_model def on_clicked(self, index): if index.isValid(): project_name = index.data(QtCore.Qt.DisplayRole) - self.project_handler.set_project(project_name) + self._launcher_model.set_project_name(project_name) class AssetsPanel(QtWidgets.QWidget): @@ -119,7 +122,7 @@ class AssetsPanel(QtWidgets.QWidget): back_clicked = QtCore.Signal() session_changed = QtCore.Signal() - def __init__(self, project_handler, dbcon, parent=None): + def __init__(self, launcher_model, dbcon, parent=None): super(AssetsPanel, self).__init__(parent=parent) self.dbcon = dbcon @@ -129,7 +132,7 @@ class AssetsPanel(QtWidgets.QWidget): btn_back = QtWidgets.QPushButton(self) btn_back.setIcon(btn_back_icon) - project_bar = ProjectBar(project_handler, self) + project_bar = ProjectBar(launcher_model, self) project_bar_layout = QtWidgets.QHBoxLayout() project_bar_layout.setContentsMargins(0, 0, 0, 0) @@ -138,12 +141,14 @@ class AssetsPanel(QtWidgets.QWidget): project_bar_layout.addWidget(project_bar) # Assets widget - assets_widget = SingleSelectAssetsWidget(dbcon=self.dbcon, parent=self) + assets_widget = LauncherAssetsWidget( + launcher_model, dbcon=self.dbcon, parent=self + ) # Make assets view flickable assets_widget.activate_flick_charm() # Tasks widget - tasks_widget = TasksWidget(self.dbcon, self) + tasks_widget = LauncherTaskWidget(launcher_model, self.dbcon, self) # Body body = QtWidgets.QSplitter(self) @@ -165,19 +170,20 @@ class AssetsPanel(QtWidgets.QWidget): layout.addWidget(body) # signals - project_handler.project_changed.connect(self._on_project_changed) + launcher_model.project_changed.connect(self._on_project_changed) assets_widget.selection_changed.connect(self._on_asset_changed) assets_widget.refreshed.connect(self._on_asset_changed) tasks_widget.task_changed.connect(self._on_task_change) btn_back.clicked.connect(self.back_clicked) - self.project_handler = project_handler self.project_bar = project_bar self.assets_widget = assets_widget self._tasks_widget = tasks_widget self._btn_back = btn_back + self._launcher_model = launcher_model + def select_asset(self, asset_name): self.assets_widget.select_asset_by_name(asset_name) @@ -196,8 +202,6 @@ class AssetsPanel(QtWidgets.QWidget): def _on_project_changed(self): self.session_changed.emit() - self.assets_widget.refresh() - def _on_asset_changed(self): """Callback on asset selection changed @@ -250,18 +254,17 @@ class LauncherWindow(QtWidgets.QDialog): | QtCore.Qt.WindowCloseButtonHint ) - project_model = ProjectModel(self.dbcon) - project_handler = ProjectHandler(self.dbcon, project_model) + launcher_model = LauncherModel(self.dbcon) - project_panel = ProjectsPanel(project_handler) - asset_panel = AssetsPanel(project_handler, self.dbcon) + project_panel = ProjectsPanel(launcher_model) + asset_panel = AssetsPanel(launcher_model, self.dbcon) page_slider = SlidePageWidget() page_slider.addWidget(project_panel) page_slider.addWidget(asset_panel) # actions - actions_bar = ActionBar(project_handler, self.dbcon, self) + actions_bar = ActionBar(launcher_model, self.dbcon, self) # statusbar message_label = QtWidgets.QLabel(self) @@ -303,8 +306,8 @@ class LauncherWindow(QtWidgets.QDialog): # signals actions_bar.action_clicked.connect(self.on_action_clicked) action_history.trigger_history.connect(self.on_history_action) - project_handler.project_changed.connect(self.on_project_change) - project_handler.timer_timeout.connect(self._on_refresh_timeout) + launcher_model.project_changed.connect(self.on_project_change) + launcher_model.timer_timeout.connect(self._on_refresh_timeout) asset_panel.back_clicked.connect(self.on_back_clicked) asset_panel.session_changed.connect(self.on_session_changed) @@ -314,7 +317,7 @@ class LauncherWindow(QtWidgets.QDialog): self._message_timer = message_timer - self.project_handler = project_handler + self._launcher_model = launcher_model self._message_label = message_label self.project_panel = project_panel @@ -324,19 +327,19 @@ class LauncherWindow(QtWidgets.QDialog): self.page_slider = page_slider def showEvent(self, event): - self.project_handler.set_active(True) - self.project_handler.start_timer(True) + self._launcher_model.set_active(True) + self._launcher_model.start_refresh_timer(True) super(LauncherWindow, self).showEvent(event) def _on_refresh_timeout(self): # Stop timer if widget is not visible if not self.isVisible(): - self.project_handler.stop_timer() + self._launcher_model.stop_refresh_timer() def changeEvent(self, event): if event.type() == QtCore.QEvent.ActivationChange: - self.project_handler.set_active(self.isActiveWindow()) + self._launcher_model.set_active(self.isActiveWindow()) super(LauncherWindow, self).changeEvent(event) def set_page(self, page): @@ -371,7 +374,7 @@ class LauncherWindow(QtWidgets.QDialog): self.discover_actions() def on_back_clicked(self): - self.project_handler.set_project(None) + self._launcher_model.set_project_name(None) self.set_page(0) self.discover_actions() diff --git a/openpype/tools/loader/app.py b/openpype/tools/loader/app.py index aa743b05fe..d73a977ac6 100644 --- a/openpype/tools/loader/app.py +++ b/openpype/tools/loader/app.py @@ -1,9 +1,10 @@ import sys from Qt import QtWidgets, QtCore -from avalon import api, io, pipeline +from avalon import api, io from openpype import style +from openpype.lib import register_event_callback from openpype.tools.utils import ( lib, PlaceholderLineEdit @@ -25,17 +26,6 @@ module = sys.modules[__name__] module.window = None -# Register callback on task change -# - callback can't be defined in Window as it is weak reference callback -# so `WeakSet` will remove it immediately -def on_context_task_change(*args, **kwargs): - if module.window: - module.window.on_context_task_change(*args, **kwargs) - - -pipeline.on("taskChanged", on_context_task_change) - - class LoaderWindow(QtWidgets.QDialog): """Asset loader interface""" @@ -194,6 +184,8 @@ class LoaderWindow(QtWidgets.QDialog): self._first_show = True + register_event_callback("taskChanged", self.on_context_task_change) + def resizeEvent(self, event): super(LoaderWindow, self).resizeEvent(event) self._overlay_frame.resize(self.size()) diff --git a/openpype/tools/loader/lib.py b/openpype/tools/loader/lib.py index 180dee3eb5..28e94237ec 100644 --- a/openpype/tools/loader/lib.py +++ b/openpype/tools/loader/lib.py @@ -1,7 +1,7 @@ import inspect from Qt import QtGui +import qtawesome -from avalon.vendor import qtawesome from openpype.tools.utils.widgets import ( OptionalAction, OptionDialog diff --git a/openpype/tools/loader/model.py b/openpype/tools/loader/model.py index 10b22d0e17..6cc6fae1fb 100644 --- a/openpype/tools/loader/model.py +++ b/openpype/tools/loader/model.py @@ -3,15 +3,13 @@ import re import math from uuid import uuid4 -from avalon import ( - style, - schema -) from Qt import QtCore, QtGui +import qtawesome -from avalon.vendor import qtawesome -from avalon.lib import HeroVersionType +from avalon import schema +from openpype.pipeline import HeroVersionType +from openpype.style import get_default_entity_icon_color from openpype.tools.utils.models import TreeModel, Item from openpype.tools.utils import lib @@ -180,7 +178,10 @@ class SubsetsModel(TreeModel, BaseRepresentationModel): self._sorter = None self._grouping = grouping self._icons = { - "subset": qtawesome.icon("fa.file-o", color=style.colors.default) + "subset": qtawesome.icon( + "fa.file-o", + color=get_default_entity_icon_color() + ) } self._items_by_id = {} @@ -1066,8 +1067,10 @@ class RepresentationModel(TreeModel, BaseRepresentationModel): self._docs = {} self._icons = lib.get_repre_icons() - self._icons["repre"] = qtawesome.icon("fa.file-o", - color=style.colors.default) + self._icons["repre"] = qtawesome.icon( + "fa.file-o", + color=get_default_entity_icon_color() + ) self._items_by_id = {} def set_version_ids(self, version_ids): @@ -1165,7 +1168,7 @@ class RepresentationModel(TreeModel, BaseRepresentationModel): "remote_site_name": self.remote_site, "icon": qtawesome.icon( "fa.folder", - color=style.colors.default + color=get_default_entity_icon_color() ) }) self._items_by_id[item_id] = group_item diff --git a/openpype/tools/loader/widgets.py b/openpype/tools/loader/widgets.py index f145756cc5..b14bdd0e93 100644 --- a/openpype/tools/loader/widgets.py +++ b/openpype/tools/loader/widgets.py @@ -1,6 +1,5 @@ import os import sys -import inspect import datetime import pprint import traceback @@ -9,8 +8,19 @@ import collections from Qt import QtWidgets, QtCore, QtGui from avalon import api, pipeline -from avalon.lib import HeroVersionType +from openpype.pipeline import HeroVersionType +from openpype.pipeline.load import ( + discover_loader_plugins, + SubsetLoaderPlugin, + loaders_from_repre_context, + get_repres_contexts, + get_subset_contexts, + load_with_repre_context, + load_with_subset_context, + load_with_subset_contexts, + IncompatibleLoaderError, +) from openpype.tools.utils import ( ErrorMessageBox, lib as tools_lib @@ -425,7 +435,7 @@ class SubsetWidget(QtWidgets.QWidget): # Get all representation->loader combinations available for the # index under the cursor, so we can list the user the options. - available_loaders = api.discover(api.Loader) + available_loaders = discover_loader_plugins() if self.tool_name: available_loaders = lib.remove_tool_name_from_loaders( available_loaders, self.tool_name @@ -435,7 +445,7 @@ class SubsetWidget(QtWidgets.QWidget): subset_loaders = [] for loader in available_loaders: # Skip if its a SubsetLoader. - if api.SubsetLoader in inspect.getmro(loader): + if issubclass(loader, SubsetLoaderPlugin): subset_loaders.append(loader) else: repre_loaders.append(loader) @@ -459,7 +469,7 @@ class SubsetWidget(QtWidgets.QWidget): repre_docs = repre_docs_by_version_id[version_id] for repre_doc in repre_docs: repre_context = repre_context_by_id[repre_doc["_id"]] - for loader in pipeline.loaders_from_repre_context( + for loader in loaders_from_repre_context( repre_loaders, repre_context ): @@ -515,7 +525,7 @@ class SubsetWidget(QtWidgets.QWidget): action = lib.get_no_loader_action(menu, one_item_selected) menu.addAction(action) else: - repre_contexts = pipeline.get_repres_contexts( + repre_contexts = get_repres_contexts( repre_context_by_id.keys(), self.dbcon) menu = lib.add_representation_loaders_to_menu( @@ -532,7 +542,7 @@ class SubsetWidget(QtWidgets.QWidget): self.load_started.emit() - if api.SubsetLoader in inspect.getmro(loader): + if issubclass(loader, SubsetLoaderPlugin): subset_ids = [] subset_version_docs = {} for item in items: @@ -541,8 +551,7 @@ class SubsetWidget(QtWidgets.QWidget): subset_version_docs[subset_id] = item["version_document"] # get contexts only for selected menu option - subset_contexts_by_id = pipeline.get_subset_contexts(subset_ids, - self.dbcon) + subset_contexts_by_id = get_subset_contexts(subset_ids, self.dbcon) subset_contexts = list(subset_contexts_by_id.values()) options = lib.get_options(action, loader, self, subset_contexts) @@ -575,8 +584,7 @@ class SubsetWidget(QtWidgets.QWidget): repre_ids.append(representation["_id"]) # get contexts only for selected menu option - repre_contexts = pipeline.get_repres_contexts(repre_ids, - self.dbcon) + repre_contexts = get_repres_contexts(repre_ids, self.dbcon) options = lib.get_options(action, loader, self, list(repre_contexts.values())) @@ -1339,12 +1347,12 @@ class RepresentationWidget(QtWidgets.QWidget): selected_side = self._get_selected_side(point_index, rows) # Get all representation->loader combinations available for the # index under the cursor, so we can list the user the options. - available_loaders = api.discover(api.Loader) + available_loaders = discover_loader_plugins() filtered_loaders = [] for loader in available_loaders: # Skip subset loaders - if api.SubsetLoader in inspect.getmro(loader): + if issubclass(loader, SubsetLoaderPlugin): continue if ( @@ -1370,7 +1378,7 @@ class RepresentationWidget(QtWidgets.QWidget): for item in items: repre_context = repre_context_by_id[item["_id"]] - for loader in pipeline.loaders_from_repre_context( + for loader in loaders_from_repre_context( filtered_loaders, repre_context ): @@ -1426,7 +1434,7 @@ class RepresentationWidget(QtWidgets.QWidget): action = lib.get_no_loader_action(menu) menu.addAction(action) else: - repre_contexts = pipeline.get_repres_contexts( + repre_contexts = get_repres_contexts( repre_context_by_id.keys(), self.dbcon) menu = lib.add_representation_loaders_to_menu(loaders, menu, repre_contexts) @@ -1472,8 +1480,7 @@ class RepresentationWidget(QtWidgets.QWidget): repre_ids.append(item.get("_id")) - repre_contexts = pipeline.get_repres_contexts(repre_ids, - self.dbcon) + repre_contexts = get_repres_contexts(repre_ids, self.dbcon) options = lib.get_options(action, loader, self, list(repre_contexts.values())) @@ -1540,7 +1547,7 @@ def _load_representations_by_loader(loader, repre_contexts, """Loops through list of repre_contexts and loads them with one loader Args: - loader (cls of api.Loader) - not initialized yet + loader (cls of LoaderPlugin) - not initialized yet repre_contexts (dicts) - full info about selected representations (containing repre_doc, version_doc, subset_doc, project info) options (dict) - qargparse arguments to fill OptionDialog @@ -1558,12 +1565,12 @@ def _load_representations_by_loader(loader, repre_contexts, _id = repre_context["representation"]["_id"] data = data_by_repre_id.get(_id) options.update(data) - pipeline.load_with_repre_context( + load_with_repre_context( loader, repre_context, options=options ) - except pipeline.IncompatibleLoaderError as exc: + except IncompatibleLoaderError as exc: print(exc) error_info.append(( "Incompatible Loader", @@ -1612,7 +1619,7 @@ def _load_subsets_by_loader(loader, subset_contexts, options, context["version"] = subset_version_docs[context["subset"]["_id"]] try: - pipeline.load_with_subset_contexts( + load_with_subset_contexts( loader, subset_contexts, options=options @@ -1638,7 +1645,7 @@ def _load_subsets_by_loader(loader, subset_contexts, options, version_doc = subset_version_docs[subset_context["subset"]["_id"]] subset_context["version"] = version_doc try: - pipeline.load_with_subset_context( + load_with_subset_context( loader, subset_context, options=options diff --git a/openpype/tools/mayalookassigner/__init__.py b/openpype/tools/mayalookassigner/__init__.py index 616a3e94d0..5e40777741 100644 --- a/openpype/tools/mayalookassigner/__init__.py +++ b/openpype/tools/mayalookassigner/__init__.py @@ -1,9 +1,9 @@ from .app import ( - App, + MayaLookAssignerWindow, show ) __all__ = [ - "App", + "MayaLookAssignerWindow", "show"] diff --git a/openpype/tools/mayalookassigner/app.py b/openpype/tools/mayalookassigner/app.py index 31bb455f95..0e633a21e3 100644 --- a/openpype/tools/mayalookassigner/app.py +++ b/openpype/tools/mayalookassigner/app.py @@ -4,10 +4,10 @@ import logging from Qt import QtWidgets, QtCore -from openpype.hosts.maya.api.lib import assign_look_by_version - -from avalon import style, io +from avalon import io +from openpype import style from openpype.tools.utils.lib import qt_app_context +from openpype.hosts.maya.api.lib import assign_look_by_version from maya import cmds # old api for MFileIO @@ -28,10 +28,10 @@ module = sys.modules[__name__] module.window = None -class App(QtWidgets.QWidget): +class MayaLookAssignerWindow(QtWidgets.QWidget): def __init__(self, parent=None): - QtWidgets.QWidget.__init__(self, parent=parent) + super(MayaLookAssignerWindow, self).__init__(parent=parent) self.log = logging.getLogger(__name__) @@ -56,30 +56,41 @@ class App(QtWidgets.QWidget): def setup_ui(self): """Build the UI""" + main_splitter = QtWidgets.QSplitter(self) + # Assets (left) - asset_outliner = AssetOutliner() + asset_outliner = AssetOutliner(main_splitter) # Looks (right) - looks_widget = QtWidgets.QWidget() - looks_layout = QtWidgets.QVBoxLayout(looks_widget) + looks_widget = QtWidgets.QWidget(main_splitter) - look_outliner = LookOutliner() # Database look overview + look_outliner = LookOutliner(looks_widget) # Database look overview - assign_selected = QtWidgets.QCheckBox("Assign to selected only") + assign_selected = QtWidgets.QCheckBox( + "Assign to selected only", looks_widget + ) assign_selected.setToolTip("Whether to assign only to selected nodes " "or to the full asset") - remove_unused_btn = QtWidgets.QPushButton("Remove Unused Looks") + remove_unused_btn = QtWidgets.QPushButton( + "Remove Unused Looks", looks_widget + ) + looks_layout = QtWidgets.QVBoxLayout(looks_widget) looks_layout.addWidget(look_outliner) looks_layout.addWidget(assign_selected) looks_layout.addWidget(remove_unused_btn) + main_splitter.addWidget(asset_outliner) + main_splitter.addWidget(looks_widget) + main_splitter.setSizes([350, 200]) + # Footer - status = QtWidgets.QStatusBar() + status = QtWidgets.QStatusBar(self) status.setSizeGripEnabled(False) status.setFixedHeight(25) - warn_layer = QtWidgets.QLabel("Current Layer is not " - "defaultRenderLayer") + warn_layer = QtWidgets.QLabel( + "Current Layer is not defaultRenderLayer", self + ) warn_layer.setAlignment(QtCore.Qt.AlignRight | QtCore.Qt.AlignVCenter) warn_layer.setStyleSheet("color: #DD5555; font-weight: bold;") warn_layer.setFixedHeight(25) @@ -92,11 +103,6 @@ class App(QtWidgets.QWidget): # Build up widgets main_layout = QtWidgets.QVBoxLayout(self) main_layout.setSpacing(0) - main_splitter = QtWidgets.QSplitter() - main_splitter.setStyleSheet("QSplitter{ border: 0px; }") - main_splitter.addWidget(asset_outliner) - main_splitter.addWidget(looks_widget) - main_splitter.setSizes([350, 200]) main_layout.addWidget(main_splitter) main_layout.addLayout(footer) @@ -124,6 +130,8 @@ class App(QtWidgets.QWidget): self.remove_unused = remove_unused_btn self.assign_selected = assign_selected + self._first_show = True + def setup_connections(self): """Connect interactive widgets with actions""" if self._connections_set_up: @@ -147,11 +155,14 @@ class App(QtWidgets.QWidget): def showEvent(self, event): self.setup_connections() - super(App, self).showEvent(event) + super(MayaLookAssignerWindow, self).showEvent(event) + if self._first_show: + self._first_show = False + self.setStyleSheet(style.load_stylesheet()) def closeEvent(self, event): self.remove_connection() - super(App, self).closeEvent(event) + super(MayaLookAssignerWindow, self).closeEvent(event) def _on_renderlayer_switch(self, *args): """Callback that updates on Maya renderlayer switch""" @@ -267,8 +278,7 @@ def show(): if widget.objectName() == "MayaWindow") with qt_app_context(): - window = App(parent=mainwindow) - window.setStyleSheet(style.load_stylesheet()) + window = MayaLookAssignerWindow(parent=mainwindow) window.show() module.window = window diff --git a/openpype/tools/mayalookassigner/commands.py b/openpype/tools/mayalookassigner/commands.py index 96fc28243b..df72e41354 100644 --- a/openpype/tools/mayalookassigner/commands.py +++ b/openpype/tools/mayalookassigner/commands.py @@ -4,10 +4,11 @@ import os import maya.cmds as cmds -from openpype.hosts.maya.api import lib - from avalon import io, api +from openpype.pipeline import remove_container +from openpype.hosts.maya.api import lib + from .vray_proxies import get_alembic_ids_cache log = logging.getLogger(__name__) @@ -206,6 +207,6 @@ def remove_unused_looks(): for container in unused: log.info("Removing unused look container: %s", container['objectName']) - api.remove(container) + remove_container(container) log.info("Finished removing unused looks. (see log for details)") diff --git a/openpype/tools/mayalookassigner/models.py b/openpype/tools/mayalookassigner/models.py index 39cab83c61..77a3c8a590 100644 --- a/openpype/tools/mayalookassigner/models.py +++ b/openpype/tools/mayalookassigner/models.py @@ -1,16 +1,21 @@ from collections import defaultdict from Qt import QtCore +import qtawesome -from avalon.vendor import qtawesome -from avalon.style import colors from openpype.tools.utils import models +from openpype.style import get_default_entity_icon_color class AssetModel(models.TreeModel): Columns = ["label"] + def __init__(self, *args, **kwargs): + super(AssetModel, self).__init__(*args, **kwargs) + + self._icon_color = get_default_entity_icon_color() + def add_items(self, items): """ Add items to model with needed data @@ -65,8 +70,10 @@ class AssetModel(models.TreeModel): node = index.internalPointer() icon = node.get("icon") if icon: - return qtawesome.icon("fa.{0}".format(icon), - color=colors.default) + return qtawesome.icon( + "fa.{0}".format(icon), + color=self._icon_color + ) return super(AssetModel, self).data(index, role) diff --git a/openpype/tools/mayalookassigner/views.py b/openpype/tools/mayalookassigner/views.py index 993023bb45..8e676ebc7f 100644 --- a/openpype/tools/mayalookassigner/views.py +++ b/openpype/tools/mayalookassigner/views.py @@ -1,9 +1,6 @@ from Qt import QtWidgets, QtCore -DEFAULT_COLOR = "#fb9c15" - - class View(QtWidgets.QTreeView): data_changed = QtCore.Signal() diff --git a/openpype/tools/mayalookassigner/vray_proxies.py b/openpype/tools/mayalookassigner/vray_proxies.py index b22ec95a4d..6a9347449a 100644 --- a/openpype/tools/mayalookassigner/vray_proxies.py +++ b/openpype/tools/mayalookassigner/vray_proxies.py @@ -12,6 +12,12 @@ from maya import cmds from avalon import io, api +from openpype.pipeline import ( + load_container, + loaders_from_representation, + discover_loader_plugins, + get_representation_path, +) from openpype.hosts.maya.api import lib @@ -155,7 +161,7 @@ def get_look_relationships(version_id): "name": "json"}) # Load relationships - shader_relation = api.get_representation_path(json_representation) + shader_relation = get_representation_path(json_representation) with open(shader_relation, "r") as f: relationships = json.load(f) @@ -193,8 +199,8 @@ def load_look(version_id): log.info("Using look for the first time ...") # Load file - loaders = api.loaders_from_representation(api.discover(api.Loader), - representation_id) + all_loaders = discover_loader_plugins() + loaders = loaders_from_representation(all_loaders, representation_id) loader = next( (i for i in loaders if i.__name__ == "LookLoader"), None) if loader is None: @@ -202,7 +208,7 @@ def load_look(version_id): # Reference the look file with lib.maintained_selection(): - container_node = api.load(loader, look_representation) + container_node = load_container(loader, look_representation) # Get container members shader_nodes = lib.get_container_members(container_node) diff --git a/openpype/tools/mayalookassigner/widgets.py b/openpype/tools/mayalookassigner/widgets.py index d575e647ce..10e573342a 100644 --- a/openpype/tools/mayalookassigner/widgets.py +++ b/openpype/tools/mayalookassigner/widgets.py @@ -3,16 +3,18 @@ from collections import defaultdict from Qt import QtWidgets, QtCore -# TODO: expose this better in avalon core -from avalon.tools import lib -from avalon.tools.models import TreeModel +from openpype.tools.utils.models import TreeModel +from openpype.tools.utils.lib import ( + preserve_expanded_rows, + preserve_selection, +) from .models import ( AssetModel, LookModel ) from . import commands -from . import views +from .views import View from maya import cmds @@ -22,25 +24,28 @@ class AssetOutliner(QtWidgets.QWidget): selection_changed = QtCore.Signal() def __init__(self, parent=None): - QtWidgets.QWidget.__init__(self, parent) + super(AssetOutliner, self).__init__(parent) - layout = QtWidgets.QVBoxLayout() - - title = QtWidgets.QLabel("Assets") + title = QtWidgets.QLabel("Assets", self) title.setAlignment(QtCore.Qt.AlignCenter) title.setStyleSheet("font-weight: bold; font-size: 12px") model = AssetModel() - view = views.View() + view = View(self) view.setModel(model) view.customContextMenuRequested.connect(self.right_mouse_menu) view.setSortingEnabled(False) view.setHeaderHidden(True) view.setIndentation(10) - from_all_asset_btn = QtWidgets.QPushButton("Get All Assets") - from_selection_btn = QtWidgets.QPushButton("Get Assets From Selection") + from_all_asset_btn = QtWidgets.QPushButton( + "Get All Assets", self + ) + from_selection_btn = QtWidgets.QPushButton( + "Get Assets From Selection", self + ) + layout = QtWidgets.QVBoxLayout(self) layout.addWidget(title) layout.addWidget(from_all_asset_btn) layout.addWidget(from_selection_btn) @@ -56,8 +61,6 @@ class AssetOutliner(QtWidgets.QWidget): self.view = view self.model = model - self.setLayout(layout) - self.log = logging.getLogger(__name__) def clear(self): @@ -88,8 +91,8 @@ class AssetOutliner(QtWidgets.QWidget): """Add all items from the current scene""" items = [] - with lib.preserve_expanded_rows(self.view): - with lib.preserve_selection(self.view): + with preserve_expanded_rows(self.view): + with preserve_selection(self.view): self.clear() nodes = commands.get_all_asset_nodes() items = commands.create_items_from_nodes(nodes) @@ -100,8 +103,8 @@ class AssetOutliner(QtWidgets.QWidget): def get_selected_assets(self): """Add all selected items from the current scene""" - with lib.preserve_expanded_rows(self.view): - with lib.preserve_selection(self.view): + with preserve_expanded_rows(self.view): + with preserve_selection(self.view): self.clear() nodes = commands.get_selected_nodes() items = commands.create_items_from_nodes(nodes) @@ -186,15 +189,10 @@ class LookOutliner(QtWidgets.QWidget): menu_apply_action = QtCore.Signal() def __init__(self, parent=None): - QtWidgets.QWidget.__init__(self, parent) - - # look manager layout - layout = QtWidgets.QVBoxLayout(self) - layout.setContentsMargins(0, 0, 0, 0) - layout.setSpacing(10) + super(LookOutliner, self).__init__(parent) # Looks from database - title = QtWidgets.QLabel("Looks") + title = QtWidgets.QLabel("Looks", self) title.setAlignment(QtCore.Qt.AlignCenter) title.setStyleSheet("font-weight: bold; font-size: 12px") title.setAlignment(QtCore.Qt.AlignCenter) @@ -205,13 +203,17 @@ class LookOutliner(QtWidgets.QWidget): proxy = QtCore.QSortFilterProxyModel() proxy.setSourceModel(model) - view = views.View() + view = View(self) view.setModel(proxy) view.setMinimumHeight(180) view.setToolTip("Use right mouse button menu for direct actions") view.customContextMenuRequested.connect(self.right_mouse_menu) view.sortByColumn(0, QtCore.Qt.AscendingOrder) + # look manager layout + layout = QtWidgets.QVBoxLayout(self) + layout.setContentsMargins(0, 0, 0, 0) + layout.setSpacing(10) layout.addWidget(title) layout.addWidget(view) diff --git a/openpype/tools/project_manager/project_manager/multiselection_combobox.py b/openpype/tools/project_manager/project_manager/multiselection_combobox.py index 890567de6d..f776831298 100644 --- a/openpype/tools/project_manager/project_manager/multiselection_combobox.py +++ b/openpype/tools/project_manager/project_manager/multiselection_combobox.py @@ -1,4 +1,4 @@ -from Qt import QtCore, QtGui, QtWidgets +from Qt import QtCore, QtWidgets class ComboItemDelegate(QtWidgets.QStyledItemDelegate): diff --git a/openpype/tools/project_manager/project_manager/style.py b/openpype/tools/project_manager/project_manager/style.py index d24fc7102f..4405d05960 100644 --- a/openpype/tools/project_manager/project_manager/style.py +++ b/openpype/tools/project_manager/project_manager/style.py @@ -1,7 +1,7 @@ import os -from Qt import QtCore, QtGui +from Qt import QtGui -from avalon.vendor import qtawesome +import qtawesome from openpype.tools.utils import paint_image_with_color diff --git a/openpype/tools/publisher/control.py b/openpype/tools/publisher/control.py index 2ce0eaad62..6707feac9c 100644 --- a/openpype/tools/publisher/control.py +++ b/openpype/tools/publisher/control.py @@ -42,18 +42,23 @@ class MainThreadProcess(QtCore.QObject): This approach gives ability to update UI meanwhile plugin is in progress. """ - timer_interval = 3 + count_timeout = 2 def __init__(self): super(MainThreadProcess, self).__init__() self._items_to_process = collections.deque() timer = QtCore.QTimer() - timer.setInterval(self.timer_interval) + timer.setInterval(0) timer.timeout.connect(self._execute) self._timer = timer + self._switch_counter = self.count_timeout + + def process(self, func, *args, **kwargs): + item = MainThreadItem(func, *args, **kwargs) + self.add_item(item) def add_item(self, item): self._items_to_process.append(item) @@ -62,6 +67,12 @@ class MainThreadProcess(QtCore.QObject): if not self._items_to_process: return + if self._switch_counter > 0: + self._switch_counter -= 1 + return + + self._switch_counter = self.count_timeout + item = self._items_to_process.popleft() item.process() @@ -173,11 +184,21 @@ class PublishReport: self._stored_plugins.append(plugin) + plugin_data_item = self._create_plugin_data_item(plugin) + + self._plugin_data_with_plugin.append({ + "plugin": plugin, + "data": plugin_data_item + }) + self._plugin_data.append(plugin_data_item) + return plugin_data_item + + def _create_plugin_data_item(self, plugin): label = None if hasattr(plugin, "label"): label = plugin.label - plugin_data_item = { + return { "name": plugin.__name__, "label": label, "order": plugin.order, @@ -186,12 +207,6 @@ class PublishReport: "skipped": False, "passed": False } - self._plugin_data_with_plugin.append({ - "plugin": plugin, - "data": plugin_data_item - }) - self._plugin_data.append(plugin_data_item) - return plugin_data_item def set_plugin_skipped(self): """Set that current plugin has been skipped.""" @@ -241,7 +256,7 @@ class PublishReport: if publish_plugins: for plugin in publish_plugins: if plugin not in self._stored_plugins: - plugins_data.append(self._add_plugin_data_item(plugin)) + plugins_data.append(self._create_plugin_data_item(plugin)) crashed_file_paths = {} if self._publish_discover_result is not None: @@ -858,8 +873,6 @@ class PublisherController: """ for idx, plugin in enumerate(self.publish_plugins): self._publish_progress = idx - # Add plugin to publish report - self._publish_report.add_plugin_iter(plugin, self._publish_context) # Reset current plugin validations error self._publish_current_plugin_validation_errors = None @@ -887,6 +900,9 @@ class PublisherController: ): yield MainThreadItem(self.stop_publish) + # Add plugin to publish report + self._publish_report.add_plugin_iter(plugin, self._publish_context) + # Trigger callback that new plugin is going to be processed self._trigger_callbacks( self._publish_plugin_changed_callback_refs, plugin @@ -971,6 +987,9 @@ class PublisherController: self._publish_next_process() + def reset_project_data_cache(self): + self._asset_docs_cache.reset() + def collect_families_from_instances(instances, only_active=False): """Collect all families for passed publish instances. diff --git a/openpype/tools/publisher/publish_report_viewer/__init__.py b/openpype/tools/publisher/publish_report_viewer/__init__.py index 3cfaaa5a05..ce1cc3729c 100644 --- a/openpype/tools/publisher/publish_report_viewer/__init__.py +++ b/openpype/tools/publisher/publish_report_viewer/__init__.py @@ -1,3 +1,6 @@ +from .report_items import ( + PublishReport +) from .widgets import ( PublishReportViewerWidget ) @@ -8,6 +11,8 @@ from .window import ( __all__ = ( + "PublishReport", + "PublishReportViewerWidget", "PublishReportViewerWindow", diff --git a/openpype/tools/publisher/publish_report_viewer/model.py b/openpype/tools/publisher/publish_report_viewer/model.py index 460d3e12d1..a88129a358 100644 --- a/openpype/tools/publisher/publish_report_viewer/model.py +++ b/openpype/tools/publisher/publish_report_viewer/model.py @@ -28,6 +28,8 @@ class InstancesModel(QtGui.QStandardItemModel): self.clear() self._items_by_id.clear() self._plugin_items_by_id.clear() + if not report_item: + return root_item = self.invisibleRootItem() @@ -119,6 +121,8 @@ class PluginsModel(QtGui.QStandardItemModel): self.clear() self._items_by_id.clear() self._plugin_items_by_id.clear() + if not report_item: + return root_item = self.invisibleRootItem() diff --git a/openpype/tools/publisher/publish_report_viewer/report_items.py b/openpype/tools/publisher/publish_report_viewer/report_items.py new file mode 100644 index 0000000000..b47d14da25 --- /dev/null +++ b/openpype/tools/publisher/publish_report_viewer/report_items.py @@ -0,0 +1,126 @@ +import uuid +import collections +import copy + + +class PluginItem: + def __init__(self, plugin_data): + self._id = uuid.uuid4() + + self.name = plugin_data["name"] + self.label = plugin_data["label"] + self.order = plugin_data["order"] + self.skipped = plugin_data["skipped"] + self.passed = plugin_data["passed"] + + errored = False + for instance_data in plugin_data["instances_data"]: + for log_item in instance_data["logs"]: + errored = log_item["type"] == "error" + if errored: + break + if errored: + break + + self.errored = errored + + @property + def id(self): + return self._id + + +class InstanceItem: + def __init__(self, instance_id, instance_data, logs_by_instance_id): + self._id = instance_id + self.label = instance_data.get("label") or instance_data.get("name") + self.family = instance_data.get("family") + self.removed = not instance_data.get("exists", True) + + logs = logs_by_instance_id.get(instance_id) or [] + errored = False + for log_item in logs: + if log_item.errored: + errored = True + break + + self.errored = errored + + @property + def id(self): + return self._id + + +class LogItem: + def __init__(self, log_item_data, plugin_id, instance_id): + self._instance_id = instance_id + self._plugin_id = plugin_id + self._errored = log_item_data["type"] == "error" + self.data = log_item_data + + def __getitem__(self, key): + return self.data[key] + + @property + def errored(self): + return self._errored + + @property + def instance_id(self): + return self._instance_id + + @property + def plugin_id(self): + return self._plugin_id + + +class PublishReport: + def __init__(self, report_data): + data = copy.deepcopy(report_data) + + context_data = data["context"] + context_data["name"] = "context" + context_data["label"] = context_data["label"] or "Context" + + logs = [] + plugins_items_by_id = {} + plugins_id_order = [] + for plugin_data in data["plugins_data"]: + item = PluginItem(plugin_data) + plugins_id_order.append(item.id) + plugins_items_by_id[item.id] = item + for instance_data_item in plugin_data["instances_data"]: + instance_id = instance_data_item["id"] + for log_item_data in instance_data_item["logs"]: + log_item = LogItem( + copy.deepcopy(log_item_data), item.id, instance_id + ) + logs.append(log_item) + + logs_by_instance_id = collections.defaultdict(list) + for log_item in logs: + logs_by_instance_id[log_item.instance_id].append(log_item) + + instance_items_by_id = {} + instance_items_by_family = {} + context_item = InstanceItem(None, context_data, logs_by_instance_id) + instance_items_by_id[context_item.id] = context_item + instance_items_by_family[context_item.family] = [context_item] + + for instance_id, instance_data in data["instances"].items(): + item = InstanceItem( + instance_id, instance_data, logs_by_instance_id + ) + instance_items_by_id[item.id] = item + if item.family not in instance_items_by_family: + instance_items_by_family[item.family] = [] + instance_items_by_family[item.family].append(item) + + self.instance_items_by_id = instance_items_by_id + self.instance_items_by_family = instance_items_by_family + + self.plugins_id_order = plugins_id_order + self.plugins_items_by_id = plugins_items_by_id + + self.logs = logs + + self.crashed_plugin_paths = report_data["crashed_file_paths"] diff --git a/openpype/tools/publisher/publish_report_viewer/widgets.py b/openpype/tools/publisher/publish_report_viewer/widgets.py index 24f1d33d0e..fd226ea0e4 100644 --- a/openpype/tools/publisher/publish_report_viewer/widgets.py +++ b/openpype/tools/publisher/publish_report_viewer/widgets.py @@ -1,10 +1,8 @@ -import copy -import uuid - -from Qt import QtWidgets, QtCore +from Qt import QtWidgets, QtCore, QtGui from openpype.widgets.nice_checkbox import NiceCheckbox +# from openpype.tools.utils import DeselectableTreeView from .constants import ( ITEM_ID_ROLE, ITEM_IS_GROUP_ROLE @@ -16,98 +14,127 @@ from .model import ( PluginsModel, PluginProxyModel ) +from .report_items import PublishReport + +FILEPATH_ROLE = QtCore.Qt.UserRole + 1 +TRACEBACK_ROLE = QtCore.Qt.UserRole + 2 +IS_DETAIL_ITEM_ROLE = QtCore.Qt.UserRole + 3 -class PluginItem: - def __init__(self, plugin_data): - self._id = uuid.uuid4() +class PluginLoadReportModel(QtGui.QStandardItemModel): + def set_report(self, report): + parent = self.invisibleRootItem() + parent.removeRows(0, parent.rowCount()) - self.name = plugin_data["name"] - self.label = plugin_data["label"] - self.order = plugin_data["order"] - self.skipped = plugin_data["skipped"] - self.passed = plugin_data["passed"] + new_items = [] + new_items_by_filepath = {} + for filepath in report.crashed_plugin_paths.keys(): + item = QtGui.QStandardItem(filepath) + new_items.append(item) + new_items_by_filepath[filepath] = item - logs = [] - errored = False - for instance_data in plugin_data["instances_data"]: - for log_item in instance_data["logs"]: - if not errored: - errored = log_item["type"] == "error" - logs.append(copy.deepcopy(log_item)) + if not new_items: + return - self.errored = errored - self.logs = logs - - @property - def id(self): - return self._id + parent.appendRows(new_items) + for filepath, item in new_items_by_filepath.items(): + traceback_txt = report.crashed_plugin_paths[filepath] + detail_item = QtGui.QStandardItem() + detail_item.setData(filepath, FILEPATH_ROLE) + detail_item.setData(traceback_txt, TRACEBACK_ROLE) + detail_item.setData(True, IS_DETAIL_ITEM_ROLE) + item.appendRow(detail_item) -class InstanceItem: - def __init__(self, instance_id, instance_data, report_data): - self._id = instance_id - self.label = instance_data.get("label") or instance_data.get("name") - self.family = instance_data.get("family") - self.removed = not instance_data.get("exists", True) +class DetailWidget(QtWidgets.QTextEdit): + def __init__(self, text, *args, **kwargs): + super(DetailWidget, self).__init__(*args, **kwargs) - logs = [] - for plugin_data in report_data["plugins_data"]: - for instance_data_item in plugin_data["instances_data"]: - if instance_data_item["id"] == self._id: - logs.extend(copy.deepcopy(instance_data_item["logs"])) + self.setReadOnly(True) + self.setHtml(text) + self.setTextInteractionFlags(QtCore.Qt.TextBrowserInteraction) + self.setWordWrapMode( + QtGui.QTextOption.WrapAtWordBoundaryOrAnywhere + ) - errored = False - for log in logs: - if log["type"] == "error": - errored = True - break - - self.errored = errored - self.logs = logs - - @property - def id(self): - return self._id + def sizeHint(self): + content_margins = ( + self.contentsMargins().top() + + self.contentsMargins().bottom() + ) + size = self.document().documentLayout().documentSize().toSize() + size.setHeight(size.height() + content_margins) + return size -class PublishReport: - def __init__(self, report_data): - data = copy.deepcopy(report_data) +class PluginLoadReportWidget(QtWidgets.QWidget): + def __init__(self, parent): + super(PluginLoadReportWidget, self).__init__(parent) - context_data = data["context"] - context_data["name"] = "context" - context_data["label"] = context_data["label"] or "Context" + view = QtWidgets.QTreeView(self) + view.setEditTriggers(view.NoEditTriggers) + view.setTextElideMode(QtCore.Qt.ElideLeft) + view.setHeaderHidden(True) + view.setAlternatingRowColors(True) + view.setVerticalScrollMode(view.ScrollPerPixel) - instance_items_by_id = {} - instance_items_by_family = {} - context_item = InstanceItem(None, context_data, data) - instance_items_by_id[context_item.id] = context_item - instance_items_by_family[context_item.family] = [context_item] + model = PluginLoadReportModel() + view.setModel(model) - for instance_id, instance_data in data["instances"].items(): - item = InstanceItem(instance_id, instance_data, data) - instance_items_by_id[item.id] = item - if item.family not in instance_items_by_family: - instance_items_by_family[item.family] = [] - instance_items_by_family[item.family].append(item) + layout = QtWidgets.QHBoxLayout(self) + layout.setContentsMargins(0, 0, 0, 0) + layout.addWidget(view, 1) - all_logs = [] - plugins_items_by_id = {} - plugins_id_order = [] - for plugin_data in data["plugins_data"]: - item = PluginItem(plugin_data) - plugins_id_order.append(item.id) - plugins_items_by_id[item.id] = item - all_logs.extend(copy.deepcopy(item.logs)) + view.expanded.connect(self._on_expand) - self.instance_items_by_id = instance_items_by_id - self.instance_items_by_family = instance_items_by_family + self._view = view + self._model = model + self._widgets_by_filepath = {} - self.plugins_id_order = plugins_id_order - self.plugins_items_by_id = plugins_items_by_id + def _on_expand(self, index): + for row in range(self._model.rowCount(index)): + child_index = self._model.index(row, index.column(), index) + self._create_widget(child_index) - self.logs = all_logs + def showEvent(self, event): + super(PluginLoadReportWidget, self).showEvent(event) + self._update_widgets_size_hints() + + def resizeEvent(self, event): + super(PluginLoadReportWidget, self).resizeEvent(event) + self._update_widgets_size_hints() + + def _update_widgets_size_hints(self): + for item in self._widgets_by_filepath.values(): + widget, index = item + if not widget.isVisible(): + continue + self._model.setData( + index, widget.sizeHint(), QtCore.Qt.SizeHintRole + ) + + def _create_widget(self, index): + if not index.data(IS_DETAIL_ITEM_ROLE): + return + + filepath = index.data(FILEPATH_ROLE) + if filepath in self._widgets_by_filepath: + return + + traceback_txt = index.data(TRACEBACK_ROLE) + detail_text = ( + "Filepath:
" + "{}

" + "Traceback:
" + "{}" + ).format(filepath, traceback_txt.replace("\n", "
")) + widget = DetailWidget(detail_text, self) + self._view.setIndexWidget(index, widget) + self._widgets_by_filepath[filepath] = (widget, index) + + def set_report(self, report): + self._widgets_by_filepath = {} + self._model.set_report(report) class DetailsWidget(QtWidgets.QWidget): @@ -123,11 +150,50 @@ class DetailsWidget(QtWidgets.QWidget): layout.addWidget(output_widget) self._output_widget = output_widget + self._report_item = None + self._instance_filter = set() + self._plugin_filter = set() def clear(self): self._output_widget.setPlainText("") - def set_logs(self, logs): + def set_report(self, report): + self._report_item = report + self._plugin_filter = set() + self._instance_filter = set() + self._update_logs() + + def set_plugin_filter(self, plugin_filter): + self._plugin_filter = plugin_filter + self._update_logs() + + def set_instance_filter(self, instance_filter): + self._instance_filter = instance_filter + self._update_logs() + + def _update_logs(self): + if not self._report_item: + self._output_widget.setPlainText("") + return + + filtered_logs = [] + for log in self._report_item.logs: + if ( + self._instance_filter + and log.instance_id not in self._instance_filter + ): + continue + + if ( + self._plugin_filter + and log.plugin_id not in self._plugin_filter + ): + continue + filtered_logs.append(log) + + self._set_logs(filtered_logs) + + def _set_logs(self, logs): lines = [] for log in logs: if log["type"] == "record": @@ -148,6 +214,60 @@ class DetailsWidget(QtWidgets.QWidget): self._output_widget.setPlainText(text) +class DeselectableTreeView(QtWidgets.QTreeView): + """A tree view that deselects on clicking on an empty area in the view""" + + def mousePressEvent(self, event): + index = self.indexAt(event.pos()) + clear_selection = False + if not index.isValid(): + modifiers = QtWidgets.QApplication.keyboardModifiers() + if modifiers == QtCore.Qt.ShiftModifier: + return + elif modifiers == QtCore.Qt.ControlModifier: + return + clear_selection = True + else: + indexes = self.selectedIndexes() + if len(indexes) == 1 and index in indexes: + clear_selection = True + + if clear_selection: + # clear the selection + self.clearSelection() + # clear the current index + self.setCurrentIndex(QtCore.QModelIndex()) + event.accept() + return + + QtWidgets.QTreeView.mousePressEvent(self, event) + + +class DetailsPopup(QtWidgets.QDialog): + closed = QtCore.Signal() + + def __init__(self, parent, center_widget): + super(DetailsPopup, self).__init__(parent) + self.setWindowTitle("Report Details") + layout = QtWidgets.QHBoxLayout(self) + + self._center_widget = center_widget + self._first_show = True + self._layout = layout + + def showEvent(self, event): + layout = self.layout() + layout.insertWidget(0, self._center_widget) + super(DetailsPopup, self).showEvent(event) + if self._first_show: + self._first_show = False + self.resize(700, 400) + + def closeEvent(self, event): + super(DetailsPopup, self).closeEvent(event) + self.closed.emit() + + class PublishReportViewerWidget(QtWidgets.QWidget): def __init__(self, parent=None): super(PublishReportViewerWidget, self).__init__(parent) @@ -171,12 +291,13 @@ class PublishReportViewerWidget(QtWidgets.QWidget): removed_instances_layout.addWidget(removed_instances_check, 0) removed_instances_layout.addWidget(removed_instances_label, 1) - instances_view = QtWidgets.QTreeView(self) + instances_view = DeselectableTreeView(self) instances_view.setObjectName("PublishDetailViews") instances_view.setModel(instances_proxy) instances_view.setIndentation(0) instances_view.setHeaderHidden(True) instances_view.setEditTriggers(QtWidgets.QTreeView.NoEditTriggers) + instances_view.setSelectionMode(QtWidgets.QTreeView.ExtendedSelection) instances_view.setExpandsOnDoubleClick(False) instances_delegate = GroupItemDelegate(instances_view) @@ -191,29 +312,49 @@ class PublishReportViewerWidget(QtWidgets.QWidget): skipped_plugins_layout.addWidget(skipped_plugins_check, 0) skipped_plugins_layout.addWidget(skipped_plugins_label, 1) - plugins_view = QtWidgets.QTreeView(self) + plugins_view = DeselectableTreeView(self) plugins_view.setObjectName("PublishDetailViews") plugins_view.setModel(plugins_proxy) plugins_view.setIndentation(0) plugins_view.setHeaderHidden(True) + plugins_view.setSelectionMode(QtWidgets.QTreeView.ExtendedSelection) plugins_view.setEditTriggers(QtWidgets.QTreeView.NoEditTriggers) plugins_view.setExpandsOnDoubleClick(False) plugins_delegate = GroupItemDelegate(plugins_view) plugins_view.setItemDelegate(plugins_delegate) - details_widget = DetailsWidget(self) + details_widget = QtWidgets.QWidget(self) + details_tab_widget = QtWidgets.QTabWidget(details_widget) + details_popup_btn = QtWidgets.QPushButton("PopUp", details_widget) - layout = QtWidgets.QGridLayout(self) + details_layout = QtWidgets.QVBoxLayout(details_widget) + details_layout.setContentsMargins(0, 0, 0, 0) + details_layout.addWidget(details_tab_widget, 1) + details_layout.addWidget(details_popup_btn, 0) + + details_popup = DetailsPopup(self, details_tab_widget) + + logs_text_widget = DetailsWidget(details_tab_widget) + plugin_load_report_widget = PluginLoadReportWidget(details_tab_widget) + + details_tab_widget.addTab(logs_text_widget, "Logs") + details_tab_widget.addTab(plugin_load_report_widget, "Crashed plugins") + + middle_widget = QtWidgets.QWidget(self) + middle_layout = QtWidgets.QGridLayout(middle_widget) + middle_layout.setContentsMargins(0, 0, 0, 0) # Row 1 - layout.addLayout(removed_instances_layout, 0, 0) - layout.addLayout(skipped_plugins_layout, 0, 1) + middle_layout.addLayout(removed_instances_layout, 0, 0) + middle_layout.addLayout(skipped_plugins_layout, 0, 1) # Row 2 - layout.addWidget(instances_view, 1, 0) - layout.addWidget(plugins_view, 1, 1) - layout.addWidget(details_widget, 1, 2) + middle_layout.addWidget(instances_view, 1, 0) + middle_layout.addWidget(plugins_view, 1, 1) - layout.setColumnStretch(2, 1) + layout = QtWidgets.QHBoxLayout(self) + layout.setContentsMargins(0, 0, 0, 0) + layout.addWidget(middle_widget, 0) + layout.addWidget(details_widget, 1) instances_view.selectionModel().selectionChanged.connect( self._on_instance_change @@ -230,10 +371,13 @@ class PublishReportViewerWidget(QtWidgets.QWidget): removed_instances_check.stateChanged.connect( self._on_removed_instances_check ) + details_popup_btn.clicked.connect(self._on_details_popup) + details_popup.closed.connect(self._on_popup_close) self._ignore_selection_changes = False self._report_item = None - self._details_widget = details_widget + self._logs_text_widget = logs_text_widget + self._plugin_load_report_widget = plugin_load_report_widget self._removed_instances_check = removed_instances_check self._instances_view = instances_view @@ -248,6 +392,10 @@ class PublishReportViewerWidget(QtWidgets.QWidget): self._plugins_model = plugins_model self._plugins_proxy = plugins_proxy + self._details_widget = details_widget + self._details_tab_widget = details_tab_widget + self._details_popup = details_popup + def _on_instance_view_clicked(self, index): if not index.isValid() or not index.data(ITEM_IS_GROUP_ROLE): return @@ -266,62 +414,46 @@ class PublishReportViewerWidget(QtWidgets.QWidget): else: self._plugins_view.expand(index) - def set_report(self, report_data): + def set_report_data(self, report_data): + report = PublishReport(report_data) + self.set_report(report) + + def set_report(self, report): self._ignore_selection_changes = True - report_item = PublishReport(report_data) - self._report_item = report_item + self._report_item = report - self._instances_model.set_report(report_item) - self._plugins_model.set_report(report_item) - self._details_widget.set_logs(report_item.logs) + self._instances_model.set_report(report) + self._plugins_model.set_report(report) + self._logs_text_widget.set_report(report) + self._plugin_load_report_widget.set_report(report) self._ignore_selection_changes = False + self._instances_view.expandAll() + self._plugins_view.expandAll() + def _on_instance_change(self, *_args): if self._ignore_selection_changes: return - valid_index = None + instance_ids = set() for index in self._instances_view.selectedIndexes(): if index.isValid(): - valid_index = index - break + instance_ids.add(index.data(ITEM_ID_ROLE)) - if valid_index is None: - return - - if self._plugins_view.selectedIndexes(): - self._ignore_selection_changes = True - self._plugins_view.selectionModel().clearSelection() - self._ignore_selection_changes = False - - plugin_id = valid_index.data(ITEM_ID_ROLE) - instance_item = self._report_item.instance_items_by_id[plugin_id] - self._details_widget.set_logs(instance_item.logs) + self._logs_text_widget.set_instance_filter(instance_ids) def _on_plugin_change(self, *_args): if self._ignore_selection_changes: return - valid_index = None + plugin_ids = set() for index in self._plugins_view.selectedIndexes(): if index.isValid(): - valid_index = index - break + plugin_ids.add(index.data(ITEM_ID_ROLE)) - if valid_index is None: - self._details_widget.set_logs(self._report_item.logs) - return - - if self._instances_view.selectedIndexes(): - self._ignore_selection_changes = True - self._instances_view.selectionModel().clearSelection() - self._ignore_selection_changes = False - - plugin_id = valid_index.data(ITEM_ID_ROLE) - plugin_item = self._report_item.plugins_items_by_id[plugin_id] - self._details_widget.set_logs(plugin_item.logs) + self._logs_text_widget.set_plugin_filter(plugin_ids) def _on_skipped_plugin_check(self): self._plugins_proxy.set_ignore_skipped( @@ -332,3 +464,16 @@ class PublishReportViewerWidget(QtWidgets.QWidget): self._instances_proxy.set_ignore_removed( self._removed_instances_check.isChecked() ) + + def _on_details_popup(self): + self._details_widget.setVisible(False) + self._details_popup.show() + + def _on_popup_close(self): + self._details_widget.setVisible(True) + layout = self._details_widget.layout() + layout.insertWidget(0, self._details_tab_widget) + + def close_details_popup(self): + if self._details_popup.isVisible(): + self._details_popup.close() diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 7a0fef7d91..678884677c 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -1,29 +1,355 @@ -from Qt import QtWidgets +import os +import json +import six +import appdirs +from Qt import QtWidgets, QtCore, QtGui from openpype import style +from openpype.lib import JSONSettingRegistry +from openpype.resources import get_openpype_icon_filepath +from openpype.tools import resources +from openpype.tools.utils import ( + IconButton, + paint_image_with_color +) + +from openpype.tools.utils.delegates import PrettyTimeDelegate + if __package__: from .widgets import PublishReportViewerWidget + from .report_items import PublishReport else: from widgets import PublishReportViewerWidget + from report_items import PublishReport + + +FILEPATH_ROLE = QtCore.Qt.UserRole + 1 +MODIFIED_ROLE = QtCore.Qt.UserRole + 2 + + +class PublisherReportRegistry(JSONSettingRegistry): + """Class handling storing publish report tool. + + Attributes: + vendor (str): Name used for path construction. + product (str): Additional name used for path construction. + + """ + + def __init__(self): + self.vendor = "pypeclub" + self.product = "openpype" + name = "publish_report_viewer" + path = appdirs.user_data_dir(self.product, self.vendor) + super(PublisherReportRegistry, self).__init__(name, path) + + +class LoadedFilesMopdel(QtGui.QStandardItemModel): + def __init__(self, *args, **kwargs): + super(LoadedFilesMopdel, self).__init__(*args, **kwargs) + self.setColumnCount(2) + self._items_by_filepath = {} + self._reports_by_filepath = {} + + self._registry = PublisherReportRegistry() + + self._loading_registry = False + self._load_registry() + + def headerData(self, section, orientation, role): + if role in (QtCore.Qt.DisplayRole, QtCore.Qt.EditRole): + if section == 0: + return "Exports" + if section == 1: + return "Modified" + return "" + super(LoadedFilesMopdel, self).headerData(section, orientation, role) + + def _load_registry(self): + self._loading_registry = True + try: + filepaths = self._registry.get_item("filepaths") + self.add_filepaths(filepaths) + except ValueError: + pass + self._loading_registry = False + + def _store_registry(self): + if self._loading_registry: + return + filepaths = list(self._items_by_filepath.keys()) + self._registry.set_item("filepaths", filepaths) + + def data(self, index, role=None): + if role is None: + role = QtCore.Qt.DisplayRole + + col = index.column() + if col != 0: + index = self.index(index.row(), 0, index.parent()) + + if role == QtCore.Qt.ToolTipRole: + if col == 0: + role = FILEPATH_ROLE + elif col == 1: + return "File modified" + return None + + elif role == QtCore.Qt.DisplayRole: + if col == 1: + role = MODIFIED_ROLE + return super(LoadedFilesMopdel, self).data(index, role) + + def add_filepaths(self, filepaths): + if not filepaths: + return + + if isinstance(filepaths, six.string_types): + filepaths = [filepaths] + + filtered_paths = [] + for filepath in filepaths: + normalized_path = os.path.normpath(filepath) + if normalized_path in self._items_by_filepath: + continue + + if ( + os.path.exists(normalized_path) + and normalized_path not in filtered_paths + ): + filtered_paths.append(normalized_path) + + if not filtered_paths: + return + + new_items = [] + for normalized_path in filtered_paths: + try: + with open(normalized_path, "r") as stream: + data = json.load(stream) + report = PublishReport(data) + except Exception: + # TODO handle errors + continue + + modified = os.path.getmtime(normalized_path) + item = QtGui.QStandardItem(os.path.basename(normalized_path)) + item.setColumnCount(self.columnCount()) + item.setData(normalized_path, FILEPATH_ROLE) + item.setData(modified, MODIFIED_ROLE) + new_items.append(item) + self._items_by_filepath[normalized_path] = item + self._reports_by_filepath[normalized_path] = report + + if not new_items: + return + + parent = self.invisibleRootItem() + parent.appendRows(new_items) + + self._store_registry() + + def remove_filepaths(self, filepaths): + if not filepaths: + return + + if isinstance(filepaths, six.string_types): + filepaths = [filepaths] + + filtered_paths = [] + for filepath in filepaths: + normalized_path = os.path.normpath(filepath) + if normalized_path in self._items_by_filepath: + filtered_paths.append(normalized_path) + + if not filtered_paths: + return + + parent = self.invisibleRootItem() + for filepath in filtered_paths: + self._reports_by_filepath.pop(normalized_path) + item = self._items_by_filepath.pop(filepath) + parent.removeRow(item.row()) + + self._store_registry() + + def get_report_by_filepath(self, filepath): + return self._reports_by_filepath.get(filepath) + + +class LoadedFilesView(QtWidgets.QTreeView): + selection_changed = QtCore.Signal() + + def __init__(self, *args, **kwargs): + super(LoadedFilesView, self).__init__(*args, **kwargs) + self.setEditTriggers(self.NoEditTriggers) + self.setIndentation(0) + self.setAlternatingRowColors(True) + + model = LoadedFilesMopdel() + self.setModel(model) + + time_delegate = PrettyTimeDelegate() + self.setItemDelegateForColumn(1, time_delegate) + + remove_btn = IconButton(self) + remove_icon_path = resources.get_icon_path("delete") + loaded_remove_image = QtGui.QImage(remove_icon_path) + pix = paint_image_with_color(loaded_remove_image, QtCore.Qt.white) + icon = QtGui.QIcon(pix) + remove_btn.setIcon(icon) + + model.rowsInserted.connect(self._on_rows_inserted) + remove_btn.clicked.connect(self._on_remove_clicked) + self.selectionModel().selectionChanged.connect( + self._on_selection_change + ) + + self._model = model + self._time_delegate = time_delegate + self._remove_btn = remove_btn + + def _update_remove_btn(self): + viewport = self.viewport() + height = viewport.height() + self.header().height() + pos_x = viewport.width() - self._remove_btn.width() - 5 + pos_y = height - self._remove_btn.height() - 5 + self._remove_btn.move(max(0, pos_x), max(0, pos_y)) + + def _on_rows_inserted(self): + header = self.header() + header.resizeSections(header.ResizeToContents) + + def resizeEvent(self, event): + super(LoadedFilesView, self).resizeEvent(event) + self._update_remove_btn() + + def showEvent(self, event): + super(LoadedFilesView, self).showEvent(event) + self._update_remove_btn() + header = self.header() + header.resizeSections(header.ResizeToContents) + + def _on_selection_change(self): + self.selection_changed.emit() + + def add_filepaths(self, filepaths): + self._model.add_filepaths(filepaths) + self._fill_selection() + + def remove_filepaths(self, filepaths): + self._model.remove_filepaths(filepaths) + self._fill_selection() + + def _on_remove_clicked(self): + index = self.currentIndex() + filepath = index.data(FILEPATH_ROLE) + self.remove_filepaths(filepath) + + def _fill_selection(self): + index = self.currentIndex() + if index.isValid(): + return + + index = self._model.index(0, 0) + if index.isValid(): + self.setCurrentIndex(index) + + def get_current_report(self): + index = self.currentIndex() + filepath = index.data(FILEPATH_ROLE) + return self._model.get_report_by_filepath(filepath) + + +class LoadedFilesWidget(QtWidgets.QWidget): + report_changed = QtCore.Signal() + + def __init__(self, parent): + super(LoadedFilesWidget, self).__init__(parent) + + self.setAcceptDrops(True) + + view = LoadedFilesView(self) + + layout = QtWidgets.QVBoxLayout(self) + layout.setContentsMargins(0, 0, 0, 0) + layout.addWidget(view, 1) + + view.selection_changed.connect(self._on_report_change) + + self._view = view + + def dragEnterEvent(self, event): + mime_data = event.mimeData() + if mime_data.hasUrls(): + event.setDropAction(QtCore.Qt.CopyAction) + event.accept() + + def dragLeaveEvent(self, event): + event.accept() + + def dropEvent(self, event): + mime_data = event.mimeData() + if mime_data.hasUrls(): + filepaths = [] + for url in mime_data.urls(): + filepath = url.toLocalFile() + ext = os.path.splitext(filepath)[-1] + if os.path.exists(filepath) and ext == ".json": + filepaths.append(filepath) + self._add_filepaths(filepaths) + event.accept() + + def _on_report_change(self): + self.report_changed.emit() + + def _add_filepaths(self, filepaths): + self._view.add_filepaths(filepaths) + + def get_current_report(self): + return self._view.get_current_report() class PublishReportViewerWindow(QtWidgets.QWidget): - # TODO add buttons to be able load report file or paste content of report default_width = 1200 default_height = 600 def __init__(self, parent=None): super(PublishReportViewerWindow, self).__init__(parent) + self.setWindowTitle("Publish report viewer") + icon = QtGui.QIcon(get_openpype_icon_filepath()) + self.setWindowIcon(icon) - main_widget = PublishReportViewerWidget(self) + body = QtWidgets.QSplitter(self) + body.setContentsMargins(0, 0, 0, 0) + body.setSizePolicy( + QtWidgets.QSizePolicy.Expanding, + QtWidgets.QSizePolicy.Expanding + ) + body.setOrientation(QtCore.Qt.Horizontal) + + loaded_files_widget = LoadedFilesWidget(body) + main_widget = PublishReportViewerWidget(body) + + body.addWidget(loaded_files_widget) + body.addWidget(main_widget) + body.setStretchFactor(0, 70) + body.setStretchFactor(1, 65) layout = QtWidgets.QHBoxLayout(self) - layout.addWidget(main_widget) + layout.addWidget(body, 1) + loaded_files_widget.report_changed.connect(self._on_report_change) + + self._loaded_files_widget = loaded_files_widget self._main_widget = main_widget self.resize(self.default_width, self.default_height) self.setStyleSheet(style.load_stylesheet()) + def _on_report_change(self): + report = self._loaded_files_widget.get_current_report() + self.set_report(report) + def set_report(self, report_data): self._main_widget.set_report(report_data) diff --git a/openpype/tools/publisher/widgets/assets_widget.py b/openpype/tools/publisher/widgets/assets_widget.py index b8696a2665..984da59c77 100644 --- a/openpype/tools/publisher/widgets/assets_widget.py +++ b/openpype/tools/publisher/widgets/assets_widget.py @@ -3,7 +3,8 @@ import collections from Qt import QtWidgets, QtCore, QtGui from openpype.tools.utils import ( PlaceholderLineEdit, - RecursiveSortFilterProxyModel + RecursiveSortFilterProxyModel, + get_asset_icon, ) from openpype.tools.utils.assets_widget import ( SingleSelectAssetsWidget, @@ -102,11 +103,15 @@ class AssetsHierarchyModel(QtGui.QStandardItemModel): for name in sorted(children_by_name.keys()): child = children_by_name[name] child_id = child["_id"] + has_children = bool(assets_by_parent_id.get(child_id)) + icon = get_asset_icon(child, has_children) + item = QtGui.QStandardItem(name) item.setFlags( QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable ) + item.setData(icon, QtCore.Qt.DecorationRole) item.setData(child_id, ASSET_ID_ROLE) item.setData(name, ASSET_NAME_ROLE) diff --git a/openpype/tools/publisher/widgets/create_dialog.py b/openpype/tools/publisher/widgets/create_dialog.py index f9f8310e09..27ce97955a 100644 --- a/openpype/tools/publisher/widgets/create_dialog.py +++ b/openpype/tools/publisher/widgets/create_dialog.py @@ -8,12 +8,14 @@ try: except Exception: commonmark = None from Qt import QtWidgets, QtCore, QtGui - +from openpype.lib import TaskNotSetError from openpype.pipeline.create import ( CreatorError, SUBSET_NAME_ALLOWED_SYMBOLS ) +from openpype.tools.utils import ErrorMessageBox + from .widgets import IconValuePixmapLabel from .assets_widget import CreateDialogAssetsWidget from .tasks_widget import CreateDialogTasksWidget @@ -27,7 +29,7 @@ from ..constants import ( SEPARATORS = ("---separator---", "---") -class CreateErrorMessageBox(QtWidgets.QDialog): +class CreateErrorMessageBox(ErrorMessageBox): def __init__( self, creator_label, @@ -35,24 +37,38 @@ class CreateErrorMessageBox(QtWidgets.QDialog): asset_name, exc_msg, formatted_traceback, - parent=None + parent ): - super(CreateErrorMessageBox, self).__init__(parent) - self.setWindowTitle("Creation failed") - self.setFocusPolicy(QtCore.Qt.StrongFocus) - if not parent: - self.setWindowFlags( - self.windowFlags() | QtCore.Qt.WindowStaysOnTopHint - ) + self._creator_label = creator_label + self._subset_name = subset_name + self._asset_name = asset_name + self._exc_msg = exc_msg + self._formatted_traceback = formatted_traceback + super(CreateErrorMessageBox, self).__init__("Creation failed", parent) - body_layout = QtWidgets.QVBoxLayout(self) - - main_label = ( + def _create_top_widget(self, parent_widget): + label_widget = QtWidgets.QLabel(parent_widget) + label_widget.setText( "Failed to create" ) - main_label_widget = QtWidgets.QLabel(main_label, self) - body_layout.addWidget(main_label_widget) + return label_widget + def _get_report_data(self): + report_message = ( + "{creator}: Failed to create Subset: \"{subset}\"" + " in Asset: \"{asset}\"" + "\n\nError: {message}" + ).format( + creator=self._creator_label, + subset=self._subset_name, + asset=self._asset_name, + message=self._exc_msg, + ) + if self._formatted_traceback: + report_message += "\n\n{}".format(self._formatted_traceback) + return [report_message] + + def _create_content(self, content_layout): item_name_template = ( "Creator: {}
" "Subset: {}
" @@ -61,119 +77,129 @@ class CreateErrorMessageBox(QtWidgets.QDialog): exc_msg_template = "{}" line = self._create_line() - body_layout.addWidget(line) + content_layout.addWidget(line) - item_name = item_name_template.format( - creator_label, subset_name, asset_name - ) - item_name_widget = QtWidgets.QLabel( - item_name.replace("\n", "
"), self - ) - body_layout.addWidget(item_name_widget) - - exc_msg = exc_msg_template.format(exc_msg.replace("\n", "
")) - message_label_widget = QtWidgets.QLabel(exc_msg, self) - body_layout.addWidget(message_label_widget) - - if formatted_traceback: - tb_widget = QtWidgets.QLabel( - formatted_traceback.replace("\n", "
"), self + item_name_widget = QtWidgets.QLabel(self) + item_name_widget.setText( + item_name_template.format( + self._creator_label, self._subset_name, self._asset_name ) - tb_widget.setTextInteractionFlags( - QtCore.Qt.TextBrowserInteraction - ) - body_layout.addWidget(tb_widget) - - footer_widget = QtWidgets.QWidget(self) - footer_layout = QtWidgets.QHBoxLayout(footer_widget) - button_box = QtWidgets.QDialogButtonBox(QtCore.Qt.Vertical) - button_box.setStandardButtons( - QtWidgets.QDialogButtonBox.StandardButton.Ok ) - button_box.accepted.connect(self._on_accept) - footer_layout.addWidget(button_box, alignment=QtCore.Qt.AlignRight) - body_layout.addWidget(footer_widget) + content_layout.addWidget(item_name_widget) - def _on_accept(self): - self.close() + message_label_widget = QtWidgets.QLabel(self) + message_label_widget.setText( + exc_msg_template.format(self.convert_text_for_html(self._exc_msg)) + ) + content_layout.addWidget(message_label_widget) - def _create_line(self): - line = QtWidgets.QFrame(self) - line.setFixedHeight(2) - line.setFrameShape(QtWidgets.QFrame.HLine) - line.setFrameShadow(QtWidgets.QFrame.Sunken) - return line + if self._formatted_traceback: + line_widget = self._create_line() + tb_widget = self._create_traceback_widget( + self._formatted_traceback + ) + content_layout.addWidget(line_widget) + content_layout.addWidget(tb_widget) # TODO add creator identifier/label to details -class CreatorDescriptionWidget(QtWidgets.QWidget): +class CreatorShortDescWidget(QtWidgets.QWidget): def __init__(self, parent=None): - super(CreatorDescriptionWidget, self).__init__(parent=parent) + super(CreatorShortDescWidget, self).__init__(parent=parent) + # --- Short description widget --- icon_widget = IconValuePixmapLabel(None, self) icon_widget.setObjectName("FamilyIconLabel") - family_label = QtWidgets.QLabel("family") + # --- Short description inputs --- + short_desc_input_widget = QtWidgets.QWidget(self) + + family_label = QtWidgets.QLabel(short_desc_input_widget) family_label.setAlignment( QtCore.Qt.AlignBottom | QtCore.Qt.AlignLeft ) - description_label = QtWidgets.QLabel("description") + description_label = QtWidgets.QLabel(short_desc_input_widget) description_label.setAlignment( QtCore.Qt.AlignTop | QtCore.Qt.AlignLeft ) - detail_description_widget = QtWidgets.QTextEdit(self) - detail_description_widget.setObjectName("InfoText") - detail_description_widget.setTextInteractionFlags( - QtCore.Qt.TextBrowserInteraction + short_desc_input_layout = QtWidgets.QVBoxLayout( + short_desc_input_widget ) + short_desc_input_layout.setSpacing(0) + short_desc_input_layout.addWidget(family_label) + short_desc_input_layout.addWidget(description_label) + # -------------------------------- - label_layout = QtWidgets.QVBoxLayout() - label_layout.setSpacing(0) - label_layout.addWidget(family_label) - label_layout.addWidget(description_label) - - top_layout = QtWidgets.QHBoxLayout() - top_layout.setContentsMargins(0, 0, 0, 0) - top_layout.addWidget(icon_widget, 0) - top_layout.addLayout(label_layout, 1) - - layout = QtWidgets.QVBoxLayout(self) + layout = QtWidgets.QHBoxLayout(self) layout.setContentsMargins(0, 0, 0, 0) - layout.addLayout(top_layout, 0) - layout.addWidget(detail_description_widget, 1) + layout.addWidget(icon_widget, 0) + layout.addWidget(short_desc_input_widget, 1) + # -------------------------------- - self.icon_widget = icon_widget - self.family_label = family_label - self.description_label = description_label - self.detail_description_widget = detail_description_widget + self._icon_widget = icon_widget + self._family_label = family_label + self._description_label = description_label def set_plugin(self, plugin=None): if not plugin: - self.icon_widget.set_icon_def(None) - self.family_label.setText("") - self.description_label.setText("") - self.detail_description_widget.setPlainText("") + self._icon_widget.set_icon_def(None) + self._family_label.setText("") + self._description_label.setText("") return plugin_icon = plugin.get_icon() description = plugin.get_description() or "" - detailed_description = plugin.get_detail_description() or "" - self.icon_widget.set_icon_def(plugin_icon) - self.family_label.setText("{}".format(plugin.family)) - self.family_label.setTextInteractionFlags(QtCore.Qt.NoTextInteraction) - self.description_label.setText(description) + self._icon_widget.set_icon_def(plugin_icon) + self._family_label.setText("{}".format(plugin.family)) + self._family_label.setTextInteractionFlags(QtCore.Qt.NoTextInteraction) + self._description_label.setText(description) - if commonmark: - html = commonmark.commonmark(detailed_description) - self.detail_description_widget.setHtml(html) + +class HelpButton(QtWidgets.QPushButton): + resized = QtCore.Signal() + + def __init__(self, *args, **kwargs): + super(HelpButton, self).__init__(*args, **kwargs) + self.setObjectName("CreateDialogHelpButton") + + self._expanded = None + self.set_expanded() + + def set_expanded(self, expanded=None): + if self._expanded is expanded: + if expanded is not None: + return + expanded = False + self._expanded = expanded + if expanded: + text = "<" else: - self.detail_description_widget.setMarkdown(detailed_description) + text = "?" + self.setText(text) + + self._update_size() + + def _update_size(self): + new_size = self.minimumSizeHint() + if self.size() != new_size: + self.resize(new_size) + self.resized.emit() + + def showEvent(self, event): + super(HelpButton, self).showEvent(event) + self._update_size() + + def resizeEvent(self, event): + super(HelpButton, self).resizeEvent(event) + self._update_size() class CreateDialog(QtWidgets.QDialog): + default_size = (900, 500) + def __init__( self, controller, asset_name=None, task_name=None, parent=None ): @@ -199,7 +225,7 @@ class CreateDialog(QtWidgets.QDialog): self._prereq_available = False - self.message_dialog = None + self._message_dialog = None name_pattern = "^[{}]*$".format(SUBSET_NAME_ALLOWED_SYMBOLS) self._name_pattern = name_pattern @@ -216,13 +242,7 @@ class CreateDialog(QtWidgets.QDialog): context_layout.addWidget(assets_widget, 2) context_layout.addWidget(tasks_widget, 1) - # Precreate attributes widgets - pre_create_widget = PreCreateWidget(self) - - # TODO add HELP button - creator_description_widget = CreatorDescriptionWidget(self) - creator_description_widget.setVisible(False) - + # --- Creators view --- creators_view = QtWidgets.QListView(self) creators_model = QtGui.QStandardItemModel() creators_view.setModel(creators_model) @@ -261,12 +281,55 @@ class CreateDialog(QtWidgets.QDialog): mid_layout.addWidget(creators_view, 1) mid_layout.addLayout(form_layout, 0) mid_layout.addWidget(create_btn, 0) + # ------------ + + # --- Creator short info and attr defs --- + creator_attrs_widget = QtWidgets.QWidget(self) + + creator_short_desc_widget = CreatorShortDescWidget( + creator_attrs_widget + ) + + separator_widget = QtWidgets.QWidget(self) + separator_widget.setObjectName("Separator") + separator_widget.setMinimumHeight(2) + separator_widget.setMaximumHeight(2) + + # Precreate attributes widget + pre_create_widget = PreCreateWidget(creator_attrs_widget) + + creator_attrs_layout = QtWidgets.QVBoxLayout(creator_attrs_widget) + creator_attrs_layout.setContentsMargins(0, 0, 0, 0) + creator_attrs_layout.addWidget(creator_short_desc_widget, 0) + creator_attrs_layout.addWidget(separator_widget, 0) + creator_attrs_layout.addWidget(pre_create_widget, 1) + # ------------------------------------- + + # --- Detailed information about creator --- + # Detailed description of creator + detail_description_widget = QtWidgets.QTextEdit(self) + detail_description_widget.setObjectName("InfoText") + detail_description_widget.setTextInteractionFlags( + QtCore.Qt.TextBrowserInteraction + ) + detail_description_widget.setVisible(False) + # ------------------------------------------- + + splitter_widget = QtWidgets.QSplitter(self) + splitter_widget.addWidget(context_widget) + splitter_widget.addWidget(mid_widget) + splitter_widget.addWidget(creator_attrs_widget) + splitter_widget.addWidget(detail_description_widget) + splitter_widget.setStretchFactor(0, 1) + splitter_widget.setStretchFactor(1, 1) + splitter_widget.setStretchFactor(2, 1) + splitter_widget.setStretchFactor(3, 1) layout = QtWidgets.QHBoxLayout(self) - layout.setSpacing(10) - layout.addWidget(context_widget, 1) - layout.addWidget(mid_widget, 1) - layout.addWidget(pre_create_widget, 1) + layout.addWidget(splitter_widget, 1) + + # Floating help button + help_btn = HelpButton(self) prereq_timer = QtCore.QTimer() prereq_timer.setInterval(50) @@ -274,6 +337,9 @@ class CreateDialog(QtWidgets.QDialog): prereq_timer.timeout.connect(self._on_prereq_timer) + help_btn.clicked.connect(self._on_help_btn) + help_btn.resized.connect(self._on_help_btn_resize) + create_btn.clicked.connect(self._on_create) variant_input.returnPressed.connect(self._on_create) variant_input.textChanged.connect(self._on_variant_change) @@ -289,12 +355,11 @@ class CreateDialog(QtWidgets.QDialog): controller.add_plugins_refresh_callback(self._on_plugins_refresh) - self._pre_create_widget = pre_create_widget + self._splitter_widget = splitter_widget self._context_widget = context_widget self._assets_widget = assets_widget self._tasks_widget = tasks_widget - self.creator_description_widget = creator_description_widget self.subset_name_input = subset_name_input @@ -307,7 +372,13 @@ class CreateDialog(QtWidgets.QDialog): self.creators_view = creators_view self.create_btn = create_btn + self._creator_short_desc_widget = creator_short_desc_widget + self._pre_create_widget = pre_create_widget + self._detail_description_widget = detail_description_widget + self._help_btn = help_btn + self._prereq_timer = prereq_timer + self._first_show = True def _context_change_is_enabled(self): return self._context_widget.isEnabled() @@ -499,10 +570,61 @@ class CreateDialog(QtWidgets.QDialog): identifier = new_index.data(CREATOR_IDENTIFIER_ROLE) self._set_creator(identifier) + def _update_help_btn(self): + pos_x = self.width() - self._help_btn.width() + point = self._creator_short_desc_widget.rect().topRight() + mapped_point = self._creator_short_desc_widget.mapTo(self, point) + pos_y = mapped_point.y() + self._help_btn.move(max(0, pos_x), max(0, pos_y)) + + def _on_help_btn_resize(self): + self._update_help_btn() + + def _on_help_btn(self): + final_size = self.size() + cur_sizes = self._splitter_widget.sizes() + spacing = self._splitter_widget.handleWidth() + + sizes = [] + for idx, value in enumerate(cur_sizes): + if idx < 3: + sizes.append(value) + + now_visible = self._detail_description_widget.isVisible() + if now_visible: + width = final_size.width() - ( + spacing + self._detail_description_widget.width() + ) + + else: + last_size = self._detail_description_widget.sizeHint().width() + width = final_size.width() + spacing + last_size + sizes.append(last_size) + + final_size.setWidth(width) + + self._detail_description_widget.setVisible(not now_visible) + self._splitter_widget.setSizes(sizes) + self.resize(final_size) + + self._help_btn.set_expanded(not now_visible) + + def _set_creator_detailed_text(self, creator): + if not creator: + self._detail_description_widget.setPlainText("") + return + detailed_description = creator.get_detail_description() or "" + if commonmark: + html = commonmark.commonmark(detailed_description) + self._detail_description_widget.setHtml(html) + else: + self._detail_description_widget.setMarkdown(detailed_description) + def _set_creator(self, identifier): creator = self.controller.manual_creators.get(identifier) - self.creator_description_widget.set_plugin(creator) + self._creator_short_desc_widget.set_plugin(creator) + self._set_creator_detailed_text(creator) self._pre_create_widget.set_plugin(creator) self._selected_creator = creator @@ -556,10 +678,9 @@ class CreateDialog(QtWidgets.QDialog): if variant_value is None: variant_value = self.variant_input.text() - match = self._compiled_name_pattern.match(variant_value) - valid = bool(match) - self.create_btn.setEnabled(valid) - if not valid: + self.create_btn.setEnabled(True) + if not self._compiled_name_pattern.match(variant_value): + self.create_btn.setEnabled(False) self._set_variant_state_property("invalid") self.subset_name_input.setText("< Invalid variant >") return @@ -569,9 +690,16 @@ class CreateDialog(QtWidgets.QDialog): asset_doc = copy.deepcopy(self._asset_doc) # Calculate subset name with Creator plugin - subset_name = self._selected_creator.get_subset_name( - variant_value, task_name, asset_doc, project_name - ) + try: + subset_name = self._selected_creator.get_subset_name( + variant_value, task_name, asset_doc, project_name + ) + except TaskNotSetError: + self.create_btn.setEnabled(False) + self._set_variant_state_property("invalid") + self.subset_name_input.setText("< Missing task >") + return + self.subset_name_input.setText(subset_name) self._validate_subset_name(subset_name, variant_value) @@ -643,11 +771,27 @@ class CreateDialog(QtWidgets.QDialog): def showEvent(self, event): super(CreateDialog, self).showEvent(event) + if self._first_show: + self._first_show = False + width, height = self.default_size + self.resize(width, height) + + third_size = int(width / 3) + self._splitter_widget.setSizes( + [third_size, third_size, width - (2 * third_size)] + ) + if self._last_pos is not None: self.move(self._last_pos) + self._update_help_btn() + self.refresh() + def resizeEvent(self, event): + super(CreateDialog, self).resizeEvent(event) + self._update_help_btn() + def _on_create(self): indexes = self.creators_view.selectedIndexes() if not indexes or len(indexes) > 1: @@ -674,14 +818,18 @@ class CreateDialog(QtWidgets.QDialog): "family": family } - error_info = None + error_msg = None + formatted_traceback = None try: self.controller.create( - creator_identifier, subset_name, instance_data, pre_create_data + creator_identifier, + subset_name, + instance_data, + pre_create_data ) except CreatorError as exc: - error_info = (str(exc), None) + error_msg = str(exc) # Use bare except because some hosts raise their exceptions that # do not inherit from python's `BaseException` @@ -690,12 +838,17 @@ class CreateDialog(QtWidgets.QDialog): formatted_traceback = "".join(traceback.format_exception( exc_type, exc_value, exc_traceback )) - error_info = (str(exc_value), formatted_traceback) + error_msg = str(exc_value) - if error_info: + if error_msg is not None: box = CreateErrorMessageBox( - creator_label, subset_name, asset_name, *error_info + creator_label, + subset_name, + asset_name, + error_msg, + formatted_traceback, + parent=self ) box.show() # Store dialog so is not garbage collected before is shown - self.message_dialog = box + self._message_dialog = box diff --git a/openpype/tools/publisher/widgets/list_view_widgets.py b/openpype/tools/publisher/widgets/list_view_widgets.py index 23a86cd070..6bddaf66c8 100644 --- a/openpype/tools/publisher/widgets/list_view_widgets.py +++ b/openpype/tools/publisher/widgets/list_view_widgets.py @@ -467,12 +467,22 @@ class InstanceListView(AbstractInstanceView): else: active = False + group_names = set() for instance_id in selected_instance_ids: widget = self._widgets_by_id.get(instance_id) - if widget is not None: - widget.set_active(active) + if widget is None: + continue + + widget.set_active(active) + group_name = self._group_by_instance_id.get(instance_id) + if group_name is not None: + group_names.add(group_name) + + for group_name in group_names: + self._update_group_checkstate(group_name) def _update_group_checkstate(self, group_name): + """Update checkstate of one group.""" widget = self._group_widgets.get(group_name) if widget is None: return diff --git a/openpype/tools/publisher/widgets/publish_widget.py b/openpype/tools/publisher/widgets/publish_widget.py index e4f3579978..80d0265dd3 100644 --- a/openpype/tools/publisher/widgets/publish_widget.py +++ b/openpype/tools/publisher/widgets/publish_widget.py @@ -213,7 +213,6 @@ class PublishFrame(QtWidgets.QFrame): close_report_btn.setIcon(close_report_icon) details_layout = QtWidgets.QVBoxLayout(details_widget) - details_layout.setContentsMargins(0, 0, 0, 0) details_layout.addWidget(report_view) details_layout.addWidget(close_report_btn) @@ -495,10 +494,11 @@ class PublishFrame(QtWidgets.QFrame): def _on_show_details(self): self._change_bg_property(2) self._main_layout.setCurrentWidget(self._details_widget) - logs = self.controller.get_publish_report() - self._report_view.set_report(logs) + report_data = self.controller.get_publish_report() + self._report_view.set_report_data(report_data) def _on_close_report_clicked(self): + self._report_view.close_details_popup() if self.controller.get_publish_crash_error(): self._change_bg_property() diff --git a/openpype/tools/publisher/widgets/tasks_widget.py b/openpype/tools/publisher/widgets/tasks_widget.py index a0b3a340ae..aa239f6334 100644 --- a/openpype/tools/publisher/widgets/tasks_widget.py +++ b/openpype/tools/publisher/widgets/tasks_widget.py @@ -1,6 +1,7 @@ from Qt import QtCore, QtGui from openpype.tools.utils.tasks_widget import TasksWidget, TASK_NAME_ROLE +from openpype.tools.utils.lib import get_default_task_icon class TasksModel(QtGui.QStandardItemModel): @@ -17,9 +18,10 @@ class TasksModel(QtGui.QStandardItemModel): controller (PublisherController): Controller which handles creation and publishing. """ - def __init__(self, controller): + def __init__(self, controller, allow_empty_task=False): super(TasksModel, self).__init__() + self._allow_empty_task = allow_empty_task self._controller = controller self._items_by_name = {} self._asset_names = [] @@ -70,8 +72,14 @@ class TasksModel(QtGui.QStandardItemModel): task_name (str): Name of task which should be available in asset's tasks. """ - task_names = self._task_names_by_asset_name.get(asset_name) - if task_names and task_name in task_names: + if asset_name not in self._task_names_by_asset_name: + return False + + if self._allow_empty_task and not task_name: + return True + + task_names = self._task_names_by_asset_name[asset_name] + if task_name in task_names: return True return False @@ -92,6 +100,8 @@ class TasksModel(QtGui.QStandardItemModel): new_task_names = self.get_intersection_of_tasks( task_names_by_asset_name ) + if self._allow_empty_task: + new_task_names.add("") old_task_names = set(self._items_by_name.keys()) if new_task_names == old_task_names: return @@ -109,9 +119,13 @@ class TasksModel(QtGui.QStandardItemModel): item = QtGui.QStandardItem(task_name) item.setData(task_name, TASK_NAME_ROLE) + if task_name: + item.setData(get_default_task_icon(), QtCore.Qt.DecorationRole) self._items_by_name[task_name] = item new_items.append(item) - root_item.appendRows(new_items) + + if new_items: + root_item.appendRows(new_items) def headerData(self, section, orientation, role=None): if role is None: diff --git a/openpype/tools/publisher/widgets/validations_widget.py b/openpype/tools/publisher/widgets/validations_widget.py index bb88e1783c..798c1f9d92 100644 --- a/openpype/tools/publisher/widgets/validations_widget.py +++ b/openpype/tools/publisher/widgets/validations_widget.py @@ -10,6 +10,9 @@ from openpype.tools.utils import BaseClickableFrame from .widgets import ( IconValuePixmapLabel ) +from ..constants import ( + INSTANCE_ID_ROLE +) class ValidationErrorInstanceList(QtWidgets.QListView): @@ -22,19 +25,20 @@ class ValidationErrorInstanceList(QtWidgets.QListView): self.setObjectName("ValidationErrorInstanceList") + self.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff) self.setSelectionMode(QtWidgets.QListView.ExtendedSelection) def minimumSizeHint(self): - result = super(ValidationErrorInstanceList, self).minimumSizeHint() - result.setHeight(self.sizeHint().height()) - return result + return self.sizeHint() def sizeHint(self): + result = super(ValidationErrorInstanceList, self).sizeHint() row_count = self.model().rowCount() height = 0 if row_count > 0: height = self.sizeHintForRow(0) * row_count - return QtCore.QSize(self.width(), height) + result.setHeight(height) + return result class ValidationErrorTitleWidget(QtWidgets.QWidget): @@ -47,6 +51,7 @@ class ValidationErrorTitleWidget(QtWidgets.QWidget): if there is a list (Valdation error may happen on context). """ selected = QtCore.Signal(int) + instance_changed = QtCore.Signal(int) def __init__(self, index, error_info, parent): super(ValidationErrorTitleWidget, self).__init__(parent) @@ -64,32 +69,38 @@ class ValidationErrorTitleWidget(QtWidgets.QWidget): toggle_instance_btn.setArrowType(QtCore.Qt.RightArrow) toggle_instance_btn.setMaximumWidth(14) - exception = error_info["exception"] - label_widget = QtWidgets.QLabel(exception.title, title_frame) + label_widget = QtWidgets.QLabel(error_info["title"], title_frame) title_frame_layout = QtWidgets.QHBoxLayout(title_frame) title_frame_layout.addWidget(toggle_instance_btn) title_frame_layout.addWidget(label_widget) instances_model = QtGui.QStandardItemModel() - instances = error_info["instances"] + error_info = error_info["error_info"] + + help_text_by_instance_id = {} context_validation = False if ( - not instances - or (len(instances) == 1 and instances[0] is None) + not error_info + or (len(error_info) == 1 and error_info[0][0] is None) ): context_validation = True toggle_instance_btn.setArrowType(QtCore.Qt.NoArrow) + description = self._prepare_description(error_info[0][1]) + help_text_by_instance_id[None] = description else: items = [] - for instance in instances: + for instance, exception in error_info: label = instance.data.get("label") or instance.data.get("name") item = QtGui.QStandardItem(label) item.setFlags( QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable ) - item.setData(instance.id) + item.setData(label, QtCore.Qt.ToolTipRole) + item.setData(instance.id, INSTANCE_ID_ROLE) items.append(item) + description = self._prepare_description(exception) + help_text_by_instance_id[instance.id] = description instances_model.invisibleRootItem().appendRows(items) @@ -114,17 +125,64 @@ class ValidationErrorTitleWidget(QtWidgets.QWidget): if not context_validation: toggle_instance_btn.clicked.connect(self._on_toggle_btn_click) + instances_view.selectionModel().selectionChanged.connect( + self._on_seleciton_change + ) + self._title_frame = title_frame self._toggle_instance_btn = toggle_instance_btn + self._view_layout = view_layout + self._instances_model = instances_model self._instances_view = instances_view + self._context_validation = context_validation + self._help_text_by_instance_id = help_text_by_instance_id + + def sizeHint(self): + result = super().sizeHint() + expected_width = 0 + for idx in range(self._view_layout.count()): + expected_width += self._view_layout.itemAt(idx).sizeHint().width() + + if expected_width < 200: + expected_width = 200 + + if result.width() < expected_width: + result.setWidth(expected_width) + return result + + def minimumSizeHint(self): + return self.sizeHint() + + def _prepare_description(self, exception): + dsc = exception.description + detail = exception.detail + if detail: + dsc += "

{}".format(detail) + + description = dsc + if commonmark: + description = commonmark.commonmark(dsc) + return description + def _mouse_release_callback(self): """Mark this widget as selected on click.""" self.set_selected(True) + def current_desctiption_text(self): + if self._context_validation: + return self._help_text_by_instance_id[None] + index = self._instances_view.currentIndex() + # TODO make sure instance is selected + if not index.isValid(): + index = self._instances_model.index(0, 0) + + indence_id = index.data(INSTANCE_ID_ROLE) + return self._help_text_by_instance_id[indence_id] + @property def is_selected(self): """Is widget marked a selected""" @@ -167,6 +225,9 @@ class ValidationErrorTitleWidget(QtWidgets.QWidget): else: self._toggle_instance_btn.setArrowType(QtCore.Qt.RightArrow) + def _on_seleciton_change(self): + self.instance_changed.emit(self._index) + class ActionButton(BaseClickableFrame): """Plugin's action callback button. @@ -185,13 +246,15 @@ class ActionButton(BaseClickableFrame): action_label = action.label or action.__name__ action_icon = getattr(action, "icon", None) label_widget = QtWidgets.QLabel(action_label, self) + icon_label = None if action_icon: icon_label = IconValuePixmapLabel(action_icon, self) layout = QtWidgets.QHBoxLayout(self) layout.setContentsMargins(5, 0, 5, 0) layout.addWidget(label_widget, 1) - layout.addWidget(icon_label, 0) + if icon_label: + layout.addWidget(icon_label, 0) self.setSizePolicy( QtWidgets.QSizePolicy.Minimum, @@ -231,6 +294,7 @@ class ValidateActionsWidget(QtWidgets.QFrame): item = self._content_layout.takeAt(0) widget = item.widget() if widget: + widget.setVisible(False) widget.deleteLater() self._actions_mapping = {} @@ -363,24 +427,23 @@ class ValidationsWidget(QtWidgets.QWidget): errors_scroll.setWidgetResizable(True) errors_widget = QtWidgets.QWidget(errors_scroll) - errors_widget.setFixedWidth(200) errors_widget.setAttribute(QtCore.Qt.WA_TranslucentBackground) errors_layout = QtWidgets.QVBoxLayout(errors_widget) errors_layout.setContentsMargins(0, 0, 0, 0) errors_scroll.setWidget(errors_widget) - error_details_widget = QtWidgets.QWidget(self) - error_details_input = QtWidgets.QTextEdit(error_details_widget) + error_details_frame = QtWidgets.QFrame(self) + error_details_input = QtWidgets.QTextEdit(error_details_frame) error_details_input.setObjectName("InfoText") error_details_input.setTextInteractionFlags( QtCore.Qt.TextBrowserInteraction ) actions_widget = ValidateActionsWidget(controller, self) - actions_widget.setFixedWidth(140) + actions_widget.setMinimumWidth(140) - error_details_layout = QtWidgets.QHBoxLayout(error_details_widget) + error_details_layout = QtWidgets.QHBoxLayout(error_details_frame) error_details_layout.addWidget(error_details_input, 1) error_details_layout.addWidget(actions_widget, 0) @@ -389,7 +452,7 @@ class ValidationsWidget(QtWidgets.QWidget): content_layout.setContentsMargins(0, 0, 0, 0) content_layout.addWidget(errors_scroll, 0) - content_layout.addWidget(error_details_widget, 1) + content_layout.addWidget(error_details_frame, 1) top_label = QtWidgets.QLabel("Publish validation report", self) top_label.setObjectName("PublishInfoMainLabel") @@ -403,7 +466,7 @@ class ValidationsWidget(QtWidgets.QWidget): self._top_label = top_label self._errors_widget = errors_widget self._errors_layout = errors_layout - self._error_details_widget = error_details_widget + self._error_details_frame = error_details_frame self._error_details_input = error_details_input self._actions_widget = actions_widget @@ -423,7 +486,7 @@ class ValidationsWidget(QtWidgets.QWidget): widget.deleteLater() self._top_label.setVisible(False) - self._error_details_widget.setVisible(False) + self._error_details_frame.setVisible(False) self._errors_widget.setVisible(False) self._actions_widget.setVisible(False) @@ -434,34 +497,35 @@ class ValidationsWidget(QtWidgets.QWidget): return self._top_label.setVisible(True) - self._error_details_widget.setVisible(True) + self._error_details_frame.setVisible(True) self._errors_widget.setVisible(True) errors_by_title = [] for plugin_info in errors: titles = [] - exception_by_title = {} - instances_by_title = {} + error_info_by_title = {} for error_info in plugin_info["errors"]: exception = error_info["exception"] title = exception.title if title not in titles: titles.append(title) - instances_by_title[title] = [] - exception_by_title[title] = exception - instances_by_title[title].append(error_info["instance"]) + error_info_by_title[title] = [] + error_info_by_title[title].append( + (error_info["instance"], exception) + ) for title in titles: errors_by_title.append({ "plugin": plugin_info["plugin"], - "exception": exception_by_title[title], - "instances": instances_by_title[title] + "error_info": error_info_by_title[title], + "title": title }) for idx, item in enumerate(errors_by_title): widget = ValidationErrorTitleWidget(idx, item, self) widget.selected.connect(self._on_select) + widget.instance_changed.connect(self._on_instance_change) self._errors_layout.addWidget(widget) self._title_widgets[idx] = widget self._error_info[idx] = item @@ -471,6 +535,8 @@ class ValidationsWidget(QtWidgets.QWidget): if self._title_widgets: self._title_widgets[0].set_selected(True) + self.updateGeometry() + def _on_select(self, index): if self._previous_select: if self._previous_select.index == index: @@ -481,10 +547,19 @@ class ValidationsWidget(QtWidgets.QWidget): error_item = self._error_info[index] - dsc = error_item["exception"].description + self._actions_widget.set_plugin(error_item["plugin"]) + + self._update_description() + + def _on_instance_change(self, index): + if self._previous_select and self._previous_select.index != index: + return + self._update_description() + + def _update_description(self): + description = self._previous_select.current_desctiption_text() if commonmark: - html = commonmark.commonmark(dsc) + html = commonmark.commonmark(description) self._error_details_input.setHtml(html) else: - self._error_details_input.setMarkdown(dsc) - self._actions_widget.set_plugin(error_item["plugin"]) + self._error_details_input.setMarkdown(description) diff --git a/openpype/tools/publisher/widgets/widgets.py b/openpype/tools/publisher/widgets/widgets.py index a63258efb7..5ced469b59 100644 --- a/openpype/tools/publisher/widgets/widgets.py +++ b/openpype/tools/publisher/widgets/widgets.py @@ -4,9 +4,9 @@ import re import copy import collections from Qt import QtWidgets, QtCore, QtGui +import qtawesome -from avalon.vendor import qtawesome - +from openpype.lib import TaskNotSetError from openpype.widgets.attribute_defs import create_widget_for_attr_def from openpype.tools import resources from openpype.tools.flickcharm import FlickCharm @@ -471,6 +471,28 @@ class AssetsField(BaseClickableFrame): self.set_selected_items(self._origin_value) +class TasksComboboxProxy(QtCore.QSortFilterProxyModel): + def __init__(self, *args, **kwargs): + super(TasksComboboxProxy, self).__init__(*args, **kwargs) + self._filter_empty = False + + def set_filter_empty(self, filter_empty): + if self._filter_empty is filter_empty: + return + self._filter_empty = filter_empty + self.invalidate() + + def filterAcceptsRow(self, source_row, parent_index): + if self._filter_empty: + model = self.sourceModel() + source_index = model.index( + source_row, self.filterKeyColumn(), parent_index + ) + if not source_index.data(QtCore.Qt.DisplayRole): + return False + return True + + class TasksCombobox(QtWidgets.QComboBox): """Combobox to show tasks for selected instances. @@ -490,13 +512,16 @@ class TasksCombobox(QtWidgets.QComboBox): delegate = QtWidgets.QStyledItemDelegate() self.setItemDelegate(delegate) - model = TasksModel(controller) - self.setModel(model) + model = TasksModel(controller, True) + proxy_model = TasksComboboxProxy() + proxy_model.setSourceModel(model) + self.setModel(proxy_model) self.currentIndexChanged.connect(self._on_index_change) self._delegate = delegate self._model = model + self._proxy_model = proxy_model self._origin_value = [] self._origin_selection = [] self._selected_items = [] @@ -507,6 +532,14 @@ class TasksCombobox(QtWidgets.QComboBox): self._text = None + def set_invalid_empty_task(self, invalid=True): + self._proxy_model.set_filter_empty(invalid) + if invalid: + self._set_is_valid(False) + self.set_text("< One or more subsets require Task selected >") + else: + self.set_text(None) + def set_multiselection_text(self, text): """Change text shown when multiple different tasks are in context.""" self._multiselection_text = text @@ -535,6 +568,7 @@ class TasksCombobox(QtWidgets.QComboBox): return self._text = text + self.repaint() def paintEvent(self, event): """Paint custom text without using QLineEdit. @@ -548,6 +582,7 @@ class TasksCombobox(QtWidgets.QComboBox): self.initStyleOption(opt) if self._text is not None: opt.currentText = self._text + style = self.style() style.drawComplexControl( QtWidgets.QStyle.CC_ComboBox, opt, painter, self @@ -594,6 +629,8 @@ class TasksCombobox(QtWidgets.QComboBox): self._ignore_index_change = True self._model.set_asset_names(asset_names) + self._proxy_model.set_filter_empty(False) + self._proxy_model.sort(0) self._ignore_index_change = False @@ -609,11 +646,15 @@ class TasksCombobox(QtWidgets.QComboBox): if self._selected_items: is_valid = True + valid_task_names = [] for task_name in self._selected_items: - is_valid = self._model.is_task_name_valid(asset_name, task_name) - if not is_valid: - break + _is_valid = self._model.is_task_name_valid(asset_name, task_name) + if _is_valid: + valid_task_names.append(task_name) + else: + is_valid = _is_valid + self._selected_items = valid_task_names if len(self._selected_items) == 0: self.set_selected_item("") @@ -625,6 +666,7 @@ class TasksCombobox(QtWidgets.QComboBox): if multiselection_text is None: multiselection_text = "|".join(self._selected_items) self.set_selected_item(multiselection_text) + self._set_is_valid(is_valid) def set_selected_items(self, asset_task_combinations=None): @@ -634,6 +676,9 @@ class TasksCombobox(QtWidgets.QComboBox): asset_task_combinations (list): List of tuples. Each item in the list contain asset name and task name. """ + self._proxy_model.set_filter_empty(False) + self._proxy_model.sort(0) + if asset_task_combinations is None: asset_task_combinations = [] @@ -708,8 +753,7 @@ class TasksCombobox(QtWidgets.QComboBox): idx = self.findText(item_name) # Set current index (must be set to -1 if is invalid) self.setCurrentIndex(idx) - if idx < 0: - self.set_text(item_name) + self.set_text(item_name) def reset_to_origin(self): """Change to task names set with last `set_selected_items` call.""" @@ -926,7 +970,7 @@ class GlobalAttrsWidget(QtWidgets.QWidget): family_value_widget.set_value() subset_value_widget.set_value() - submit_btn = QtWidgets.QPushButton("Submit", self) + submit_btn = QtWidgets.QPushButton("Confirm", self) cancel_btn = QtWidgets.QPushButton("Cancel", self) submit_btn.setEnabled(False) cancel_btn.setEnabled(False) @@ -938,7 +982,7 @@ class GlobalAttrsWidget(QtWidgets.QWidget): btns_layout.addWidget(cancel_btn) main_layout = QtWidgets.QFormLayout(self) - main_layout.addRow("Name", variant_input) + main_layout.addRow("Variant", variant_input) main_layout.addRow("Asset", asset_value_widget) main_layout.addRow("Task", task_value_widget) main_layout.addRow("Family", family_value_widget) @@ -992,7 +1036,33 @@ class GlobalAttrsWidget(QtWidgets.QWidget): project_name = self.controller.project_name subset_names = set() + invalid_tasks = False for instance in self._current_instances: + new_variant_value = instance.get("variant") + new_asset_name = instance.get("asset") + new_task_name = instance.get("task") + if variant_value is not None: + new_variant_value = variant_value + + if asset_name is not None: + new_asset_name = asset_name + + if task_name is not None: + new_task_name = task_name + + asset_doc = asset_docs_by_name[new_asset_name] + + try: + new_subset_name = instance.creator.get_subset_name( + new_variant_value, new_task_name, asset_doc, project_name + ) + except TaskNotSetError: + invalid_tasks = True + instance.set_task_invalid(True) + subset_names.add(instance["subset"]) + continue + + subset_names.add(new_subset_name) if variant_value is not None: instance["variant"] = variant_value @@ -1001,25 +1071,18 @@ class GlobalAttrsWidget(QtWidgets.QWidget): instance.set_asset_invalid(False) if task_name is not None: - instance["task"] = task_name + instance["task"] = task_name or None instance.set_task_invalid(False) - new_variant_value = instance.get("variant") - new_asset_name = instance.get("asset") - new_task_name = instance.get("task") - - asset_doc = asset_docs_by_name[new_asset_name] - - new_subset_name = instance.creator.get_subset_name( - new_variant_value, new_task_name, asset_doc, project_name - ) - subset_names.add(new_subset_name) instance["subset"] = new_subset_name + if invalid_tasks: + self.task_value_widget.set_invalid_empty_task() + self.subset_value_widget.set_value(subset_names) self._set_btns_enabled(False) - self._set_btns_visible(False) + self._set_btns_visible(invalid_tasks) self.instance_context_changed.emit() @@ -1092,7 +1155,7 @@ class GlobalAttrsWidget(QtWidgets.QWidget): variants.add(instance.get("variant") or self.unknown_value) families.add(instance.get("family") or self.unknown_value) asset_name = instance.get("asset") or self.unknown_value - task_name = instance.get("task") or self.unknown_value + task_name = instance.get("task") or "" asset_names.add(asset_name) asset_task_combinations.append((asset_name, task_name)) subset_names.add(instance.get("subset") or self.unknown_value) diff --git a/openpype/tools/publisher/window.py b/openpype/tools/publisher/window.py index 642bd17589..b74e95b227 100644 --- a/openpype/tools/publisher/window.py +++ b/openpype/tools/publisher/window.py @@ -84,7 +84,7 @@ class PublisherWindow(QtWidgets.QDialog): # Content # Subset widget - subset_frame = QtWidgets.QWidget(self) + subset_frame = QtWidgets.QFrame(self) subset_views_widget = BorderedLabelWidget( "Subsets to publish", subset_frame @@ -225,6 +225,9 @@ class PublisherWindow(QtWidgets.QDialog): controller.add_publish_validated_callback(self._on_publish_validated) controller.add_publish_stopped_callback(self._on_publish_stop) + # Store header for TrayPublisher + self._header_layout = header_layout + self.content_stacked_layout = content_stacked_layout self.publish_frame = publish_frame self.subset_frame = subset_frame diff --git a/openpype/tools/pyblish_pype/app.py b/openpype/tools/pyblish_pype/app.py index d15d586103..a252b96427 100644 --- a/openpype/tools/pyblish_pype/app.py +++ b/openpype/tools/pyblish_pype/app.py @@ -90,9 +90,8 @@ def show(parent=None): install_fonts() install_translator(app) - ctrl = control.Controller() - if self._window is None: + ctrl = control.Controller() self._window = window.Window(ctrl, parent) self._window.destroyed.connect(on_destroyed) diff --git a/openpype/tools/pyblish_pype/control.py b/openpype/tools/pyblish_pype/control.py index 9774c8020b..f657936b79 100644 --- a/openpype/tools/pyblish_pype/control.py +++ b/openpype/tools/pyblish_pype/control.py @@ -152,6 +152,8 @@ class Controller(QtCore.QObject): self.instance_toggled.connect(self._on_instance_toggled) self._main_thread_processor = MainThreadProcess() + self._current_state = "" + def reset_variables(self): self.log.debug("Resetting pyblish context variables") @@ -159,6 +161,7 @@ class Controller(QtCore.QObject): self.is_running = False self.stopped = False self.errored = False + self._current_state = "" # Active producer of pairs self.pair_generator = None @@ -167,7 +170,6 @@ class Controller(QtCore.QObject): # Orders which changes GUI # - passing collectors order disables plugin/instance toggle - self.collectors_order = None self.collect_state = 0 # - passing validators order disables validate button and gives ability @@ -176,11 +178,8 @@ class Controller(QtCore.QObject): self.validated = False # Get collectors and validators order - self.order_groups.reset() - plugin_groups = self.order_groups.groups() - plugin_groups_keys = list(plugin_groups.keys()) - self.collectors_order = plugin_groups_keys[0] - self.validators_order = self.order_groups.validation_order() + plugin_groups_keys = list(self.order_groups.groups.keys()) + self.validators_order = self.order_groups.validation_order next_group_order = None if len(plugin_groups_keys) > 1: next_group_order = plugin_groups_keys[1] @@ -191,13 +190,18 @@ class Controller(QtCore.QObject): "stop_on_validation": False, # Used? "last_plugin_order": None, - "current_group_order": self.collectors_order, + "current_group_order": plugin_groups_keys[0], "next_group_order": next_group_order, "nextOrder": None, "ordersWithError": set() } + self._set_state_by_order() self.log.debug("Reset of pyblish context variables done") + @property + def current_state(self): + return self._current_state + def presets_by_hosts(self): # Get global filters as base presets = get_project_settings(os.environ['AVALON_PROJECT']) or {} @@ -224,6 +228,16 @@ class Controller(QtCore.QObject): def reset_context(self): self.log.debug("Resetting pyblish context object") + comment = None + if ( + self.context is not None and + self.context.data.get("comment") and + # We only preserve the user typed comment if we are *not* + # resetting from a successful publish without errors + self._current_state != "Published" + ): + comment = self.context.data["comment"] + self.context = pyblish.api.Context() self.context._publish_states = InstanceStates.ContextType @@ -245,6 +259,10 @@ class Controller(QtCore.QObject): self.context.families = ("__context__",) + if comment: + # Preserve comment on reset if user previously had a comment + self.context.data["comment"] = comment + self.log.debug("Reset of pyblish context object done") def reset(self): @@ -293,6 +311,9 @@ class Controller(QtCore.QObject): def on_published(self): if self.is_running: self.is_running = False + self._current_state = ( + "Published" if not self.errored else "Published, with errors" + ) self.was_finished.emit() self._main_thread_processor.stop() @@ -355,7 +376,7 @@ class Controller(QtCore.QObject): new_current_group_order = self.processing["next_group_order"] if new_current_group_order is not None: current_next_order_found = False - for order in self.order_groups.groups().keys(): + for order in self.order_groups.groups.keys(): if current_next_order_found: new_next_group_order = order break @@ -368,8 +389,15 @@ class Controller(QtCore.QObject): new_current_group_order ) + # Force update to the current state + self._set_state_by_order() + if self.collect_state == 0: self.collect_state = 1 + self._current_state = ( + "Ready" if not self.errored else + "Collected, with errors" + ) self.switch_toggleability.emit(True) self.passed_group.emit(current_group_order) yield IterationBreak("Collected") @@ -377,6 +405,11 @@ class Controller(QtCore.QObject): else: self.passed_group.emit(current_group_order) if self.errored: + self._current_state = ( + "Stopped, due to errors" if not + self.processing["stop_on_validation"] else + "Validated, with errors" + ) yield IterationBreak("Last group errored") if self.collect_state == 1: @@ -386,17 +419,23 @@ class Controller(QtCore.QObject): if not self.validated and plugin.order > self.validators_order: self.validated = True if self.processing["stop_on_validation"]: + self._current_state = ( + "Validated" if not self.errored else + "Validated, with errors" + ) yield IterationBreak("Validated") # Stop if was stopped if self.stopped: self.stopped = False + self._current_state = "Paused" yield IterationBreak("Stopped") # check test if will stop self.processing["nextOrder"] = plugin.order message = self.test(**self.processing) if message: + self._current_state = "Paused" yield IterationBreak("Stopped due to \"{}\"".format(message)) self.processing["last_plugin_order"] = plugin.order @@ -426,6 +465,7 @@ class Controller(QtCore.QObject): # Stop if was stopped if self.stopped: self.stopped = False + self._current_state = "Paused" yield IterationBreak("Stopped") yield (plugin, instance) @@ -536,20 +576,27 @@ class Controller(QtCore.QObject): MainThreadItem(on_next) ) + def _set_state_by_order(self): + order = self.processing["current_group_order"] + self._current_state = self.order_groups.groups[order]["state"] + def collect(self): """ Iterate and process Collect plugins - load_plugins method is launched again when finished """ + self._set_state_by_order() self._main_thread_processor.process(self._start_collect) self._main_thread_processor.start() def validate(self): """ Process plugins to validations_order value.""" + self._set_state_by_order() self._main_thread_processor.process(self._start_validate) self._main_thread_processor.start() def publish(self): """ Iterate and process all remaining plugins.""" + self._set_state_by_order() self._main_thread_processor.process(self._start_publish) self._main_thread_processor.start() diff --git a/openpype/tools/pyblish_pype/model.py b/openpype/tools/pyblish_pype/model.py index bb1aff2a9a..2931a379b3 100644 --- a/openpype/tools/pyblish_pype/model.py +++ b/openpype/tools/pyblish_pype/model.py @@ -29,10 +29,9 @@ import pyblish from . import settings, util from .awesome import tags as awesome -import Qt from Qt import QtCore, QtGui +import qtawesome from six import text_type -from .vendor import qtawesome from .constants import PluginStates, InstanceStates, GroupStates, Roles from openpype.api import get_system_settings @@ -428,12 +427,12 @@ class PluginModel(QtGui.QStandardItemModel): self.clear() def append(self, plugin): - plugin_groups = self.controller.order_groups.groups() + plugin_groups = self.controller.order_groups.groups label = None order = None - for _order, _label in reversed(plugin_groups.items()): + for _order, item in reversed(plugin_groups.items()): if _order is None or plugin.order < _order: - label = _label + label = item["label"] order = _order else: break diff --git a/openpype/tools/pyblish_pype/util.py b/openpype/tools/pyblish_pype/util.py index d3d76b187c..9f3697be16 100644 --- a/openpype/tools/pyblish_pype/util.py +++ b/openpype/tools/pyblish_pype/util.py @@ -95,224 +95,44 @@ def collect_families_from_instances(instances, only_active=False): class OrderGroups: - # Validator order can be set with environment "PYBLISH_VALIDATION_ORDER" - # - this variable sets when validation button will hide and proecssing - # of validation will end with ability to continue in process - default_validation_order = pyblish.api.ValidatorOrder + 0.5 - - # Group range can be set with environment "PYBLISH_GROUP_RANGE" - default_group_range = 1 - - # Group string can be set with environment "PYBLISH_GROUP_SETTING" - default_groups = { - pyblish.api.CollectorOrder + 0.5: "Collect", - pyblish.api.ValidatorOrder + 0.5: "Validate", - pyblish.api.ExtractorOrder + 0.5: "Extract", - pyblish.api.IntegratorOrder + 0.5: "Integrate", - None: "Other" - } - - # *** This example should have same result as is `default_groups` if - # `group_range` is set to "1" - __groups_str_example__ = ( - # half of `group_range` is added to 0 because number means it is Order - "0=Collect" - # if `<` is before than it means group range is not used - # but is expected that number is already max - ",<1.5=Validate" - # "Extractor" will be used in range `<1.5; 2.5)` - ",<2.5=Extract" - ",<3.5=Integrate" - # "Other" if number is not set than all remaining plugins are in - # - in this case Other's range is <3.5; infinity) - ",Other" - ) - - _groups = None - _validation_order = None - _group_range = None - - def __init__( - self, group_str=None, group_range=None, validation_order=None - ): - super(OrderGroups, self).__init__() - # Override class methods with object methods - self.groups = self._object_groups - self.validation_order = self._object_validation_order - self.group_range = self._object_group_range - self.reset = self._object_reset - - # set - if group_range is not None: - self._group_range = self.parse_group_range( - group_range - ) - - if group_str is not None: - self._groups = self.parse_group_str( - group_str - ) - - if validation_order is not None: - self._validation_order = self.parse_validation_order( - validation_order - ) - - @staticmethod - def _groups_method(obj): - if obj._groups is None: - obj._groups = obj.parse_group_str( - group_range=obj.group_range() - ) - return obj._groups - - @staticmethod - def _reset_method(obj): - obj._groups = None - obj._validation_order = None - obj._group_range = None - - @classmethod - def reset(cls): - return cls._reset_method(cls) - - def _object_reset(self): - return self._reset_method(self) - - @classmethod - def groups(cls): - return cls._groups_method(cls) - - def _object_groups(self): - return self._groups_method(self) - - @staticmethod - def _validation_order_method(obj): - if obj._validation_order is None: - obj._validation_order = obj.parse_validation_order( - group_range=obj.group_range() - ) - return obj._validation_order - - @classmethod - def validation_order(cls): - return cls._validation_order_method(cls) - - def _object_validation_order(self): - return self._validation_order_method(self) - - @staticmethod - def _group_range_method(obj): - if obj._group_range is None: - obj._group_range = obj.parse_group_range() - return obj._group_range - - @classmethod - def group_range(cls): - return cls._group_range_method(cls) - - def _object_group_range(self): - return self._group_range_method(self) - - @staticmethod - def sort_groups(_groups_dict): - sorted_dict = collections.OrderedDict() - - # make sure won't affect any dictionary as pointer - groups_dict = copy.deepcopy(_groups_dict) - last_order = None - if None in groups_dict: - last_order = groups_dict.pop(None) - - for key in sorted(groups_dict): - sorted_dict[key] = groups_dict[key] - - if last_order is not None: - sorted_dict[None] = last_order - - return sorted_dict - - @staticmethod - def parse_group_str(groups_str=None, group_range=None): - if groups_str is None: - groups_str = os.environ.get("PYBLISH_GROUP_SETTING") - - if groups_str is None: - return OrderGroups.sort_groups(OrderGroups.default_groups) - - items = groups_str.split(",") - groups = {} - for item in items: - if "=" not in item: - order = None - label = item - else: - order, label = item.split("=") - order = order.strip() - if not order: - order = None - elif order.startswith("<"): - order = float(order.replace("<", "")) - else: - if group_range is None: - group_range = OrderGroups.default_group_range - print( - "Using default Plugin group range \"{}\".".format( - OrderGroups.default_group_range - ) - ) - order = float(order) + float(group_range) / 2 - - if order in groups: - print(( - "Order \"{}\" is registered more than once." - " Using first found." - ).format(str(order))) - continue - - groups[order] = label - - return OrderGroups.sort_groups(groups) - - @staticmethod - def parse_validation_order(validation_order_value=None, group_range=None): - if validation_order_value is None: - validation_order_value = os.environ.get("PYBLISH_VALIDATION_ORDER") - - if validation_order_value is None: - return OrderGroups.default_validation_order - - if group_range is None: - group_range = OrderGroups.default_group_range - - group_range_half = float(group_range) / 2 - - if isinstance(validation_order_value, numbers.Integral): - return validation_order_value + group_range_half - - if validation_order_value.startswith("<"): - validation_order_value = float( - validation_order_value.replace("<", "") - ) - else: - validation_order_value = ( - float(validation_order_value) - + group_range_half - ) - return validation_order_value - - @staticmethod - def parse_group_range(group_range=None): - if group_range is None: - group_range = os.environ.get("PYBLISH_GROUP_RANGE") - - if group_range is None: - return OrderGroups.default_group_range - - if isinstance(group_range, numbers.Integral): - return group_range - - return float(group_range) + validation_order = pyblish.api.ValidatorOrder + 0.5 + groups = collections.OrderedDict(( + ( + pyblish.api.CollectorOrder + 0.5, + { + "label": "Collect", + "state": "Collecting.." + } + ), + ( + pyblish.api.ValidatorOrder + 0.5, + { + "label": "Validate", + "state": "Validating.." + } + ), + ( + pyblish.api.ExtractorOrder + 0.5, + { + "label": "Extract", + "state": "Extracting.." + } + ), + ( + pyblish.api.IntegratorOrder + 0.5, + { + "label": "Integrate", + "state": "Integrating.." + } + ), + ( + None, + { + "label": "Other", + "state": "Finishing.." + } + ) + )) def env_variable_to_bool(env_key, default=False): diff --git a/openpype/tools/pyblish_pype/window.py b/openpype/tools/pyblish_pype/window.py index 9c4d4b10f4..d27ec34345 100644 --- a/openpype/tools/pyblish_pype/window.py +++ b/openpype/tools/pyblish_pype/window.py @@ -296,25 +296,6 @@ class Window(QtWidgets.QDialog): self.main_layout.setSpacing(0) self.main_layout.addWidget(main_widget) - # Display info - info_effect = QtWidgets.QGraphicsOpacityEffect(footer_info) - footer_info.setGraphicsEffect(info_effect) - - on = QtCore.QPropertyAnimation(info_effect, b"opacity") - on.setDuration(0) - on.setStartValue(0) - on.setEndValue(1) - - fade = QtCore.QPropertyAnimation(info_effect, b"opacity") - fade.setDuration(500) - fade.setStartValue(1.0) - fade.setEndValue(0.0) - - animation_info_msg = QtCore.QSequentialAnimationGroup() - animation_info_msg.addAnimation(on) - animation_info_msg.addPause(2000) - animation_info_msg.addAnimation(fade) - """Setup Widgets are referred to in CSS via their object-name. We @@ -448,6 +429,8 @@ class Window(QtWidgets.QDialog): self.footer_button_validate = footer_button_validate self.footer_button_play = footer_button_play + self.footer_info = footer_info + self.overview_instance_view = overview_instance_view self.overview_plugin_view = overview_plugin_view self.plugin_model = plugin_model @@ -457,8 +440,6 @@ class Window(QtWidgets.QDialog): self.presets_button = presets_button - self.animation_info_msg = animation_info_msg - self.terminal_model = terminal_model self.terminal_proxy = terminal_proxy self.terminal_view = terminal_view @@ -984,6 +965,8 @@ class Window(QtWidgets.QDialog): self.footer_button_stop.setEnabled(True) self.footer_button_play.setEnabled(False) + self._update_state() + def on_passed_group(self, order): for group_item in self.instance_model.group_items.values(): group_index = self.instance_sort_proxy.mapFromSource( @@ -1015,6 +998,8 @@ class Window(QtWidgets.QDialog): self.overview_plugin_view.setAnimated(False) self.overview_plugin_view.collapse(group_index) + self._update_state() + def on_was_stopped(self): self.overview_plugin_view.setAnimated(settings.Animated) errored = self.controller.errored @@ -1039,6 +1024,9 @@ class Window(QtWidgets.QDialog): and not self.controller.stopped ) self.button_suspend_logs.setEnabled(suspend_log_bool) + + self._update_state() + if not self.isVisible(): self.setVisible(True) @@ -1084,6 +1072,7 @@ class Window(QtWidgets.QDialog): ) self.update_compatibility() + self._update_state() def on_was_processed(self, result): existing_ids = set(self.instance_model.instance_items.keys()) @@ -1150,9 +1139,10 @@ class Window(QtWidgets.QDialog): self.intent_box.setCurrentIndex(self.intent_model.default_index) self.comment_box.placeholder.setVisible(False) - self.comment_box.placeholder.setVisible(True) # Launch controller reset self.controller.reset() + if not self.comment_box.text(): + self.comment_box.placeholder.setVisible(True) def validate(self): self.info(self.tr("Preparing validate..")) @@ -1165,6 +1155,8 @@ class Window(QtWidgets.QDialog): self.controller.validate() + self._update_state() + def publish(self): self.info(self.tr("Preparing publish..")) self.footer_button_stop.setEnabled(True) @@ -1176,6 +1168,8 @@ class Window(QtWidgets.QDialog): self.controller.publish() + self._update_state() + def act(self, plugin_item, action): self.info("%s %s.." % (self.tr("Preparing"), action)) @@ -1290,6 +1284,9 @@ class Window(QtWidgets.QDialog): # # ------------------------------------------------------------------------- + def _update_state(self): + self.footer_info.setText(self.controller.current_state) + def info(self, message): """Print user-facing information @@ -1297,19 +1294,12 @@ class Window(QtWidgets.QDialog): message (str): Text message for the user """ - - info = self.findChild(QtWidgets.QLabel, "FooterInfo") - info.setText(message) - # Include message in terminal self.terminal_model.append([{ "label": message, "type": "info" }]) - self.animation_info_msg.stop() - self.animation_info_msg.start() - if settings.PrintInfo: # Print message to console util.u_print(message) diff --git a/openpype/tools/sceneinventory/model.py b/openpype/tools/sceneinventory/model.py index d2b7f8b70f..7173ae751e 100644 --- a/openpype/tools/sceneinventory/model.py +++ b/openpype/tools/sceneinventory/model.py @@ -4,11 +4,13 @@ import logging from collections import defaultdict from Qt import QtCore, QtGui -from avalon import api, io, style, schema -from avalon.vendor import qtawesome +import qtawesome -from avalon.lib import HeroVersionType -from avalon.tools.models import TreeModel, Item +from avalon import api, io, schema +from openpype.pipeline import HeroVersionType +from openpype.style import get_default_entity_icon_color +from openpype.tools.utils.models import TreeModel, Item +from openpype.modules import ModulesManager from .lib import ( get_site_icons, @@ -16,8 +18,6 @@ from .lib import ( get_progress_for_repre ) -from openpype.modules import ModulesManager - class InventoryModel(TreeModel): """The model for the inventory""" @@ -38,6 +38,8 @@ class InventoryModel(TreeModel): self._hierarchy_view = False + self._default_icon_color = get_default_entity_icon_color() + manager = ModulesManager() sync_server = manager.modules_by_name["sync_server"] self.sync_enabled = sync_server.enabled @@ -131,7 +133,7 @@ class InventoryModel(TreeModel): if role == QtCore.Qt.DecorationRole: if index.column() == 0: # Override color - color = item.get("color", style.colors.default) + color = item.get("color", self._default_icon_color) if item.get("isGroupNode"): # group-item return qtawesome.icon("fa.folder", color=color) if item.get("isNotSet"): diff --git a/openpype/tools/sceneinventory/switch_dialog.py b/openpype/tools/sceneinventory/switch_dialog.py index 4946c073d4..0e7b1b759a 100644 --- a/openpype/tools/sceneinventory/switch_dialog.py +++ b/openpype/tools/sceneinventory/switch_dialog.py @@ -1,9 +1,14 @@ import collections import logging from Qt import QtWidgets, QtCore +import qtawesome -from avalon import io, api, pipeline -from avalon.vendor import qtawesome +from avalon import io, pipeline +from openpype.pipeline import ( + discover_loader_plugins, + switch_container, + get_repres_contexts, +) from .widgets import ( ButtonWithMenu, @@ -343,13 +348,13 @@ class SwitchAssetDialog(QtWidgets.QDialog): def _get_loaders(self, repre_ids): repre_contexts = None if repre_ids: - repre_contexts = pipeline.get_repres_contexts(repre_ids) + repre_contexts = get_repres_contexts(repre_ids) if not repre_contexts: return list() available_loaders = [] - for loader_plugin in api.discover(api.Loader): + for loader_plugin in discover_loader_plugins(): # Skip loaders without switch method if not hasattr(loader_plugin, "switch"): continue @@ -1352,7 +1357,7 @@ class SwitchAssetDialog(QtWidgets.QDialog): repre_doc = repres_by_name[container_repre_name] try: - api.switch(container, repre_doc, loader) + switch_container(container, repre_doc, loader) except Exception: msg = ( "Couldn't switch asset." diff --git a/openpype/tools/sceneinventory/view.py b/openpype/tools/sceneinventory/view.py index 80f26a881d..c38390c614 100644 --- a/openpype/tools/sceneinventory/view.py +++ b/openpype/tools/sceneinventory/view.py @@ -3,13 +3,22 @@ import logging from functools import partial from Qt import QtWidgets, QtCore +import qtawesome -from avalon import io, api, style -from avalon.vendor import qtawesome -from avalon.lib import HeroVersionType -from avalon.tools import lib as tools_lib +from avalon import io, api +from openpype import style +from openpype.pipeline import ( + HeroVersionType, + update_container, + remove_container, +) from openpype.modules import ModulesManager +from openpype.tools.utils.lib import ( + get_progress_for_repre, + iter_model_rows, + format_version +) from .switch_dialog import SwitchAssetDialog from .model import InventoryModel @@ -20,12 +29,12 @@ DEFAULT_COLOR = "#fb9c15" log = logging.getLogger("SceneInventory") -class SceneInvetoryView(QtWidgets.QTreeView): +class SceneInventoryView(QtWidgets.QTreeView): data_changed = QtCore.Signal() hierarchy_view_changed = QtCore.Signal(bool) def __init__(self, parent=None): - super(SceneInvetoryView, self).__init__(parent=parent) + super(SceneInventoryView, self).__init__(parent=parent) # view settings self.setIndentation(12) @@ -191,7 +200,7 @@ class SceneInvetoryView(QtWidgets.QTreeView): version_name = version_name_by_id.get(version_id) if version_name is not None: try: - api.update(item, version_name) + update_container(item, version_name) except AssertionError: self._show_version_error_dialog( version_name, [item] @@ -219,7 +228,7 @@ class SceneInvetoryView(QtWidgets.QTreeView): def _on_update_to_latest(items): for item in items: try: - api.update(item, -1) + update_container(item, -1) except AssertionError: self._show_version_error_dialog(None, [item]) log.warning("Update failed", exc_info=True) @@ -244,7 +253,7 @@ class SceneInvetoryView(QtWidgets.QTreeView): def _on_update_to_hero(items): for item in items: try: - api.update(item, HeroVersionType(-1)) + update_container(item, HeroVersionType(-1)) except AssertionError: self._show_version_error_dialog('hero', [item]) log.warning("Update failed", exc_info=True) @@ -373,7 +382,7 @@ class SceneInvetoryView(QtWidgets.QTreeView): if not repre_doc: continue - progress = tools_lib.get_progress_for_repre( + progress = get_progress_for_repre( repre_doc, active_site, remote_site @@ -544,7 +553,7 @@ class SceneInvetoryView(QtWidgets.QTreeView): "toggle": selection_model.Toggle, }[options.get("mode", "select")] - for item in tools_lib.iter_model_rows(model, 0): + for item in iter_model_rows(model, 0): item = item.data(InventoryModel.ItemRole) if item.get("isGroupNode"): continue @@ -704,7 +713,7 @@ class SceneInvetoryView(QtWidgets.QTreeView): labels = [] for version in all_versions: is_hero = version["type"] == "hero_version" - label = tools_lib.format_version(version["name"], is_hero) + label = format_version(version["name"], is_hero) labels.append(label) versions_by_label[label] = version["name"] @@ -723,7 +732,7 @@ class SceneInvetoryView(QtWidgets.QTreeView): version = versions_by_label[label] for item in items: try: - api.update(item, version) + update_container(item, version) except AssertionError: self._show_version_error_dialog(version, [item]) log.warning("Update failed", exc_info=True) @@ -754,7 +763,7 @@ class SceneInvetoryView(QtWidgets.QTreeView): return for item in items: - api.remove(item) + remove_container(item) self.data_changed.emit() def _show_version_error_dialog(self, version, items): @@ -792,3 +801,40 @@ class SceneInvetoryView(QtWidgets.QTreeView): ).format(version_str) dialog.setText(msg) dialog.exec_() + + def update_all(self): + """Update all items that are currently 'outdated' in the view""" + # Get the source model through the proxy model + model = self.model().sourceModel() + + # Get all items from outdated groups + outdated_items = [] + for index in iter_model_rows(model, + column=0, + include_root=False): + item = index.data(model.ItemRole) + + if not item.get("isGroupNode"): + continue + + # Only the group nodes contain the "highest_version" data and as + # such we find only the groups and take its children. + if not model.outdated(item): + continue + + # Collect all children which we want to update + children = item.children() + outdated_items.extend(children) + + if not outdated_items: + log.info("Nothing to update.") + return + + # Trigger update to latest + for item in outdated_items: + try: + update_container(item, -1) + except AssertionError: + self._show_version_error_dialog(None, [item]) + log.warning("Update failed", exc_info=True) + self.data_changed.emit() diff --git a/openpype/tools/sceneinventory/window.py b/openpype/tools/sceneinventory/window.py index e363a99d07..b40fbb69e4 100644 --- a/openpype/tools/sceneinventory/window.py +++ b/openpype/tools/sceneinventory/window.py @@ -2,7 +2,7 @@ import os import sys from Qt import QtWidgets, QtCore -from avalon.vendor import qtawesome +import qtawesome from avalon import io, api from openpype import style @@ -18,7 +18,7 @@ from .model import ( InventoryModel, FilterProxyModel ) -from .view import SceneInvetoryView +from .view import SceneInventoryView module = sys.modules[__name__] @@ -54,14 +54,21 @@ class SceneInventoryWindow(QtWidgets.QDialog): outdated_only_checkbox.setToolTip("Show outdated files only") outdated_only_checkbox.setChecked(False) + icon = qtawesome.icon("fa.arrow-up", color="white") + update_all_button = QtWidgets.QPushButton(self) + update_all_button.setToolTip("Update all outdated to latest version") + update_all_button.setIcon(icon) + icon = qtawesome.icon("fa.refresh", color="white") refresh_button = QtWidgets.QPushButton(self) + refresh_button.setToolTip("Refresh") refresh_button.setIcon(icon) control_layout = QtWidgets.QHBoxLayout() control_layout.addWidget(filter_label) control_layout.addWidget(text_filter) control_layout.addWidget(outdated_only_checkbox) + control_layout.addWidget(update_all_button) control_layout.addWidget(refresh_button) # endregion control @@ -73,7 +80,7 @@ class SceneInventoryWindow(QtWidgets.QDialog): proxy.setDynamicSortFilter(True) proxy.setFilterCaseSensitivity(QtCore.Qt.CaseInsensitive) - view = SceneInvetoryView(self) + view = SceneInventoryView(self) view.setModel(proxy) # set some nice default widths for the view @@ -98,11 +105,13 @@ class SceneInventoryWindow(QtWidgets.QDialog): self._on_outdated_state_change ) view.hierarchy_view_changed.connect( - self._on_hiearchy_view_change + self._on_hierarchy_view_change ) view.data_changed.connect(self.refresh) refresh_button.clicked.connect(self.refresh) + update_all_button.clicked.connect(self._on_update_all) + self._update_all_button = update_all_button self._outdated_only_checkbox = outdated_only_checkbox self._view = view self._model = model @@ -146,7 +155,7 @@ class SceneInventoryWindow(QtWidgets.QDialog): kwargs["selected"] = self._view._selected self._model.refresh(**kwargs) - def _on_hiearchy_view_change(self, enabled): + def _on_hierarchy_view_change(self, enabled): self._proxy.set_hierarchy_view(enabled) self._model.set_hierarchy_view(enabled) @@ -158,6 +167,9 @@ class SceneInventoryWindow(QtWidgets.QDialog): self._outdated_only_checkbox.isChecked() ) + def _on_update_all(self): + self._view.update_all() + def show(root=None, debug=False, parent=None, items=None): """Display Scene Inventory GUI diff --git a/openpype/tools/settings/local_settings/experimental_widget.py b/openpype/tools/settings/local_settings/experimental_widget.py index e863d9afb0..22ef952356 100644 --- a/openpype/tools/settings/local_settings/experimental_widget.py +++ b/openpype/tools/settings/local_settings/experimental_widget.py @@ -28,7 +28,7 @@ class LocalExperimentalToolsWidgets(QtWidgets.QWidget): layout.addRow(empty_label) - experimental_defs = ExperimentalTools(filter_hosts=False) + experimental_defs = ExperimentalTools(refresh=False) checkboxes_by_identifier = {} for tool in experimental_defs.tools: checkbox = QtWidgets.QCheckBox(self) diff --git a/openpype/tools/settings/settings/base.py b/openpype/tools/settings/settings/base.py index bbfbc58627..706e2fdcf0 100644 --- a/openpype/tools/settings/settings/base.py +++ b/openpype/tools/settings/settings/base.py @@ -1,6 +1,7 @@ import sys import json import traceback +import functools from Qt import QtWidgets, QtGui, QtCore @@ -325,7 +326,8 @@ class BaseWidget(QtWidgets.QWidget): action = QtWidgets.QAction(project_name) submenu.addAction(action) - actions_mapping[action] = lambda: self._apply_values_from_project( + actions_mapping[action] = functools.partial( + self._apply_values_from_project, project_name ) menu.addMenu(submenu) diff --git a/openpype/tools/settings/settings/categories.py b/openpype/tools/settings/settings/categories.py index 18a9764b34..a5b5cd40f0 100644 --- a/openpype/tools/settings/settings/categories.py +++ b/openpype/tools/settings/settings/categories.py @@ -1,9 +1,9 @@ -import os import sys import traceback import contextlib from enum import Enum from Qt import QtWidgets, QtCore +import qtawesome from openpype.lib import get_openpype_version from openpype.tools.utils import set_style_property @@ -63,7 +63,6 @@ from .item_widgets import ( PathInputWidget ) from .color_widget import ColorWidget -from avalon.vendor import qtawesome class CategoryState(Enum): @@ -91,6 +90,8 @@ class SettingsCategoryWidget(QtWidgets.QWidget): state_changed = QtCore.Signal() saved = QtCore.Signal(QtWidgets.QWidget) restart_required_trigger = QtCore.Signal() + reset_started = QtCore.Signal() + reset_finished = QtCore.Signal() full_path_requested = QtCore.Signal(str, str) require_restart_label_text = ( @@ -379,7 +380,12 @@ class SettingsCategoryWidget(QtWidgets.QWidget): """Change path of widget based on category full path.""" pass + def change_path(self, path): + """Change path and go to widget.""" + self.breadcrumbs_bar.change_path(path) + def set_path(self, path): + """Called from clicked widget.""" self.breadcrumbs_bar.set_path(path) def _add_developer_ui(self, footer_layout, footer_widget): @@ -492,6 +498,7 @@ class SettingsCategoryWidget(QtWidgets.QWidget): self._update_labels_visibility() def reset(self): + self.reset_started.emit() self.set_state(CategoryState.Working) self._on_reset_start() @@ -596,6 +603,7 @@ class SettingsCategoryWidget(QtWidgets.QWidget): self._on_reset_crash() else: self._on_reset_success() + self.reset_finished.emit() def _on_source_version_change(self, version): if self._updating_root: @@ -706,7 +714,12 @@ class SettingsCategoryWidget(QtWidgets.QWidget): self._outdated_version_label, self._require_restart_label, } - if self.entity.require_restart: + if self.is_modifying_defaults or self.entity is None: + require_restart = False + else: + require_restart = self.entity.require_restart + + if require_restart: visible_label = self._require_restart_label elif self._is_loaded_version_outdated: visible_label = self._outdated_version_label diff --git a/openpype/tools/settings/settings/search_dialog.py b/openpype/tools/settings/settings/search_dialog.py new file mode 100644 index 0000000000..e6538cfe67 --- /dev/null +++ b/openpype/tools/settings/settings/search_dialog.py @@ -0,0 +1,187 @@ +import re +import collections + +from Qt import QtCore, QtWidgets, QtGui + +ENTITY_LABEL_ROLE = QtCore.Qt.UserRole + 1 +ENTITY_PATH_ROLE = QtCore.Qt.UserRole + 2 + + +def get_entity_children(entity): + # TODO find better way how to go through all children + if hasattr(entity, "values"): + return entity.values() + return [] + + +class RecursiveSortFilterProxyModel(QtCore.QSortFilterProxyModel): + """Filters recursively to regex in all columns""" + + def __init__(self): + super(RecursiveSortFilterProxyModel, self).__init__() + + # Note: Recursive filtering was introduced in Qt 5.10. + self.setRecursiveFilteringEnabled(True) + + def filterAcceptsRow(self, row, parent): + if not parent.isValid(): + return False + + regex = self.filterRegExp() + if not regex.isEmpty() and regex.isValid(): + pattern = regex.pattern() + compiled_regex = re.compile(pattern, re.IGNORECASE) + source_model = self.sourceModel() + + # Check current index itself in all columns + source_index = source_model.index(row, 0, parent) + if source_index.isValid(): + for role in (ENTITY_PATH_ROLE, ENTITY_LABEL_ROLE): + value = source_model.data(source_index, role) + if value and compiled_regex.search(value): + return True + return False + + return super( + RecursiveSortFilterProxyModel, self + ).filterAcceptsRow(row, parent) + + +class SearchEntitiesDialog(QtWidgets.QDialog): + path_clicked = QtCore.Signal(str) + + def __init__(self, parent): + super(SearchEntitiesDialog, self).__init__(parent=parent) + + self.setWindowTitle("Search Settings") + + filter_edit = QtWidgets.QLineEdit(self) + filter_edit.setPlaceholderText("Search...") + + model = EntityTreeModel() + proxy = RecursiveSortFilterProxyModel() + proxy.setSourceModel(model) + proxy.setDynamicSortFilter(True) + + view = QtWidgets.QTreeView(self) + view.setAllColumnsShowFocus(True) + view.setSortingEnabled(True) + view.setModel(proxy) + model.setColumnCount(3) + + layout = QtWidgets.QVBoxLayout(self) + layout.addWidget(filter_edit) + layout.addWidget(view) + + filter_changed_timer = QtCore.QTimer() + filter_changed_timer.setInterval(200) + filter_changed_timer.setSingleShot(True) + + view.selectionModel().selectionChanged.connect( + self._on_selection_change + ) + filter_changed_timer.timeout.connect(self._on_filter_timer) + filter_edit.textChanged.connect(self._on_filter_changed) + + self._filter_edit = filter_edit + self._model = model + self._proxy = proxy + self._view = view + self._filter_changed_timer = filter_changed_timer + + self._first_show = True + + def set_root_entity(self, entity): + self._model.set_root_entity(entity) + self._view.resizeColumnToContents(0) + + def showEvent(self, event): + super(SearchEntitiesDialog, self).showEvent(event) + if self._first_show: + self._first_show = False + self.resize(700, 500) + + def _on_filter_changed(self, txt): + self._filter_changed_timer.start() + + def _on_filter_timer(self): + text = self._filter_edit.text() + self._proxy.setFilterRegExp(text) + + # WARNING This expanding and resizing is relatively slow. + self._view.expandAll() + self._view.resizeColumnToContents(0) + + def _on_selection_change(self): + current = self._view.currentIndex() + path = current.data(ENTITY_PATH_ROLE) + self.path_clicked.emit(path) + + +class EntityTreeModel(QtGui.QStandardItemModel): + def __init__(self, *args, **kwargs): + super(EntityTreeModel, self).__init__(*args, **kwargs) + self.setColumnCount(3) + + def data(self, index, role=None): + if role is None: + role = QtCore.Qt.DisplayRole + + col = index.column() + if role in (QtCore.Qt.DisplayRole, QtCore.Qt.EditRole): + if col == 0: + pass + elif col == 1: + role = ENTITY_LABEL_ROLE + elif col == 2: + role = ENTITY_PATH_ROLE + + if col > 0: + index = self.index(index.row(), 0, index.parent()) + return super(EntityTreeModel, self).data(index, role) + + def flags(self, index): + if index.column() > 0: + index = self.index(index.row(), 0, index.parent()) + return super(EntityTreeModel, self).flags(index) + + def headerData(self, section, orientation, role=QtCore.Qt.DisplayRole): + if role == QtCore.Qt.DisplayRole: + if section == 0: + return "Key" + elif section == 1: + return "Label" + elif section == 2: + return "Path" + return "" + return super(EntityTreeModel, self).headerData( + section, orientation, role + ) + + def set_root_entity(self, root_entity): + parent = self.invisibleRootItem() + parent.removeRows(0, parent.rowCount()) + if not root_entity: + return + + # We don't want to see the root entity so we directly add its children + fill_queue = collections.deque() + fill_queue.append((root_entity, parent)) + cols = self.columnCount() + while fill_queue: + parent_entity, parent_item = fill_queue.popleft() + child_items = [] + for child in get_entity_children(parent_entity): + label = child.label + path = child.path + key = path.split("/")[-1] + item = QtGui.QStandardItem(key) + item.setEditable(False) + item.setData(label, ENTITY_LABEL_ROLE) + item.setData(path, ENTITY_PATH_ROLE) + item.setColumnCount(cols) + child_items.append(item) + fill_queue.append((child, item)) + + if child_items: + parent_item.appendRows(child_items) diff --git a/openpype/tools/settings/settings/widgets.py b/openpype/tools/settings/settings/widgets.py index f793aab057..577c2630ab 100644 --- a/openpype/tools/settings/settings/widgets.py +++ b/openpype/tools/settings/settings/widgets.py @@ -2,7 +2,7 @@ import os import copy import uuid from Qt import QtWidgets, QtCore, QtGui -from avalon.vendor import qtawesome +import qtawesome from avalon.mongodb import ( AvalonMongoConnection, AvalonMongoDB diff --git a/openpype/tools/settings/settings/window.py b/openpype/tools/settings/settings/window.py index 8a01bf1bce..22778e4a5b 100644 --- a/openpype/tools/settings/settings/window.py +++ b/openpype/tools/settings/settings/window.py @@ -9,6 +9,7 @@ from .widgets import ( RestartDialog, SettingsTabWidget ) +from .search_dialog import SearchEntitiesDialog from openpype import style from openpype.lib import is_admin_password_required @@ -58,15 +59,22 @@ class MainWidget(QtWidgets.QWidget): self.setLayout(layout) + search_dialog = SearchEntitiesDialog(self) + self._shadow_widget = ShadowWidget("Working...", self) self._shadow_widget.setVisible(False) + header_tab_widget.currentChanged.connect(self._on_tab_changed) + search_dialog.path_clicked.connect(self._on_search_path_clicked) + for tab_widget in tab_widgets: tab_widget.saved.connect(self._on_tab_save) tab_widget.state_changed.connect(self._on_state_change) tab_widget.restart_required_trigger.connect( self._on_restart_required ) + tab_widget.reset_started.connect(self._on_reset_started) + tab_widget.reset_started.connect(self._on_reset_finished) tab_widget.full_path_requested.connect(self._on_full_path_request) header_tab_widget.context_menu_requested.connect( @@ -75,6 +83,7 @@ class MainWidget(QtWidgets.QWidget): self._header_tab_widget = header_tab_widget self.tab_widgets = tab_widgets + self._search_dialog = search_dialog def _on_tab_save(self, source_widget): for tab_widget in self.tab_widgets: @@ -170,6 +179,21 @@ class MainWidget(QtWidgets.QWidget): for tab_widget in self.tab_widgets: tab_widget.reset() + def _update_search_dialog(self, clear=False): + if self._search_dialog.isVisible(): + entity = None + if not clear: + widget = self._header_tab_widget.currentWidget() + entity = widget.entity + self._search_dialog.set_root_entity(entity) + + def _on_tab_changed(self): + self._update_search_dialog() + + def _on_search_path_clicked(self, path): + widget = self._header_tab_widget.currentWidget() + widget.change_path(path) + def _on_restart_required(self): # Don't show dialog if there are not registered slots for # `trigger_restart` signal. @@ -184,3 +208,26 @@ class MainWidget(QtWidgets.QWidget): result = dialog.exec_() if result == 1: self.trigger_restart.emit() + + def _on_reset_started(self): + widget = self.sender() + current_widget = self._header_tab_widget.currentWidget() + if current_widget is widget: + self._update_search_dialog(True) + + def _on_reset_finished(self): + widget = self.sender() + current_widget = self._header_tab_widget.currentWidget() + if current_widget is widget: + self._update_search_dialog() + + def keyPressEvent(self, event): + if event.matches(QtGui.QKeySequence.Find): + # todo: search in all widgets (or in active)? + widget = self._header_tab_widget.currentWidget() + self._search_dialog.show() + self._search_dialog.set_root_entity(widget.entity) + event.accept() + return + + return super(MainWidget, self).keyPressEvent(event) diff --git a/openpype/tools/standalonepublish/publish.py b/openpype/tools/standalonepublish/publish.py index af269c4381..582e7eccf8 100644 --- a/openpype/tools/standalonepublish/publish.py +++ b/openpype/tools/standalonepublish/publish.py @@ -3,10 +3,10 @@ import sys import openpype import pyblish.api +from openpype.tools.utils.host_tools import show_publish def main(env): - from avalon.tools import publish # Registers pype's Global pyblish plugins openpype.install() @@ -19,7 +19,7 @@ def main(env): continue pyblish.api.register_plugin_path(path) - return publish.show() + return show_publish() if __name__ == "__main__": diff --git a/openpype/tools/standalonepublish/widgets/model_asset.py b/openpype/tools/standalonepublish/widgets/model_asset.py index 60afe8f96c..a7316a2aa7 100644 --- a/openpype/tools/standalonepublish/widgets/model_asset.py +++ b/openpype/tools/standalonepublish/widgets/model_asset.py @@ -1,10 +1,15 @@ import logging import collections -from Qt import QtCore, QtGui -from . import TreeModel, Node -from avalon.vendor import qtawesome -from avalon import style +from Qt import QtCore, QtGui +import qtawesome + +from openpype.style import ( + get_default_entity_icon_color, + get_deprecated_entity_font_color, +) + +from . import TreeModel, Node log = logging.getLogger(__name__) @@ -49,6 +54,14 @@ class AssetModel(TreeModel): def __init__(self, dbcon, parent=None): super(AssetModel, self).__init__(parent=parent) self.dbcon = dbcon + + self._default_asset_icon_color = QtGui.QColor( + get_default_entity_icon_color() + ) + self._deprecated_asset_font_color = QtGui.QColor( + get_deprecated_entity_font_color() + ) + self.refresh() def _add_hierarchy(self, assets, parent=None, silos=None): @@ -163,7 +176,7 @@ class AssetModel(TreeModel): icon = data.get("icon", None) if icon is None and node.get("type") == "silo": icon = "database" - color = data.get("color", style.colors.default) + color = data.get("color", self._default_asset_icon_color) if icon is None: # Use default icons if no custom one is specified. @@ -189,7 +202,7 @@ class AssetModel(TreeModel): if role == QtCore.Qt.ForegroundRole: # font color if "deprecated" in node.get("tags", []): - return QtGui.QColor(style.colors.light).darker(250) + return QtGui.QColor(self._deprecated_asset_font_color) if role == self.ObjectIdRole: return node.get("_id", None) diff --git a/openpype/tools/standalonepublish/widgets/model_tasks_template.py b/openpype/tools/standalonepublish/widgets/model_tasks_template.py index 476f45391d..648f7ed479 100644 --- a/openpype/tools/standalonepublish/widgets/model_tasks_template.py +++ b/openpype/tools/standalonepublish/widgets/model_tasks_template.py @@ -1,7 +1,9 @@ from Qt import QtCore +import qtawesome + +from openpype.style import get_default_entity_icon_color + from . import Node, TreeModel -from avalon.vendor import qtawesome -from avalon import style class TasksTemplateModel(TreeModel): @@ -14,7 +16,7 @@ class TasksTemplateModel(TreeModel): self.selectable = selectable self.icon = qtawesome.icon( 'fa.calendar-check-o', - color=style.colors.default + color=get_default_entity_icon_color() ) def set_tasks(self, tasks): diff --git a/openpype/tools/standalonepublish/widgets/widget_asset.py b/openpype/tools/standalonepublish/widgets/widget_asset.py index 2886d600bf..e6b74f8f82 100644 --- a/openpype/tools/standalonepublish/widgets/widget_asset.py +++ b/openpype/tools/standalonepublish/widgets/widget_asset.py @@ -1,10 +1,10 @@ import contextlib from Qt import QtWidgets, QtCore +import qtawesome from openpype.tools.utils import PlaceholderLineEdit -from avalon.vendor import qtawesome -from avalon import style +from openpype.style import get_default_tools_icon_color from . import RecursiveSortFilterProxyModel, AssetModel from . import TasksTemplateModel, DeselectableTreeView @@ -165,7 +165,9 @@ class AssetWidget(QtWidgets.QWidget): # Header header = QtWidgets.QHBoxLayout() - icon = qtawesome.icon("fa.refresh", color=style.colors.light) + icon = qtawesome.icon( + "fa.refresh", color=get_default_tools_icon_color() + ) refresh = QtWidgets.QPushButton(icon, "") refresh.setToolTip("Refresh items") diff --git a/openpype/tools/standalonepublish/widgets/widget_family.py b/openpype/tools/standalonepublish/widgets/widget_family.py index ae44899a89..08cd45bbf2 100644 --- a/openpype/tools/standalonepublish/widgets/widget_family.py +++ b/openpype/tools/standalonepublish/widgets/widget_family.py @@ -1,14 +1,11 @@ -import os import re from Qt import QtWidgets, QtCore from . import HelpRole, FamilyRole, ExistsRole, PluginRole, PluginKeyRole from . import FamilyDescriptionWidget -from openpype.api import ( - get_project_settings, - Creator -) +from openpype.api import get_project_settings +from openpype.pipeline import LegacyCreator from openpype.lib import TaskNotSetError from openpype.pipeline.create import SUBSET_NAME_ALLOWED_SYMBOLS @@ -390,7 +387,7 @@ class FamilyWidget(QtWidgets.QWidget): sp_settings = settings.get('standalonepublisher', {}) for key, creator_data in sp_settings.get("create", {}).items(): - creator = type(key, (Creator, ), creator_data) + creator = type(key, (LegacyCreator, ), creator_data) label = creator.label or creator.family item = QtWidgets.QListWidgetItem(label) diff --git a/openpype/tools/standalonepublish/widgets/widget_family_desc.py b/openpype/tools/standalonepublish/widgets/widget_family_desc.py index 8c95ddf2e4..79681615b9 100644 --- a/openpype/tools/standalonepublish/widgets/widget_family_desc.py +++ b/openpype/tools/standalonepublish/widgets/widget_family_desc.py @@ -1,7 +1,7 @@ -from Qt import QtWidgets, QtCore, QtGui -from . import FamilyRole, PluginRole -from avalon.vendor import qtawesome import six +from Qt import QtWidgets, QtCore, QtGui +import qtawesome +from . import FamilyRole, PluginRole class FamilyDescriptionWidget(QtWidgets.QWidget): diff --git a/openpype/tools/subsetmanager/window.py b/openpype/tools/subsetmanager/window.py index b7430d0626..a53af52174 100644 --- a/openpype/tools/subsetmanager/window.py +++ b/openpype/tools/subsetmanager/window.py @@ -2,9 +2,9 @@ import os import sys from Qt import QtWidgets, QtCore +import qtawesome from avalon import api -from avalon.vendor import qtawesome from openpype import style from openpype.tools.utils import PlaceholderLineEdit diff --git a/openpype/tools/traypublisher/__init__.py b/openpype/tools/traypublisher/__init__.py new file mode 100644 index 0000000000..188a234a9e --- /dev/null +++ b/openpype/tools/traypublisher/__init__.py @@ -0,0 +1,6 @@ +from .window import main + + +__all__ = ( + "main", +) diff --git a/openpype/tools/traypublisher/window.py b/openpype/tools/traypublisher/window.py new file mode 100644 index 0000000000..d0453c4f23 --- /dev/null +++ b/openpype/tools/traypublisher/window.py @@ -0,0 +1,170 @@ +"""Tray publisher is extending publisher tool. + +Adds ability to select project using overlay widget with list of projects. + +Tray publisher can be considered as host implementeation with creators and +publishing plugins. +""" + +from Qt import QtWidgets, QtCore + +import avalon.api +from avalon.api import AvalonMongoDB +from openpype.hosts.traypublisher import ( + api as traypublisher +) +from openpype.tools.publisher import PublisherWindow +from openpype.tools.utils.constants import PROJECT_NAME_ROLE +from openpype.tools.utils.models import ( + ProjectModel, + ProjectSortFilterProxy +) + + +class StandaloneOverlayWidget(QtWidgets.QFrame): + project_selected = QtCore.Signal(str) + + def __init__(self, publisher_window): + super(StandaloneOverlayWidget, self).__init__(publisher_window) + self.setObjectName("OverlayFrame") + + middle_frame = QtWidgets.QFrame(self) + middle_frame.setObjectName("ChooseProjectFrame") + + content_widget = QtWidgets.QWidget(middle_frame) + + # Create db connection for projects model + dbcon = AvalonMongoDB() + dbcon.install() + + header_label = QtWidgets.QLabel("Choose project", content_widget) + header_label.setObjectName("ChooseProjectLabel") + # Create project models and view + projects_model = ProjectModel(dbcon) + projects_proxy = ProjectSortFilterProxy() + projects_proxy.setSourceModel(projects_model) + + projects_view = QtWidgets.QListView(content_widget) + projects_view.setObjectName("ChooseProjectView") + projects_view.setModel(projects_proxy) + projects_view.setEditTriggers( + QtWidgets.QAbstractItemView.NoEditTriggers + ) + + confirm_btn = QtWidgets.QPushButton("Confirm", content_widget) + btns_layout = QtWidgets.QHBoxLayout() + btns_layout.addStretch(1) + btns_layout.addWidget(confirm_btn, 0) + + content_layout = QtWidgets.QVBoxLayout(content_widget) + content_layout.setContentsMargins(0, 0, 0, 0) + content_layout.setSpacing(20) + content_layout.addWidget(header_label, 0) + content_layout.addWidget(projects_view, 1) + content_layout.addLayout(btns_layout, 0) + + middle_layout = QtWidgets.QHBoxLayout(middle_frame) + middle_layout.setContentsMargins(30, 30, 10, 10) + middle_layout.addWidget(content_widget) + + main_layout = QtWidgets.QHBoxLayout(self) + main_layout.setContentsMargins(10, 10, 10, 10) + main_layout.addStretch(1) + main_layout.addWidget(middle_frame, 2) + main_layout.addStretch(1) + + projects_view.doubleClicked.connect(self._on_double_click) + confirm_btn.clicked.connect(self._on_confirm_click) + + self._projects_view = projects_view + self._projects_model = projects_model + self._confirm_btn = confirm_btn + + self._publisher_window = publisher_window + + def showEvent(self, event): + self._projects_model.refresh() + super(StandaloneOverlayWidget, self).showEvent(event) + + def _on_double_click(self): + self.set_selected_project() + + def _on_confirm_click(self): + self.set_selected_project() + + def set_selected_project(self): + index = self._projects_view.currentIndex() + + project_name = index.data(PROJECT_NAME_ROLE) + if not project_name: + return + + traypublisher.set_project_name(project_name) + self.setVisible(False) + self.project_selected.emit(project_name) + + +class TrayPublishWindow(PublisherWindow): + def __init__(self, *args, **kwargs): + super(TrayPublishWindow, self).__init__(reset_on_show=False) + + overlay_widget = StandaloneOverlayWidget(self) + + btns_widget = QtWidgets.QWidget(self) + + back_to_overlay_btn = QtWidgets.QPushButton( + "Change project", btns_widget + ) + save_btn = QtWidgets.QPushButton("Save", btns_widget) + # TODO implement save mechanism of tray publisher + save_btn.setVisible(False) + + btns_layout = QtWidgets.QHBoxLayout(btns_widget) + btns_layout.setContentsMargins(0, 0, 0, 0) + + btns_layout.addWidget(save_btn, 0) + btns_layout.addWidget(back_to_overlay_btn, 0) + + self._header_layout.addWidget(btns_widget, 0) + + overlay_widget.project_selected.connect(self._on_project_select) + back_to_overlay_btn.clicked.connect(self._on_back_to_overlay) + save_btn.clicked.connect(self._on_tray_publish_save) + + self._back_to_overlay_btn = back_to_overlay_btn + self._overlay_widget = overlay_widget + + def _on_back_to_overlay(self): + self._overlay_widget.setVisible(True) + self._resize_overlay() + + def _resize_overlay(self): + self._overlay_widget.resize( + self.width(), + self.height() + ) + + def resizeEvent(self, event): + super(TrayPublishWindow, self).resizeEvent(event) + self._resize_overlay() + + def _on_project_select(self, project_name): + # TODO register project specific plugin paths + self.controller.save_changes() + self.controller.reset_project_data_cache() + + self.reset() + if not self.controller.instances: + self._on_create_clicked() + + def _on_tray_publish_save(self): + self.controller.save_changes() + print("NOT YET IMPLEMENTED") + + +def main(): + avalon.api.install(traypublisher) + app = QtWidgets.QApplication([]) + window = TrayPublishWindow() + window.show() + app.exec_() diff --git a/openpype/tools/utils/__init__.py b/openpype/tools/utils/__init__.py index 46af051069..ea1133c442 100644 --- a/openpype/tools/utils/__init__.py +++ b/openpype/tools/utils/__init__.py @@ -2,11 +2,12 @@ from .widgets import ( PlaceholderLineEdit, BaseClickableFrame, ClickableFrame, + ClickableLabel, ExpandBtn, PixmapLabel, IconButton, ) - +from .views import DeselectableTreeView from .error_dialog import ErrorMessageBox from .lib import ( WrappedCallbackItem, @@ -14,6 +15,8 @@ from .lib import ( get_warning_pixmap, set_style_property, DynamicQThread, + qt_app_context, + get_asset_icon, ) from .models import ( @@ -24,10 +27,13 @@ __all__ = ( "PlaceholderLineEdit", "BaseClickableFrame", "ClickableFrame", + "ClickableLabel", "ExpandBtn", "PixmapLabel", "IconButton", + "DeselectableTreeView", + "ErrorMessageBox", "WrappedCallbackItem", @@ -35,6 +41,8 @@ __all__ = ( "get_warning_pixmap", "set_style_property", "DynamicQThread", + "qt_app_context", + "get_asset_icon", "RecursiveSortFilterProxyModel", ) diff --git a/openpype/tools/utils/assets_widget.py b/openpype/tools/utils/assets_widget.py index be9f442d10..3d4efcdd4d 100644 --- a/openpype/tools/utils/assets_widget.py +++ b/openpype/tools/utils/assets_widget.py @@ -3,11 +3,12 @@ import collections import Qt from Qt import QtWidgets, QtCore, QtGui +import qtawesome -from avalon import style -from avalon.vendor import qtawesome - -from openpype.style import get_objected_colors +from openpype.style import ( + get_objected_colors, + get_default_tools_icon_color, +) from openpype.tools.flickcharm import FlickCharm from .views import ( @@ -16,7 +17,10 @@ from .views import ( ) from .widgets import PlaceholderLineEdit from .models import RecursiveSortFilterProxyModel -from .lib import DynamicQThread +from .lib import ( + DynamicQThread, + get_asset_icon +) if Qt.__binding__ == "PySide": from PySide.QtGui import QStyleOptionViewItemV4 @@ -354,7 +358,6 @@ class AssetModel(QtGui.QStandardItemModel): Args: force (bool): Stop currently running refresh start new refresh. - clear (bool): Clear model before refresh thread starts. """ # Skip fetch if there is already other thread fetching documents if self._refreshing: @@ -509,25 +512,9 @@ class AssetModel(QtGui.QStandardItemModel): item.setData(asset_label, QtCore.Qt.DisplayRole) item.setData(asset_label, ASSET_LABEL_ROLE) - icon_color = asset_data.get("color") or style.colors.default - icon_name = asset_data.get("icon") - if not icon_name: - # Use default icons if no custom one is specified. - # If it has children show a full folder, otherwise - # show an open folder - if item.rowCount() > 0: - icon_name = "folder" - else: - icon_name = "folder-o" - - try: - # font-awesome key - full_icon_name = "fa.{0}".format(icon_name) - icon = qtawesome.icon(full_icon_name, color=icon_color) - item.setData(icon, QtCore.Qt.DecorationRole) - - except Exception: - pass + has_children = item.rowCount() > 0 + icon = get_asset_icon(asset_doc, has_children) + item.setData(icon, QtCore.Qt.DecorationRole) def _threaded_fetch(self): asset_docs = self._fetch_asset_docs() @@ -603,7 +590,7 @@ class AssetsWidget(QtWidgets.QWidget): view.setModel(proxy) current_asset_icon = qtawesome.icon( - "fa.arrow-down", color=style.colors.light + "fa.arrow-down", color=get_default_tools_icon_color() ) current_asset_btn = QtWidgets.QPushButton(self) current_asset_btn.setIcon(current_asset_icon) @@ -611,7 +598,9 @@ class AssetsWidget(QtWidgets.QWidget): # Hide by default current_asset_btn.setVisible(False) - refresh_icon = qtawesome.icon("fa.refresh", color=style.colors.light) + refresh_icon = qtawesome.icon( + "fa.refresh", color=get_default_tools_icon_color() + ) refresh_btn = QtWidgets.QPushButton(self) refresh_btn.setIcon(refresh_icon) refresh_btn.setToolTip("Refresh items") diff --git a/openpype/tools/utils/delegates.py b/openpype/tools/utils/delegates.py index 4ec6079bb7..d3718b1734 100644 --- a/openpype/tools/utils/delegates.py +++ b/openpype/tools/utils/delegates.py @@ -6,7 +6,7 @@ import numbers import Qt from Qt import QtWidgets, QtGui, QtCore -from avalon.lib import HeroVersionType +from openpype.pipeline import HeroVersionType from .models import TreeModel from . import lib diff --git a/openpype/tools/utils/host_tools.py b/openpype/tools/utils/host_tools.py index a7ad8fef3b..2d9733ec94 100644 --- a/openpype/tools/utils/host_tools.py +++ b/openpype/tools/utils/host_tools.py @@ -3,8 +3,9 @@ It is possible to create `HostToolsHelper` in host implementation or use singleton approach with global functions (using helper anyway). """ - +import os import avalon.api +import pyblish.api from .lib import qt_app_context @@ -196,28 +197,45 @@ class HostToolsHelper: library_loader_tool.refresh() def show_publish(self, parent=None): - """Publish UI.""" - from avalon.tools import publish + """Try showing the most desirable publish GUI - publish.show(parent) + This function cycles through the currently registered + graphical user interfaces, if any, and presents it to + the user. + """ + + pyblish_show = self._discover_pyblish_gui() + return pyblish_show(parent) + + def _discover_pyblish_gui(self): + """Return the most desirable of the currently registered GUIs""" + # Prefer last registered + guis = list(reversed(pyblish.api.registered_guis())) + for gui in guis: + try: + gui = __import__(gui).show + except (ImportError, AttributeError): + continue + else: + return gui + + 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: - import mayalookassigner + from openpype.tools.mayalookassigner import MayaLookAssignerWindow - mayalookassigner_window = mayalookassigner.App(parent) + 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.""" - from avalon import style with qt_app_context(): look_assigner_tool = self.get_look_assigner_tool(parent) look_assigner_tool.show() - look_assigner_tool.setStyleSheet(style.load_stylesheet()) def get_experimental_tools_dialog(self, parent=None): """Dialog of experimental tools. @@ -394,3 +412,11 @@ def show_publish(parent=None): def show_experimental_tools_dialog(parent=None): _SingletonPoint.show_tool_by_name("experimental_tools", parent) + + +def get_pyblish_icon(): + pyblish_dir = os.path.abspath(os.path.dirname(pyblish.api.__file__)) + icon_path = os.path.join(pyblish_dir, "icons", "logo-32x32.svg") + if os.path.exists(icon_path): + return icon_path + return None diff --git a/openpype/tools/utils/lib.py b/openpype/tools/utils/lib.py index 01b9e25ef3..93b156bef8 100644 --- a/openpype/tools/utils/lib.py +++ b/openpype/tools/utils/lib.py @@ -4,11 +4,11 @@ import contextlib import collections from Qt import QtWidgets, QtCore, QtGui +import qtawesome import avalon.api -from avalon import style -from avalon.vendor import qtawesome +from openpype.style import get_default_entity_icon_color from openpype.api import ( get_project_settings, Logger @@ -92,12 +92,104 @@ def qt_app_context(): yield app -# Backwards compatibility -application = qt_app_context - - class SharedObjects: jobs = {} + icons = {} + + +def get_qta_icon_by_name_and_color(icon_name, icon_color): + if not icon_name or not icon_color: + return None + + full_icon_name = "{0}-{1}".format(icon_name, icon_color) + if full_icon_name in SharedObjects.icons: + return SharedObjects.icons[full_icon_name] + + variants = [icon_name] + qta_instance = qtawesome._instance() + for key in qta_instance.charmap.keys(): + variants.append("{0}.{1}".format(key, icon_name)) + + icon = None + for variant in variants: + try: + icon = qtawesome.icon(variant, color=icon_color) + break + except Exception: + pass + + SharedObjects.icons[full_icon_name] = icon + return icon + + +def get_project_icon(project_doc): + if project_doc: + icon_name = project_doc.get("data", {}).get("icon") + icon = get_qta_icon_by_name_and_color(icon_name, "white") + if icon: + return icon + + return get_qta_icon_by_name_and_color( + "fa.map", get_default_entity_icon_color() + ) + + +def get_asset_icon_name(asset_doc, has_children=True): + icon_name = asset_doc["data"].get("icon") + if icon_name: + return icon_name + + if has_children: + return "folder" + return "folder-o" + + +def get_asset_icon_color(asset_doc): + icon_color = asset_doc["data"].get("color") + if icon_color: + return icon_color + return get_default_entity_icon_color() + + +def get_asset_icon(asset_doc, has_children=False): + icon_name = get_asset_icon_name(asset_doc, has_children) + icon_color = get_asset_icon_color(asset_doc) + + return get_qta_icon_by_name_and_color(icon_name, icon_color) + + +def get_default_task_icon(color=None): + if color is None: + color = get_default_entity_icon_color() + return get_qta_icon_by_name_and_color("fa.male", color) + + +def get_task_icon(project_doc, asset_doc, task_name): + """Get icon for a task. + + Icon should be defined by task type which is stored on project. + """ + + color = get_default_entity_icon_color() + + tasks_info = asset_doc.get("data", {}).get("tasks") or {} + task_info = tasks_info.get(task_name) or {} + task_icon = task_info.get("icon") + if task_icon: + icon = get_qta_icon_by_name_and_color(task_icon, color) + if icon is not None: + return icon + + task_type = task_info.get("type") + task_types = project_doc["config"]["tasks"] + + task_type_info = task_types.get(task_type) or {} + task_type_icon = task_type_info.get("icon") + if task_type_icon: + icon = get_qta_icon_by_name_and_color(task_icon, color) + if icon is not None: + return icon + return get_default_task_icon(color) def schedule(func, time, channel="default"): @@ -360,6 +452,7 @@ class GroupsConfig: def __init__(self, dbcon): self.dbcon = dbcon self.groups = {} + self._default_group_color = get_default_entity_icon_color() @classmethod def default_group_config(cls): @@ -367,7 +460,7 @@ class GroupsConfig: cls._default_group_config = { "icon": qtawesome.icon( "fa.object-group", - color=style.colors.default + color=get_default_entity_icon_color() ), "order": 0 } @@ -401,7 +494,7 @@ class GroupsConfig: for config in group_configs: name = config["name"] icon = "fa." + config.get("icon", "object-group") - color = config.get("color", style.colors.default) + color = config.get("color", self._default_group_color) order = float(config.get("order", 0)) self.groups[name] = { diff --git a/openpype/tools/utils/tasks_widget.py b/openpype/tools/utils/tasks_widget.py index 6c7787d06a..eab183d5f3 100644 --- a/openpype/tools/utils/tasks_widget.py +++ b/openpype/tools/utils/tasks_widget.py @@ -1,7 +1,8 @@ from Qt import QtWidgets, QtCore, QtGui +import qtawesome -from avalon import style -from avalon.vendor import qtawesome +from openpype.style import get_disabled_entity_icon_color +from openpype.tools.utils.lib import get_task_icon from .views import DeselectableTreeView @@ -9,63 +10,47 @@ from .views import DeselectableTreeView TASK_NAME_ROLE = QtCore.Qt.UserRole + 1 TASK_TYPE_ROLE = QtCore.Qt.UserRole + 2 TASK_ORDER_ROLE = QtCore.Qt.UserRole + 3 +TASK_ASSIGNEE_ROLE = QtCore.Qt.UserRole + 4 class TasksModel(QtGui.QStandardItemModel): """A model listing the tasks combined for a list of assets""" + def __init__(self, dbcon, parent=None): super(TasksModel, self).__init__(parent=parent) self.dbcon = dbcon self.setHeaderData( 0, QtCore.Qt.Horizontal, "Tasks", QtCore.Qt.DisplayRole ) - self._default_icon = qtawesome.icon( - "fa.male", - color=style.colors.default - ) + self._no_tasks_icon = qtawesome.icon( "fa.exclamation-circle", - color=style.colors.mid + color=get_disabled_entity_icon_color() ) self._cached_icons = {} - self._project_task_types = {} + self._project_doc = {} self._empty_tasks_item = None self._last_asset_id = None self._loaded_project_name = None def _context_is_valid(self): - if self.dbcon.Session.get("AVALON_PROJECT"): + if self._get_current_project(): return True return False def refresh(self): - self._refresh_task_types() + self._refresh_project_doc() self.set_asset_id(self._last_asset_id) - def _refresh_task_types(self): + def _refresh_project_doc(self): # Get the project configured icons from database - task_types = {} + project_doc = {} if self._context_is_valid(): - project = self.dbcon.find_one( - {"type": "project"}, - {"config.tasks"} - ) - task_types = project["config"].get("tasks") or task_types - self._project_task_types = task_types + project_doc = self.dbcon.find_one({"type": "project"}) - def _try_get_awesome_icon(self, icon_name): - icon = None - if icon_name: - try: - icon = qtawesome.icon( - "fa.{}".format(icon_name), - color=style.colors.default - ) - - except Exception: - pass - return icon + self._loaded_project_name = self._get_current_project() + self._project_doc = project_doc def headerData(self, section, orientation, role=None): if role is None: @@ -80,28 +65,8 @@ class TasksModel(QtGui.QStandardItemModel): return super(TasksModel, self).headerData(section, orientation, role) - def _get_icon(self, task_icon, task_type_icon): - if task_icon in self._cached_icons: - return self._cached_icons[task_icon] - - icon = self._try_get_awesome_icon(task_icon) - if icon is not None: - self._cached_icons[task_icon] = icon - return icon - - if task_type_icon in self._cached_icons: - icon = self._cached_icons[task_type_icon] - self._cached_icons[task_icon] = icon - return icon - - icon = self._try_get_awesome_icon(task_type_icon) - if icon is None: - icon = self._default_icon - - self._cached_icons[task_icon] = icon - self._cached_icons[task_type_icon] = icon - - return icon + def _get_current_project(self): + return self.dbcon.Session.get("AVALON_PROJECT") def set_asset_id(self, asset_id): asset_doc = None @@ -126,6 +91,9 @@ class TasksModel(QtGui.QStandardItemModel): Arguments: asset_doc (dict): Asset document from MongoDB. """ + if self._loaded_project_name != self._get_current_project(): + self._refresh_project_doc() + asset_tasks = {} self._last_asset_id = None if asset_doc: @@ -136,19 +104,25 @@ class TasksModel(QtGui.QStandardItemModel): root_item.removeRows(0, root_item.rowCount()) items = [] + for task_name, task_info in asset_tasks.items(): - task_icon = task_info.get("icon") task_type = task_info.get("type") task_order = task_info.get("order") - task_type_info = self._project_task_types.get(task_type) or {} - task_type_icon = task_type_info.get("icon") - icon = self._get_icon(task_icon, task_type_icon) + icon = get_task_icon(self._project_doc, asset_doc, task_name) + + task_assignees = set() + assignees_data = task_info.get("assignees") or [] + for assignee in assignees_data: + username = assignee.get("username") + if username: + task_assignees.add(username) label = "{} ({})".format(task_name, task_type or "type N/A") item = QtGui.QStandardItem(label) item.setData(task_name, TASK_NAME_ROLE) item.setData(task_type, TASK_TYPE_ROLE) item.setData(task_order, TASK_ORDER_ROLE) + item.setData(task_assignees, TASK_ASSIGNEE_ROLE) item.setData(icon, QtCore.Qt.DecorationRole) item.setFlags(QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable) items.append(item) diff --git a/openpype/tools/utils/views.py b/openpype/tools/utils/views.py index 97aaf622a4..a2f1f15b95 100644 --- a/openpype/tools/utils/views.py +++ b/openpype/tools/utils/views.py @@ -1,5 +1,5 @@ import os -from avalon import style +from openpype.resources import get_image_path from Qt import QtWidgets, QtCore, QtGui, QtSvg @@ -24,11 +24,8 @@ class TreeViewSpinner(QtWidgets.QTreeView): def __init__(self, parent=None): super(TreeViewSpinner, self).__init__(parent=parent) - loading_image_path = os.path.join( - os.path.dirname(os.path.abspath(style.__file__)), - "svg", - "spinner-200.svg" - ) + loading_image_path = get_image_path("spinner-200.svg") + self.spinner = QtSvg.QSvgRenderer(loading_image_path) self.is_loading = False diff --git a/openpype/tools/utils/widgets.py b/openpype/tools/utils/widgets.py index c62b838231..d5ae909be8 100644 --- a/openpype/tools/utils/widgets.py +++ b/openpype/tools/utils/widgets.py @@ -1,8 +1,8 @@ import logging from Qt import QtWidgets, QtCore, QtGui - -from avalon.vendor import qtawesome, qargparse +import qargparse +import qtawesome from openpype.style import ( get_objected_colors, get_style_image_path @@ -63,6 +63,29 @@ class ClickableFrame(BaseClickableFrame): self.clicked.emit() +class ClickableLabel(QtWidgets.QLabel): + """Label that catch left mouse click and can trigger 'clicked' signal.""" + clicked = QtCore.Signal() + + def __init__(self, parent): + super(ClickableLabel, self).__init__(parent) + + self._mouse_pressed = False + + def mousePressEvent(self, event): + if event.button() == QtCore.Qt.LeftButton: + self._mouse_pressed = True + super(ClickableLabel, self).mousePressEvent(event) + + def mouseReleaseEvent(self, event): + if self._mouse_pressed: + self._mouse_pressed = False + if self.rect().contains(event.pos()): + self.clicked.emit() + + super(ClickableLabel, self).mouseReleaseEvent(event) + + class ExpandBtnLabel(QtWidgets.QLabel): """Label showing expand icon meant for ExpandBtn.""" def __init__(self, parent): diff --git a/openpype/tools/workfiles/app.py b/openpype/tools/workfiles/app.py index 4b5bf07b47..63958ac57b 100644 --- a/openpype/tools/workfiles/app.py +++ b/openpype/tools/workfiles/app.py @@ -9,10 +9,9 @@ import datetime import Qt from Qt import QtWidgets, QtCore -from avalon import io, api, pipeline +from avalon import io, api from openpype import style -from openpype.pipeline.lib import BeforeWorkfileSave from openpype.tools.utils.lib import ( qt_app_context ) @@ -21,6 +20,7 @@ from openpype.tools.utils.assets_widget import SingleSelectAssetsWidget from openpype.tools.utils.tasks_widget import TasksWidget from openpype.tools.utils.delegates import PrettyTimeDelegate from openpype.lib import ( + emit_event, Anatomy, get_workfile_doc, create_workfile_doc, @@ -29,6 +29,10 @@ from openpype.lib import ( create_workdir_extra_folders, get_system_general_anatomy_data ) +from openpype.lib.avalon_context import ( + update_current_task, + compute_session_changes +) from .model import FilesModel from .view import FilesView @@ -667,7 +671,7 @@ class FilesWidget(QtWidgets.QWidget): session["AVALON_APP"], project_name=session["AVALON_PROJECT"] ) - changes = pipeline.compute_session_changes( + changes = compute_session_changes( session, asset=self._get_asset_doc(), task=self._task_name, @@ -681,7 +685,7 @@ class FilesWidget(QtWidgets.QWidget): """Enter the asset and task session currently selected""" session = api.Session.copy() - changes = pipeline.compute_session_changes( + changes = compute_session_changes( session, asset=self._get_asset_doc(), task=self._task_name, @@ -692,7 +696,7 @@ class FilesWidget(QtWidgets.QWidget): # to avoid any unwanted Task Changed callbacks to be triggered. return - api.update_current_task( + update_current_task( asset=self._get_asset_doc(), task=self._task_name, template_key=self.template_key @@ -726,9 +730,9 @@ class FilesWidget(QtWidgets.QWidget): self.file_opened.emit() def save_changes_prompt(self): - self._messagebox = messagebox = QtWidgets.QMessageBox() - - messagebox.setWindowFlags(QtCore.Qt.FramelessWindowHint) + self._messagebox = messagebox = QtWidgets.QMessageBox(parent=self) + messagebox.setWindowFlags(messagebox.windowFlags() | + QtCore.Qt.FramelessWindowHint) messagebox.setIcon(messagebox.Warning) messagebox.setWindowTitle("Unsaved Changes!") messagebox.setText( @@ -739,10 +743,6 @@ class FilesWidget(QtWidgets.QWidget): messagebox.Yes | messagebox.No | messagebox.Cancel ) - # Parenting the QMessageBox to the Widget seems to crash - # so we skip parenting and explicitly apply the stylesheet. - messagebox.setStyle(self.style()) - result = messagebox.exec_() if result == messagebox.Yes: return True @@ -823,7 +823,11 @@ class FilesWidget(QtWidgets.QWidget): return # Trigger before save event - BeforeWorkfileSave.emit(work_filename, self._workdir_path) + emit_event( + "workfile.save.before", + {"filename": work_filename, "workdir_path": self._workdir_path}, + source="workfiles.tool" + ) # Make sure workfiles root is updated # - this triggers 'workio.work_root(...)' which may change value of @@ -853,7 +857,11 @@ class FilesWidget(QtWidgets.QWidget): api.Session["AVALON_PROJECT"] ) # Trigger after save events - pipeline.emit("after.workfile.save", [filepath]) + emit_event( + "workfile.save.after", + {"filename": work_filename, "workdir_path": self._workdir_path}, + source="workfiles.tool" + ) self.workfile_created.emit(filepath) # Refresh files model diff --git a/openpype/tools/workfiles/model.py b/openpype/tools/workfiles/model.py index 583f495606..e9184842fc 100644 --- a/openpype/tools/workfiles/model.py +++ b/openpype/tools/workfiles/model.py @@ -1,11 +1,15 @@ import os import logging -from Qt import QtCore, QtGui +from Qt import QtCore +import qtawesome -from avalon import style -from avalon.vendor import qtawesome -from avalon.tools.models import TreeModel, Item +from openpype.style import ( + get_default_entity_icon_color, + get_disabled_entity_icon_color, +) + +from openpype.tools.utils.models import TreeModel, Item log = logging.getLogger(__name__) @@ -25,7 +29,10 @@ class FilesModel(TreeModel): self._root = None self._file_extensions = file_extensions self._icons = { - "file": qtawesome.icon("fa.file-o", color=style.colors.default) + "file": qtawesome.icon( + "fa.file-o", + color=get_default_entity_icon_color() + ) } def set_root(self, root): @@ -64,7 +71,10 @@ class FilesModel(TreeModel): "date": None, "filepath": None, "enabled": False, - "icon": qtawesome.icon("fa.times", color=style.colors.mid) + "icon": qtawesome.icon( + "fa.times", + color=get_disabled_entity_icon_color() + ) }) self.add_child(item) self.endResetModel() diff --git a/openpype/vendor/python/common/qargparse.py b/openpype/vendor/python/common/qargparse.py new file mode 100644 index 0000000000..ebde9ae76d --- /dev/null +++ b/openpype/vendor/python/common/qargparse.py @@ -0,0 +1,817 @@ +""" +NOTE: The required `Qt` module has changed to use the one that vendorized. + Remember to change to relative import when updating this. +""" + +import re +import logging + +from collections import OrderedDict as odict +from Qt import QtCore, QtWidgets, QtGui +import qtawesome + +__version__ = "0.5.2" +_log = logging.getLogger(__name__) +_type = type # used as argument + +try: + # Python 2 + _basestring = basestring +except NameError: + _basestring = str + + +class QArgumentParser(QtWidgets.QWidget): + """User interface arguments + + Arguments: + arguments (list, optional): Instances of QArgument + description (str, optional): Long-form text of what this parser is for + storage (QSettings, optional): Persistence to disk, providing + value() and setValue() methods + + """ + + changed = QtCore.Signal(QtCore.QObject) # A QArgument + + def __init__(self, + arguments=None, + description=None, + storage=None, + parent=None): + super(QArgumentParser, self).__init__(parent) + self.setAttribute(QtCore.Qt.WA_StyledBackground) + + # Create internal settings + if storage is True: + storage = QtCore.QSettings( + QtCore.QSettings.IniFormat, + QtCore.QSettings.UserScope, + __name__, "QArgparse", + ) + + if storage is not None: + _log.info("Storing settings @ %s" % storage.fileName()) + + arguments = arguments or [] + + assert hasattr(arguments, "__iter__"), "arguments must be iterable" + assert isinstance(storage, (type(None), QtCore.QSettings)), ( + "storage must be of type QSettings" + ) + + layout = QtWidgets.QGridLayout(self) + layout.setRowStretch(999, 1) + + if description: + layout.addWidget(QtWidgets.QLabel(description), 0, 0, 1, 2) + + self._row = 1 + self._storage = storage + self._arguments = odict() + self._desciption = description + + for arg in arguments or []: + self._addArgument(arg) + + self.setStyleSheet(style) + + def setDescription(self, text): + self._desciption.setText(text) + + def addArgument(self, name, type=None, default=None, **kwargs): + # Infer type from default + if type is None and default is not None: + type = _type(default) + + # Default to string + type = type or str + + Argument = { + None: String, + int: Integer, + float: Float, + bool: Boolean, + str: String, + list: Enum, + tuple: Enum, + }.get(type, type) + + arg = Argument(name, default=default, **kwargs) + self._addArgument(arg) + return arg + + def _addArgument(self, arg): + if arg["name"] in self._arguments: + raise ValueError("Duplicate argument '%s'" % arg["name"]) + + if self._storage is not None: + default = self._storage.value(arg["name"]) + + if default: + if isinstance(arg, Boolean): + default = bool({ + None: QtCore.Qt.Unchecked, + + 0: QtCore.Qt.Unchecked, + 1: QtCore.Qt.Checked, + 2: QtCore.Qt.Checked, + + "0": QtCore.Qt.Unchecked, + "1": QtCore.Qt.Checked, + "2": QtCore.Qt.Checked, + + # May be stored as string, if used with IniFormat + "false": QtCore.Qt.Unchecked, + "true": QtCore.Qt.Checked, + }.get(default)) + + arg["default"] = default + + arg.changed.connect(lambda: self.on_changed(arg)) + + label = ( + QtWidgets.QLabel(arg["label"]) + if arg.label + else QtWidgets.QLabel() + ) + widget = arg.create() + icon = qtawesome.icon("fa.refresh", color="white") + reset = QtWidgets.QPushButton(icon, "") # default + reset.setToolTip("Reset") + reset.setProperty("type", "reset") + reset.clicked.connect(lambda: self.on_reset(arg)) + + # Shown on edit + reset.hide() + + for widget in (label, widget): + widget.setToolTip(arg["help"]) + widget.setObjectName(arg["name"]) # useful in CSS + widget.setProperty("type", type(arg).__name__) + widget.setAttribute(QtCore.Qt.WA_StyledBackground) + widget.setEnabled(arg["enabled"]) + + # Align label on top of row if widget is over two times heiger + height = (lambda w: w.sizeHint().height()) + label_on_top = height(label) * 2 < height(widget) + alignment = (QtCore.Qt.AlignTop,) if label_on_top else () + + layout = self.layout() + layout.addWidget(label, self._row, 0, *alignment) + layout.addWidget(widget, self._row, 1) + layout.addWidget(reset, self._row, 2, *alignment) + layout.setColumnStretch(1, 1) + + def on_changed(*_): + reset.setVisible(arg["edited"]) + + arg.changed.connect(on_changed) + + self._row += 1 + self._arguments[arg["name"]] = arg + + def clear(self): + assert self._storage, "Cannot clear without persistent storage" + self._storage.clear() + _log.info("Clearing settings @ %s" % self._storage.fileName()) + + def find(self, name): + return self._arguments[name] + + def on_reset(self, arg): + arg.write(arg["default"]) + + def on_changed(self, arg): + arg["edited"] = arg.read() != arg["default"] + self.changed.emit(arg) + + # Optional PEP08 syntax + add_argument = addArgument + + +class QArgument(QtCore.QObject): + """Base class of argument user interface + """ + changed = QtCore.Signal() + + # Provide a left-hand side label for this argument + label = True + # For defining default value for each argument type + default = None + + def __init__(self, name, default=None, **kwargs): + super(QArgument, self).__init__(kwargs.pop("parent", None)) + + kwargs["name"] = name + kwargs["label"] = kwargs.get("label", camel_to_title(name)) + kwargs["default"] = self.default if default is None else default + kwargs["help"] = kwargs.get("help", "") + kwargs["read"] = kwargs.get("read") + kwargs["write"] = kwargs.get("write") + kwargs["enabled"] = bool(kwargs.get("enabled", True)) + kwargs["edited"] = False + + self._data = kwargs + + def __str__(self): + return self["name"] + + def __repr__(self): + return "%s(\"%s\")" % (type(self).__name__, self["name"]) + + def __getitem__(self, key): + return self._data[key] + + def __setitem__(self, key, value): + self._data[key] = value + + def __eq__(self, other): + if isinstance(other, _basestring): + return self["name"] == other + return super(QArgument, self).__eq__(other) + + def __ne__(self, other): + return not self.__eq__(other) + + def create(self): + return QtWidgets.QWidget() + + def read(self): + return self._read() + + def write(self, value): + self._write(value) + self.changed.emit() + + +class Boolean(QArgument): + """Boolean type user interface + + Presented by `QtWidgets.QCheckBox`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + default (bool, optional): Argument's default value, default None + enabled (bool, optional): Whether to enable this widget, default True + + """ + def create(self): + widget = QtWidgets.QCheckBox() + widget.clicked.connect(self.changed.emit) + + if isinstance(self, Tristate): + self._read = lambda: widget.checkState() + state = { + 0: QtCore.Qt.Unchecked, + 1: QtCore.Qt.PartiallyChecked, + 2: QtCore.Qt.Checked, + "1": QtCore.Qt.PartiallyChecked, + "0": QtCore.Qt.Unchecked, + "2": QtCore.Qt.Checked, + } + else: + self._read = lambda: bool(widget.checkState()) + state = { + None: QtCore.Qt.Unchecked, + + 0: QtCore.Qt.Unchecked, + 1: QtCore.Qt.Checked, + 2: QtCore.Qt.Checked, + + "0": QtCore.Qt.Unchecked, + "1": QtCore.Qt.Checked, + "2": QtCore.Qt.Checked, + + # May be stored as string, if used with QSettings(..IniFormat) + "false": QtCore.Qt.Unchecked, + "true": QtCore.Qt.Checked, + } + + self._write = lambda value: widget.setCheckState(state[value]) + widget.clicked.connect(self.changed.emit) + + if self["default"] is not None: + self._write(self["default"]) + + return widget + + def read(self): + return self._read() + + +class Tristate(QArgument): + """Not implemented""" + + +class Number(QArgument): + """Base class of numeric type user interface""" + default = 0 + + def create(self): + if isinstance(self, Float): + widget = QtWidgets.QDoubleSpinBox() + widget.setMinimum(self._data.get("min", 0.0)) + widget.setMaximum(self._data.get("max", 99.99)) + else: + widget = QtWidgets.QSpinBox() + widget.setMinimum(self._data.get("min", 0)) + widget.setMaximum(self._data.get("max", 99)) + + widget.editingFinished.connect(self.changed.emit) + self._read = lambda: widget.value() + self._write = lambda value: widget.setValue(value) + + if self["default"] != self.default: + self._write(self["default"]) + + return widget + + +class Integer(Number): + """Integer type user interface + + A subclass of `qargparse.Number`, presented by `QtWidgets.QSpinBox`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + default (int, optional): Argument's default value, default 0 + min (int, optional): Argument's minimum value, default 0 + max (int, optional): Argument's maximum value, default 99 + enabled (bool, optional): Whether to enable this widget, default True + + """ + + +class Float(Number): + """Float type user interface + + A subclass of `qargparse.Number`, presented by `QtWidgets.QDoubleSpinBox`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + default (float, optional): Argument's default value, default 0.0 + min (float, optional): Argument's minimum value, default 0.0 + max (float, optional): Argument's maximum value, default 99.99 + enabled (bool, optional): Whether to enable this widget, default True + + """ + + +class Range(Number): + """Range type user interface + + A subclass of `qargparse.Number`, not production ready. + + """ + + +class Double3(QArgument): + """Double3 type user interface + + Presented by three `QtWidgets.QLineEdit` widget with `QDoubleValidator` + installed. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + default (tuple or list, optional): Default (0, 0, 0). + enabled (bool, optional): Whether to enable this widget, default True + + """ + default = (0, 0, 0) + + def create(self): + widget = QtWidgets.QWidget() + layout = QtWidgets.QHBoxLayout(widget) + layout.setContentsMargins(0, 0, 0, 0) + x, y, z = (self.child_arg(layout, i) for i in range(3)) + + self._read = lambda: ( + float(x.text()), float(y.text()), float(z.text())) + self._write = lambda value: [ + w.setText(str(float(v))) for w, v in zip([x, y, z], value)] + + if self["default"] != self.default: + self._write(self["default"]) + + return widget + + def child_arg(self, layout, index): + widget = QtWidgets.QLineEdit() + widget.setValidator(QtGui.QDoubleValidator()) + + default = str(float(self["default"][index])) + widget.setText(default) + + def focusOutEvent(event): + if not widget.text(): + widget.setText(default) # Ensure value exists for `_read` + QtWidgets.QLineEdit.focusOutEvent(widget, event) + widget.focusOutEvent = focusOutEvent + + widget.editingFinished.connect(self.changed.emit) + widget.returnPressed.connect(widget.editingFinished.emit) + + layout.addWidget(widget) + + return widget + + +class String(QArgument): + """String type user interface + + Presented by `QtWidgets.QLineEdit`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + default (str, optional): Argument's default value, default None + placeholder (str, optional): Placeholder message for the widget + enabled (bool, optional): Whether to enable this widget, default True + + """ + def __init__(self, *args, **kwargs): + super(String, self).__init__(*args, **kwargs) + self._previous = None + + def create(self): + widget = QtWidgets.QLineEdit() + widget.editingFinished.connect(self.onEditingFinished) + widget.returnPressed.connect(widget.editingFinished.emit) + self._read = lambda: widget.text() + self._write = lambda value: widget.setText(value) + + if isinstance(self, Info): + widget.setReadOnly(True) + widget.setPlaceholderText(self._data.get("placeholder", "")) + + if self["default"] is not None: + self._write(self["default"]) + self._previous = self["default"] + + return widget + + def onEditingFinished(self): + current = self._read() + + if current != self._previous: + self.changed.emit() + self._previous = current + + +class Info(String): + """String type user interface but read-only + + A subclass of `qargparse.String`, presented by `QtWidgets.QLineEdit`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + default (str, optional): Argument's default value, default None + enabled (bool, optional): Whether to enable this widget, default True + + """ + + +class Color(String): + """Color type user interface + + A subclass of `qargparse.String`, not production ready. + + """ + + +class Button(QArgument): + """Button type user interface + + Presented by `QtWidgets.QPushButton`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + default (bool, optional): Argument's default value, default None + enabled (bool, optional): Whether to enable this widget, default True + + """ + label = False + + def create(self): + widget = QtWidgets.QPushButton(self["label"]) + widget.clicked.connect(self.changed.emit) + + state = [ + QtCore.Qt.Unchecked, + QtCore.Qt.Checked, + ] + + if isinstance(self, Toggle): + widget.setCheckable(True) + if hasattr(widget, "isChecked"): + self._read = lambda: state[int(widget.isChecked())] + self._write = ( + lambda value: widget.setChecked(value) + ) + else: + self._read = lambda: widget.checkState() + self._write = ( + lambda value: widget.setCheckState(state[int(value)]) + ) + else: + self._read = lambda: "clicked" + self._write = lambda value: None + + if self["default"] is not None: + self._write(self["default"]) + + return widget + + +class Toggle(Button): + """Checkable `Button` type user interface + + Presented by `QtWidgets.QPushButton`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + default (bool, optional): Argument's default value, default None + enabled (bool, optional): Whether to enable this widget, default True + + """ + + +class InfoList(QArgument): + """String list type user interface + + Presented by `QtWidgets.QListView`, not production ready. + + """ + def __init__(self, name, **kwargs): + kwargs["default"] = kwargs.pop("default", ["Empty"]) + super(InfoList, self).__init__(name, **kwargs) + + def create(self): + class Model(QtCore.QStringListModel): + def data(self, index, role): + return super(Model, self).data(index, role) + + model = QtCore.QStringListModel(self["default"]) + widget = QtWidgets.QListView() + widget.setModel(model) + widget.setEditTriggers(widget.NoEditTriggers) + + self._read = lambda: model.stringList() + self._write = lambda value: model.setStringList(value) + + return widget + + +class Choice(QArgument): + """Argument user interface for selecting one from list + + Presented by `QtWidgets.QListView`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + items (list, optional): List of strings for select, default `["Empty"]` + default (str, optional): Default item in `items`, use first of `items` + if not given. + enabled (bool, optional): Whether to enable this widget, default True + + """ + def __init__(self, name, **kwargs): + kwargs["items"] = kwargs.get("items", ["Empty"]) + kwargs["default"] = kwargs.pop("default", kwargs["items"][0]) + super(Choice, self).__init__(name, **kwargs) + + def index(self, value): + """Return numerical equivalent to self.read()""" + return self["items"].index(value) + + def create(self): + def on_changed(selected, deselected): + try: + selected = selected.indexes()[0] + except IndexError: + # At least one item must be selected at all times + selected = deselected.indexes()[0] + + value = selected.data(QtCore.Qt.DisplayRole) + set_current(value) + self.changed.emit() + + def set_current(current): + options = model.stringList() + + if current == "Empty": + index = 0 + else: + for index, member in enumerate(options): + if member == current: + break + else: + raise ValueError( + "%s not a member of %s" % (current, options) + ) + + qindex = model.index(index, 0, QtCore.QModelIndex()) + smodel.setCurrentIndex(qindex, smodel.ClearAndSelect) + self["current"] = options[index] + + def reset(items, default=None): + items = items or ["Empty"] + model.setStringList(items) + set_current(default or items[0]) + + model = QtCore.QStringListModel() + widget = QtWidgets.QListView() + widget.setModel(model) + widget.setEditTriggers(widget.NoEditTriggers) + widget.setSelectionMode(widget.SingleSelection) + smodel = widget.selectionModel() + smodel.selectionChanged.connect(on_changed) + + self._read = lambda: self["current"] + self._write = lambda value: set_current(value) + self.reset = reset + + reset(self["items"], self["default"]) + + return widget + + +class Separator(QArgument): + """Visual separator + + Example: + + item1 + item2 + ------------ + item3 + item4 + + """ + + def create(self): + widget = QtWidgets.QWidget() + + self._read = lambda: None + self._write = lambda value: None + + return widget + + +class Enum(QArgument): + """Argument user interface for selecting one from dropdown list + + Presented by `QtWidgets.QComboBox`. + + Arguments: + name (str): The name of argument + label (str, optional): Display name, convert from `name` if not given + help (str, optional): Tool tip message of this argument + items (list, optional): List of strings for select, default `[]` + default (int, optional): Index of default item, use first of `items` + if not given. + enabled (bool, optional): Whether to enable this widget, default True + + """ + def __init__(self, name, **kwargs): + kwargs["default"] = kwargs.pop("default", 0) + kwargs["items"] = kwargs.get("items", []) + + assert isinstance(kwargs["items"], (tuple, list)), ( + "items must be list" + ) + + super(Enum, self).__init__(name, **kwargs) + + def create(self): + widget = QtWidgets.QComboBox() + widget.addItems(self["items"]) + widget.currentIndexChanged.connect( + lambda index: self.changed.emit()) + + self._read = lambda: widget.currentText() + self._write = lambda value: widget.setCurrentIndex(value) + + if self["default"] is not None: + self._write(self["default"]) + + return widget + + +style = """\ +QWidget { + /* Explicitly specify a size, to account for automatic HDPi */ + font-size: 11px; +} + +*[type="Button"] { + text-align:left; +} + +*[type="Info"] { + background: transparent; + border: none; +} + +QLabel[type="Separator"] { + min-height: 20px; + text-decoration: underline; +} + +QPushButton[type="reset"] { + max-width: 11px; + max-height: 11px; +} + +""" + + +def camelToTitle(text): + """Convert camelCase `text` to Title Case + + Example: + >>> camelToTitle("mixedCase") + "Mixed Case" + >>> camelToTitle("myName") + "My Name" + >>> camelToTitle("you") + "You" + >>> camelToTitle("You") + "You" + >>> camelToTitle("This is That") + "This Is That" + + """ + + return re.sub( + r"((?<=[a-z])[A-Z]|(?= 3 + except: + import thread as _thread # Python < 3 + except ImportError: + import _dummy_thread as _thread + +""" +# Exports only things specified by thread documentation; +# skipping obsolete synonyms allocate(), start_new(), exit_thread(). +__all__ = ['error', 'start_new_thread', 'exit', 'get_ident', 'allocate_lock', + 'interrupt_main', 'LockType'] + +# A dummy value +TIMEOUT_MAX = 2**31 + +# NOTE: this module can be imported early in the extension building process, +# and so top level imports of other modules should be avoided. Instead, all +# imports are done when needed on a function-by-function basis. Since threads +# are disabled, the import lock should not be an issue anyway (??). + +class error(Exception): + """Dummy implementation of _thread.error.""" + + def __init__(self, *args): + self.args = args + +def start_new_thread(function, args, kwargs={}): + """Dummy implementation of _thread.start_new_thread(). + + Compatibility is maintained by making sure that ``args`` is a + tuple and ``kwargs`` is a dictionary. If an exception is raised + and it is SystemExit (which can be done by _thread.exit()) it is + caught and nothing is done; all other exceptions are printed out + by using traceback.print_exc(). + + If the executed function calls interrupt_main the KeyboardInterrupt will be + raised when the function returns. + + """ + if type(args) != type(tuple()): + raise TypeError("2nd arg must be a tuple") + if type(kwargs) != type(dict()): + raise TypeError("3rd arg must be a dict") + global _main + _main = False + try: + function(*args, **kwargs) + except SystemExit: + pass + except: + import traceback + traceback.print_exc() + _main = True + global _interrupt + if _interrupt: + _interrupt = False + raise KeyboardInterrupt + +def exit(): + """Dummy implementation of _thread.exit().""" + raise SystemExit + +def get_ident(): + """Dummy implementation of _thread.get_ident(). + + Since this module should only be used when _threadmodule is not + available, it is safe to assume that the current process is the + only thread. Thus a constant can be safely returned. + """ + return -1 + +def allocate_lock(): + """Dummy implementation of _thread.allocate_lock().""" + return LockType() + +def stack_size(size=None): + """Dummy implementation of _thread.stack_size().""" + if size is not None: + raise error("setting thread stack size not supported") + return 0 + +class LockType(object): + """Class implementing dummy implementation of _thread.LockType. + + Compatibility is maintained by maintaining self.locked_status + which is a boolean that stores the state of the lock. Pickling of + the lock, though, should not be done since if the _thread module is + then used with an unpickled ``lock()`` from here problems could + occur from this class not having atomic methods. + + """ + + def __init__(self): + self.locked_status = False + + def acquire(self, waitflag=None, timeout=-1): + """Dummy implementation of acquire(). + + For blocking calls, self.locked_status is automatically set to + True and returned appropriately based on value of + ``waitflag``. If it is non-blocking, then the value is + actually checked and not set if it is already acquired. This + is all done so that threading.Condition's assert statements + aren't triggered and throw a little fit. + + """ + if waitflag is None or waitflag: + self.locked_status = True + return True + else: + if not self.locked_status: + self.locked_status = True + return True + else: + if timeout > 0: + import time + time.sleep(timeout) + return False + + __enter__ = acquire + + def __exit__(self, typ, val, tb): + self.release() + + def release(self): + """Release the dummy lock.""" + # XXX Perhaps shouldn't actually bother to test? Could lead + # to problems for complex, threaded code. + if not self.locked_status: + raise error + self.locked_status = False + return True + + def locked(self): + return self.locked_status + +# Used to signal that interrupt_main was called in a "thread" +_interrupt = False +# True when not executing in a "thread" +_main = True + +def interrupt_main(): + """Set _interrupt flag to True to have start_new_thread raise + KeyboardInterrupt upon exiting.""" + if _main: + raise KeyboardInterrupt + else: + global _interrupt + _interrupt = True diff --git a/openpype/vendor/python/python_2/functools32/functools32.py b/openpype/vendor/python/python_2/functools32/functools32.py new file mode 100644 index 0000000000..c44551fac0 --- /dev/null +++ b/openpype/vendor/python/python_2/functools32/functools32.py @@ -0,0 +1,423 @@ +"""functools.py - Tools for working with functions and callable objects +""" +# Python module wrapper for _functools C module +# to allow utilities written in Python to be added +# to the functools module. +# Written by Nick Coghlan +# and Raymond Hettinger +# Copyright (C) 2006-2010 Python Software Foundation. +# See C source code for _functools credits/copyright + +__all__ = ['update_wrapper', 'wraps', 'WRAPPER_ASSIGNMENTS', 'WRAPPER_UPDATES', + 'total_ordering', 'cmp_to_key', 'lru_cache', 'reduce', 'partial'] + +from _functools import partial, reduce +from collections import MutableMapping, namedtuple +from .reprlib32 import recursive_repr as _recursive_repr +from weakref import proxy as _proxy +import sys as _sys +try: + from thread import allocate_lock as Lock +except ImportError: + from ._dummy_thread32 import allocate_lock as Lock + +################################################################################ +### OrderedDict +################################################################################ + +class _Link(object): + __slots__ = 'prev', 'next', 'key', '__weakref__' + +class OrderedDict(dict): + 'Dictionary that remembers insertion order' + # An inherited dict maps keys to values. + # The inherited dict provides __getitem__, __len__, __contains__, and get. + # The remaining methods are order-aware. + # Big-O running times for all methods are the same as regular dictionaries. + + # The internal self.__map dict maps keys to links in a doubly linked list. + # The circular doubly linked list starts and ends with a sentinel element. + # The sentinel element never gets deleted (this simplifies the algorithm). + # The sentinel is in self.__hardroot with a weakref proxy in self.__root. + # The prev links are weakref proxies (to prevent circular references). + # Individual links are kept alive by the hard reference in self.__map. + # Those hard references disappear when a key is deleted from an OrderedDict. + + def __init__(self, *args, **kwds): + '''Initialize an ordered dictionary. The signature is the same as + regular dictionaries, but keyword arguments are not recommended because + their insertion order is arbitrary. + + ''' + if len(args) > 1: + raise TypeError('expected at most 1 arguments, got %d' % len(args)) + try: + self.__root + except AttributeError: + self.__hardroot = _Link() + self.__root = root = _proxy(self.__hardroot) + root.prev = root.next = root + self.__map = {} + self.__update(*args, **kwds) + + def __setitem__(self, key, value, + dict_setitem=dict.__setitem__, proxy=_proxy, Link=_Link): + 'od.__setitem__(i, y) <==> od[i]=y' + # Setting a new item creates a new link at the end of the linked list, + # and the inherited dictionary is updated with the new key/value pair. + if key not in self: + self.__map[key] = link = Link() + root = self.__root + last = root.prev + link.prev, link.next, link.key = last, root, key + last.next = link + root.prev = proxy(link) + dict_setitem(self, key, value) + + def __delitem__(self, key, dict_delitem=dict.__delitem__): + 'od.__delitem__(y) <==> del od[y]' + # Deleting an existing item uses self.__map to find the link which gets + # removed by updating the links in the predecessor and successor nodes. + dict_delitem(self, key) + link = self.__map.pop(key) + link_prev = link.prev + link_next = link.next + link_prev.next = link_next + link_next.prev = link_prev + + def __iter__(self): + 'od.__iter__() <==> iter(od)' + # Traverse the linked list in order. + root = self.__root + curr = root.next + while curr is not root: + yield curr.key + curr = curr.next + + def __reversed__(self): + 'od.__reversed__() <==> reversed(od)' + # Traverse the linked list in reverse order. + root = self.__root + curr = root.prev + while curr is not root: + yield curr.key + curr = curr.prev + + def clear(self): + 'od.clear() -> None. Remove all items from od.' + root = self.__root + root.prev = root.next = root + self.__map.clear() + dict.clear(self) + + def popitem(self, last=True): + '''od.popitem() -> (k, v), return and remove a (key, value) pair. + Pairs are returned in LIFO order if last is true or FIFO order if false. + + ''' + if not self: + raise KeyError('dictionary is empty') + root = self.__root + if last: + link = root.prev + link_prev = link.prev + link_prev.next = root + root.prev = link_prev + else: + link = root.next + link_next = link.next + root.next = link_next + link_next.prev = root + key = link.key + del self.__map[key] + value = dict.pop(self, key) + return key, value + + def move_to_end(self, key, last=True): + '''Move an existing element to the end (or beginning if last==False). + + Raises KeyError if the element does not exist. + When last=True, acts like a fast version of self[key]=self.pop(key). + + ''' + link = self.__map[key] + link_prev = link.prev + link_next = link.next + link_prev.next = link_next + link_next.prev = link_prev + root = self.__root + if last: + last = root.prev + link.prev = last + link.next = root + last.next = root.prev = link + else: + first = root.next + link.prev = root + link.next = first + root.next = first.prev = link + + def __sizeof__(self): + sizeof = _sys.getsizeof + n = len(self) + 1 # number of links including root + size = sizeof(self.__dict__) # instance dictionary + size += sizeof(self.__map) * 2 # internal dict and inherited dict + size += sizeof(self.__hardroot) * n # link objects + size += sizeof(self.__root) * n # proxy objects + return size + + update = __update = MutableMapping.update + keys = MutableMapping.keys + values = MutableMapping.values + items = MutableMapping.items + __ne__ = MutableMapping.__ne__ + + __marker = object() + + def pop(self, key, default=__marker): + '''od.pop(k[,d]) -> v, remove specified key and return the corresponding + value. If key is not found, d is returned if given, otherwise KeyError + is raised. + + ''' + if key in self: + result = self[key] + del self[key] + return result + if default is self.__marker: + raise KeyError(key) + return default + + def setdefault(self, key, default=None): + 'od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od' + if key in self: + return self[key] + self[key] = default + return default + + @_recursive_repr() + def __repr__(self): + 'od.__repr__() <==> repr(od)' + if not self: + return '%s()' % (self.__class__.__name__,) + return '%s(%r)' % (self.__class__.__name__, list(self.items())) + + def __reduce__(self): + 'Return state information for pickling' + items = [[k, self[k]] for k in self] + inst_dict = vars(self).copy() + for k in vars(OrderedDict()): + inst_dict.pop(k, None) + if inst_dict: + return (self.__class__, (items,), inst_dict) + return self.__class__, (items,) + + def copy(self): + 'od.copy() -> a shallow copy of od' + return self.__class__(self) + + @classmethod + def fromkeys(cls, iterable, value=None): + '''OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. + If not specified, the value defaults to None. + + ''' + self = cls() + for key in iterable: + self[key] = value + return self + + def __eq__(self, other): + '''od.__eq__(y) <==> od==y. Comparison to another OD is order-sensitive + while comparison to a regular mapping is order-insensitive. + + ''' + if isinstance(other, OrderedDict): + return len(self)==len(other) and \ + all(p==q for p, q in zip(self.items(), other.items())) + return dict.__eq__(self, other) + +# update_wrapper() and wraps() are tools to help write +# wrapper functions that can handle naive introspection + +WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__doc__') +WRAPPER_UPDATES = ('__dict__',) +def update_wrapper(wrapper, + wrapped, + assigned = WRAPPER_ASSIGNMENTS, + updated = WRAPPER_UPDATES): + """Update a wrapper function to look like the wrapped function + + wrapper is the function to be updated + wrapped is the original function + assigned is a tuple naming the attributes assigned directly + from the wrapped function to the wrapper function (defaults to + functools.WRAPPER_ASSIGNMENTS) + updated is a tuple naming the attributes of the wrapper that + are updated with the corresponding attribute from the wrapped + function (defaults to functools.WRAPPER_UPDATES) + """ + wrapper.__wrapped__ = wrapped + for attr in assigned: + try: + value = getattr(wrapped, attr) + except AttributeError: + pass + else: + setattr(wrapper, attr, value) + for attr in updated: + getattr(wrapper, attr).update(getattr(wrapped, attr, {})) + # Return the wrapper so this can be used as a decorator via partial() + return wrapper + +def wraps(wrapped, + assigned = WRAPPER_ASSIGNMENTS, + updated = WRAPPER_UPDATES): + """Decorator factory to apply update_wrapper() to a wrapper function + + Returns a decorator that invokes update_wrapper() with the decorated + function as the wrapper argument and the arguments to wraps() as the + remaining arguments. Default arguments are as for update_wrapper(). + This is a convenience function to simplify applying partial() to + update_wrapper(). + """ + return partial(update_wrapper, wrapped=wrapped, + assigned=assigned, updated=updated) + +def total_ordering(cls): + """Class decorator that fills in missing ordering methods""" + convert = { + '__lt__': [('__gt__', lambda self, other: not (self < other or self == other)), + ('__le__', lambda self, other: self < other or self == other), + ('__ge__', lambda self, other: not self < other)], + '__le__': [('__ge__', lambda self, other: not self <= other or self == other), + ('__lt__', lambda self, other: self <= other and not self == other), + ('__gt__', lambda self, other: not self <= other)], + '__gt__': [('__lt__', lambda self, other: not (self > other or self == other)), + ('__ge__', lambda self, other: self > other or self == other), + ('__le__', lambda self, other: not self > other)], + '__ge__': [('__le__', lambda self, other: (not self >= other) or self == other), + ('__gt__', lambda self, other: self >= other and not self == other), + ('__lt__', lambda self, other: not self >= other)] + } + roots = set(dir(cls)) & set(convert) + if not roots: + raise ValueError('must define at least one ordering operation: < > <= >=') + root = max(roots) # prefer __lt__ to __le__ to __gt__ to __ge__ + for opname, opfunc in convert[root]: + if opname not in roots: + opfunc.__name__ = opname + opfunc.__doc__ = getattr(int, opname).__doc__ + setattr(cls, opname, opfunc) + return cls + +def cmp_to_key(mycmp): + """Convert a cmp= function into a key= function""" + class K(object): + __slots__ = ['obj'] + def __init__(self, obj): + self.obj = obj + def __lt__(self, other): + return mycmp(self.obj, other.obj) < 0 + def __gt__(self, other): + return mycmp(self.obj, other.obj) > 0 + def __eq__(self, other): + return mycmp(self.obj, other.obj) == 0 + def __le__(self, other): + return mycmp(self.obj, other.obj) <= 0 + def __ge__(self, other): + return mycmp(self.obj, other.obj) >= 0 + def __ne__(self, other): + return mycmp(self.obj, other.obj) != 0 + __hash__ = None + return K + +_CacheInfo = namedtuple("CacheInfo", "hits misses maxsize currsize") + +def lru_cache(maxsize=100): + """Least-recently-used cache decorator. + + If *maxsize* is set to None, the LRU features are disabled and the cache + can grow without bound. + + Arguments to the cached function must be hashable. + + View the cache statistics named tuple (hits, misses, maxsize, currsize) with + f.cache_info(). Clear the cache and statistics with f.cache_clear(). + Access the underlying function with f.__wrapped__. + + See: http://en.wikipedia.org/wiki/Cache_algorithms#Least_Recently_Used + + """ + # Users should only access the lru_cache through its public API: + # cache_info, cache_clear, and f.__wrapped__ + # The internals of the lru_cache are encapsulated for thread safety and + # to allow the implementation to change (including a possible C version). + + def decorating_function(user_function, + tuple=tuple, sorted=sorted, len=len, KeyError=KeyError): + + hits, misses = [0], [0] + kwd_mark = (object(),) # separates positional and keyword args + lock = Lock() # needed because OrderedDict isn't threadsafe + + if maxsize is None: + cache = dict() # simple cache without ordering or size limit + + @wraps(user_function) + def wrapper(*args, **kwds): + key = args + if kwds: + key += kwd_mark + tuple(sorted(kwds.items())) + try: + result = cache[key] + hits[0] += 1 + return result + except KeyError: + pass + result = user_function(*args, **kwds) + cache[key] = result + misses[0] += 1 + return result + else: + cache = OrderedDict() # ordered least recent to most recent + cache_popitem = cache.popitem + cache_renew = cache.move_to_end + + @wraps(user_function) + def wrapper(*args, **kwds): + key = args + if kwds: + key += kwd_mark + tuple(sorted(kwds.items())) + with lock: + try: + result = cache[key] + cache_renew(key) # record recent use of this key + hits[0] += 1 + return result + except KeyError: + pass + result = user_function(*args, **kwds) + with lock: + cache[key] = result # record recent use of this key + misses[0] += 1 + if len(cache) > maxsize: + cache_popitem(0) # purge least recently used cache entry + return result + + def cache_info(): + """Report cache statistics""" + with lock: + return _CacheInfo(hits[0], misses[0], maxsize, len(cache)) + + def cache_clear(): + """Clear the cache and cache statistics""" + with lock: + cache.clear() + hits[0] = misses[0] = 0 + + wrapper.cache_info = cache_info + wrapper.cache_clear = cache_clear + return wrapper + + return decorating_function diff --git a/openpype/vendor/python/python_2/functools32/reprlib32.py b/openpype/vendor/python/python_2/functools32/reprlib32.py new file mode 100644 index 0000000000..af919758ca --- /dev/null +++ b/openpype/vendor/python/python_2/functools32/reprlib32.py @@ -0,0 +1,157 @@ +"""Redo the builtin repr() (representation) but with limits on most sizes.""" + +__all__ = ["Repr", "repr", "recursive_repr"] + +import __builtin__ as builtins +from itertools import islice +try: + from thread import get_ident +except ImportError: + from _dummy_thread32 import get_ident + +def recursive_repr(fillvalue='...'): + 'Decorator to make a repr function return fillvalue for a recursive call' + + def decorating_function(user_function): + repr_running = set() + + def wrapper(self): + key = id(self), get_ident() + if key in repr_running: + return fillvalue + repr_running.add(key) + try: + result = user_function(self) + finally: + repr_running.discard(key) + return result + + # Can't use functools.wraps() here because of bootstrap issues + wrapper.__module__ = getattr(user_function, '__module__') + wrapper.__doc__ = getattr(user_function, '__doc__') + wrapper.__name__ = getattr(user_function, '__name__') + wrapper.__annotations__ = getattr(user_function, '__annotations__', {}) + return wrapper + + return decorating_function + +class Repr: + + def __init__(self): + self.maxlevel = 6 + self.maxtuple = 6 + self.maxlist = 6 + self.maxarray = 5 + self.maxdict = 4 + self.maxset = 6 + self.maxfrozenset = 6 + self.maxdeque = 6 + self.maxstring = 30 + self.maxlong = 40 + self.maxother = 30 + + def repr(self, x): + return self.repr1(x, self.maxlevel) + + def repr1(self, x, level): + typename = type(x).__name__ + if ' ' in typename: + parts = typename.split() + typename = '_'.join(parts) + if hasattr(self, 'repr_' + typename): + return getattr(self, 'repr_' + typename)(x, level) + else: + return self.repr_instance(x, level) + + def _repr_iterable(self, x, level, left, right, maxiter, trail=''): + n = len(x) + if level <= 0 and n: + s = '...' + else: + newlevel = level - 1 + repr1 = self.repr1 + pieces = [repr1(elem, newlevel) for elem in islice(x, maxiter)] + if n > maxiter: pieces.append('...') + s = ', '.join(pieces) + if n == 1 and trail: right = trail + right + return '%s%s%s' % (left, s, right) + + def repr_tuple(self, x, level): + return self._repr_iterable(x, level, '(', ')', self.maxtuple, ',') + + def repr_list(self, x, level): + return self._repr_iterable(x, level, '[', ']', self.maxlist) + + def repr_array(self, x, level): + header = "array('%s', [" % x.typecode + return self._repr_iterable(x, level, header, '])', self.maxarray) + + def repr_set(self, x, level): + x = _possibly_sorted(x) + return self._repr_iterable(x, level, 'set([', '])', self.maxset) + + def repr_frozenset(self, x, level): + x = _possibly_sorted(x) + return self._repr_iterable(x, level, 'frozenset([', '])', + self.maxfrozenset) + + def repr_deque(self, x, level): + return self._repr_iterable(x, level, 'deque([', '])', self.maxdeque) + + def repr_dict(self, x, level): + n = len(x) + if n == 0: return '{}' + if level <= 0: return '{...}' + newlevel = level - 1 + repr1 = self.repr1 + pieces = [] + for key in islice(_possibly_sorted(x), self.maxdict): + keyrepr = repr1(key, newlevel) + valrepr = repr1(x[key], newlevel) + pieces.append('%s: %s' % (keyrepr, valrepr)) + if n > self.maxdict: pieces.append('...') + s = ', '.join(pieces) + return '{%s}' % (s,) + + def repr_str(self, x, level): + s = builtins.repr(x[:self.maxstring]) + if len(s) > self.maxstring: + i = max(0, (self.maxstring-3)//2) + j = max(0, self.maxstring-3-i) + s = builtins.repr(x[:i] + x[len(x)-j:]) + s = s[:i] + '...' + s[len(s)-j:] + return s + + def repr_int(self, x, level): + s = builtins.repr(x) # XXX Hope this isn't too slow... + if len(s) > self.maxlong: + i = max(0, (self.maxlong-3)//2) + j = max(0, self.maxlong-3-i) + s = s[:i] + '...' + s[len(s)-j:] + return s + + def repr_instance(self, x, level): + try: + s = builtins.repr(x) + # Bugs in x.__repr__() can cause arbitrary + # exceptions -- then make up something + except Exception: + return '<%s instance at %x>' % (x.__class__.__name__, id(x)) + if len(s) > self.maxother: + i = max(0, (self.maxother-3)//2) + j = max(0, self.maxother-3-i) + s = s[:i] + '...' + s[len(s)-j:] + return s + + +def _possibly_sorted(x): + # Since not all sequences of items can be sorted and comparison + # functions may raise arbitrary exceptions, return an unsorted + # sequence in that case. + try: + return sorted(x) + except Exception: + return list(x) + +aRepr = Repr() +repr = aRepr.repr diff --git a/openpype/version.py b/openpype/version.py index cb3658a827..17e514642d 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.9.0-nightly.3" +__version__ = "3.9.1-nightly.1" diff --git a/openpype/widgets/attribute_defs/files_widget.py b/openpype/widgets/attribute_defs/files_widget.py index fb48528bdc..87b98e2378 100644 --- a/openpype/widgets/attribute_defs/files_widget.py +++ b/openpype/widgets/attribute_defs/files_widget.py @@ -433,7 +433,7 @@ class MultiFilesWidget(QtWidgets.QFrame): filenames = index.data(FILENAMES_ROLE) for filename in filenames: filepaths.add(os.path.join(dirpath, filename)) - return filepaths + return list(filepaths) def set_filters(self, folders_allowed, exts_filter): self._files_proxy_model.set_allow_folders(folders_allowed) @@ -552,7 +552,7 @@ class MultiFilesWidget(QtWidgets.QFrame): self._update_visibility() def _update_visibility(self): - files_exists = self._files_model.rowCount() > 0 + files_exists = self._files_proxy_model.rowCount() > 0 self._files_view.setVisible(files_exists) self._empty_widget.setVisible(not files_exists) diff --git a/openpype/widgets/color_widgets/color_inputs.py b/openpype/widgets/color_widgets/color_inputs.py index 6f5d4baa02..d6564ca29b 100644 --- a/openpype/widgets/color_widgets/color_inputs.py +++ b/openpype/widgets/color_widgets/color_inputs.py @@ -8,42 +8,56 @@ class AlphaSlider(QtWidgets.QSlider): def __init__(self, *args, **kwargs): super(AlphaSlider, self).__init__(*args, **kwargs) self._mouse_clicked = False + self._handle_size = 0 + self.setSingleStep(1) self.setMinimum(0) self.setMaximum(255) self.setValue(255) - self._checkerboard = None - - def checkerboard(self): - if self._checkerboard is None: - self._checkerboard = draw_checkerboard_tile( - 3, QtGui.QColor(173, 173, 173), QtGui.QColor(27, 27, 27) - ) - return self._checkerboard + self._handle_brush = QtGui.QBrush(QtGui.QColor(127, 127, 127)) def mousePressEvent(self, event): self._mouse_clicked = True if event.button() == QtCore.Qt.LeftButton: - self._set_value_to_pos(event.pos().x()) + self._set_value_to_pos(event.pos()) return event.accept() return super(AlphaSlider, self).mousePressEvent(event) - def _set_value_to_pos(self, pos_x): - value = ( - self.maximum() - self.minimum() - ) * pos_x / self.width() + self.minimum() - self.setValue(value) - def mouseMoveEvent(self, event): if self._mouse_clicked: - self._set_value_to_pos(event.pos().x()) + self._set_value_to_pos(event.pos()) + super(AlphaSlider, self).mouseMoveEvent(event) def mouseReleaseEvent(self, event): self._mouse_clicked = True super(AlphaSlider, self).mouseReleaseEvent(event) + def _set_value_to_pos(self, pos): + if self.orientation() == QtCore.Qt.Horizontal: + self._set_value_to_pos_x(pos.x()) + else: + self._set_value_to_pos_y(pos.y()) + + def _set_value_to_pos_x(self, pos_x): + _range = self.maximum() - self.minimum() + handle_size = self._handle_size + half_handle = handle_size / 2 + pos_x -= half_handle + width = self.width() - handle_size + value = ((_range * pos_x) / width) + self.minimum() + self.setValue(value) + + def _set_value_to_pos_y(self, pos_y): + _range = self.maximum() - self.minimum() + handle_size = self._handle_size + half_handle = handle_size / 2 + pos_y = self.height() - pos_y - half_handle + height = self.height() - handle_size + value = (_range * pos_y / height) + self.minimum() + self.setValue(value) + def paintEvent(self, event): painter = QtGui.QPainter(self) opt = QtWidgets.QStyleOptionSlider() @@ -52,64 +66,82 @@ class AlphaSlider(QtWidgets.QSlider): painter.fillRect(event.rect(), QtCore.Qt.transparent) painter.setRenderHint(QtGui.QPainter.HighQualityAntialiasing) + + horizontal = self.orientation() == QtCore.Qt.Horizontal + rect = self.style().subControlRect( QtWidgets.QStyle.CC_Slider, opt, QtWidgets.QStyle.SC_SliderGroove, self ) - final_height = 9 - offset_top = 0 - if rect.height() > final_height: - offset_top = int((rect.height() - final_height) / 2) - rect = QtCore.QRect( - rect.x(), - offset_top, - rect.width(), - final_height - ) - pix_rect = QtCore.QRect(event.rect()) - pix_rect.setX(rect.x()) - pix_rect.setWidth(rect.width() - (2 * rect.x())) - pix = QtGui.QPixmap(pix_rect.width(), pix_rect.height()) - pix_painter = QtGui.QPainter(pix) - pix_painter.drawTiledPixmap(pix_rect, self.checkerboard()) + _range = self.maximum() - self.minimum() + _offset = self.value() - self.minimum() + if horizontal: + _handle_half = rect.height() / 2 + _handle_size = _handle_half * 2 + width = rect.width() - _handle_size + pos_x = ((width / _range) * _offset) + pos_y = rect.center().y() - _handle_half + 1 + else: + _handle_half = rect.width() / 2 + _handle_size = _handle_half * 2 + height = rect.height() - _handle_size + pos_x = rect.center().x() - _handle_half + 1 + pos_y = height - ((height / _range) * _offset) + + handle_rect = QtCore.QRect( + pos_x, pos_y, _handle_size, _handle_size + ) + + self._handle_size = _handle_size + _offset = 2 + _size = _handle_size - _offset + if horizontal: + if rect.height() > _size: + new_rect = QtCore.QRect(0, 0, rect.width(), _size) + center_point = QtCore.QPoint( + rect.center().x(), handle_rect.center().y() + ) + new_rect.moveCenter(center_point) + rect = new_rect + + ratio = rect.height() / 2 + + else: + if rect.width() > _size: + new_rect = QtCore.QRect(0, 0, _size, rect.height()) + center_point = QtCore.QPoint( + handle_rect.center().x(), rect.center().y() + ) + new_rect.moveCenter(center_point) + rect = new_rect + + ratio = rect.width() / 2 + + painter.save() + clip_path = QtGui.QPainterPath() + clip_path.addRoundedRect(rect, ratio, ratio) + painter.setClipPath(clip_path) + checker_size = int(_handle_size / 3) + if checker_size == 0: + checker_size = 1 + checkerboard = draw_checkerboard_tile( + checker_size, QtGui.QColor(173, 173, 173), QtGui.QColor(27, 27, 27) + ) + painter.drawTiledPixmap(rect, checkerboard) gradient = QtGui.QLinearGradient(rect.topLeft(), rect.bottomRight()) gradient.setColorAt(0, QtCore.Qt.transparent) gradient.setColorAt(1, QtCore.Qt.white) - pix_painter.fillRect(pix_rect, gradient) - pix_painter.end() - - brush = QtGui.QBrush(pix) - painter.save() painter.setPen(QtCore.Qt.NoPen) - painter.setBrush(brush) - ratio = rect.height() / 2 - painter.drawRoundedRect(rect, ratio, ratio) + painter.fillRect(rect, gradient) painter.restore() - _handle_rect = self.style().subControlRect( - QtWidgets.QStyle.CC_Slider, - opt, - QtWidgets.QStyle.SC_SliderHandle, - self - ) - - handle_rect = QtCore.QRect(rect) - if offset_top > 1: - height = handle_rect.height() - handle_rect.setY(handle_rect.y() - 1) - handle_rect.setHeight(height + 2) - handle_rect.setX(_handle_rect.x()) - handle_rect.setWidth(handle_rect.height()) - painter.save() - painter.setPen(QtCore.Qt.NoPen) - painter.setBrush(QtGui.QColor(127, 127, 127)) + painter.setBrush(self._handle_brush) painter.drawEllipse(handle_rect) - painter.restore() diff --git a/openpype/widgets/color_widgets/color_triangle.py b/openpype/widgets/color_widgets/color_triangle.py index f4a86c4fa5..e15b9e9f65 100644 --- a/openpype/widgets/color_widgets/color_triangle.py +++ b/openpype/widgets/color_widgets/color_triangle.py @@ -1,5 +1,5 @@ from enum import Enum -from math import floor, sqrt, sin, cos, acos, pi as PI +from math import floor, ceil, sqrt, sin, cos, acos, pi as PI from Qt import QtWidgets, QtCore, QtGui TWOPI = PI * 2 @@ -187,10 +187,10 @@ class QtColorTriangle(QtWidgets.QWidget): self.outer_radius = (size - 1) / 2 self.pen_width = int( - floor(self.outer_radius / self.ellipse_thick_ratio) + ceil(self.outer_radius / self.ellipse_thick_ratio) ) self.ellipse_size = int( - floor(self.outer_radius / self.ellipse_size_ratio) + ceil(self.outer_radius / self.ellipse_size_ratio) ) cx = float(self.contentsRect().center().x()) @@ -542,10 +542,10 @@ class QtColorTriangle(QtWidgets.QWidget): self.outer_radius = (size - 1) / 2 self.pen_width = int( - floor(self.outer_radius / self.ellipse_thick_ratio) + ceil(self.outer_radius / self.ellipse_thick_ratio) ) self.ellipse_size = int( - floor(self.outer_radius / self.ellipse_size_ratio) + ceil(self.outer_radius / self.ellipse_size_ratio) ) cx = float(self.contentsRect().center().x()) diff --git a/poetry.lock b/poetry.lock index b6eba33e0a..ee7b839b8d 100644 --- a/poetry.lock +++ b/poetry.lock @@ -674,7 +674,7 @@ ansicon = {version = "*", markers = "platform_system == \"Windows\""} [[package]] name = "jsonschema" -version = "3.2.0" +version = "2.6.0" description = "An implementation of JSON Schema validation for Python" category = "main" optional = false @@ -1219,6 +1219,26 @@ category = "main" optional = false python-versions = "*" +[[package]] +name = "qtawesome" +version = "0.7.3" +description = "FontAwesome icons in PyQt and PySide applications" +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +qtpy = "*" +six = "*" + +[[package]] +name = "qtpy" +version = "1.11.3" +description = "Provides an abstraction layer on top of the various Qt bindings (PyQt5, PyQt4 and PySide) and additional custom QWidgets." +category = "main" +optional = false +python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*" + [[package]] name = "recommonmark" version = "0.7.1" @@ -2101,8 +2121,8 @@ jinxed = [ {file = "jinxed-1.1.0.tar.gz", hash = "sha256:d8f1731f134e9e6b04d95095845ae6c10eb15cb223a5f0cabdea87d4a279c305"}, ] jsonschema = [ - {file = "jsonschema-3.2.0-py2.py3-none-any.whl", hash = "sha256:4e5b3cf8216f577bee9ce139cbe72eca3ea4f292ec60928ff24758ce626cd163"}, - {file = "jsonschema-3.2.0.tar.gz", hash = "sha256:c8a85b28d377cc7737e46e2d9f2b4f44ee3c0e1deac6bf46ddefc7187d30797a"}, + {file = "jsonschema-2.6.0-py2.py3-none-any.whl", hash = "sha256:000e68abd33c972a5248544925a0cae7d1125f9bf6c58280d37546b946769a08"}, + {file = "jsonschema-2.6.0.tar.gz", hash = "sha256:6ff5f3180870836cae40f06fa10419f557208175f13ad7bc26caa77beb1f6e02"}, ] keyring = [ {file = "keyring-22.4.0-py3-none-any.whl", hash = "sha256:d6c531f6d12f3304db6029af1d19894bd446ecbbadd22465fa0f096b3e12d258"}, @@ -2651,6 +2671,14 @@ pywin32-ctypes = [ {file = "Qt.py-1.3.6-py2.py3-none-any.whl", hash = "sha256:7edf6048d07a6924707506b5ba34a6e05d66dde9a3f4e3a62f9996ccab0b91c7"}, {file = "Qt.py-1.3.6.tar.gz", hash = "sha256:0d78656a2f814602eee304521c7bf5da0cec414818b3833712c77524294c404a"}, ] +qtawesome = [ + {file = "QtAwesome-0.7.3-py2.py3-none-any.whl", hash = "sha256:ddf4530b4af71cec13b24b88a4cdb56ec85b1e44c43c42d0698804c7137b09b0"}, + {file = "QtAwesome-0.7.3.tar.gz", hash = "sha256:b98b9038d19190e83ab26d91c4d8fc3a36591ee2bc7f5016d4438b8240d097bd"}, +] +qtpy = [ + {file = "QtPy-1.11.3-py2.py3-none-any.whl", hash = "sha256:e121fbee8e95645af29c5a4aceba8d657991551fc1aa3b6b6012faf4725a1d20"}, + {file = "QtPy-1.11.3.tar.gz", hash = "sha256:d427addd37386a8d786db81864a5536700861d95bf085cb31d1bea855d699557"}, +] recommonmark = [ {file = "recommonmark-0.7.1-py2.py3-none-any.whl", hash = "sha256:1b1db69af0231efce3fa21b94ff627ea33dee7079a01dd0a7f8482c3da148b3f"}, {file = "recommonmark-0.7.1.tar.gz", hash = "sha256:bdb4db649f2222dcd8d2d844f0006b958d627f732415d399791ee436a3686d67"}, diff --git a/pyproject.toml b/pyproject.toml index 052ed92bbc..128d1cd615 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "OpenPype" -version = "3.9.0-nightly.3" # OpenPype +version = "3.9.1-nightly.1" # OpenPype description = "Open VFX and Animation pipeline with support." authors = ["OpenPype Team "] license = "MIT License" @@ -41,7 +41,7 @@ Click = "^7" dnspython = "^2.1.0" ftrack-python-api = "2.0.*" google-api-python-client = "^1.12.8" # sync server google support (should be separate?) -jsonschema = "^3.2.0" +jsonschema = "^2.6.0" keyring = "^22.0.1" log4mongo = "^1.7" pathlib2= "^2.3.5" # deadline submit publish job only (single place, maybe not needed?) @@ -50,6 +50,8 @@ pyblish-base = "^1.8.8" pynput = "^1.7.2" # idle manager in tray pymongo = "^3.11.2" "Qt.py" = "^1.3.3" +qtpy = "^1.11.3" +qtawesome = "0.7.3" speedcopy = "^2.1" six = "^1.15" semver = "^2.13.0" # for version resolution diff --git a/repos/avalon-core b/repos/avalon-core index 159d2f23e4..7753d15507 160000 --- a/repos/avalon-core +++ b/repos/avalon-core @@ -1 +1 @@ -Subproject commit 159d2f23e4c79c04dfac57b68d2ee6ac67adec1b +Subproject commit 7753d15507afadc143b7d49db8fcfaa6a29fed91 diff --git a/repos/avalon-unreal-integration b/repos/avalon-unreal-integration deleted file mode 160000 index 43f6ea9439..0000000000 --- a/repos/avalon-unreal-integration +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 43f6ea943980b29c02a170942b566ae11f2b7080 diff --git a/tests/README.md b/tests/README.md index 6fb86cd027..bb1cdbdef8 100644 --- a/tests/README.md +++ b/tests/README.md @@ -13,11 +13,11 @@ Structure: How to run: ---------- - use Openpype command 'runtests' from command line (`.venv` in ${OPENPYPE_ROOT} must be activated to use configured Python!) --- `${OPENPYPE_ROOT}/python start.py runtests` +-- `python ${OPENPYPE_ROOT}/start.py runtests` By default, this command will run all tests in ${OPENPYPE_ROOT}/tests. Specific location could be provided to this command as an argument, either as absolute path, or relative path to ${OPENPYPE_ROOT}. -(eg. `${OPENPYPE_ROOT}/python start.py runtests ../tests/integration`) will trigger only tests in `integration` folder. +(eg. `python ${OPENPYPE_ROOT}/start.py start.py runtests ../tests/integration`) will trigger only tests in `integration` folder. See `${OPENPYPE_ROOT}/cli.py:runtests` for other arguments. diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py index 400c0dcc2a..aa850be1a6 100644 --- a/tests/integration/conftest.py +++ b/tests/integration/conftest.py @@ -19,6 +19,11 @@ def pytest_addoption(parser): help="Keep empty to locate latest installed variant or explicit" ) + parser.addoption( + "--timeout", action="store", default=None, + help="Overwrite default timeout" + ) + @pytest.fixture(scope="module") def test_data_folder(request): @@ -33,3 +38,8 @@ def persist(request): @pytest.fixture(scope="module") def app_variant(request): return request.config.getoption("--app_variant") + + +@pytest.fixture(scope="module") +def timeout(request): + return request.config.getoption("--timeout") diff --git a/tests/integration/hosts/aftereffects/lib.py b/tests/integration/hosts/aftereffects/lib.py new file mode 100644 index 0000000000..9fffc6073d --- /dev/null +++ b/tests/integration/hosts/aftereffects/lib.py @@ -0,0 +1,34 @@ +import os +import pytest +import shutil + +from tests.lib.testing_classes import HostFixtures + + +class AfterEffectsTestClass(HostFixtures): + @pytest.fixture(scope="module") + def last_workfile_path(self, download_test_data, output_folder_url): + """Get last_workfile_path from source data. + + Maya expects workfile in proper folder, so copy is done first. + """ + src_path = os.path.join(download_test_data, + "input", + "workfile", + "test_project_test_asset_TestTask_v001.aep") + dest_folder = os.path.join(download_test_data, + self.PROJECT, + self.ASSET, + "work", + self.TASK) + os.makedirs(dest_folder) + dest_path = os.path.join(dest_folder, + "test_project_test_asset_TestTask_v001.aep") + shutil.copy(src_path, dest_path) + + yield dest_path + + @pytest.fixture(scope="module") + def startup_scripts(self, monkeypatch_session, download_test_data): + """Points Maya to userSetup file from input data""" + pass diff --git a/tests/integration/hosts/aftereffects/test_publish_in_aftereffects.py b/tests/integration/hosts/aftereffects/test_publish_in_aftereffects.py index 407c4f8a3a..4925cbd2d7 100644 --- a/tests/integration/hosts/aftereffects/test_publish_in_aftereffects.py +++ b/tests/integration/hosts/aftereffects/test_publish_in_aftereffects.py @@ -1,11 +1,12 @@ -import pytest -import os -import shutil +import logging -from tests.lib.testing_classes import PublishTest +from tests.lib.assert_classes import DBAssert +from tests.integration.hosts.aftereffects.lib import AfterEffectsTestClass + +log = logging.getLogger("test_publish_in_aftereffects") -class TestPublishInAfterEffects(PublishTest): +class TestPublishInAfterEffects(AfterEffectsTestClass): """Basic test case for publishing in AfterEffects Uses generic TestCase to prepare fixtures for test data, testing DBs, @@ -23,7 +24,7 @@ class TestPublishInAfterEffects(PublishTest): Checks tmp folder if all expected files were published. """ - PERSIST = True + PERSIST = False TEST_FILES = [ ("1c8261CmHwyMgS-g7S4xL5epAp0jCBmhf", @@ -32,70 +33,44 @@ class TestPublishInAfterEffects(PublishTest): ] APP = "aftereffects" - APP_VARIANT = "2022" + APP_VARIANT = "" APP_NAME = "{}/{}".format(APP, APP_VARIANT) TIMEOUT = 120 # publish timeout - @pytest.fixture(scope="module") - def last_workfile_path(self, download_test_data): - """Get last_workfile_path from source data. - - Maya expects workfile in proper folder, so copy is done first. - """ - src_path = os.path.join(download_test_data, - "input", - "workfile", - "test_project_test_asset_TestTask_v001.aep") - dest_folder = os.path.join(download_test_data, - self.PROJECT, - self.ASSET, - "work", - self.TASK) - os.makedirs(dest_folder) - dest_path = os.path.join(dest_folder, - "test_project_test_asset_TestTask_v001.aep") - shutil.copy(src_path, dest_path) - - yield dest_path - - @pytest.fixture(scope="module") - def startup_scripts(self, monkeypatch_session, download_test_data): - """Points AfterEffects to userSetup file from input data""" - pass - def test_db_asserts(self, dbcon, publish_finished): """Host and input data dependent expected results in DB.""" print("test_db_asserts") + failures = [] - assert 2 == dbcon.count_documents({"type": "version"}), \ - "Not expected no of versions" + failures.append(DBAssert.count_of_types(dbcon, "version", 2)) - assert 0 == dbcon.count_documents({"type": "version", - "name": {"$ne": 1}}), \ - "Only versions with 1 expected" + failures.append( + DBAssert.count_of_types(dbcon, "version", 0, name={"$ne": 1})) - assert 1 == dbcon.count_documents({"type": "subset", - "name": "imageMainBackgroundcopy" - }), \ - "modelMain subset must be present" + failures.append( + DBAssert.count_of_types(dbcon, "subset", 1, + name="imageMainBackgroundcopy")) - assert 1 == dbcon.count_documents({"type": "subset", - "name": "workfileTest_task"}), \ - "workfileTesttask subset must be present" + failures.append( + DBAssert.count_of_types(dbcon, "subset", 1, + name="workfileTest_task")) - assert 1 == dbcon.count_documents({"type": "subset", - "name": "reviewTesttask"}), \ - "reviewTesttask subset must be present" + failures.append( + DBAssert.count_of_types(dbcon, "subset", 1, + name="reviewTesttask")) - assert 4 == dbcon.count_documents({"type": "representation"}), \ - "Not expected no of representations" + failures.append( + DBAssert.count_of_types(dbcon, "representation", 4)) - assert 1 == dbcon.count_documents({"type": "representation", - "context.subset": "renderTestTaskDefault", # noqa E501 - "context.ext": "png"}), \ - "Not expected no of representations with ext 'png'" + additional_args = {"context.subset": "renderTestTaskDefault", + "context.ext": "png"} + failures.append( + DBAssert.count_of_types(dbcon, "representation", 1, + additional_args=additional_args)) + + assert not any(failures) if __name__ == "__main__": diff --git a/tests/integration/hosts/photoshop/test_publish_in_photoshop.py b/tests/integration/hosts/photoshop/test_publish_in_photoshop.py index 32053cd9d4..5387bbe51e 100644 --- a/tests/integration/hosts/photoshop/test_publish_in_photoshop.py +++ b/tests/integration/hosts/photoshop/test_publish_in_photoshop.py @@ -1,5 +1,10 @@ +import logging + +from tests.lib.assert_classes import DBAssert from tests.integration.hosts.photoshop.lib import PhotoshopTestClass +log = logging.getLogger("test_publish_in_photoshop") + class TestPublishInPhotoshop(PhotoshopTestClass): """Basic test case for publishing in Photoshop @@ -30,7 +35,7 @@ class TestPublishInPhotoshop(PhotoshopTestClass): {OPENPYPE_ROOT}/.venv/Scripts/python.exe {OPENPYPE_ROOT}/start.py runtests ../tests/integration/hosts/photoshop # noqa: E501 """ - PERSIST = False + PERSIST = True TEST_FILES = [ ("1zD2v5cBgkyOm_xIgKz3WKn8aFB_j8qC-", "test_photoshop_publish.zip", "") @@ -44,33 +49,56 @@ class TestPublishInPhotoshop(PhotoshopTestClass): TIMEOUT = 120 # publish timeout - def test_db_asserts(self, dbcon, publish_finished): """Host and input data dependent expected results in DB.""" print("test_db_asserts") - assert 3 == dbcon.count_documents({"type": "version"}), \ - "Not expected no of versions" + failures = [] - assert 0 == dbcon.count_documents({"type": "version", - "name": {"$ne": 1}}), \ - "Only versions with 1 expected" + failures.append(DBAssert.count_of_types(dbcon, "version", 4)) - assert 1 == dbcon.count_documents({"type": "subset", - "name": "imageMainBackgroundcopy"} - ), \ - "modelMain subset must be present" + failures.append( + DBAssert.count_of_types(dbcon, "version", 0, name={"$ne": 1})) - assert 1 == dbcon.count_documents({"type": "subset", - "name": "workfileTesttask"}), \ - "workfileTest_task subset must be present" + failures.append( + DBAssert.count_of_types(dbcon, "subset", 1, + name="imageMainForeground")) - assert 6 == dbcon.count_documents({"type": "representation"}), \ - "Not expected no of representations" + failures.append( + DBAssert.count_of_types(dbcon, "subset", 1, + name="imageMainBackground")) - assert 1 == dbcon.count_documents({"type": "representation", - "context.subset": "imageMainBackgroundcopy", # noqa: E501 - "context.ext": "png"}), \ - "Not expected no of representations with ext 'png'" + failures.append( + DBAssert.count_of_types(dbcon, "subset", 1, + name="workfileTest_task")) + + failures.append( + DBAssert.count_of_types(dbcon, "representation", 8)) + + additional_args = {"context.subset": "imageMainForeground", + "context.ext": "png"} + failures.append( + DBAssert.count_of_types(dbcon, "representation", 1, + additional_args=additional_args)) + + additional_args = {"context.subset": "imageMainForeground", + "context.ext": "jpg"} + failures.append( + DBAssert.count_of_types(dbcon, "representation", 1, + additional_args=additional_args)) + + additional_args = {"context.subset": "imageMainBackground", + "context.ext": "png"} + failures.append( + DBAssert.count_of_types(dbcon, "representation", 1, + additional_args=additional_args)) + + additional_args = {"context.subset": "imageMainBackground", + "context.ext": "jpg"} + failures.append( + DBAssert.count_of_types(dbcon, "representation", 1, + additional_args=additional_args)) + + assert not any(failures) if __name__ == "__main__": diff --git a/tests/lib/assert_classes.py b/tests/lib/assert_classes.py index 7298853b67..98f758767d 100644 --- a/tests/lib/assert_classes.py +++ b/tests/lib/assert_classes.py @@ -1,5 +1,6 @@ """Classed and methods for comparing expected and published items in DBs""" + class DBAssert: @classmethod @@ -41,5 +42,7 @@ class DBAssert: print("Comparing count of {}{} {}".format(queried_type, detail_str, status)) + if msg: + print(msg) return msg diff --git a/tests/lib/testing_classes.py b/tests/lib/testing_classes.py index fa467acf9c..0a9da1aca8 100644 --- a/tests/lib/testing_classes.py +++ b/tests/lib/testing_classes.py @@ -293,13 +293,16 @@ class PublishTest(ModuleUnitTest): yield app_process @pytest.fixture(scope="module") - def publish_finished(self, dbcon, launched_app, download_test_data): + def publish_finished(self, dbcon, launched_app, download_test_data, + timeout): """Dummy fixture waiting for publish to finish""" import time time_start = time.time() + timeout = timeout or self.TIMEOUT + timeout = float(timeout) while launched_app.poll() is None: time.sleep(0.5) - if time.time() - time_start > self.TIMEOUT: + if time.time() - time_start > timeout: launched_app.terminate() raise ValueError("Timeout reached") diff --git a/tests/openpype/modules/default_modules/royal_render/test_rr_job.py b/tests/unit/openpype/default_modules/royal_render/test_rr_job.py similarity index 100% rename from tests/openpype/modules/default_modules/royal_render/test_rr_job.py rename to tests/unit/openpype/default_modules/royal_render/test_rr_job.py diff --git a/tools/ci_tools.py b/tools/ci_tools.py index e5ca0c2c28..aeb367af38 100644 --- a/tools/ci_tools.py +++ b/tools/ci_tools.py @@ -19,7 +19,10 @@ def get_release_type_github(Log, github_token): match = re.search("pull request #(\d+)", line) if match: pr_number = match.group(1) - pr = repo.get_pull(int(pr_number)) + try: + pr = repo.get_pull(int(pr_number)) + except: + continue for label in pr.labels: labels.add(label.name) diff --git a/website/docs/admin_builds.md b/website/docs/admin_builds.md new file mode 100644 index 0000000000..a4e0e77242 --- /dev/null +++ b/website/docs/admin_builds.md @@ -0,0 +1,20 @@ +--- +id: admin_builds +title: Builds and Releases +sidebar_label: Builds +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Admins might find prepared builds on https://github.com/pypeclub/OpenPype/releases for all major platforms. + +### Currently built on OS versions +- Windows 10 +- Ubuntu 20.04 +- Centos 7.6 +- MacOS Mohave (10.14.6) + +In case your studio requires build for different OS version, or any specific build, please take a look at +[Requirements](dev_requirements.md) and [Build](dev_build.md) for more details how to create binaries to distribute. + \ No newline at end of file diff --git a/website/docs/admin_distribute.md b/website/docs/admin_distribute.md index 9e9d21998d..2cccce0fbd 100644 --- a/website/docs/admin_distribute.md +++ b/website/docs/admin_distribute.md @@ -63,4 +63,18 @@ You can run OpenPype with `--use-staging` argument to add use staging versions. :::note Running staging version is identified by orange **P** icon in system tray. -::: \ No newline at end of file +::: + +### OpenPype versioning + +OpenPype version control is based on semantic versioning. + +:::note +The version of OpenPype is indicated by the variable `__version__` in the file `.\openpype\version.py`. +::: + +For example OpenPype will consider the versions in this order: `3.8.0-nightly` < `3.8.0-nightly.1` < `3.8.0-rc.1` < `3.8.0` < `3.8.1-nightly.1` <`3.8.1` < `3.9.0` < `3.10.0` < `4.0.0`. + +See https://semver.org/ for more details. + +For studios customizing the source code of OpenPype, a practical approach could be to build by adding a name and a number after the PATCH and not to deploy 3.8.0 from original OpenPype repository. For example, your builds will be: `3.8.0-yourstudio.1` < `3.8.0-yourstudio.2` < `3.8.1-yourstudio.1`. \ No newline at end of file diff --git a/website/docs/admin_settings.md b/website/docs/admin_settings.md index ba4bb1a9be..9b00e6c612 100644 --- a/website/docs/admin_settings.md +++ b/website/docs/admin_settings.md @@ -22,7 +22,7 @@ We use simple colour coding to show you any changes to the settings: - **Orange**: [Project Override](#project-overrides) - **Blue**: Changed and unsaved value -![Colour coding](assets\settings\settings_colour_coding.png) +![Colour coding](assets/settings/settings_colour_coding.png) You'll find that settings are split into categories: diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 4e448fbd02..2f88a9f238 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -81,4 +81,4 @@ If you're connected to your studio, OpenPype will check for, and install updates ## Advanced use -For more advanced use of OpenPype commands please visit [Admin section](admin_openpype_commands). +For more advanced use of OpenPype commands please visit [Admin section](admin_openpype_commands.md). diff --git a/website/docs/artist_hosts_aftereffects.md b/website/docs/artist_hosts_aftereffects.md index f9ef40fe1a..a9660bd13c 100644 --- a/website/docs/artist_hosts_aftereffects.md +++ b/website/docs/artist_hosts_aftereffects.md @@ -15,7 +15,7 @@ sidebar_label: AfterEffects ## Setup -To install the extension, download, install [Anastasyi's Extension Manager](https://install.anastasiy.com/). Open Anastasyi's Extension Manager and select AfterEffects in menu. Then go to `{path to pype}/repos/avalon-core/avalon/aftereffects/extension.zxp`. +To install the extension, download, install [Anastasyi's Extension Manager](https://install.anastasiy.com/). Open Anastasyi's Extension Manager and select AfterEffects in menu. Then go to `{path to pype}hosts/aftereffects/api/extension.zxp`. Drag extension.zxp and drop it to Anastasyi's Extension Manager. The extension will install itself. diff --git a/website/docs/artist_hosts_photoshop.md b/website/docs/artist_hosts_photoshop.md index 16539bcf79..b2b5fd58da 100644 --- a/website/docs/artist_hosts_photoshop.md +++ b/website/docs/artist_hosts_photoshop.md @@ -14,7 +14,7 @@ sidebar_label: Photoshop ## Setup -To install the extension, download, install [Anastasyi's Extension Manager](https://install.anastasiy.com/). Open Anastasyi's Extension Manager and select Photoshop in menu. Then go to `{path to pype}/repos/avalon-core/avalon/photoshop/extension.zxp`. Drag extension.zxp and drop it to Anastasyi's Extension Manager. The extension will install itself. +To install the extension, download, install [Anastasyi's Extension Manager](https://install.anastasiy.com/). Open Anastasyi's Extension Manager and select Photoshop in menu. Then go to `{path to pype}hosts/photoshop/api/extension.zxp`. Drag extension.zxp and drop it to Anastasyi's Extension Manager. The extension will install itself. ## Usage diff --git a/website/docs/artist_hosts_resolve.md b/website/docs/artist_hosts_resolve.md index afd050648f..7c462484f5 100644 --- a/website/docs/artist_hosts_resolve.md +++ b/website/docs/artist_hosts_resolve.md @@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; :::warning -Before you are able to start with OpenPype tools in DaVinci Resolve, installation of its own Python 3.6 interpreter and PySide 2 has to be done. Go to [Installation of python and pyside](#installation-of-python-and-pyside) link for more information +Before you are able to start with OpenPype tools in DaVinci Resolve, installation of its own Python 3.6 interpreter and PySide 2 has to be done. Go to [Installation of python and pyside](admin_hosts_resolve.md#installation-of-python-and-pyside) link for more information ::: diff --git a/website/docs/dev_introduction.md b/website/docs/dev_introduction.md new file mode 100644 index 0000000000..5b48635a08 --- /dev/null +++ b/website/docs/dev_introduction.md @@ -0,0 +1,10 @@ +--- +id: dev_introduction +title: Introduction +sidebar_label: Introduction +--- + + +Here you should find additional information targeted on developers who would like to contribute or dive deeper into OpenPype platform + +Currently there are details about automatic testing, in the future this should be location for API definition and documentation diff --git a/website/docs/dev_testing.md b/website/docs/dev_testing.md new file mode 100644 index 0000000000..cab298ae37 --- /dev/null +++ b/website/docs/dev_testing.md @@ -0,0 +1,143 @@ +--- +id: dev_testing +title: Testing in OpenPype +sidebar_label: Testing +--- + +## Introduction +As OpenPype is growing there also grows need for automatic testing. There are already bunch of tests present in root folder of OpenPype directory. +But many tests should yet be created! + +### How to run (integration) tests + +#### Requirements +- installed DCC you want to test +- `mongorestore` on a PATH + +If you would like just to experiment with provided integration tests, and have particular DCC installed on your machine, you could run test for this host by: + +- From source: +``` +- use Openpype command 'runtests' from command line (`.venv` in ${OPENPYPE_ROOT} must be activated to use configured Python!) +- `python ${OPENPYPE_ROOT}/start.py runtests ../tests/integration/hosts/nuke` +``` +- From build: +``` +- ${OPENPYPE_BUILD}/openpype_console run {ABSOLUTE_PATH_OPENPYPE_ROOT}/tests/integration/hosts/nuke` +``` +Modify tests path argument to limit which tests should be run (`../tests/integration` will run all implemented integration tests). + +### Content of tests folder + +Main tests folder contains hierarchy of folders with tests and supporting lib files. It is intended that tests in each folder of the hierarchy could be run separately. + +Main folders in the structure: +- `integration` - end to end tests in host applications, mimicking regular publishing process +- `lib` - helper classes +- `resources` - test data skeletons etc. +- `unit` - unit test covering methods and functions in OP + + +### lib folder + +This location should contain library of helpers and miscellaneous classes used for integration or unit tests. + +Content: +- `assert_classes.py` - helpers for easier use of assert expressions +- `db_handler.py` - class for creation of DB dumps/restore/purge +- `file_hanlder.py` - class for preparation/cleanup of test data +- `testing_classes.py` - base classes for testing of publish in various DCCs + +### integration folder + +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. + +There will be eventually also possibility to build workfile and publish it programmatically, this would work only in DCCs that support it (Maya, Nuke). + +It is expected that each test class should work with single worfkile with supporting resources (as a dump of project DB, all necessary environment variables, expected published files etc.) + +There are currently implemented basic publish tests for `Maya`, `Nuke`, `AfterEffects` and `Photoshop`. Additional hosts will be added. + +Each `test_` class should contain single test class based on `tests.lib.testing_classes.PublishTest`. This base class handles all necessary +functionality for testing in a host application. + +#### Steps of publish test + +Each publish test consists of areas: +- preparation +- launch of host application +- publish +- comparison of results in DB and file system +- cleanup + +##### Preparation + +Each test publish case expects zip file with this structure: +- `expected` - published files after workfile is published (in same structure as in regular manual publish) +- `input` + - `dumps` - database dumps (check `tests.lib.db_handler` for implemented functionality) + - `openpype` - settings + - `test_db` - skeleton of test project (contains project document, asset document etc.) + - `env_vars` - `env_var.json` file with a dictionary of all required environment variables + - `json` - json files with human readable content of databases + - `startup` - any required initialization scripts (for example Nuke requires one `init.py` file) + - `workfile` - contains single workfile + +These folders needs to be zipped (in zip's root must be this structure directly!), currently zip files for all prepared tests are stored in OpenPype GDrive folder. + +Each test then goes in steps (by default): +- download test data zip +- create temporary folder and unzip there data zip file +- purge test DB if exists, import dump files from unzipped folder +- sets environment variables from `env_vars` folder +- launches host application and trigger publish process +- waits until publish process finishes, application closes (or timeouts) +- compares results in DB with expected values +- compares published files structure with expected values +- cleans up temporary test DB and folder + +##### Launch of application and publish + +Integration tests are using same approach as OpenPype process regarding launching of host applications (eg. `ApplicationManager().launch`). +Each host application is in charge of triggering of publish process and closing itself. Different hosts handle this differently, Adobe products are handling this via injected "HEADLESS_PUBLISH" environment variable, +Maya and Nuke must contain this in theirs startup files. + +Base `PublishTest` class contains configurable timeout in case of publish process is not working, or taking too long. + +##### Comparison of results + +Each test class requires re-iplemented `PublishTest.test_db_asserts` fixture. This method is triggered after publish is finished and should +compare current results in DB (each test has its own database which gets filled with dump data first, cleaned up after test finishing) with expected results. + +`tests.lib.assert_classes.py` contains prepared method `count_of_types` which makes easier to write assert expression. This method also produces formatted error message. + +Basic use case: +```DBAssert.count_of_types(dbcon, "version", 2)``` >> It is expected that DB contains only 2 documents of `type==version` + +If zip file contains file structure in `expected` folder, `PublishTest.test_folder_structure_same` implements comparison of expected and published file structure, +eg. if test case published all expected files. + +##### Cleanup + +By default, each test case pulls data from GDrive, unzips them in temporary folder, runs publish, compares results and then +purges created temporary test database and temporary folder. This could be changed by setting of `PublishTest.PERSIST`. If set to True, DB and published folder are kept intact +until next run of any test. + +In case you want to modify test data, use `PublishTest.TEST_DATA_FOLDER` to point test to specific location where test folder is already unzipped. + +Both options are mostly useful for debugging during implementation of new test cases. + +#### Test configuration + +Each test case could be configured from command line with: +- `test_data_folder` - use specific folder with extracted test zip file +- `persist` - keep content of temporary folder and database after test finishes +- `app_variant` - run test for specific version of host app, matches app variants in Settings, eg. `2021` for Photoshop, `12-2` for Nuke +- `timeout` - override default time (in seconds) + +### unit folder + +Here should be located unit tests for classes, methods of OpenPype etc. As most classes expect to be triggered in OpenPype context, best option is to +start these tests in similar fashion as `integration` tests (eg. via `runtests`). \ No newline at end of file diff --git a/website/docs/module_deadline.md b/website/docs/module_deadline.md index 32dbcfa6df..c96da91909 100644 --- a/website/docs/module_deadline.md +++ b/website/docs/module_deadline.md @@ -12,15 +12,15 @@ import TabItem from '@theme/TabItem'; For [AWS Thinkbox Deadline](https://www.awsthinkbox.com/deadline) support you need to set a few things up in both OpenPype and Deadline itself -1. Deploy OpenPype executable to all nodes of Deadline farm. See [Install & Run](admin_use). +1. Deploy OpenPype executable to all nodes of Deadline farm. See [Install & Run](admin_use.md) 2. Enable Deadline Module in the [OpenPype Admin Settings](admin_settings_system.md#deadline). -3. Set up *Deadline Web API service*. For more details on how to do it, see [here](https://docs.thinkboxsoftware.com/products/deadline/10.0/1_User%20Manual/manual/web-service.html). +3. Set up *Deadline Web API service*. For more details on how to do it, see [here](https://docs.thinkboxsoftware.com/products/deadline/10.1/1_User%20Manual/manual/web-service.html). 4. Point OpenPype to your deadline webservice URL in the [OpenPype Admin Settings](admin_settings_system.md#deadline). -5. Install our custom plugin and scripts to your deadline repository. It should be as simple as copying content of `openPype/vendor/deadline/custom` to `path/to/your/deadline/repository/custom`. +5. Install our custom plugin and scripts to your deadline repository. It should be as simple as copying content of `openpype/modules/deadline/repository/custom` to `path/to/your/deadline/repository/custom`. ## Configuration diff --git a/website/docs/module_slack.md b/website/docs/module_slack.md index 67b200259d..3a2842da63 100644 --- a/website/docs/module_slack.md +++ b/website/docs/module_slack.md @@ -47,7 +47,7 @@ It is possible to create multiple tokens and configure different scopes for them ### Profiles Profiles are used to select when to trigger notification. One or multiple profiles -could be configured, `Families`, `Task names` (regex available), `Host names` combination is needed. +could be configured, `Families`, `Task names` (regex available), `Host names`, `Subset names` (regex available) combination is needed. Eg. If I want to be notified when render is published from Maya, setting is: diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 7edcda8532..131dc1b8ad 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -58,10 +58,16 @@ module.exports = { to: 'docs/artist_getting_started', label: 'User Docs', position: 'left' - }, { + }, + { to: 'docs/system_introduction', label: 'Admin Docs', position: 'left' + }, + { + to: 'docs/dev_introduction', + label: 'Dev Docs', + position: 'left' }, { to: 'https://pype.club', diff --git a/website/sidebars.js b/website/sidebars.js index 38e4206b84..16af1e1151 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -46,11 +46,9 @@ module.exports = { type: "category", label: "Getting Started", items: [ - "dev_requirements", - "dev_build", + "admin_builds", "admin_distribute", "admin_use", - "dev_contribute", "admin_openpype_commands", ], }, @@ -133,4 +131,11 @@ module.exports = { ], }, ], + Dev: [ + "dev_introduction", + "dev_requirements", + "dev_build", + "dev_testing", + "dev_contribute" + ] }; diff --git a/website/src/components/BadgesSection/badges.js b/website/src/components/BadgesSection/badges.js index 4bc85df2ef..5b179d066d 100644 --- a/website/src/components/BadgesSection/badges.js +++ b/website/src/components/BadgesSection/badges.js @@ -1,58 +1,63 @@ export default { upper: [ - { - title: "License", - src: - "https://img.shields.io/github/license/pypeclub/pype?labelColor=303846", - href: "https://github.com/pypeclub/pype", - }, - { - title: "Release", - src: - "https://img.shields.io/github/v/release/pypeclub/pype?labelColor=303846", - href: "https://github.com/pypeclub/pype", - }, - { - title: "Requirements State", - src: - "https://img.shields.io/requires/github/pypeclub/pype?labelColor=303846", - href: - "https://requires.io/github/pypeclub/pype/requirements/?branch=main", - }, { title: "VFX Platform", src: "https://img.shields.io/badge/vfx%20platform-2021-lightgrey?labelColor=303846", href: "https://vfxplatform.com", }, + { + title: "License", + src: + "https://img.shields.io/github/license/pypeclub/openpype?labelColor=303846", + href: "https://github.com/pypeclub/openpype", + }, + { + title: "Release", + src: + "https://img.shields.io/github/v/release/pypeclub/openpype?labelColor=303846", + href: "https://github.com/pypeclub/openpype", + }, { title: "GitHub last commit", src: - "https://img.shields.io/github/last-commit/pypeclub/pype/develop?labelColor=303846", - href: "https://github.com/pypeclub/pype", + "https://img.shields.io/github/last-commit/pypeclub/openpype/develop?labelColor=303846", + href: "https://github.com/pypeclub/openpype", }, { title: "GitHub commit activity", src: - "https://img.shields.io/github/commit-activity/y/pypeclub/pype?labelColor=303846", - href: "https://github.com/pypeclub/pype", + "https://img.shields.io/github/commit-activity/y/pypeclub/openpype?labelColor=303846", + href: "https://github.com/pypeclub/openpype", }, { title: "Repository Size", src: - "https://img.shields.io/github/repo-size/pypeclub/pype?labelColor=303846", - href: "https://github.com/pypeclub/pype", + "https://img.shields.io/github/repo-size/pypeclub/openpype?labelColor=303846", + href: "https://github.com/pypeclub/openpype", + }, + { + title: "Repository Size", + src: + "https://img.shields.io/github/contributors/pypeclub/openpype?labelColor=303846", + href: "https://github.com/pypeclub/openpype", + }, + { + title: "Stars", + src: + "https://img.shields.io/github/stars/pypeclub?labelColor=303846", + href: "https://github.com/pypeclub/openpype", }, { title: "Forks", src: - "https://img.shields.io/github/forks/pypeclub/pype?style=social&labelColor=303846", - href: "https://github.com/pypeclub/pype", + "https://img.shields.io/github/forks/pypeclub/openpype?labelColor=303846", + href: "https://github.com/pypeclub/openpype", }, { title: "Discord", src: - "https://img.shields.io/discord/517362899170230292?label=discord&logo=discord&logoColor=white&labelColor=303846", + "https://img.shields.io/discord/517362899170230292?label=discord&logo=discord&logoColor=white&labelColor=303846", href: "https://discord.gg/sFNPWXG", }, ], diff --git a/website/src/pages/index.js b/website/src/pages/index.js index 29b81e973f..791b309bbc 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -129,6 +129,21 @@ const studios = [ title: "Moonrock Animation Studio", image: "/img/moonrock_logo.png", infoLink: "https://www.moonrock.eu/", + }, + { + title: "Lumine Studio", + image: "/img/LUMINE_LogoMaster_black_2k.png", + infoLink: "https://www.luminestudio.com/", + }, + { + title: "Overmind Studios", + image: "/img/OMS_logo_black_color.png", + infoLink: "https://www.overmind-studios.de/", + }, + { + title: "Ember Light", + image: "/img/EmberLight_black.png", + infoLink: "https://emberlight.se/", } ]; @@ -275,107 +290,121 @@ function Home() { @@ -409,7 +438,7 @@ function Home() { {studios && studios.length && (
-

Studios using openPYPE

+

Studios using openPype

{studios.map((props, idx) => ( diff --git a/website/static/img/EmberLight_black.png b/website/static/img/EmberLight_black.png new file mode 100644 index 0000000000..e8a9f95d06 Binary files /dev/null and b/website/static/img/EmberLight_black.png differ diff --git a/website/static/img/Ember_Light.jpg b/website/static/img/Ember_Light.jpg new file mode 100644 index 0000000000..9081bc7cea Binary files /dev/null and b/website/static/img/Ember_Light.jpg differ diff --git a/website/static/img/LUMINE_LogoMaster_black_2k.png b/website/static/img/LUMINE_LogoMaster_black_2k.png new file mode 100644 index 0000000000..37ef01486d Binary files /dev/null and b/website/static/img/LUMINE_LogoMaster_black_2k.png differ diff --git a/website/static/img/OMS_logo_black_color.png b/website/static/img/OMS_logo_black_color.png new file mode 100644 index 0000000000..9046927e32 Binary files /dev/null and b/website/static/img/OMS_logo_black_color.png differ diff --git a/website/static/img/app_aquarium.png b/website/static/img/app_aquarium.png new file mode 100644 index 0000000000..1ff0acb8aa Binary files /dev/null and b/website/static/img/app_aquarium.png differ diff --git a/website/static/img/app_flame.png b/website/static/img/app_flame.png new file mode 100644 index 0000000000..ba9b69e45f Binary files /dev/null and b/website/static/img/app_flame.png differ diff --git a/website/static/img/app_kitsu.png b/website/static/img/app_kitsu.png new file mode 100644 index 0000000000..b4e3d00ebd Binary files /dev/null and b/website/static/img/app_kitsu.png differ diff --git a/website/static/img/app_shotgrid.png b/website/static/img/app_shotgrid.png new file mode 100644 index 0000000000..102e70b049 Binary files /dev/null and b/website/static/img/app_shotgrid.png differ