Skip to content

Fix azure-appconfiguration linting for pylint 4.0.6 - #48266

Open
Ali Satwat Khan (alisatwat3) wants to merge 14 commits into
Azure:mainfrom
alisatwat3:fix/azure-appconfiguration-pylint-4.0.6
Open

Fix azure-appconfiguration linting for pylint 4.0.6#48266
Ali Satwat Khan (alisatwat3) wants to merge 14 commits into
Azure:mainfrom
alisatwat3:fix/azure-appconfiguration-pylint-4.0.6

Conversation

@alisatwat3

Copy link
Copy Markdown

Description

Fixes #48262

Updates azure-appconfiguration for compatibility with Pylint 4.0.6 and Azure Pylint Guidelines Checker 0.5.9.

Changes include:

  • Completing constructor parameter documentation.
  • Adding narrow lint suppressions where APIs intentionally accept documented **kwargs.
  • Allowing tests to intentionally import private implementation details under test.
  • No runtime behavior or public API changes.

Validation:

  • Pylint source, tests, and samples: 10.00/10
  • Targeted unit tests: 55 passed
  • Black 24.4.0: passed
  • git diff --check: passed

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

Copilot AI balanced review requested due to automatic review settings July 26, 2026 23:16
@github-actions github-actions Bot added App Configuration Azure.ApplicationModel.Configuration Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Jul 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Thank you for your contribution Ali Satwat Khan (@alisatwat3)! We will review the pull request and get back to you soon.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
8 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates azure-appconfiguration for Pylint 4.0.6 compatibility without runtime or API changes.

Changes:

  • Adds constructor parameter documentation.
  • Applies targeted lint suppressions for intentional **kwargs and private test imports.
  • Preserves existing runtime behavior.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/test_sync_token_policy.py Allows private implementation imports in tests.
tests/test_query_param_policy.py Allows private policy import.
tests/test_http.py Allows private HTTP helper imports.
tests/test_consistency.py Allows generated model imports.
tests/test_azure_appconfiguration_client.py Allows private policy import.
tests/test_azure_appconfiguration_client_async.py Allows private policy import.
tests/test_audience.py Allows private audience helper import.
tests/test_audience_policy.py Allows private policy import.
tests/test_audience_error_handling_live.py Allows private policy import in live tests.
tests/test_audience_error_handling_live_async.py Allows private policy import in async live tests.
aio/_sync_token_async.py Suppresses intentional keyword-doc linting.
aio/_azure_appconfiguration_client_async.py Suppresses intentional keyword-doc linting.
_sync_token.py Suppresses intentional keyword-doc linting.
_models.py Adds model constructor documentation.
_azure_appconfiguration_requests.py Documents policy constructor parameters.
_azure_appconfiguration_client.py Suppresses intentional keyword-doc linting.
_audience_error_handling_policy.py Documents the audience-state parameter.

Comment thread sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_models.py Outdated
@alisatwat3

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 26, 2026 23:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings July 27, 2026 08:49

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings July 29, 2026 22:08
Copilot AI previously approved these changes Jul 29, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Ready to approve

The changes are narrowly scoped lint annotations consistent with the documented intent and introduce no behavioral changes.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details
  • Files reviewed: 12/12 changed files
  • Comments generated: 0 new
  • Review effort level: Medium

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Copilot AI review requested due to automatic review settings July 30, 2026 09:26
Copilot AI dismissed their stale review, a newer Copilot review was requested July 30, 2026 09:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Not ready to approve

The client-level pragmas should be narrowed so they do not hide future method documentation violations.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details

Comments suppressed due to low confidence (2)

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_azure_appconfiguration_client.py:48

  • This pragma is scoped to the entire class, so it also suppresses this documentation check for every method added below. Since only the constructor/class docstring intentionally documents values accepted through **kwargs, use disable-next for the class declaration to keep future method docstrings linted.
class AzureAppConfigurationClient:  # pylint: disable=docstring-keyword-should-match-keyword-only

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/aio/_azure_appconfiguration_client_async.py:49

  • This pragma is scoped to the entire class, so it also suppresses this documentation check for every async client method. Limit it to the class declaration with disable-next; that still covers the intentional constructor **kwargs documentation without hiding future method violations.
class AzureAppConfigurationClient:  # pylint: disable=docstring-keyword-should-match-keyword-only
  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Copilot AI review requested due to automatic review settings July 30, 2026 22:36
Copilot AI dismissed their stale review, a newer Copilot review was requested July 30, 2026 22:38
Copilot AI previously approved these changes Jul 30, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Ready to approve

The narrow lint suppressions are consistent with the documented intentional **kwargs API and introduce no runtime changes.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Copilot AI review requested due to automatic review settings August 2, 2026 13:31
Copilot AI dismissed their stale review, a newer Copilot review was requested August 2, 2026 13:33
Copilot AI previously approved these changes Aug 2, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Ready to approve

The narrow lint suppressions correctly address the documented constructor kwargs without changing behavior.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Copilot AI review requested due to automatic review settings August 3, 2026 09:59
Copilot AI dismissed their stale review, a newer Copilot review was requested August 3, 2026 10:01
Copilot AI previously approved these changes Aug 3, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Ready to approve

Both changes are narrow lint suppressions matching the intentional documented **kwargs API pattern.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Copilot AI review requested due to automatic review settings August 3, 2026 17:22
Copilot AI dismissed their stale review, a newer Copilot review was requested August 3, 2026 17:24
Copilot AI previously approved these changes Aug 3, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Ready to approve

The suppressions are narrowly scoped, consistent, and do not affect runtime behavior.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Copilot AI review requested due to automatic review settings August 3, 2026 19:42
Copilot AI dismissed their stale review, a newer Copilot review was requested August 3, 2026 19:44
Copilot AI previously approved these changes Aug 3, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Ready to approve

The targeted suppressions accurately cover intentional keyword documentation without changing behavior.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Copilot AI review requested due to automatic review settings August 4, 2026 08:49
Copilot AI dismissed their stale review, a newer Copilot review was requested August 4, 2026 08:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Ready to approve

The narrow lint suppressions consistently address the intended warning without affecting behavior.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

App Configuration Azure.ApplicationModel.Configuration Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

azure-appconfiguration needs linting updates for pylint version 4.0.6

3 participants