Skip to content
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

Fix type annotations for Docker labels #621

Merged
merged 1 commit into from
Nov 15, 2021
Merged

Fix type annotations for Docker labels #621

merged 1 commit into from
Nov 15, 2021

Conversation

vivienm
Copy link
Contributor

@vivienm vivienm commented Sep 8, 2021

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: ignore hints 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

  • I think the code is well written
  • Unit tests for the changes exist (note: tests use correct types already)
  • Documentation reflects the changes (note: unrelevant)
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the changes folder
    • name it <issue_id>.<type> for example (588.bug)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .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.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

Copy link
Member

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@asvetlov asvetlov merged commit 315af29 into aio-libs:master Nov 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants