chore: add future deprecation warnings #398
Merged
Conversation
This file contains 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
As work starts on the next major version of Pact for Python, we need to start warning users that the current version will be deprecated in the future. This commit adds a warning to the top of all modules and standalone functions that will be deprecated in the next major version. While the class names themselves might remain, the way they are used may change to accommodate the changes in the underlying workings, and to accommodate versions 3 and 4 of the Pact specification. Once the work on the Pact Python v3 is complete, a thorough migration guide will be written. Signed-off-by: JP-Ellis <[email protected]>
YOU54F
reviewed
Oct 3, 2023
YOU54F
approved these changes
Oct 3, 2023
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.
📝 Summary
As work starts on the next major version of Pact for Python, we need to start warning users that the current version will be deprecated in the future.
This commit adds a warning to the top of all modules and standalone functions informing end-users of a major upstream change. While the class names themselves might remain, the way they are used may change to accommodate the changes brought by the move to the Pact reference library, and to accommodate versions 3 and 4 of the Pact specification.
Once the work on Pact Python v3 is complete, a thorough migration guide will be written and only those classes, methods and functions which are breaking will have a
DeprecationWarningadded.🚨 Breaking Changes🔨 Test Plan
Not Applicable
🔗 Related issues/PRs
PendingDeprecationWarningto the existing library #397