Skip to content

Add type-hints to DataSaver #373

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.

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

Merged
merged 1 commit into from
Oct 12, 2022
Merged
Changes from all commits
Commits
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
28 changes: 16 additions & 12 deletions adaptive/learner/data_saver.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import functools
from collections import OrderedDict
from typing import Any, Callable

from adaptive.learner.base_learner import BaseLearner
from adaptive.utils import copy_docstring_from
Expand Down Expand Up @@ -39,7 +40,7 @@ class DataSaver:
>>> learner = DataSaver(_learner, arg_picker=itemgetter('y'))
"""

def __init__(self, learner, arg_picker):
def __init__(self, learner: BaseLearner, arg_picker: Callable) -> None:
self.learner = learner
self.extra_data = OrderedDict()
self.function = learner.function
Expand All @@ -49,21 +50,21 @@ def new(self) -> DataSaver:
"""Return a new `DataSaver` with the same `arg_picker` and `learner`."""
return DataSaver(self.learner.new(), self.arg_picker)

def __getattr__(self, attr):
def __getattr__(self, attr: str) -> Any:
return getattr(self.learner, attr)

@copy_docstring_from(BaseLearner.tell)
def tell(self, x, result):
def tell(self, x: Any, result: Any) -> None:
y = self.arg_picker(result)
self.extra_data[x] = result
self.learner.tell(x, y)

@copy_docstring_from(BaseLearner.tell_pending)
def tell_pending(self, x):
def tell_pending(self, x: Any) -> None:
self.learner.tell_pending(x)

def to_dataframe(
self, extra_data_name: str = "extra_data", **kwargs
self, extra_data_name: str = "extra_data", **kwargs: Any
) -> pandas.DataFrame:
"""Return the data as a concatenated `pandas.DataFrame` from child learners.

Expand Down Expand Up @@ -98,7 +99,7 @@ def load_dataframe(
extra_data_name: str = "extra_data",
input_names: tuple[str] = (),
**kwargs,
):
) -> None:
"""Load the data from a `pandas.DataFrame` into the learner.

Parameters
Expand All @@ -122,33 +123,36 @@ def load_dataframe(
key = _to_key(x[:-1])
self.extra_data[key] = x[-1]

def _get_data(self):
def _get_data(self) -> tuple[Any, OrderedDict]:
return self.learner._get_data(), self.extra_data

def _set_data(self, data):
def _set_data(
self,
data: tuple[Any, OrderedDict],
) -> None:
learner_data, self.extra_data = data
self.learner._set_data(learner_data)

def __getstate__(self):
def __getstate__(self) -> tuple[BaseLearner, Callable, OrderedDict]:
return (
self.learner,
self.arg_picker,
self.extra_data,
)

def __setstate__(self, state):
def __setstate__(self, state: tuple[BaseLearner, Callable, OrderedDict]) -> None:
learner, arg_picker, extra_data = state
self.__init__(learner, arg_picker)
self.extra_data = extra_data

@copy_docstring_from(BaseLearner.save)
def save(self, fname, compress=True):
def save(self, fname, compress=True) -> None:
# We copy this method because the 'DataSaver' is not a
# subclass of the 'BaseLearner'.
BaseLearner.save(self, fname, compress)

@copy_docstring_from(BaseLearner.load)
def load(self, fname, compress=True):
def load(self, fname, compress=True) -> None:
# We copy this method because the 'DataSaver' is not a
# subclass of the 'BaseLearner'.
BaseLearner.load(self, fname, compress)
Expand Down