Introduce Pydantic data models and API type annotations #4560
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
lists are not hashable and did cause an exception here
|
|
Sab44
commented
Mar 25, 2025
src/pyload/core/api/__init__.py
Outdated
| @@ -1215,15 +1236,15 @@ def get_account_types(self): | |||
|
|
|||
| @legacy("updateAccount") | |||
| @permission(Perms.ACCOUNTS) | |||
| def update_account(self, plugin, account, password=None, options={}): | |||
| def update_account(self, plugin: str, account: str, password: str = None, options: dict[str: Any] = {}) -> None: | |||
There was a problem hiding this comment.
I understand the code analysis is throwing a warning here, but I think for now we should keep the default arguments as they were before.
Open
Sab44
commented
Mar 25, 2025
| except Exception: | ||
| return jsonify(False), 500 | ||
|
|
||
|
|
There was a problem hiding this comment.
I deleted this function because I don't think it actually worked.
it calls get_queue() which returns PackageData and then tries to access it id - but PackageData has no id property/key.
Even if we assume that pid was meant here, then it will call api.get_package_files() which doesn't exist.
So something was very broken here. If you think we should keep it then please let me know how to fix this method to actually work as expected.
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.
Describe the changes
As outlined in my comment on #4414 this is the first step to enable automatic API documentation.
So far, everything seems to work just fine.
With this, we can parse the existing methods into an OpenAPI specificaton, will submit this in a follow-up PR. I have a working draft, but it needs some polishing.
I've tried to encapsulate all changes to logical commits to make the review easier. In any case, I'd say this should probably stay on the develop branch for a couple of weeks before merging into main to make sure it doesn't cause any issues.
Additional references
Related issue #4414