fix: pkg_resources deprecation warning on runtime #307
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
| import pkg_resources | ||
| from pkg_resources import DistributionNotFound | ||
| version = pkg_resources.require("razorpay")[0].version | ||
| except (PackageNotFoundError, DistributionNotFound, NameError): # pragma: no cover |
Contributor
There was a problem hiding this comment.
Catching multiple exceptions ensures robustness, but consider logging a warning if version retrieval fails, to aid client debugging.
Contributor
There was a problem hiding this comment.
Catching NameError is thoughtful for edge-case compatibility, but it may also mask unrelated issues. Consider logging or at least adding a comment for future maintainers.
| # DistributionNotFound: pkg_resources couldn't find the package | ||
| # NameError: in case the exception classes aren't defined due to import issues | ||
| pass | ||
| return version |
Contributor
There was a problem hiding this comment.
Returning an empty string on exception is safe, but would it be more useful to return None or log a warning for SDK users who may rely on version info?
Contributor
Author
There was a problem hiding this comment.
@razorpay-sanjib Returning None would break the string formatting in User-Agent header. but we can add warning like this
except:
warnings.warn(
"Could not detect razorpay package version. Using fallback version. "
"This may indicate an installation issue.",
UserWarning,
stacklevel=4
)
return version
…orpay/razorpay-python into fix/pkg_resource-deprecation
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.
Fix deprecation warning on runtime