Upgrade to mypy 0.930

kopf/__init__.py

@@ -34,6 +34,9 @@
     MultiProgressStorage,
     SmartProgressStorage,
 )
+from kopf._cogs.helpers.typedefs import (
+    Logger,
+)
 from kopf._cogs.helpers.versions import (
     version as __version__,
 )
@@ -95,7 +98,6 @@
     lifecycles,  # as a separate name on the public namespace
 )
 from kopf._core.actions.execution import (
-    Logger,
     ErrorsMode,
     TemporaryError,
     PermanentError,

kopf/_cogs/aiokits/aiotasks.py

@@ -10,11 +10,12 @@
 so there is no added overhead; instead, the implicit overhead is made explicit.
 """
 import asyncio
-import logging
 import sys
 from typing import TYPE_CHECKING, Any, Awaitable, Callable, Collection, Coroutine, \
                    Generator, NamedTuple, Optional, Set, Tuple, TypeVar, Union
 
+from kopf._cogs.helpers import typedefs
+
 _T = TypeVar('_T')
 
 # A workaround for a difference in tasks at runtime and type-checking time.
@@ -79,7 +80,7 @@ async def guard(
         flag: Optional[asyncio.Event] = None,
         finishable: bool = False,
         cancellable: bool = False,
-        logger: Optional[Union[logging.Logger, logging.LoggerAdapter]] = None,
+        logger: Optional[typedefs.Logger] = None,
 ) -> None:
     """
     A guard for a presumably eternal (never-finishing) task.
@@ -125,7 +126,7 @@ def create_guarded_task(
         flag: Optional[asyncio.Event] = None,
         finishable: bool = False,
         cancellable: bool = False,
-        logger: Optional[Union[logging.Logger, logging.LoggerAdapter]] = None,
+        logger: Optional[typedefs.Logger] = None,
 ) -> Task:
     """
     Create a guarded eternal task. See :func:`guard` for explanation.
@@ -165,7 +166,7 @@ async def stop(
         quiet: bool = False,
         cancelled: bool = False,
         interval: Optional[float] = None,
-        logger: Optional[Union[logging.Logger, logging.LoggerAdapter]] = None,
+        logger: Optional[typedefs.Logger] = None,
 ) -> Tuple[Set[Task], Set[Task]]:
     """
     Cancel the tasks and wait for them to finish; log if some are stuck.

kopf/_cogs/clients/api.py

@@ -2,16 +2,16 @@
 import collections.abc
 import itertools
 import json
-import logging
 import ssl
 import urllib.parse
-from typing import Any, AsyncIterator, Mapping, Optional, Tuple, Union
+from typing import Any, AsyncIterator, Mapping, Optional, Tuple
 
 import aiohttp
 
 from kopf._cogs.aiokits import aiotasks
 from kopf._cogs.clients import auth, errors
 from kopf._cogs.configs import configuration
+from kopf._cogs.helpers import typedefs
 
 
 @auth.authenticated
@@ -50,7 +50,7 @@ async def request(
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[aiohttp.ClientTimeout] = None,
         context: Optional[auth.APIContext] = None,  # injected by the decorator
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> aiohttp.ClientResponse:
     if context is None:  # for type-checking!
         raise RuntimeError("API instance is not injected by the decorator.")
@@ -106,7 +106,7 @@ async def get(
         payload: Optional[object] = None,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[aiohttp.ClientTimeout] = None,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Any:
     response = await request(
         method='get',
@@ -128,7 +128,7 @@ async def post(
         payload: Optional[object] = None,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[aiohttp.ClientTimeout] = None,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Any:
     response = await request(
         method='post',
@@ -150,7 +150,7 @@ async def patch(
         payload: Optional[object] = None,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[aiohttp.ClientTimeout] = None,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Any:
     response = await request(
         method='patch',
@@ -172,7 +172,7 @@ async def delete(
         payload: Optional[object] = None,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[aiohttp.ClientTimeout] = None,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Any:
     response = await request(
         method='delete',
@@ -195,7 +195,7 @@ async def stream(
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[aiohttp.ClientTimeout] = None,
         stopper: Optional[aiotasks.Future] = None,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> AsyncIterator[Any]:
     response = await request(
         method='get',

kopf/_cogs/clients/creating.py

@@ -1,8 +1,8 @@
-import logging
-from typing import Optional, Union, cast
+from typing import Optional, cast
 
 from kopf._cogs.clients import api
 from kopf._cogs.configs import configuration
+from kopf._cogs.helpers import typedefs
 from kopf._cogs.structs import bodies, references
 
 
@@ -13,7 +13,7 @@ async def create_obj(
         namespace: references.Namespace = None,
         name: Optional[str] = None,
         body: Optional[bodies.RawBody] = None,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Optional[bodies.RawBody]:
     """
     Create a resource.

kopf/_cogs/clients/events.py

@@ -1,12 +1,11 @@
 import copy
 import datetime
-import logging
-from typing import Union
 
 import aiohttp
 
 from kopf._cogs.clients import api, errors
 from kopf._cogs.configs import configuration
+from kopf._cogs.helpers import typedefs
 from kopf._cogs.structs import bodies, references
 
 MAX_MESSAGE_LENGTH = 1024
@@ -21,7 +20,7 @@ async def post_event(
         message: str = '',
         resource: references.Resource,
         settings: configuration.OperatorSettings,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> None:
     """
     Issue an event for the object.

kopf/_cogs/clients/fetching.py

@@ -1,8 +1,8 @@
-import logging
-from typing import Collection, List, Tuple, Union
+from typing import Collection, List, Tuple
 
 from kopf._cogs.clients import api
 from kopf._cogs.configs import configuration
+from kopf._cogs.helpers import typedefs
 from kopf._cogs.structs import bodies, references
 
 
@@ -11,7 +11,7 @@ async def list_objs(
         settings: configuration.OperatorSettings,
         resource: references.Resource,
         namespace: references.Namespace,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Tuple[Collection[bodies.RawBody], str]:
     """
     List the objects of specific resource type.

kopf/_cogs/clients/patching.py

@@ -1,8 +1,8 @@
-import logging
-from typing import Optional, Union
+from typing import Optional
 
 from kopf._cogs.clients import api, errors
 from kopf._cogs.configs import configuration
+from kopf._cogs.helpers import typedefs
 from kopf._cogs.structs import bodies, patches, references
 
 
@@ -13,7 +13,7 @@ async def patch_obj(
         namespace: references.Namespace,
         name: Optional[str],
         patch: patches.Patch,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Optional[bodies.RawBody]:
     """
     Patch a resource of specific kind.

kopf/_cogs/clients/scanning.py

@@ -1,16 +1,16 @@
 import asyncio
-import logging
-from typing import Collection, Mapping, Optional, Set, Union
+from typing import Collection, Mapping, Optional, Set
 
 from kopf._cogs.clients import api, errors
 from kopf._cogs.configs import configuration
+from kopf._cogs.helpers import typedefs
 from kopf._cogs.structs import references
 
 
 async def read_version(
         *,
         settings: configuration.OperatorSettings,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Mapping[str, str]:
     rsp: Mapping[str, str] = await api.get('/version', settings=settings, logger=logger)
     return rsp
@@ -19,7 +19,7 @@ async def read_version(
 async def scan_resources(
         *,
         settings: configuration.OperatorSettings,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
         groups: Optional[Collection[str]] = None,
 ) -> Collection[references.Resource]:
     coros = {
@@ -35,7 +35,7 @@ async def scan_resources(
 async def _read_old_api(
         *,
         settings: configuration.OperatorSettings,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
         groups: Optional[Collection[str]],
 ) -> Collection[references.Resource]:
     resources: Set[references.Resource] = set()
@@ -60,7 +60,7 @@ async def _read_old_api(
 async def _read_new_apis(
         *,
         settings: configuration.OperatorSettings,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
         groups: Optional[Collection[str]],
 ) -> Collection[references.Resource]:
     resources: Set[references.Resource] = set()
@@ -91,7 +91,7 @@ async def _read_version(
         version: str,
         preferred: bool,
         settings: configuration.OperatorSettings,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> Collection[references.Resource]:
     try:
         rsp = await api.get(url, settings=settings, logger=logger)

kopf/_cogs/configs/conventions.py

@@ -130,9 +130,7 @@ def __init__(
             v1: bool,
             **kwargs: Any,
     ) -> None:
-        # TODO: Remove type-ignore when this is fixed: https://github.com/python/mypy/issues/5887
-        #       Too many arguments for "__init__" of "object" -- but this is typical for mixins!
-        super().__init__(*args, **kwargs)  # type: ignore
+        super().__init__(*args, **kwargs)
         self.prefix = prefix
         self.v1 = v1
 

kopf/_cogs/helpers/typedefs.py

@@ -0,0 +1,22 @@
+"""
+Rudimentary type [re-]definitions for cross-versioned Python & mypy.
+
+The problem is that new mypy versions often bring type-sheds with StdLib types
+defined as generics, while the old Python runtime (down to 3.7)
+does not support the usual syntax.
+Examples: asyncio.Task, asyncio.Future, logging.LoggerAdapter, and others.
+
+This modules defines them in a most suitable and reusable way. Plus it adds
+some common plain type definitions used across the codebase (for convenience).
+"""
+import logging
+from typing import TYPE_CHECKING, Any, Union
+
+if TYPE_CHECKING:
+    LoggerAdapter = logging.LoggerAdapter[Any]
+else:
+    LoggerAdapter = logging.LoggerAdapter
+
+# As publicly exposed: we only promise that it is based on one of the built-in loggable classes.
+# Mind that these classes have multi-versioned stubs, so we avoid redefining the protocol ourselves.
+Logger = Union[logging.Logger, LoggerAdapter]

kopf/_cogs/structs/dicts.py

@@ -12,7 +12,7 @@
 FieldSpec = Union[None, str, FieldPath, List[str]]
 
 _T = TypeVar('_T')
-_K = TypeVar('_K')
+_K = TypeVar('_K', bound=str)  # int & bool keys are possible but discouraged
 _V = TypeVar('_V')
 
 

kopf/_core/actions/application.py

@@ -20,12 +20,12 @@
 """
 import asyncio
 import datetime
-import logging
-from typing import Collection, Optional, Union
+from typing import Collection, Optional
 
 from kopf._cogs.aiokits import aiotime
 from kopf._cogs.clients import patching
 from kopf._cogs.configs import configuration
+from kopf._cogs.helpers import typedefs
 from kopf._cogs.structs import bodies, dicts, diffs, patches, references
 from kopf._core.actions import loggers
 
@@ -110,7 +110,7 @@ async def patch_and_check(
         resource: references.Resource,
         body: bodies.Body,
         patch: patches.Patch,
-        logger: Union[logging.Logger, logging.LoggerAdapter],
+        logger: typedefs.Logger,
 ) -> None:
     """
     Apply a patch and verify that it is applied correctly.

kopf/_core/actions/execution.py

@@ -12,14 +12,14 @@
 import dataclasses
 import datetime
 import enum
-import logging
 from contextvars import ContextVar
 from typing import Any, AsyncContextManager, AsyncIterator, Callable, Collection, Iterable, \
-                   Mapping, MutableMapping, NewType, Optional, Sequence, Set, TypeVar, Union
+                   Mapping, MutableMapping, NewType, Optional, Sequence, Set, TypeVar
 
 from typing_extensions import Protocol
 
 from kopf._cogs.configs import configuration
+from kopf._cogs.helpers import typedefs
 from kopf._cogs.structs import ids
 from kopf._core.actions import invocation
 
@@ -61,10 +61,6 @@ class ErrorsMode(enum.Enum):
     PERMANENT = enum.auto()
 
 
-# As publicly exposed: we only promise that it is based on one of the built-in loggable classes.
-# Mind that these classes have multi-versioned stubs, so we avoid redefining the protocol ourselves.
-Logger = Union[logging.Logger, logging.LoggerAdapter]
-
 # A specialised type to highlight the purpose or origin of the data of type Any,
 # to not be mixed with other arbitrary Any values, where it is indeed "any".
 Result = NewType('Result', object)
@@ -137,7 +133,7 @@ class State(Mapping[ids.HandlerId, HandlerState]):
 @dataclasses.dataclass
 class Cause(invocation.Kwargable):
     """ Base non-specific cause as used in the framework's reactor. """
-    logger: Logger
+    logger: typedefs.Logger
 
     @property
     def _kwargs(self) -> Mapping[str, Any]:

kopf/_core/actions/invocation.py

@@ -9,12 +9,11 @@
 import contextlib
 import contextvars
 import functools
-from typing import Any, Callable, Coroutine, Iterable, Iterator, List, \
-                   Mapping, Optional, Tuple, TypeVar, Union, cast
+from typing import Any, Callable, Coroutine, Iterable, Iterator, \
+                   List, Mapping, Optional, Tuple, TypeVar, Union
 
 from typing_extensions import final
 
-from kopf._cogs.aiokits import aiotasks
 from kopf._cogs.configs import configuration
 
 # An internal typing hack shows that the handler can be sync fn with the result,
@@ -133,7 +132,7 @@ async def invoke(
         # Note: the docs say the result is a future, but typesheds say it is a coroutine => cast()!
         loop = asyncio.get_running_loop()
         executor = settings.execution.executor if settings is not None else None
-        future = cast(aiotasks.Future, loop.run_in_executor(executor, real_fn))
+        future = loop.run_in_executor(executor, real_fn)
         cancellation: Optional[asyncio.CancelledError] = None
         while not future.done():
             try: