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: Incorrect return type annotations of DockerImages methods #909

Merged
merged 5 commits into from
Nov 20, 2024

Conversation

jopemachine
Copy link
Contributor

@jopemachine jopemachine commented Oct 30, 2024

What do these changes do?

Fix incorrect type annotations for the methods calling _handle_response() in the aiodocker/images.py file.

  • DockerImages.build()
  • DockerImages.push()
  • DockerImages.pull()

Are there changes in behavior for the user?

Users will be able to know the correct return type when running these APIs with stream=False (the default behavior).

Related issue number

None

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • 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."

@jopemachine jopemachine changed the title fix: Wrong method return type declarations fix: DockerImages.build(), DockerImages.pull(), DockerImages.push() methods' incorrect return type declarations Oct 30, 2024
@jopemachine jopemachine marked this pull request as ready for review October 30, 2024 05:36
@jopemachine jopemachine changed the title fix: DockerImages.build(), DockerImages.pull(), DockerImages.push() methods' incorrect return type declarations fix: Incorrect return type annotations of DockerImages Oct 30, 2024
@jopemachine jopemachine changed the title fix: Incorrect return type annotations of DockerImages fix: Incorrect return type annotations of DockerImages methods Oct 30, 2024
Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.66%. Comparing base (702003d) to head (c1cfd56).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #909   +/-   ##
=======================================
  Coverage   80.66%   80.66%           
=======================================
  Files          24       24           
  Lines        1443     1443           
  Branches      206      206           
=======================================
  Hits         1164     1164           
  Misses        187      187           
  Partials       92       92           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

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.

Thank you very much!

@asvetlov asvetlov enabled auto-merge (squash) November 20, 2024 18:58
@asvetlov asvetlov merged commit 286cfdc into aio-libs:main Nov 20, 2024
11 checks passed
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.

3 participants