mirror of
				https://github.com/Unleash/unleash.git
				synced 2025-10-27 11:02:16 +01:00 
			
		
		
		
	docs: fix python sdk syntax highlighting, header levels (#1596)
* docs: fix python sdk syntax highlighting, header levels * docs(fix): remove invalid toggle names
This commit is contained in:
		
							parent
							
								
									c30e92dc49
								
							
						
					
					
						commit
						d384a76a28
					
				| @ -18,48 +18,48 @@ from UnleashClient import UnleashClient | ||||
|     client.is_enabled("unleash.beta.variants") | ||||
| ``` | ||||
| 
 | ||||
| ### Checking if a feature is enabled {#checking-if-a-feature-is-enabled} | ||||
| ## Checking if a feature is enabled {#checking-if-a-feature-is-enabled} | ||||
| 
 | ||||
| A check of a simple toggle: | ||||
| 
 | ||||
| ```Python | ||||
| client.is_enabled("My Toggle") | ||||
| ```python | ||||
| client.is_enabled("my_toggle") | ||||
| ``` | ||||
| 
 | ||||
| Specifying a default value: | ||||
| 
 | ||||
| ```Python | ||||
| client.is_enabled("My Toggle", default_value=True) | ||||
| ```python | ||||
| client.is_enabled("my_toggle", default_value=True) | ||||
| ``` | ||||
| 
 | ||||
| Supplying application context: | ||||
| 
 | ||||
| ```Python | ||||
| ```python | ||||
| app_context = {"userId": "test@email.com"} | ||||
| client.is_enabled("User ID Toggle", app_context) | ||||
| client.is_enabled("user_id_toggle", app_context) | ||||
| ``` | ||||
| 
 | ||||
| Supplying a fallback function: | ||||
| 
 | ||||
| ```Python | ||||
| ```python | ||||
| def custom_fallback(feature_name: str, context: dict) -> bool: | ||||
|     return True | ||||
| 
 | ||||
| client.is_enabled("My Toggle", fallback_function=custom_fallback) | ||||
| client.is_enabled("my_toggle", fallback_function=custom_fallback) | ||||
| ``` | ||||
| 
 | ||||
| - Must accept the feature name and context as an argument. | ||||
| - Client will evaluate the fallback function only if exception occurs when calling the `is_enabled()` method i.e. feature flag not found or other general exception. | ||||
| - If both a `default_value` and `fallback_function` are supplied, client will define the default value by `OR`ing the default value and the output of the fallback function. | ||||
| 
 | ||||
| ### Getting a variant {#getting-a-variant} | ||||
| ## 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("MyvariantToggle", context) | ||||
| variant = client.get_variant("my_variant_toggle", context) | ||||
| 
 | ||||
| print(variant) | ||||
| > { | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user