Your opinion will help to improve our service

Detailed Description

Supply dynamic configs for the service in testsuite.

Classes
class	_Changelog

class	_ChangelogEntry

class	_ConfigDefaults

class	_ConfigEntry

class	_Missing

class	_RemoveKey

class	_Updates

class	BaseError
	Base class for exceptions from this module. More...

class	DynamicConfig
	Simple dynamic config backend. More...

class	DynamicConfigNotFoundError
	Config parameter was not found and no default was provided. More...

class	DynamicConfigUninitialized
	Calling `dynamic_config.get` before defaults are fetched from the service. More...

class	InvalidDefaultsError
	Dynamic config defaults action returned invalid response. More...

class	UnknownConfigError
	Invalid dynamic config name in `@pytest.mark.config` More...

class	UseStaticDefault

Functions
_ConfigDict	_create_config_dict (ConfigValuesDict values, Optional[Set[str]] kill_switches_disabled=None)

DynamicConfig	dynamic_config (request, search_path, object_substitute, cache_invalidation_state, _dynamic_config_defaults_storage, config_service_defaults, dynamic_config_changelog, _dynconf_load_json_cached, dynconf_cache_names)
	Fixture that allows to control dynamic config values used by the service.

Iterable[str]	dynconf_cache_names ()

	_dynconf_json_cache ()

	_dynconf_load_json_cached (json_loads, _dynconf_json_cache)

DynamicConfig	taxi_config (dynamic_config)
	Deprecated, use `dynamic_config` instead.

ConfigValuesDict	dynamic_config_fallback_patch ()
	Override this fixture to replace some dynamic config values specifically for testsuite tests:

ConfigValuesDict	config_service_defaults (config_fallback_path, dynamic_config_fallback_patch)
	Fixture that returns default values for dynamic config.

_ConfigDefaults	_dynamic_config_defaults_storage ()

	userver_config_dynconf_cache (service_tmpdir)
	Returns a function that adjusts the static configuration file for the testsuite.

	userver_config_dynconf_fallback (config_service_defaults)
	Returns a function that adjusts the static configuration file for the testsuite.

	userver_config_dynconf_url (mockserver_info)
	Returns a function that adjusts the static configuration file for the testsuite.

None	mock_configs_service (mockserver, DynamicConfig dynamic_config, _Changelog dynamic_config_changelog)
	Adds a mockserver handler that forwards dynamic_config to service's `dynamic-config-client` component.

	_userver_dynconfig_cache_control (_Changelog dynamic_config_changelog)

Callable[[], None]	_check_config_marks (request, _dynamic_config_defaults_storage)

Variables
list	USERVER_CONFIG_HOOKS

dict	USERVER_CACHE_CONTROL_HOOKS

	ConfigValuesDict = Dict[str, Any]

	_REMOVE_KEY = _RemoveKey()

	_MISSING = _Missing()

	_ConfigDict = Dict[str, _ConfigEntry \| _RemoveKey]

	USE_STATIC_DEFAULT = UseStaticDefault()

tuple	_CHECK_CONFIG_ERROR

Function Documentation

◆ _check_config_marks()

Callable[[], None] pytest_userver.plugins.dynamic_config._check_config_marks	(	request,
		_dynamic_config_defaults_storage
	)

protected

Definition at line 752 of file dynamic_config.py.

◆ _create_config_dict()

_ConfigDict pytest_userver.plugins.dynamic_config._create_config_dict	(	ConfigValuesDict	values,
		Optional[Set[str]]	kill_switches_disabled = `None`
	)

protected

Definition at line 85 of file dynamic_config.py.

◆ _dynamic_config_defaults_storage()

_ConfigDefaults pytest_userver.plugins.dynamic_config._dynamic_config_defaults_storage ( )

protected

Definition at line 584 of file dynamic_config.py.

◆ _dynconf_json_cache()

pytest_userver.plugins.dynamic_config._dynconf_json_cache ( )

protected

Definition at line 489 of file dynamic_config.py.

◆ _dynconf_load_json_cached()

pytest_userver.plugins.dynamic_config._dynconf_load_json_cached	(	json_loads,
		_dynconf_json_cache
	)

protected

Definition at line 494 of file dynamic_config.py.

◆ _userver_dynconfig_cache_control()

pytest_userver.plugins.dynamic_config._userver_dynconfig_cache_control ( _Changelog dynamic_config_changelog )

protected

Definition at line 728 of file dynamic_config.py.

◆ dynconf_cache_names()

Iterable[str] pytest_userver.plugins.dynamic_config.dynconf_cache_names ( )

Definition at line 484 of file dynamic_config.py.

◆ taxi_config()

DynamicConfig pytest_userver.plugins.dynamic_config.taxi_config ( dynamic_config )

Deprecated, use dynamic_config instead.

Definition at line 504 of file dynamic_config.py.

Variable Documentation

◆ _CHECK_CONFIG_ERROR

tuple pytest_userver.plugins.dynamic_config._CHECK_CONFIG_ERROR

protected

Initial value:

=  (
    'Your are trying to override config value using '
    '@pytest.mark.config({}) '
    'that does not seem to be used by your service.\n\n'
    'In case you really need to disable this check please add the '
    'following mark to your testcase:\n\n'
    '@pytest.mark.disable_config_check'
)

Definition at line 740 of file dynamic_config.py.

◆ _ConfigDict

pytest_userver.plugins.dynamic_config._ConfigDict = Dict[str, _ConfigEntry | _RemoveKey]

protected

Definition at line 82 of file dynamic_config.py.

◆ _MISSING

pytest_userver.plugins.dynamic_config._MISSING = _Missing()

protected

Definition at line 73 of file dynamic_config.py.

◆ _REMOVE_KEY

pytest_userver.plugins.dynamic_config._REMOVE_KEY = _RemoveKey()

protected

Definition at line 66 of file dynamic_config.py.

◆ ConfigValuesDict

pytest_userver.plugins.dynamic_config.ConfigValuesDict = Dict[str, Any]

Definition at line 59 of file dynamic_config.py.

◆ USE_STATIC_DEFAULT

pytest_userver.plugins.dynamic_config.USE_STATIC_DEFAULT = UseStaticDefault()

Definition at line 398 of file dynamic_config.py.

◆ USERVER_CACHE_CONTROL_HOOKS

dict pytest_userver.plugins.dynamic_config.USERVER_CACHE_CONTROL_HOOKS

Initial value:

=  {
    'dynamic-config-client-updater': '_userver_dynconfig_cache_control',
}

Definition at line 31 of file dynamic_config.py.

◆ USERVER_CONFIG_HOOKS

list pytest_userver.plugins.dynamic_config.USERVER_CONFIG_HOOKS

Initial value:

=  [
    'userver_config_dynconf_cache',
    'userver_config_dynconf_fallback',
    'userver_config_dynconf_url',
]

Definition at line 26 of file dynamic_config.py.

Table of Contents

Detailed Description

Classes

Functions

Variables

Function Documentation

◆ _check_config_marks()

◆ _create_config_dict()

◆ _dynamic_config_defaults_storage()

◆ _dynconf_json_cache()

◆ _dynconf_load_json_cached()

◆ _userver_dynconfig_cache_control()

◆ dynconf_cache_names()

◆ taxi_config()

Variable Documentation

◆ _CHECK_CONFIG_ERROR

◆ _ConfigDict

◆ _MISSING

◆ _REMOVE_KEY

◆ ConfigValuesDict

◆ USE_STATIC_DEFAULT

◆ USERVER_CACHE_CONTROL_HOOKS

◆ USERVER_CONFIG_HOOKS