Fix: do not require empty data dict for create()#1038
Merged
max-wittig merged 1 commit intopython-gitlab:masterfrom Mar 8, 2020
nejch:fix/allow-empty-create-data
Merged
Fix: do not require empty data dict for create()#1038max-wittig merged 1 commit intopython-gitlab:masterfrom nejch:fix/allow-empty-create-data
max-wittig merged 1 commit intopython-gitlab:masterfrom
nejch:fix/allow-empty-create-data
Conversation
Member
|
You're right. This was kinda unpythonic before. Thanks for the change! |
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.
There's a quirk in the
CreateMixinwhen checking for required attributes in_check_missing_create_attrs, which requires a data dict. But some create methods don't require additional data, e.g. if the only required attribute is already provided by their parent manager id (e.g. for project export, see https://docs.gitlab.com/ee/api/project_import_export.html).This means the docs are sometimes asking people to pass an empty dict which I think is confusing for newcomers (and maybe unpythonic?).
This small fix allows using
create()without passing a dict. TheUpdateMixinis doing something similar withnew_data = new_data or {}but I thought this is a bit more explicit with None.I didn't add any checks as the data is already validated in
_check_missing_create_attrsbased on each Manager's_create_attrsand is already tested (see below), so I hope I covered everything :)python-gitlab/gitlab/tests/test_mixins.py
Lines 265 to 276 in e5afb55