App Configuration Provider Cleanup by mrm9084 · Pull Request #47801 · Azure/azure-sdk-for-python

mrm9084 · 2026-07-01T21:20:35Z

Description

Mostly Updates missing/wrong doc strings and type hints.

But also:

Removes some dead code from old refactors mostly JOSN type in multiple locations.
Unused imports
Fixes watch settings type checking
raise instead of raise e
A few places we checked for int overflow, but that isn't a thing in python.

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.

Mostly docstring fixes and a couple bug fixes.

Copilot

Pull request overview

This PR cleans up the Azure App Configuration Provider implementation by improving docstrings/type hints, removing unused/dead code, and refining replica discovery/refresh behavior (including closing no-longer-used replica clients and distinguishing DNS timeout vs empty replica results).

Changes:

Improve/normalize docstrings and type hints across sync/async provider, client managers, and Key Vault secret providers.
Refine replica discovery/refresh logic: distinguish SRV lookup timeout vs empty replica list, and close replica clients removed from the failover set.
Clean up constants/imports and minor behavioral fixes (e.g., raise vs raise e, whitespace handling).

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
sdk/appconfiguration/azure-appconfiguration-provider/tests/test_utils.py	Updates assertion to match new attempts validation message.
sdk/appconfiguration/azure-appconfiguration-provider/tests/test_request_tracing_context.py	Updates tests to use renamed env-var constants.
sdk/appconfiguration/azure-appconfiguration-provider/tests/test_configuration_client_manager.py	Adds `close()` to test stub client to support new close calls.
sdk/appconfiguration/azure-appconfiguration-provider/tests/test_configuration_client_manager_load_balance.py	Adds `close()` to test stub client to support new close calls.
sdk/appconfiguration/azure-appconfiguration-provider/tests/aio/test_configuration_async_client_manager.py	Adds `async close()` to async test stub client.
sdk/appconfiguration/azure-appconfiguration-provider/tests/aio/test_configuration_async_client_manager_load_balance.py	Adds `async close()` to async test stub client.
sdk/appconfiguration/azure-appconfiguration-provider/CHANGELOG.md	Documents replica-client leak fix and timeout-vs-empty discovery behavior.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/aio/_key_vault/_async_secret_provider.py	Removes unused JSON alias/import; fixes close docstring wording.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/aio/_azureappconfigurationproviderasync.py	Adds docstring for `_attempt_refresh` and removes unused JSON alias.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/aio/_async_load.py	Fixes docstring keyword typing text and removes duplicated docs.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/aio/_async_discovery.py	Raises `TimeoutError` on SRV timeout to distinguish from empty results.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/aio/_async_client_manager.py	Improves type hints/docstrings; catches timeout via exception; closes removed replicas.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_utils.py	Doc/type cleanup and backoff calc simplification; adjusts validation/error text.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_snapshot_reference_parser.py	Improves docstring and normalizes whitespace handling.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_request_tracing_context.py	Renames imported env-var constants; removes dead constants; minor loop var cleanup.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_refresh_timer.py	Simplifies backoff cap logic (removes redundant overflow check).
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_models.py	Tightens docstring typing for Key Vault options and selectors.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_load.py	Moves JSON alias local; fixes docstring keyword typing text and removes duplicated docs.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_key_vault/_secret_provider.py	Removes unused JSON alias/import; fixes close docstring wording.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_key_vault/_secret_provider_base.py	Removes unused typing aliases; clarifies validation message.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_json.py	Clarifies docstring wording for comment-stripping helper.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_discovery.py	Raises `TimeoutError` on SRV timeout to distinguish from empty results.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_constants.py	Renames env-var constants to uppercase; minor comment formatting.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_client_manager.py	Improves type hints/docstrings; catches timeout via exception; closes removed replicas.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_client_manager_base.py	Removes unused typing aliases; renames load-balancing param; simplifies backoff cap.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_azureappconfigurationproviderbase.py	Refines watched-setting parsing and adds locks on additional read operations.
sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_azureappconfigurationprovider.py	Makes connection_string kw pop default-safe and adds docstring for `_attempt_refresh`.

yuanqu72 · 2026-07-13T20:52:54Z

-        :param str etag: etag to check for changes
-        :param Mapping[str, str] headers: headers to use for the request
+        :param Optional[str] etag: etag to check for changes
+        :param Dict[str, str] headers: headers to use for the request


Should we keep the Mapping interface instead of a concrete Dict here?

yuanqu72 · 2026-07-13T21:28:34Z

    startup_timeout = kwargs.pop("startup_timeout", DEFAULT_STARTUP_TIMEOUT)
    if startup_timeout < 0:
-        raise ValueError("Startup timeout must be greater than or equal to 0 seconds.")
+        raise ValueError("Startup timeout must be at least 1 second.")


Shouldn't this be at least 0 instead of 1?

I'm thinking this is from a version of this before I split things up to bug fixes and doc updates. I'll revert.

yuanqu72 · 2026-07-13T21:30:23Z

    attempts += 1
    if attempts < 1:
-        raise ValueError("Number of attempts must be at least 1.")
+        raise ValueError("Number of attempts must be at least 0.")


Any reason we change this number to 0? attempts < 1 naturally checks if the value is supposed to be at least 1?

The user provides attempts but we add 1 to it before doing this check. So, they as a user need at least 0 to be provided.

mrm9084 added 5 commits July 1, 2026 13:48

Updating Provider

5fe5fd4

Mostly docstring fixes and a couple bug fixes.

fixed formatting

ab4fc7a

pylint updates

26ea971

undo skills

1bbca38

Update CHANGELOG.md

c09e52c

mrm9084 requested a review from Copilot July 1, 2026 21:20

mrm9084 requested review from avanigupta and jimmyca15 as code owners July 1, 2026 21:20

github-actions Bot added the App Configuration Azure.ApplicationModel.Configuration label Jul 1, 2026

Copilot started reviewing on behalf of mrm9084 July 1, 2026 21:21 View session

Copilot AI reviewed Jul 1, 2026

View reviewed changes

mrm9084 added 2 commits July 7, 2026 15:43

Moving bug fixes to there own PR

2792d78

moving other changes to other branch

dc02e13

yuanqu72 reviewed Jul 13, 2026

View reviewed changes

Update _utils.py

ca77570

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

App Configuration Provider Cleanup#47801

App Configuration Provider Cleanup#47801
mrm9084 wants to merge 8 commits into
Azure:mainfrom
mrm9084:Cleanup

mrm9084 commented Jul 1, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yuanqu72 Jul 13, 2026

Uh oh!

yuanqu72 Jul 13, 2026

Uh oh!

mrm9084 Jul 13, 2026

Uh oh!

yuanqu72 Jul 13, 2026

Uh oh!

mrm9084 Jul 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

mrm9084 commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

All SDK Contribution checklist:

General Guidelines and Best Practices

Testing Guidelines

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yuanqu72 Jul 13, 2026

Choose a reason for hiding this comment

Uh oh!

yuanqu72 Jul 13, 2026

Choose a reason for hiding this comment

Uh oh!

mrm9084 Jul 13, 2026

Choose a reason for hiding this comment

Uh oh!

yuanqu72 Jul 13, 2026

Choose a reason for hiding this comment

Uh oh!

mrm9084 Jul 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mrm9084 commented Jul 1, 2026 •

edited

Loading