Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Custom staging dir functionality migration #887

Open
wants to merge 16 commits into
base: develop
Choose a base branch
from
Open

Custom staging dir functionality migration #887

wants to merge 16 commits into from

Conversation

jakubjezek001
Copy link
Member

Changelog Description

The functionality of the staging directory has exceeded its original purpose of publishing. Considering its increased usage in the creation process, we need to migrate it to a dedicated module within the pipeline parent.

Additional info

Migrated development from ynput/OpenPype#5207

  • adding functionality to Creator base class
  • consistency of naming across all features
  • making sure backward compatibility to older names and locations remain in settings and api
  • anatomy templates with Staging Dir category

Testing notes:

  1. all should be working as it was before

@jakubjezek001
Add staging directory functions and configurations
282d172 
- Added functions to handle custom staging directories
- Updated imports and removed deprecated code
- Created a new module for staging directory handling
@jakubjezek001
Add staging directory functionality and a new plugin for managing sta…
8b16746 
…ging directories in the pipeline.

- Added import statement for 'os' in creator_plugins.py
- Implemented method 'apply_staging_dir' to apply staging directory with persistence to instance's transient data in creator_plugins.py
- Updated comments and added TODOs related to staging directories in various files
- Created a new plugin 'CollectManagedStagingDir' to manage staging directories in publish/lib.py
@ynbot
Copy link
Contributor

ynbot commented Sep 12, 2024

Task linked: OP-5264 Use custom staging dir function for Nuke creators

@ynbot ynbot added type: feature Adding something new and exciting to the product size/M labels Sep 12, 2024
@jakubjezek001 jakubjezek001 added the sponsored This is directly sponsored by a client or community member label Sep 12, 2024
@jakubjezek001
Update variable names for clarity and consistency.
9e57f74 
- Renamed variables for better understanding and uniformity
- Improved readability by using more descriptive names
@jakubjezek001
Merge remote-tracking branch 'origin/feature/AY-971_Use-custom-stagin…
16abc3a 
…g-dir-functions' into feature/AY-971_Use-custom-staging-dir-functions
@jakubjezek001 jakubjezek001 mentioned this pull request Sep 13, 2024
Draft
iLLiCiTiT
iLLiCiTiT reviewed Sep 16, 2024
View reviewed changes
client/ayon_core/pipeline/stagingdir.py
prefix=kwargs.get("prefix"),
suffix=kwargs.get("suffix"),
),
"stagingDir_persistent": False,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Combination of camel case and snake case. I would rename to stagingDirPersistent or staging_dir_persistent.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is used across all hosts, and it would require separated PR for removing this. This had been inherited from previous implementation.

jakubjezek001 and others added 9 commits October 24, 2024 13:41
@jakubjezek001
returning empty lines
2b5ab54
@jakubjezek001 @iLLiCiTiT
Update client/ayon_core/pipeline/create/creator_plugins.py
9a86078 
Co-authored-by: Jakub Trllo <[email protected]>
@jakubjezek001 @iLLiCiTiT
Update client/ayon_core/pipeline/publish/lib.py
bd03634 
Co-authored-by: Jakub Trllo <[email protected]>
@jakubjezek001
returning empty lines
2b76595
@jakubjezek001 @iLLiCiTiT
Update client/ayon_core/pipeline/create/creator_plugins.py
396af0c 
Co-authored-by: Jakub Trllo <[email protected]>
@jakubjezek001
Add warnings module for future use
fedf8e6 
Imported the 'warnings' module for potential future usage in the codebase.
@jakubjezek001 @iLLiCiTiT
Apply suggestions from code review
ea23f35 
Co-authored-by: Jakub Trllo <[email protected]>
@jakubjezek001
reviewer suggestions for changes
ea4ec67 
- Renamed function `get_staging_dir` to `get_staging_dir_info` for clarity.
- Updated variable names in multiple files to use `template_data` instead of `formatting_data`.
- Adjusted function parameters in the staging directory module for consistency and added new optional parameters.
- Improved logging by passing logger instances instead of creating new loggers within functions.
@jakubjezek001
Remove unnecessary root addition in get_staging_dir_info function.
1eb0904 
The code changes remove the unnecessary addition of roots to ctx_data in the get_staging_dir_info function.
@jakubjezek001
Merge branch 'develop' into feature/AY-971_Use-custom-staging-dir-fun…
81e2170 
…ctions
@jakubjezek001
Refactor Creator class method to handle missing info better.
fa9af2f 
- Updated return type in docstring
- Added a comment for clarity
- Removed unnecessary return statements
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BigRoy BigRoy Awaiting requested review from BigRoy

@kalisp kalisp Awaiting requested review from kalisp

@iLLiCiTiT iLLiCiTiT Awaiting requested review from iLLiCiTiT

At least 1 approving review is required to merge this pull request.

Assignees

@jakubjezek001 jakubjezek001

Labels
size/M sponsored This is directly sponsored by a client or community member type: feature Adding something new and exciting to the product
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jakubjezek001 @ynbot @iLLiCiTiT