refactor: add type hints and pydantic validation schemas#35
Open
lupppig wants to merge 2 commits intoEnAccess:mainfrom
Open
refactor: add type hints and pydantic validation schemas#35lupppig wants to merge 2 commits intoEnAccess:mainfrom
lupppig wants to merge 2 commits intoEnAccess:mainfrom
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
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.
Brief summary of the change made
This Pull Request introduces explicit Python typing and Pydantic validation schemas to the OpenPAYGO module.
pyproject.toml: Addedpydanticas a core dependency.openpaygo/models.py: Created strict typed schemas such as:MetricsRequestDataMetricsDataFormatMetricsHistoricalDataStepopenpaygo/token_encode.py,token_decode.py,token_shared.py: Added comprehensive type hints to all cryptographic generation and decoding methods.openpaygo/metrics_request.py,metrics_response.py: Updated to utilize the new Pydantic models to automatically validate and strip out invalid payload variables or historical data mappings before deep processing.Closes: #34
Are there any other side effects of this change that we should be aware of?
There should be no structural side effects to existing functionality since all internal math and logic sequences remain untouched.
However, users passing completely invalid or untyped structures (e.g., an array instead of a dictionary for a metric format) will now encounter a ValidationError at instantiation rather than an obscure
TypeErrororKeyErrordeeper in the processing stack.Describe how you tested your changes?
Pull Request checklist
Please confirm you have completed any of the necessary steps below.