Skip to content

Commit

Permalink
doc: load with an instance of TaskOnKart
Browse files Browse the repository at this point in the history
  • Loading branch information
kitagry committed Sep 16, 2024
1 parent 2b811ef commit 56fc81f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/task_on_kart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,15 @@ The `load` method loads individual task input by passing a key of an input dicti
data_b = self.load('b')
As an alternative, the `load` method loads individual task input by passing an instance of TaskOnKart as follows:

.. code:: python
def run(self):
data_a = self.load(TaskA())
data_b = self.load(TaskB())
We can also omit the :func:`~gokart.task.TaskOnKart.requires` and write the task used by :func:`~gokart.parameter.TaskInstanceParameter`.
Extensions include :func:`~gokart.task.TaskOnKart.load_data_frame` and :func:`~gokart.task.TaskOnKart.load_generator`. Please refer to :func:`~gokart.task.TaskOnKart.load`, :doc:`task_parameters`, and described later Advanced Features section.

Expand Down
16 changes: 16 additions & 0 deletions test/test_build.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ def run(self):
self.dump('done')


class _LoadRequires(gokart.TaskOnKart[None]):
task: _DummyTask = gokart.TaskInstanceParameter()

def requires(self):
return self.task

def run(self):
_ = self.load(self.task)
self.dump(None)


class RunTest(unittest.TestCase):
def setUp(self):
luigi.setup_logging.DaemonLogging._configured = False
Expand Down Expand Up @@ -102,6 +113,11 @@ def test_failed_task(self):
with self.assertRaises(GokartBuildError):
gokart.build(_DummyFailedTask(), reset_register=False, log_level=logging.CRITICAL)

def test_load_requires(self):
text = 'test'
output = gokart.build(_LoadRequires(task=_DummyTask(param=text)), reset_register=False)
self.assertEqual(output, None)


class LoggerConfigTest(unittest.TestCase):
def test_logger_config(self):
Expand Down

0 comments on commit 56fc81f

Please sign in to comment.