[alexanto]

Replaces the 26 flat constructor arguments of UnleashClient and AsyncUnleashClient with option groups, moves the API token to its own api_key argument, and makes the client's settings immutable.

Planned for release in v7. This is a breaking change.

# Before:
client = UnleashClient(
    url="https://YOUR-API-URL",
    app_name="my-python-app",
    environment="production",
    custom_headers={"Authorization": "<API token>"},
    refresh_interval=30,
    disable_metrics=True,
    experimental_mode={"type": "streaming"},
)

# After:
client = UnleashClient(
    "https://YOUR-API-URL",
    "my-python-app",
    api_key="<API token>",
    identity=IdentityOptions(environment="production"),
    mode=StreamingOptions(),  # or PollingOptions(interval=30)
    metrics=MetricsOptions(disabled=True),
)

What changes:

• Option groups: settings are grouped into frozen dataclasses: IdentityOptions, HttpOptions, MetricsOptions, and a mode that is either PollingOptions or StreamingOptions.
• api_key: the API token is its own argument instead of an Authorization entry in the custom headers. An Authorization header in HttpOptions.headers raises a ValueError, so an unmigrated v6 client fails at startup instead of silently getting 401s and serving cached flags.
• Polling and streaming are separate types, with polling as default
• Keyword-only arguments: everything after url and app_name (the two required arguments) must be passed by name
• Immutable settings
  read-only. Their nrence, becauseoptions can hold objects that can't be copied, such as an SSL
  context.
• Removed properties: the 19 unleash_* settings properties and their setters
• ExperimentalMode removed

Docs: readme, changelog and migration guide added.

Type of change

• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• This change requires an update in the unleash-sdk-examples repo for the python app

How Has This Been Tested?

• Unit tests, including some new ones
• Spec Tests
• Manual tests with the example app

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

[Copilot]

🟡 Changes recommended

Mutable HTTP option dictionaries and shared nested values still allow request settings to change after construction, violating the immutability guarantee.

1 open issue

• Protect HttpOptions mappings from shared mutable state · New

_{Review effort: Balanced}

[sighphyre]

I'm down. I like it @ppicom you have thoughts?

[ppicom]

Nope @sighphyre, no thoughts. LGTM! 🚢 🇮🇹