Refactor: Improve dataset deprecation message #251
Conversation
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
I've upgraded the deprecation message for the `load_dataset` function to be more informative for you. The new message now includes: - A statement that `load_dataset` will be removed in version 1.0.0. - An explanation that `dataset_load` (the replacement) offers more flexibility and new features. - A clear code example showing how to migrate from the old to the new function: # OLD: load_dataset(adapter, handle, path, ...) # NEW: dataset_load(adapter, handle, path, ...) I've also added a unit test to verify that the `DeprecationWarning` is triggered correctly and that the content of the warning message is as expected. The test ensures that the testing environment uses the most up-to-date version of the code by modifying `sys.path` and using `importlib.reload`.
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.
I've upgraded the deprecation message for the
load_datasetfunction to be more informative for you.The new message now includes:
load_datasetwill be removed in version 1.0.0.dataset_load(the replacement) offers more flexibility and new features.I've also added a unit test to verify that the
DeprecationWarningis triggered correctly and that the content of the warning message is as expected. The test ensures that the testing environment uses the most up-to-date version of the code by modifyingsys.pathand usingimportlib.reload.