Skip to content

Adding a type hint to the process method of the BasePlugin class #2224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Adding a type hint to the process method of the BasePlugin class #2224

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc78c7f
Adding a type hint to the process method of the `BasePlugin` class
mo-philrelton Nov 3, 2025
1102fc1
Type hinting changes requested for PostProcessingPlugin
mo-philrelton Nov 3, 2025
d255fff
Reverting to __call__(...) -> Any for simplicity and speed of execution
mo-philrelton Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions improver/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from abc import ABC, abstractmethod
from collections.abc import Iterable
from importlib.metadata import PackageNotFoundError, version
from typing import Any

try:
__version__ = version("improver")
Expand All @@ -21,7 +22,7 @@ class BasePlugin(ABC):
method by redirecting to __call__.
"""

def __call__(self, *args, **kwargs):
def __call__(self, *args, **kwargs) -> Any:
"""Makes subclasses callable to use process
Args:
*args:
Expand All @@ -34,7 +35,7 @@ def __call__(self, *args, **kwargs):
return self.process(*args, **kwargs)

@abstractmethod
def process(self, *args, **kwargs):
def process(self, *args, **kwargs) -> Any:
"""Abstract class for rest to implement."""
pass

Expand All @@ -44,7 +45,7 @@ class PostProcessingPlugin(BasePlugin):
Makes generalised changes to metadata relating to post-processing.
"""

def __call__(self, *args, **kwargs):
def __call__(self, *args, **kwargs) -> Any:
"""Makes subclasses callable to use process
Args:
*args:
Expand Down