Home Assistant Unofficial Reference 2024.12.1
homeassistant.scripts.check_config Namespace Reference

Functions

def async_check_config (config_dir)
 
def check (config_dir, secrets=False)
 
def color (the_color, *args, reset=None)
 
def dump_dict (layer, indent_count=3, listi=False, **kwargs)
 
def line_info (obj, **kwargs)
 
int run (list script_args)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string C_HEAD = "bold"
 
string ERROR_STR = "General Errors"
 
tuple REQUIREMENTS = ("colorlog==6.8.2",)
 
string WARNING_STR = "General Warnings"
 

Detailed Description

Script to check the configuration file.

Function Documentation

◆ async_check_config()

def homeassistant.scripts.check_config.async_check_config (   config_dir)
Check the HA config.

Definition at line 253 of file check_config.py.

◆ check()

def homeassistant.scripts.check_config.check (   config_dir,
  secrets = False 
)
Perform a check by mocking hass load functions.

Definition at line 171 of file check_config.py.

◆ color()

def homeassistant.scripts.check_config.color (   the_color,
args,
  reset = None 
)
Color helper.

Definition at line 47 of file check_config.py.

◆ dump_dict()

def homeassistant.scripts.check_config.dump_dict (   layer,
  indent_count = 3,
  listi = False,
**  kwargs 
)
Display a dict.

A friendly version of print yaml_loader.yaml.dump(config).

Definition at line 276 of file check_config.py.

◆ line_info()

def homeassistant.scripts.check_config.line_info (   obj,
**  kwargs 
)
Display line config source.

Definition at line 267 of file check_config.py.

◆ run()

int homeassistant.scripts.check_config.run ( list  script_args)
Handle check config commandline script.

Definition at line 61 of file check_config.py.

Variable Documentation

◆ _LOGGER

homeassistant.scripts.check_config._LOGGER = logging.getLogger(__name__)
private

Definition at line 33 of file check_config.py.

◆ C_HEAD

string homeassistant.scripts.check_config.C_HEAD = "bold"

Definition at line 42 of file check_config.py.

◆ ERROR_STR

string homeassistant.scripts.check_config.ERROR_STR = "General Errors"

Definition at line 43 of file check_config.py.

◆ REQUIREMENTS

tuple homeassistant.scripts.check_config.REQUIREMENTS = ("colorlog==6.8.2",)

Definition at line 31 of file check_config.py.

◆ WARNING_STR

string homeassistant.scripts.check_config.WARNING_STR = "General Warnings"

Definition at line 44 of file check_config.py.