mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
77 lines
2.6 KiB
Markdown
77 lines
2.6 KiB
Markdown
---
|
|
title: Python SDK
|
|
---
|
|
|
|
> You will need your `API URL` and your `API token` in order to connect the Client SDK to you Unleash instance. You can find this information in the “Admin” section Unleash management UI. [Read more](../../how-to/how-to-create-api-tokens.mdx)
|
|
|
|
```python
|
|
from UnleashClient import UnleashClient
|
|
|
|
client = UnleashClient(
|
|
url="<API url>",
|
|
app_name="my-python-app",
|
|
custom_headers={'Authorization': '<API token>'})
|
|
|
|
client.initialize_client()
|
|
|
|
client.is_enabled("unleash.beta.variants")
|
|
```
|
|
|
|
## Checking if a feature is enabled {#checking-if-a-feature-is-enabled}
|
|
|
|
Check a feature's status:
|
|
|
|
```Python title="Check whether a feature is enabled"
|
|
client.is_enabled("my_toggle")
|
|
```
|
|
|
|
To supply application context, use the second positional argument:
|
|
|
|
```Python title="Check whether a feature is enabled for the given context"
|
|
app_context = {"userId": "test@email.com"}
|
|
client.is_enabled("user_id_toggle", app_context)
|
|
```
|
|
|
|
### Fallback function and default values
|
|
|
|
You can specify a fallback function for cases where the client doesn't recognize the toggle by using the `fallback_function` keyword argument:
|
|
|
|
```Python title="Check a feature status, using a fallback if the feature is unrecognized."
|
|
def custom_fallback(feature_name: str, context: dict) -> bool:
|
|
return True
|
|
|
|
client.is_enabled("my_toggle", fallback_function=custom_fallback)
|
|
```
|
|
|
|
You can also use the `fallback_function` argument to replace the obsolete `default_value` keyword argument by using a lambda that ignores its inputs. Whatever the lambda returns will be used as the default value.
|
|
|
|
```Python title="Use fallback_function to provide a default value"
|
|
client.is_enabled("my_toggle", fallback_function=lambda feature_name, context: True)
|
|
```
|
|
|
|
The fallback function **must** accept the feature name and context as positional arguments in that order.
|
|
|
|
The client will evaluate the fallback function only if an exception occurs when calling the `is_enabled()` method. This happens when the client can't find the feature flag. The client _may_ also throw other, general exceptions.
|
|
|
|
## Getting a variant {#getting-a-variant}
|
|
|
|
Checking for a variant:
|
|
|
|
```python
|
|
context = {'userId': '2'} # Context must have userId, sessionId, or remoteAddr. If none are present, distribution will be random.
|
|
|
|
variant = client.get_variant("my_variant_toggle", context)
|
|
|
|
print(variant)
|
|
> {
|
|
> "name": "variant1",
|
|
> "payload": {
|
|
> "type": "string",
|
|
> "value": "val1"
|
|
> },
|
|
> "enabled": True
|
|
> }
|
|
```
|
|
|
|
Read more at [github.com/Unleash/unleash-client-python](https://github.com/Unleash/unleash-client-python)
|