feat: add deprecation warnings for legacy sync input and output in Job Attachments#991
Merged
godobyte merged 1 commit intoaws-deadline:mainlinefrom Feb 5, 2026
Merged
Conversation
leongdl
previously approved these changes
Feb 5, 2026
mwiebe
reviewed
Feb 5, 2026
…b Attachments Signed-off-by: Godot Bian <13778003+godobyte@users.noreply.github.com>
|
leongdl
approved these changes
Feb 5, 2026
mwiebe
approved these changes
Feb 5, 2026
This was referenced Feb 24, 2026
Closed
Merged
crowecawcaw
added a commit
to crowecawcaw/deadline-cloud
that referenced
this pull request
Feb 26, 2026
…b Attachments (aws-deadline#991) Signed-off-by: Godot Bian <13778003+godobyte@users.noreply.github.com> Co-authored-by: Godot Bian <13778003+godobyte@users.noreply.github.com>
Merged
vinadomi11
pushed a commit
to vinadomi11/deadline-cloud
that referenced
this pull request
Mar 5, 2026
…b Attachments (aws-deadline#991) Signed-off-by: Godot Bian <13778003+godobyte@users.noreply.github.com> Co-authored-by: Godot Bian <13778003+godobyte@users.noreply.github.com> Signed-off-by: vinadomi11 <vtubbs@amazon.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



What was the problem/requirement? (What/Why)
The
AssetSyncclass contains three methods (attachment_sync_inputs,sync_inputs, andsync_outputs) that are no longer used by the worker agent after theASSET_SYNC_JOB_USER_FEATUREwas fully released. These methods represent the legacy approach to attachment synchronization that has been replaced by the OpenJD task-based implementation usingAttachmentDownloadActionandAttachmentUploadAction.While these methods are only used in tests and scripted testing tools, they remain part of the public API and could potentially be used by external consumers. To safely deprecate them without breaking existing code, proper deprecation warnings are needed.
What was the solution? (How)
Added formal deprecation warnings to three methods in
asset_sync.py:attachment_sync_inputs()- Addedwarnings.warn()withDeprecationWarningsync_inputs()- Addedwarnings.warn()withDeprecationWarningsync_outputs()- Addedwarnings.warn()withDeprecationWarningEach method now:
DeprecationWarningwhen called.. deprecated::formatstacklevel=2to show the warning at the caller's locationAdded
import warningsto the module imports.What is the impact of this change?
Positive Impacts:
User Impact:
How was this change tested?
See DEVELOPMENT.md for information on running tests.
downloadorasset_syncmodules? If so, then it is highly recommended that you ensure that the docker-based unit tests pass. - Yes, changes toasset_syncmodule. Docker tests should be run.Testing performed:
Was this change documented?
.. deprecated::sections to all three method docstringsDoes this PR introduce new dependencies?
This library is designed to be integrated into third-party applications that have bespoke and customized deployment environments. Adding dependencies will increase the chance of library version conflicts and incompatibilities.
warningsmoduleIs this a breaking change?
Not yet - This is not a breaking change. The deprecated methods continue to function exactly as before. The only change is that they now emit
DeprecationWarningmessages to inform users that these methods will be removed in a future version.Users can:
warnings.filterwarnings()This follows standard Python deprecation practices and provides a graceful migration path.
Does this change impact security?
No, this change only adds deprecation warnings to existing methods without modifying their behavior or file/directory handling.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.