Snippet

Decorator Factory for Conditional Test Environment Setup

This expert decorator factory pattern dynamically applies Django test setting overrides based on control flow conditions evaluated at runtime. It combines Python function closure principles with Django's override_settings context manager to provide flexible setup environments for targeted unit tests.

snippet.py

python

from functools import wraps
from typing import Callable
from django.test import override_settings
 
def conditionally_override(**settings_kwargs):
    def decorator(func: Callable):
        @wraps(func)
        def wrapper(*args, **kwargs):
            if settings_kwargs.get('DEBUG', False):
                with override_settings(**settings_kwargs):
                    return func(*args, **kwargs)
            return func(*args, **kwargs)
        return wrapper
    return decorator

django

Breakdown

from functools import wraps

Imports wraps decorator to preserve underlying function metadata.

from typing import Callable

Imports Callable type hint for decorating target function parameter.

from django.test import override_settings

Imports Django testing utility for overriding active application configuration settings.

def conditionally_override(**settings_kwargs):

Defines parameter factory accepting key-value pairs of settings to override.

def decorator(func: Callable):

Constructs decorator accepting target test function argument.

@wraps(func)

Applies metadata preservation onto nested wrapper execution unit.

def wrapper(*args, **kwargs):

Defines inner function wrapping test execution logic.

if settings_kwargs.get('DEBUG', False):

Evaluates dynamic predicate condition based on passed configuration dictionary.

with override_settings(**settings_kwargs):

Enters setting override context manager applying temporary configuration variables.

return func(*args, **kwargs)

Executes wrapped test function within overridden settings context scope.

return func(*args, **kwargs)

Executes test directly when conditional predicate evaluates false.

return wrapper

Returns decorated wrapper function signature.

return decorator

Returns decorator function from factory definition.

Previous snippet Next snippet

More Expert Python exercises →

Decorator Factory for Conditional Test Environment Setup

Related