fix default polling method listed in docstring #830
Merged
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
iscai-msft
commented
Nov 18, 2020
| :keyword polling: True for ARMPolling, False for no polling, or a | ||
| polling object for personal polling strategy | ||
| :paramtype polling: bool or ~azure.core.polling.{{ "Async" if async_mode else "" }}PollingMethod | ||
| {% set default_polling_method = "ARMPolling"if code_model.options['azure_arm'] else "LROBasePolling" %} |
Contributor
Author
There was a problem hiding this comment.
Main point of this PR (sorry there's a lot of fluff where I add a keyword to dedup code in the LRO world). Before, we would always generate ARMPolling as the default polling method, even when arm flag wasn't set
lmazuel
requested changes
Nov 23, 2020
Member
lmazuel
left a comment
lmazuel
left a comment
There was a problem hiding this comment.
Make this with a default, directive and namer
…into improve_lro_docstrings * 'autorestv3' of https://github.com/Azure/autorest.python: add typing imports to multiapi client and config (#794) deduplicate model serialization code (#828) remove azure-arm flag when generating paging (#829) clean up tasks file (#827)
iscai-msft
commented
Nov 25, 2020
| ), | ||
| } | ||
|
|
||
| operation["extensions"]["default-no-polling-method-sync"] = "azure.core.polling.NoPolling" |
Contributor
Author
There was a problem hiding this comment.
I've added the default no polling, and the base polling method. to the namer as well. I'm not exposing a directive to override these (at least not yet, there seems to be no use case for it). But I wanted all of the LRO paths to be in one area, and it cleaned up the code in the LROOperation model class
lmazuel
reviewed
Dec 30, 2020
|
|
||
| def get_poller_path(self, async_mode: bool) -> str: | ||
| extension_name = "poller-async" if async_mode else "poller-sync" | ||
| extension_name = "poller-{}sync".format("a" if async_mode else "") |
Member
There was a problem hiding this comment.
Does it really improve the readability? :p
Contributor
Author
There was a problem hiding this comment.
made some fixes for readability
…into improve_lro_docstrings * 'autorestv3' of https://github.com/Azure/autorest.python: add enum description son top of declaration, wrap comments (#844) add default value 'api-key' for `--credential-key-header-name` (#840) update head-as-boolean spec
iscai-msft
added a commit
that referenced
this pull request
Jan 5, 2021
…into black_plugin * 'autorestv3' of https://github.com/Azure/autorest.python: fix default polling method listed in docstring (#830) add enum description son top of declaration, wrap comments (#844) add default value 'api-key' for `--credential-key-header-name` (#840) update head-as-boolean spec
iscai-msft
added a commit
that referenced
this pull request
Jan 7, 2021
…into docs * 'autorestv3' of https://github.com/Azure/autorest.python: add black flag (#836) fix default polling method listed in docstring (#830) add enum description son top of declaration, wrap comments (#844)
iscai-msft
added a commit
that referenced
this pull request
Jan 14, 2021
…into paging_separate_operations * 'autorestv3' of https://github.com/Azure/autorest.python: add black flag (#836) fix default polling method listed in docstring (#830)
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.
fixes #782