-
Notifications
You must be signed in to change notification settings - Fork 4.2k
refactor: convert content libraries python API from attr.s to dataclass, fix types [FC-0083] #36381
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor: convert content libraries python API from attr.s to dataclass, fix types [FC-0083] #36381
Conversation
|
Thanks for the pull request, @bradenmacdonald! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
pomegranited
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 So clean! Thank you @bradenmacdonald
- I tested this on my tutor dev stack by doing basic libraries operations in the Authoring MFE
- I read through the code
-
I checked for accessibility issuesN/A -
Includes documentationN/A -
User-facing strings are extracted for translationN/A
|
Thanks @pomegranited ! Would you be able to merge this on Monday? It's very low risk but I don't wanna do a Friday afternoon merge. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
1 similar comment
|
2U Release Notice: This PR has been deployed to the edX production environment. |
…ss, fix types [FC-0083] (openedx#36381) * refactor: convert libraries API from attr.s to dataclass, fix types * fix: make corresponding updates to 'search' code
…ss, fix types [FC-0083] (openedx#36381) * refactor: convert libraries API from attr.s to dataclass, fix types * fix: make corresponding updates to 'search' code
…ss, fix types [FC-0083] (openedx#36381) * refactor: convert libraries API from attr.s to dataclass, fix types * fix: make corresponding updates to 'search' code
…ss, fix types [FC-0083] (#36381) * refactor: convert libraries API from attr.s to dataclass, fix types * fix: make corresponding updates to 'search' code
(Separated from #36371 to reduce the diff)
Description
The functionality of the third-party attrs library is now available in the python standard library, and the syntax of the built-in version is much nicer. This PR updates the content libraries API to use the standard version, and adds a bunch of missing type hints.
Technically, this is a small breaking change to the content libraries API:
learning_packagefield onContentLibraryMetadataobjects was replaced withlearning_package_id. I'm not even sure if our libraries API should be exposing the learning package at all, but if we are we should only expose the ID.searchapp had to be updated but it's much cleaner now than it was before.As the whole content libraries feature is in beta/development, I don't think anyone will be impacted by these very minor API tweaks.
Private ref: FAL-4052