Fix type annotations for Docker labels#621
Merged
asvetlov merged 1 commit intoaio-libs:masterfrom Nov 15, 2021
vivienm:master
Merged
Fix type annotations for Docker labels#621asvetlov merged 1 commit intoaio-libs:masterfrom vivienm:master
asvetlov merged 1 commit intoaio-libs:masterfrom
vivienm:master
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.
What do these changes do?
This commit fixes invalid type hints for Docker labels: the Docker engine API expects a string-to-string mapping, not a list. See for instance https://docs.docker.com/engine/api/v1.41/#operation/ServiceCreate.
Are there changes in behavior for the user?
Labels require dicts, but Mypy expects lists, so users need to introduce
# type: ignorehints when using labels in typechecked code. If this PR gets accepted, theses hints will become spurious and, depending on Mypy settings, users may have to remove them for typechecking to succeed.Related issue number
Checklist
CONTRIBUTORS.txtchangesfolder<issue_id>.<type>for example (588.bug)issue_idchange it to the pr id after creating the pr.feature: Signifying a new feature..bugfix: Signifying a bug fix..doc: Signifying a documentation improvement..removal: Signifying a deprecation or removal of public API..misc: A ticket has been closed, but it is not of interest to users.