Rename _Hook{Spec,Impl}Opts -> Hook{Spec,Impl}Opts, export from pluggy

For typing purposes, refs #428.

Author: bluetech

src/pluggy/__init__.py

@@ -10,6 +10,8 @@
     "PluginValidationError",
     "HookCaller",
     "HookCallError",
+    "HookSpecOpts",
+    "HookImplOpts",
     "HookRelay",
     "HookspecMarker",
     "HookimplMarker",
@@ -18,4 +20,11 @@
 
 from ._manager import PluginManager, PluginValidationError
 from ._result import HookCallError, Result
-from ._hooks import HookspecMarker, HookimplMarker, HookCaller, HookRelay
+from ._hooks import (
+    HookspecMarker,
+    HookimplMarker,
+    HookCaller,
+    HookRelay,
+    HookSpecOpts,
+    HookImplOpts,
+)

src/pluggy/_hooks.py

@@ -37,7 +37,7 @@
 _HookImplFunction = Callable[..., Union[_T, Generator[None, Result[_T], None]]]
 
 
-class _HookSpecOpts(TypedDict):
+class HookSpecOpts(TypedDict):
     """Options for a hook specification."""
 
     #: Whether the hook is :ref:`first result only <firstresult>`.
@@ -48,7 +48,7 @@ class _HookSpecOpts(TypedDict):
     warn_on_impl: Warning | None
 
 
-class _HookImplOpts(TypedDict):
+class HookImplOpts(TypedDict):
     """Options for a hook implementation."""
 
     #: Whether the hook implementation is a :ref:`wrapper <hookwrapper>`.
@@ -132,7 +132,7 @@ def __call__(  # noqa: F811
         def setattr_hookspec_opts(func: _F) -> _F:
             if historic and firstresult:
                 raise ValueError("cannot have a historic firstresult hook")
-            opts: _HookSpecOpts = {
+            opts: HookSpecOpts = {
                 "firstresult": firstresult,
                 "historic": historic,
                 "warn_on_impl": warn_on_impl,
@@ -247,7 +247,7 @@ def __call__(  # noqa: F811
         """
 
         def setattr_hookimpl_opts(func: _F) -> _F:
-            opts: _HookImplOpts = {
+            opts: HookImplOpts = {
                 "wrapper": wrapper,
                 "hookwrapper": hookwrapper,
                 "optionalhook": optionalhook,
@@ -264,7 +264,7 @@ def setattr_hookimpl_opts(func: _F) -> _F:
             return setattr_hookimpl_opts(function)
 
 
-def normalize_hookimpl_opts(opts: _HookImplOpts) -> None:
+def normalize_hookimpl_opts(opts: HookImplOpts) -> None:
     opts.setdefault("tryfirst", False)
     opts.setdefault("trylast", False)
     opts.setdefault("wrapper", False)
@@ -379,7 +379,7 @@ def __init__(
         name: str,
         hook_execute: _HookExec,
         specmodule_or_class: _Namespace | None = None,
-        spec_opts: _HookSpecOpts | None = None,
+        spec_opts: HookSpecOpts | None = None,
     ) -> None:
         """:meta private:"""
         self.name: Final = name
@@ -399,7 +399,7 @@ def has_spec(self) -> bool:
     def set_specification(
         self,
         specmodule_or_class: _Namespace,
-        spec_opts: _HookSpecOpts,
+        spec_opts: HookSpecOpts,
     ) -> None:
         if self.spec is not None:
             raise ValueError(
@@ -522,7 +522,7 @@ def call_extra(
             not self.is_historic()
         ), "Cannot directly call a historic hook - use call_historic instead."
         self._verify_all_args_are_provided(kwargs)
-        opts: _HookImplOpts = {
+        opts: HookImplOpts = {
             "wrapper": False,
             "hookwrapper": False,
             "optionalhook": False,
@@ -626,7 +626,7 @@ def __init__(
         plugin: _Plugin,
         plugin_name: str,
         function: _HookImplFunction[object],
-        hook_impl_opts: _HookImplOpts,
+        hook_impl_opts: HookImplOpts,
     ) -> None:
         self.function: Final = function
         self.argnames, self.kwargnames = varnames(self.function)
@@ -654,7 +654,7 @@ class HookSpec:
         "warn_on_impl",
     )
 
-    def __init__(self, namespace: _Namespace, name: str, opts: _HookSpecOpts) -> None:
+    def __init__(self, namespace: _Namespace, name: str, opts: HookSpecOpts) -> None:
         self.namespace = namespace
         self.function: Callable[..., object] = getattr(namespace, name)
         self.name = name

src/pluggy/_manager.py

@@ -15,15 +15,15 @@
 from . import _tracing
 from ._callers import _multicall
 from ._hooks import _HookImplFunction
-from ._hooks import _HookImplOpts
-from ._hooks import _HookSpecOpts
 from ._hooks import _Namespace
 from ._hooks import _Plugin
 from ._hooks import _SubsetHookCaller
 from ._hooks import HookCaller
 from ._hooks import HookImpl
+from ._hooks import HookImplOpts
 from ._hooks import HookRelay
 from ._hooks import HookSpec
+from ._hooks import HookSpecOpts
 from ._hooks import normalize_hookimpl_opts
 from ._result import Result
 
@@ -166,7 +166,7 @@ def register(self, plugin: _Plugin, name: str | None = None) -> str | None:
                 hook._add_hookimpl(hookimpl)
         return plugin_name
 
-    def parse_hookimpl_opts(self, plugin: _Plugin, name: str) -> _HookImplOpts | None:
+    def parse_hookimpl_opts(self, plugin: _Plugin, name: str) -> HookImplOpts | None:
         """Try to obtain a hook implementation from an item with the given name
         in the given plugin which is being searched for hook impls.
 
@@ -181,7 +181,7 @@ def parse_hookimpl_opts(self, plugin: _Plugin, name: str) -> _HookImplOpts | Non
         if not inspect.isroutine(method):
             return None
         try:
-            res: _HookImplOpts | None = getattr(
+            res: HookImplOpts | None = getattr(
                 method, self.project_name + "_impl", None
             )
         except Exception:
@@ -260,7 +260,7 @@ def add_hookspecs(self, module_or_class: _Namespace) -> None:
 
     def parse_hookspec_opts(
         self, module_or_class: _Namespace, name: str
-    ) -> _HookSpecOpts | None:
+    ) -> HookSpecOpts | None:
         """Try to obtain a hook specification from an item with the given name
         in the given module or class which is being searched for hook specs.
 
@@ -273,7 +273,7 @@ def parse_hookspec_opts(
         options for items decorated with :class:`HookspecMarker`.
         """
         method: HookSpec = getattr(module_or_class, name)
-        opts: _HookSpecOpts | None = getattr(method, self.project_name + "_spec", None)
+        opts: HookSpecOpts | None = getattr(method, self.project_name + "_spec", None)
         return opts
 
     def get_plugins(self) -> set[Any]: