Skip to content

Commit

Permalink
Add empty line after module docstring [helpers + other] (home-assista…
Browse files Browse the repository at this point in the history
  • Loading branch information
cdce8p authored Mar 8, 2024
1 parent c773d57 commit 19ab3d6
Show file tree
Hide file tree
Showing 284 changed files with 287 additions and 0 deletions.
1 change: 1 addition & 0 deletions homeassistant/__main__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Start Home Assistant."""

from __future__ import annotations

import argparse
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Provide an authentication layer for Home Assistant."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/auth_store.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Storage for auth models."""

from __future__ import annotations

from datetime import timedelta
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/const.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Constants for the auth module."""

from datetime import timedelta

ACCESS_TOKEN_EXPIRATION = timedelta(minutes=30)
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/jwt_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
we can cache the result of the decode of valid tokens
to speed up the process.
"""

from __future__ import annotations

from datetime import timedelta
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/mfa_modules/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Pluggable auth modules for Home Assistant."""

from __future__ import annotations

import importlib
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/mfa_modules/insecure_example.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Example auth module."""

from __future__ import annotations

from typing import Any
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/mfa_modules/notify.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Sending HOTP through notify service
"""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/mfa_modules/totp.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Time-based One Time Password auth module."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/models.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Auth models."""

from __future__ import annotations

from datetime import datetime, timedelta
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/permissions/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Permissions for Home Assistant."""

from __future__ import annotations

from collections.abc import Callable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/permissions/entities.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Entity permissions."""

from __future__ import annotations

from collections import OrderedDict
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/permissions/events.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Permission for events."""

from __future__ import annotations

from typing import Final
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/permissions/merge.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Merging of policies."""

from __future__ import annotations

from typing import cast
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/permissions/models.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Models for permissions."""

from __future__ import annotations

from typing import TYPE_CHECKING
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/permissions/system_policies.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""System policies."""

from .const import CAT_ENTITIES, POLICY_READ, SUBCAT_ALL

ADMIN_POLICY = {CAT_ENTITIES: True}
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/permissions/types.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Common code for permissions."""

from collections.abc import Mapping

# MyPy doesn't support recursion yet. So writing it out as far as we need.
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/permissions/util.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helpers to deal with permissions."""

from __future__ import annotations

from collections.abc import Callable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/providers/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Auth providers for Home Assistant."""

from __future__ import annotations

from collections.abc import Mapping
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/providers/command_line.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Auth provider that validates credentials via an external command."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/providers/homeassistant.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Home Assistant auth provider."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/providers/insecure_example.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Example auth provider."""

from __future__ import annotations

from collections.abc import Mapping
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/providers/legacy_api_password.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
It will be removed when auth system production ready
"""

from __future__ import annotations

from collections.abc import Mapping
Expand Down
1 change: 1 addition & 0 deletions homeassistant/auth/providers/trusted_networks.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
It shows list of users if access from trusted network.
Abort login flow if not access from trusted network.
"""

from __future__ import annotations

from collections.abc import Mapping
Expand Down
1 change: 1 addition & 0 deletions homeassistant/backports/enum.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
This file is kept for now to avoid breaking custom components that might
import it.
"""

from __future__ import annotations

from enum import StrEnum
Expand Down
1 change: 1 addition & 0 deletions homeassistant/block_async_io.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Block blocking calls being done in asyncio."""

from http.client import HTTPConnection
import time

Expand Down
1 change: 1 addition & 0 deletions homeassistant/bootstrap.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Provide methods to bootstrap a Home Assistant instance."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/components/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
format "<DOMAIN>.<OBJECT_ID>".
- Each component should publish services only under its own domain.
"""

from __future__ import annotations

import logging
Expand Down
1 change: 1 addition & 0 deletions homeassistant/config.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Module to help with parsing and generating configuration files."""

from __future__ import annotations

from collections import OrderedDict
Expand Down
1 change: 1 addition & 0 deletions homeassistant/config_entries.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Manage config entries in Home Assistant."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/const.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Constants used by Home Assistant components."""

from __future__ import annotations

from enum import StrEnum
Expand Down
1 change: 1 addition & 0 deletions homeassistant/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Home Assistant is a Home Automation framework for observing the state
of entities and react to changes.
"""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/data_entry_flow.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Classes to help gather user submissions."""

from __future__ import annotations

import abc
Expand Down
1 change: 1 addition & 0 deletions homeassistant/exceptions.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""The exceptions used by Home Assistant."""

from __future__ import annotations

from collections.abc import Generator, Sequence
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helper methods for components within Home Assistant."""

from __future__ import annotations

from collections.abc import Iterable, Sequence
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/aiohttp_client.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helper for aiohttp webclient stuff."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/area_registry.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Provide a way to connect devices to one physical location."""

from __future__ import annotations

from collections.abc import Iterable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/check_config.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helper to check the configuration file."""

from __future__ import annotations

from collections import OrderedDict
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/collection.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helper to deal with YAML + storage."""

from __future__ import annotations

from abc import ABC, abstractmethod
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/condition.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Offer reusable conditions."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/config_entry_flow.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helpers for data entry flows for config entries."""

from __future__ import annotations

from collections.abc import Awaitable, Callable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/config_entry_oauth2_flow.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- OAuth2 implementation that works with local provided client ID/secret
"""

from __future__ import annotations

from abc import ABC, ABCMeta, abstractmethod
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/config_validation.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helpers for config validation using voluptuous."""

from __future__ import annotations

from collections.abc import Callable, Hashable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/data_entry_flow.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helpers for the data entry flow."""

from __future__ import annotations

from http import HTTPStatus
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/debounce.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Debounce helper."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/deprecation.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Deprecation helpers for Home Assistant."""

from __future__ import annotations

from collections.abc import Callable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/device_registry.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Provide a way to connect entities belonging to one device."""

from __future__ import annotations

from collections import UserDict
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/discovery.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- listen_platform/discover_platform is for platforms. These are used by
components to allow discovery of their platforms.
"""

from __future__ import annotations

from collections.abc import Callable, Coroutine
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/discovery_flow.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""The discovery flow helper."""

from __future__ import annotations

from collections.abc import Coroutine
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/dispatcher.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helpers for Home Assistant dispatcher & internal component/platform."""

from __future__ import annotations

from collections.abc import Callable, Coroutine
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/entity.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""An abstract class for entities."""

from __future__ import annotations

from abc import ABCMeta
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/entity_component.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helpers for components that manage entities."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/entity_platform.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Class to manage the entities for a single platform."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/entity_registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
registered. Registering a new entity while a timer is in progress resets the
timer.
"""

from __future__ import annotations

from collections import UserDict
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/entity_values.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""A class to hold entity values."""

from __future__ import annotations

from collections import OrderedDict
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/entityfilter.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helper class to implement include/exclude of entities and domains."""

from __future__ import annotations

from collections.abc import Callable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/event.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helpers for listening to events."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/floor_registry.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Provide a way to assign areas to floors in one's home."""

from __future__ import annotations

from collections.abc import Iterable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/frame.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Provide frame helper for finding the current frame context."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/group.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helper for groups."""

from __future__ import annotations

from collections.abc import Iterable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/http.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helper to track the current http request."""

from __future__ import annotations

import asyncio
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/httpx_client.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Helper for httpx."""

from __future__ import annotations

from collections.abc import Callable
Expand Down
1 change: 1 addition & 0 deletions homeassistant/helpers/icon.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Icon helper methods."""

from __future__ import annotations

import asyncio
Expand Down
Loading

0 comments on commit 19ab3d6

Please sign in to comment.