b4bac0f7a0
* Remove unnecessary exception re-wraps * Preserve exception chains on re-raise We slap "from cause" to almost all possible cases here. In some cases it could conceivably be better to do "from None" if we really want to hide the cause. However those should be in the minority, and "from cause" should be an improvement over the corresponding raise without a "from" in all cases anyway. The only case where we raise from None here is in plex, where the exception for an original invalid SSL cert is not the root cause for failure to validate a newly fetched one. Follow local convention on exception variable names if there is a consistent one, otherwise `err` to match with majority of codebase. * Fix mistaken re-wrap in homematicip_cloud/hap.py Missed the difference between HmipConnectionError and HmipcConnectionError. * Do not hide original error on plex new cert validation error Original is not the cause for the new one, but showing old in the traceback is useful nevertheless.
108 lines
3 KiB
Python
108 lines
3 KiB
Python
"""Provide frame helper for finding the current frame context."""
|
|
import asyncio
|
|
import functools
|
|
import logging
|
|
from traceback import FrameSummary, extract_stack
|
|
from typing import Any, Callable, Optional, Tuple, TypeVar, cast
|
|
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CALLABLE_T = TypeVar("CALLABLE_T", bound=Callable) # pylint: disable=invalid-name
|
|
|
|
|
|
def get_integration_frame(
|
|
exclude_integrations: Optional[set] = None,
|
|
) -> Tuple[FrameSummary, str, str]:
|
|
"""Return the frame, integration and integration path of the current stack frame."""
|
|
found_frame = None
|
|
if not exclude_integrations:
|
|
exclude_integrations = set()
|
|
|
|
for frame in reversed(extract_stack()):
|
|
for path in ("custom_components/", "homeassistant/components/"):
|
|
try:
|
|
index = frame.filename.index(path)
|
|
start = index + len(path)
|
|
end = frame.filename.index("/", start)
|
|
integration = frame.filename[start:end]
|
|
if integration not in exclude_integrations:
|
|
found_frame = frame
|
|
|
|
break
|
|
except ValueError:
|
|
continue
|
|
|
|
if found_frame is not None:
|
|
break
|
|
|
|
if found_frame is None:
|
|
raise MissingIntegrationFrame
|
|
|
|
return found_frame, integration, path
|
|
|
|
|
|
class MissingIntegrationFrame(HomeAssistantError):
|
|
"""Raised when no integration is found in the frame."""
|
|
|
|
|
|
def report(what: str) -> None:
|
|
"""Report incorrect usage.
|
|
|
|
Async friendly.
|
|
"""
|
|
try:
|
|
integration_frame = get_integration_frame()
|
|
except MissingIntegrationFrame as err:
|
|
# Did not source from an integration? Hard error.
|
|
raise RuntimeError(
|
|
f"Detected code that {what}. Please report this issue."
|
|
) from err
|
|
|
|
report_integration(what, integration_frame)
|
|
|
|
|
|
def report_integration(
|
|
what: str, integration_frame: Tuple[FrameSummary, str, str]
|
|
) -> None:
|
|
"""Report incorrect usage in an integration.
|
|
|
|
Async friendly.
|
|
"""
|
|
|
|
found_frame, integration, path = integration_frame
|
|
|
|
index = found_frame.filename.index(path)
|
|
if path == "custom_components/":
|
|
extra = " to the custom component author"
|
|
else:
|
|
extra = ""
|
|
|
|
_LOGGER.warning(
|
|
"Detected integration that %s. "
|
|
"Please report issue%s for %s using this method at %s, line %s: %s",
|
|
what,
|
|
extra,
|
|
integration,
|
|
found_frame.filename[index:],
|
|
found_frame.lineno,
|
|
found_frame.line.strip(),
|
|
)
|
|
|
|
|
|
def warn_use(func: CALLABLE_T, what: str) -> CALLABLE_T:
|
|
"""Mock a function to warn when it was about to be used."""
|
|
if asyncio.iscoroutinefunction(func):
|
|
|
|
@functools.wraps(func)
|
|
async def report_use(*args: Any, **kwargs: Any) -> None:
|
|
report(what)
|
|
|
|
else:
|
|
|
|
@functools.wraps(func)
|
|
def report_use(*args: Any, **kwargs: Any) -> None:
|
|
report(what)
|
|
|
|
return cast(CALLABLE_T, report_use)
|