Skip to content

Some missing API additions and enhancements#623

Merged
asvetlov merged 11 commits intoaio-libs:masterfrom
GitHK:add-filters-to-networks
Nov 15, 2021
Merged

Some missing API additions and enhancements#623
asvetlov merged 11 commits intoaio-libs:masterfrom
GitHK:add-filters-to-networks

Conversation

@GitHK
Copy link
Copy Markdown
Contributor

@GitHK GitHK commented Sep 14, 2021

What do these changes do?

Following the existing patterns, I'd like add some missing features to the API:

  • Adds missing filters option to networks.list().
  • Adds missing filters option to volumes.list().
  • Adds volumes.get() method.

Please let me know if testing is not sufficient and if other cases need to be considered as well.

Question: While regenerating the docs, I am getting the below error. Any tips?

Running Sphinx v4.1.2
loading intersphinx inventory from https://docs.python.org/objects.inv...
loading intersphinx inventory from https://aiohttp.readthedocs.io/en/stable/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
intersphinx inventory has moved: https://aiohttp.readthedocs.io/en/stable/objects.inv -> https://docs.aiohttp.org/en/stable/objects.inv
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: [new config] 14 added, 0 changed, 0 removed
reading sources... [100%] volumes

Warning, treated as error:
Cannot resolve forward reference in type annotations of "aiodocker.execs.Exec": name 'Docker' is not defined
make[1]: *** [Makefile:20: html] Error 2

Are there changes in behavior for the user?

As my current understanding of the library, this change will not impact any existing code.

Related issue number

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."

@GitHK GitHK changed the title first try WIP: adding filters support to networks.list() Sep 14, 2021
@GitHK GitHK changed the title WIP: adding filters support to networks.list() Add filters support to networks.list() Sep 14, 2021
@GitHK GitHK marked this pull request as ready for review September 14, 2021 11:00
@GitHK GitHK marked this pull request as draft September 14, 2021 11:25
@GitHK GitHK changed the title Add filters support to networks.list() Add filters support when listing networks and volumes Sep 14, 2021
@GitHK GitHK changed the title Add filters support when listing networks and volumes Some missing API additions and enhancements Sep 14, 2021
@GitHK GitHK marked this pull request as ready for review September 14, 2021 12:01
Copy link
Copy Markdown
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 0b52c7b 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