A more robust logic to parse API settings. #53
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
All key-value settings in api.py were parsed through the following syntax:
```python
if settings["something"] is None:
...
```
This is problematic because it forces downstream implementations to also
provide all the fields, also when they are not required.
In particular, when new fields are added, downstream implementations
also have to provide them, or the integration will break.
The `settings.get("something")` syntax should be preferred, and settings
itself should also be initialized to a dict by default to prevent
dereferencing a `None` (I mean, if no settings are provided at all the
code should probably still break, but with a relevant error instead of a
fuzzier `TypeError`).
Closes: r4sas#51
Closes: r4sas#52
Closes: https://github.com/Pioverpie/privatebin-api#12
r4sas
reviewed
Feb 21, 2025
r4sas
approved these changes
Mar 8, 2025
|
Thank you! |
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.
All key-value settings in api.py were parsed through the following syntax:
This is problematic because it forces downstream implementations to also provide all the fields, also when they are not required.
In particular, when new fields are added, downstream implementations also have to provide them, or the integration will break.
The
settings.get("something")syntax should be preferred, and settings itself should also be initialized to a dict by default to prevent dereferencing aNone(I mean, if no settings are provided at all the code should probably still break, but with a relevant error instead of a fuzzierTypeError).Closes: #51
Closes: #52
Closes: https://github.com/Pioverpie/privatebin-api#12