class documentation

class CheckRegistry:

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method get​_checks Undocumented
Method register Can be used as a function or a decorator. Register given function f labeled with given tags. The function should receive **kwargs and return list of Errors and Warnings.
Method run​_checks Run all registered checks and return list of Errors and Warnings.
Method tag​_exists Undocumented
Method tags​_available Undocumented
Instance Variable deployment​_checks Undocumented
Instance Variable registered​_checks Undocumented
def __init__(self):

Undocumented

def get_checks(self, include_deployment_checks=False):

Undocumented

def register(self, check=None, *tags, **kwargs):

Can be used as a function or a decorator. Register given function f labeled with given tags. The function should receive **kwargs and return list of Errors and Warnings.

Example:

registry = CheckRegistry()
@registry.register('mytag', 'anothertag')
def my_check(app_configs, **kwargs):
    # ... perform checks and collect `errors` ...
    return errors
# or
registry.register(my_check, 'mytag', 'anothertag')
def run_checks(self, app_configs=None, tags=None, include_deployment_checks=False, databases=None):
Run all registered checks and return list of Errors and Warnings.
def tag_exists(self, tag, include_deployment_checks=False):

Undocumented

def tags_available(self, deployment_checks=False):

Undocumented

deployment_checks: set =

Undocumented

registered_checks: set =

Undocumented