Home-Assistant/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-12-25 05:26:47 +00:00
Code Activity

Black

Browse Source
This commit is contained in:
Paulus Schoutsen
2019-07-31 12:25:30 -07:00
parent da05dfe708
commit 4de97abc3a
2676 changed files with 163166 additions and 140084 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
homeassistant/loader.py
View File

@@ -30,23 +30,23 @@ from typing import (
if TYPE_CHECKING:
from homeassistant.core import HomeAssistant # noqa
CALLABLE_T = TypeVar('CALLABLE_T', bound=Callable) # noqa pylint: disable=invalid-name
CALLABLE_T = TypeVar("CALLABLE_T", bound=Callable) # noqa pylint: disable=invalid-name
DEPENDENCY_BLACKLIST = {'config'}
DEPENDENCY_BLACKLIST = {"config"}
_LOGGER = logging.getLogger(__name__)
DATA_COMPONENTS = 'components'
DATA_INTEGRATIONS = 'integrations'
DATA_CUSTOM_COMPONENTS = 'custom_components'
PACKAGE_CUSTOM_COMPONENTS = 'custom_components'
PACKAGE_BUILTIN = 'homeassistant.components'
DATA_COMPONENTS = "components"
DATA_INTEGRATIONS = "integrations"
DATA_CUSTOM_COMPONENTS = "custom_components"
PACKAGE_CUSTOM_COMPONENTS = "custom_components"
PACKAGE_BUILTIN = "homeassistant.components"
LOOKUP_PATHS = [PACKAGE_CUSTOM_COMPONENTS, PACKAGE_BUILTIN]
CUSTOM_WARNING = (
'You are using a custom integration for %s which has not '
'been tested by Home Assistant. This component might '
'cause stability problems, be sure to disable it if you '
'do experience issues with Home Assistant.'
"You are using a custom integration for %s which has not "
"been tested by Home Assistant. This component might "
"cause stability problems, be sure to disable it if you "
"do experience issues with Home Assistant."
)
_UNDEF = object()
@@ -54,17 +54,18 @@ _UNDEF = object()
def manifest_from_legacy_module(domain: str, module: ModuleType) -> Dict:
"""Generate a manifest from a legacy module."""
return {
'domain': domain,
'name': domain,
'documentation': None,
'requirements': getattr(module, 'REQUIREMENTS', []),
'dependencies': getattr(module, 'DEPENDENCIES', []),
'codeowners': [],
"domain": domain,
"name": domain,
"documentation": None,
"requirements": getattr(module, "REQUIREMENTS", []),
"dependencies": getattr(module, "DEPENDENCIES", []),
"codeowners": [],
}
async def _async_get_custom_components(
hass: 'HomeAssistant') -> Dict[str, 'Integration']:
hass: "HomeAssistant"
) -> Dict[str, "Integration"]:
"""Return list of custom integrations."""
try:
import custom_components
@@ -81,16 +82,17 @@ async def _async_get_custom_components(
]
dirs = await hass.async_add_executor_job(
get_sub_directories, custom_components.__path__)
get_sub_directories, custom_components.__path__
)
integrations = await asyncio.gather(*(
hass.async_add_executor_job(
Integration.resolve_from_root,
hass,
custom_components,
comp.name)
for comp in dirs
))
integrations = await asyncio.gather(
*(
hass.async_add_executor_job(
Integration.resolve_from_root, hass, custom_components, comp.name
)
for comp in dirs
)
)
return {
integration.domain: integration
@@ -100,7 +102,8 @@ async def _async_get_custom_components(
async def async_get_custom_components(
hass: 'HomeAssistant') -> Dict[str, 'Integration']:
hass: "HomeAssistant"
) -> Dict[str, "Integration"]:
"""Return cached list of custom integrations."""
reg_or_evt = hass.data.get(DATA_CUSTOM_COMPONENTS)
@@ -115,25 +118,26 @@ async def async_get_custom_components(
if isinstance(reg_or_evt, asyncio.Event):
await reg_or_evt.wait()
return cast(Dict[str, 'Integration'],
hass.data.get(DATA_CUSTOM_COMPONENTS))
return cast(Dict[str, "Integration"], hass.data.get(DATA_CUSTOM_COMPONENTS))
return cast(Dict[str, 'Integration'],
reg_or_evt)
return cast(Dict[str, "Integration"], reg_or_evt)
async def async_get_config_flows(hass: 'HomeAssistant') -> Set[str]:
async def async_get_config_flows(hass: "HomeAssistant") -> Set[str]:
"""Return cached list of config flows."""
from homeassistant.generated.config_flows import FLOWS
flows = set() # type: Set[str]
flows.update(FLOWS)
integrations = await async_get_custom_components(hass)
flows.update([
integration.domain
for integration in integrations.values()
if integration.config_flow
])
flows.update(
[
integration.domain
for integration in integrations.values()
if integration.config_flow
]
)
return flows
@@ -142,13 +146,12 @@ class Integration:
"""An integration in Home Assistant."""
@classmethod
def resolve_from_root(cls, hass: 'HomeAssistant', root_module: ModuleType,
domain: str) -> 'Optional[Integration]':
def resolve_from_root(
cls, hass: "HomeAssistant", root_module: ModuleType, domain: str
) -> "Optional[Integration]":
"""Resolve an integration from a root module."""
for base in root_module.__path__: # type: ignore
manifest_path = (
pathlib.Path(base) / domain / 'manifest.json'
)
for base in root_module.__path__: # type: ignore
manifest_path = pathlib.Path(base) / domain / "manifest.json"
if not manifest_path.is_file():
continue
@@ -156,20 +159,24 @@ class Integration:
try:
manifest = json.loads(manifest_path.read_text())
except ValueError as err:
_LOGGER.error("Error parsing manifest.json file at %s: %s",
manifest_path, err)
_LOGGER.error(
"Error parsing manifest.json file at %s: %s", manifest_path, err
)
continue
return cls(
hass, "{}.{}".format(root_module.__name__, domain),
manifest_path.parent, manifest
hass,
"{}.{}".format(root_module.__name__, domain),
manifest_path.parent,
manifest,
)
return None
@classmethod
def resolve_legacy(cls, hass: 'HomeAssistant', domain: str) \
-> 'Optional[Integration]':
def resolve_legacy(
cls, hass: "HomeAssistant", domain: str
) -> "Optional[Integration]":
"""Resolve legacy component.
Will create a stub manifest.
@@ -180,23 +187,31 @@ class Integration:
return None
return cls(
hass, comp.__name__, pathlib.Path(comp.__file__).parent,
manifest_from_legacy_module(domain, comp)
hass,
comp.__name__,
pathlib.Path(comp.__file__).parent,
manifest_from_legacy_module(domain, comp),
)
def __init__(self, hass: 'HomeAssistant', pkg_path: str,
file_path: pathlib.Path, manifest: Dict):
def __init__(
self,
hass: "HomeAssistant",
pkg_path: str,
file_path: pathlib.Path,
manifest: Dict,
):
"""Initialize an integration."""
self.hass = hass
self.pkg_path = pkg_path
self.file_path = file_path
self.name = manifest['name'] # type: str
self.domain = manifest['domain'] # type: str
self.dependencies = manifest['dependencies'] # type: List[str]
self.name = manifest["name"] # type: str
self.domain = manifest["domain"] # type: str
self.dependencies = manifest["dependencies"] # type: List[str]
self.after_dependencies = manifest.get(
'after_dependencies') # type: Optional[List[str]]
self.requirements = manifest['requirements'] # type: List[str]
self.config_flow = manifest.get('config_flow', False) # type: bool
"after_dependencies"
) # type: Optional[List[str]]
self.requirements = manifest["requirements"] # type: List[str]
self.config_flow = manifest.get("config_flow", False) # type: bool
_LOGGER.info("Loaded %s from %s", self.domain, pkg_path)
@property
@@ -226,8 +241,7 @@ class Integration:
return "<Integration {}: {}>".format(self.domain, self.pkg_path)
async def async_get_integration(hass: 'HomeAssistant', domain: str)\
-> Integration:
async def async_get_integration(hass: "HomeAssistant", domain: str) -> Integration:
"""Get an integration."""
cache = hass.data.get(DATA_INTEGRATIONS)
if cache is None:
@@ -236,7 +250,8 @@ async def async_get_integration(hass: 'HomeAssistant', domain: str)\
cache = hass.data[DATA_INTEGRATIONS] = {}
int_or_evt = cache.get(
domain, _UNDEF) # type: Union[Integration, asyncio.Event, None]
domain, _UNDEF
) # type: Union[Integration, asyncio.Event, None]
if isinstance(int_or_evt, asyncio.Event):
await int_or_evt.wait()
@@ -306,15 +321,18 @@ class CircularDependency(LoaderError):
def __init__(self, from_domain: str, to_domain: str) -> None:
"""Initialize circular dependency error."""
super().__init__("Circular dependency detected: {} -> {}.".format(
from_domain, to_domain))
super().__init__(
"Circular dependency detected: {} -> {}.".format(from_domain, to_domain)
)
self.from_domain = from_domain
self.to_domain = to_domain
def _load_file(hass, # type: HomeAssistant
comp_or_platform: str,
base_paths: List[str]) -> Optional[ModuleType]:
def _load_file(
hass, # type: HomeAssistant
comp_or_platform: str,
base_paths: List[str],
) -> Optional[ModuleType]:
"""Try to load specified file.
Looks in config dir first, then built-in components.
@@ -332,8 +350,7 @@ def _load_file(hass, # type: HomeAssistant
return None
cache = hass.data[DATA_COMPONENTS] = {}
for path in ('{}.{}'.format(base, comp_or_platform)
for base in base_paths):
for path in ("{}.{}".format(base, comp_or_platform) for base in base_paths):
try:
module = importlib.import_module(path)
@@ -346,7 +363,7 @@ def _load_file(hass, # type: HomeAssistant
# custom_components/switch/some_platform.py exists,
# the import custom_components.switch would succeed.
# __file__ was unset for namespaces before Python 3.7
if getattr(module, '__file__', None) is None:
if getattr(module, "__file__", None) is None:
continue
cache[comp_or_platform] = module
@@ -363,15 +380,17 @@ def _load_file(hass, # type: HomeAssistant
# and custom_components.switch.demo.
white_listed_errors = []
parts = []
for part in path.split('.'):
for part in path.split("."):
parts.append(part)
white_listed_errors.append(
"No module named '{}'".format('.'.join(parts)))
"No module named '{}'".format(".".join(parts))
)
if str(err) not in white_listed_errors:
_LOGGER.exception(
("Error loading %s. Make sure all "
"dependencies are installed"), path)
("Error loading %s. Make sure all " "dependencies are installed"),
path,
)
return None
@@ -379,9 +398,11 @@ def _load_file(hass, # type: HomeAssistant
class ModuleWrapper:
"""Class to wrap a Python module and auto fill in hass argument."""
def __init__(self,
hass, # type: HomeAssistant
module: ModuleType) -> None:
def __init__(
self,
hass, # type: HomeAssistant
module: ModuleType,
) -> None:
"""Initialize the module wrapper."""
self._hass = hass
self._module = module
@@ -390,7 +411,7 @@ class ModuleWrapper:
"""Fetch an attribute."""
value = getattr(self._module, attr)
if hasattr(value, '__bind_hass'):
if hasattr(value, "__bind_hass"):
value = ft.partial(value, self._hass)
setattr(self, attr, value)
@@ -401,8 +422,7 @@ class Components:
"""Helper to load components."""
def __init__(
self,
hass # type: HomeAssistant
self, hass # type: HomeAssistant
) -> None:
"""Initialize the Components class."""
self._hass = hass
@@ -413,14 +433,13 @@ class Components:
integration = self._hass.data.get(DATA_INTEGRATIONS, {}).get(comp_name)
if isinstance(integration, Integration):
component = integration.get_component(
) # type: Optional[ModuleType]
component = integration.get_component() # type: Optional[ModuleType]
else:
# Fallback to importing old-school
component = _load_file(self._hass, comp_name, LOOKUP_PATHS)
if component is None:
raise ImportError('Unable to load {}'.format(comp_name))
raise ImportError("Unable to load {}".format(comp_name))
wrapped = ModuleWrapper(self._hass, component)
setattr(self, comp_name, wrapped)
@@ -431,16 +450,14 @@ class Helpers:
"""Helper to load helpers."""
def __init__(
self,
hass # type: HomeAssistant
self, hass # type: HomeAssistant
) -> None:
"""Initialize the Helpers class."""
self._hass = hass
def __getattr__(self, helper_name: str) -> ModuleWrapper:
"""Fetch a helper."""
helper = importlib.import_module(
'homeassistant.helpers.{}'.format(helper_name))
helper = importlib.import_module("homeassistant.helpers.{}".format(helper_name))
wrapped = ModuleWrapper(self._hass, helper)
setattr(self, helper_name, wrapped)
return wrapped
@@ -448,12 +465,14 @@ class Helpers:
def bind_hass(func: CALLABLE_T) -> CALLABLE_T:
"""Decorate function to indicate that first argument is hass."""
setattr(func, '__bind_hass', True)
setattr(func, "__bind_hass", True)
return func
async def async_component_dependencies(hass, # type: HomeAssistant
domain: str) -> Set[str]:
async def async_component_dependencies(
hass, # type: HomeAssistant
domain: str,
) -> Set[str]:
"""Return all dependencies and subdependencies of components.
Raises CircularDependency if a circular dependency is found.
@@ -461,9 +480,12 @@ async def async_component_dependencies(hass, # type: HomeAssistant
return await _async_component_dependencies(hass, domain, set(), set())
async def _async_component_dependencies(hass, # type: HomeAssistant
domain: str, loaded: Set[str],
loading: Set) -> Set[str]:
async def _async_component_dependencies(
hass, # type: HomeAssistant
domain: str,
loaded: Set[str],
loading: Set,
) -> Set[str]:
"""Recursive function to get component dependencies.
Async friendly.
@@ -482,7 +504,8 @@ async def _async_component_dependencies(hass, # type: HomeAssistant
raise CircularDependency(domain, dependency_domain)
dep_loaded = await _async_component_dependencies(
hass, dependency_domain, loaded, loading)
hass, dependency_domain, loaded, loading
)
loaded.update(dep_loaded)
@@ -492,8 +515,9 @@ async def _async_component_dependencies(hass, # type: HomeAssistant
return loaded
def _async_mount_config_dir(hass, # type: HomeAssistant
) -> bool:
def _async_mount_config_dir(
hass, # type: HomeAssistant
) -> bool:
"""Mount config dir in order to load custom_component.
Async friendly but not a coroutine.