App Config - Pylint Changes - #48288
Conversation
|
Azure Pipelines: Successfully started running 1 pipeline(s). 9 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
There was a problem hiding this comment.
Pull request overview
Updates App Configuration docstrings to satisfy Pylint 4.0.6 checks without changing runtime behavior.
Changes:
- Adds constructor parameter documentation to models and policies.
- Removes invalid callback parameter documentation.
- Expands public model descriptions.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
_sync_token_async.py |
Simplifies async policy documentation. |
_sync_token.py |
Simplifies sync policy documentation. |
_models.py |
Expands model and paging documentation. |
_azure_appconfiguration_requests.py |
Documents credential policy parameters. |
_audience_error_handling_policy.py |
Documents the audience flag. |
_request_tracing_context.py |
Documents load-balancing configuration. |
Comments suppressed due to low confidence (2)
sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_models.py:152
- This attribute documentation claims
Allrequirement semantics, butFeatureFlagConfigurationSettingneither exposes nor preserves a requirement type; its serialized value contains onlyclient_filters. Please avoid advertising unsupported behavior here.
"""Filters that run on the client to determine whether the feature is enabled. By default
(requirement type "Any"), the feature is considered enabled if at least one filter evaluates
to true. With requirement type "All", every filter must evaluate to true."""
sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_models.py:200
- The constructor cannot choose
All: there is norequirement_typeargument and the generated conditions contain onlyclient_filters. This wording makes an unsupported mode appear available to callers, so document only the emitted default semantics.
:keyword filters: Filters that run on the client to determine whether the feature is enabled.
By default (requirement type "Any"), the feature is considered enabled if at least one filter
evaluates to true. With requirement type "All", every filter must evaluate to true.
:paramtype filters: list[dict[str, Any]] or None
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (3)
sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_models.py:136
- The
FeatureFlagConfigurationSettingmodel does not expose or serialize a requirement type: its constructor writes onlyconditions.client_filters(lines 216–218), and_from_generateddrops anyrequirement_typefrom a fetched value (lines 258–291). DocumentingAllhere therefore implies that callers can select semantics this API cannot represent. Please keep this description neutral unless requirement-type support is added.
:keyword filters: Filters that run on the client to determine whether the feature is enabled.
By default (requirement type "Any"), the feature is considered enabled if at least one filter
evaluates to true. With requirement type "All", every filter must evaluate to true.
:paramtype filters: list[dict[str, Any]] or None
sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_models.py:152
- This attribute cannot carry the documented requirement type; it contains only the client-filter list, while serialization always emits
client_filterswithoutrequirement_type. MentioningAny/Allhere overstates the model's supported behavior.
"""Filters that run on the client to determine whether the feature is enabled. By default
(requirement type "Any"), the feature is considered enabled if at least one filter evaluates
to true. With requirement type "All", every filter must evaluate to true."""
sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_models.py:200
- The constructor accepts only the filter list and always serializes it without a
requirement_type, so callers cannot request the documentedAllbehavior. Please avoid documenting requirement-type modes on this parameter unless the model is extended to preserve and serialize them.
:keyword filters: Filters that run on the client to determine whether the feature is enabled.
By default (requirement type "Any"), the feature is considered enabled if at least one filter
evaluates to true. With requirement type "All", every filter must evaluate to true.
:paramtype filters: list[dict[str, Any]] or None
Description
Fixes for:
Have a request out for a test ignore for
no-cross-package-private-import(Testing private methods)Have requests out for sample ignores for
reimported,wrong-import-position,wrong-import-order, andungrouped-imports(These are due to how sample files are used in docs such asReadme.mdand we need to list the imports for each usage.)All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines