import inspect
import os
import sys
from functools import lru_cache
from typing import TYPE_CHECKING, FrozenSet, List, NamedTuple, Optional, Union, overload
from dagster import check, seven
from dagster.core.code_pointer import (
CodePointer,
CustomPointer,
FileCodePointer,
ModuleCodePointer,
get_python_file_from_target,
)
from dagster.core.errors import DagsterInvariantViolationError
from dagster.core.origin import (
DEFAULT_DAGSTER_ENTRY_POINT,
PipelinePythonOrigin,
RepositoryPythonOrigin,
)
from dagster.core.selector import parse_solid_selection
from dagster.serdes import pack_value, unpack_value, whitelist_for_serdes
from dagster.utils import frozenlist
from dagster.utils.backcompat import experimental
from .pipeline_base import IPipeline
if TYPE_CHECKING:
from dagster.core.asset_defs.asset_group import AssetGroup
from .graph_definition import GraphDefinition
from .pipeline_definition import PipelineDefinition
from .repository_definition import RepositoryDefinition
def get_ephemeral_repository_name(pipeline_name: str) -> str:
check.str_param(pipeline_name, "pipeline_name")
return "__repository__{pipeline_name}".format(pipeline_name=pipeline_name)
@whitelist_for_serdes
class ReconstructableRepository(
NamedTuple(
"_ReconstructableRepository",
[
("pointer", CodePointer),
("container_image", Optional[str]),
("executable_path", Optional[str]),
("entry_point", List[str]),
],
)
):
def __new__(
cls,
pointer,
container_image=None,
executable_path=None,
entry_point=None,
):
return super(ReconstructableRepository, cls).__new__(
cls,
pointer=check.inst_param(pointer, "pointer", CodePointer),
container_image=check.opt_str_param(container_image, "container_image"),
executable_path=check.opt_str_param(executable_path, "executable_path"),
entry_point=(
frozenlist(check.list_param(entry_point, "entry_point", of_type=str))
if entry_point != None
else DEFAULT_DAGSTER_ENTRY_POINT
),
)
@lru_cache(maxsize=1)
def get_definition(self):
return repository_def_from_pointer(self.pointer)
def get_reconstructable_pipeline(self, name):
return ReconstructablePipeline(self, name)
@classmethod
def for_file(cls, file, fn_name, working_directory=None, container_image=None):
if not working_directory:
working_directory = os.getcwd()
return cls(FileCodePointer(file, fn_name, working_directory), container_image)
@classmethod
def for_module(cls, module, fn_name, working_directory=None, container_image=None):
return cls(ModuleCodePointer(module, fn_name, working_directory), container_image)
def get_python_origin(self):
return RepositoryPythonOrigin(
executable_path=self.executable_path if self.executable_path else sys.executable,
code_pointer=self.pointer,
container_image=self.container_image,
entry_point=self.entry_point,
)
def get_python_origin_id(self):
return self.get_python_origin().get_id()
[docs]@whitelist_for_serdes
class ReconstructablePipeline(
NamedTuple(
"_ReconstructablePipeline",
[
("repository", ReconstructableRepository),
("pipeline_name", str),
("solid_selection_str", Optional[str]),
("solids_to_execute", Optional[FrozenSet[str]]),
],
),
IPipeline,
):
"""Defines a reconstructable pipeline. When your pipeline/job must cross process boundaries,
Dagster must know how to reconstruct the pipeline/job on the other side of the process boundary.
Args:
repository (ReconstructableRepository): The reconstructable representation of the repository
the pipeline/job belongs to.
pipeline_name (str): The name of the pipeline/job.
solid_selection_str (Optional[str]): The string value of a comma separated list of user-input
solid/op selection. None if no selection is specified, i.e. the entire pipeline/job will
be run.
solids_to_execute (Optional[FrozenSet[str]]): A set of solid/op names to execute. None if no selection
is specified, i.e. the entire pipeline/job will be run.
"""
def __new__(
cls,
repository,
pipeline_name,
solid_selection_str=None,
solids_to_execute=None,
):
check.opt_set_param(solids_to_execute, "solids_to_execute", of_type=str)
return super(ReconstructablePipeline, cls).__new__(
cls,
repository=check.inst_param(repository, "repository", ReconstructableRepository),
pipeline_name=check.str_param(pipeline_name, "pipeline_name"),
solid_selection_str=check.opt_str_param(solid_selection_str, "solid_selection_str"),
solids_to_execute=solids_to_execute,
)
@property
def solid_selection(self) -> Optional[List[str]]:
return seven.json.loads(self.solid_selection_str) if self.solid_selection_str else None
@lru_cache(maxsize=1)
def get_definition(self):
from dagster.core.definitions.job_definition import JobDefinition
defn = self.repository.get_definition().get_pipeline(self.pipeline_name)
if isinstance(defn, JobDefinition):
return (
self.repository.get_definition().get_pipeline(self.pipeline_name)
# jobs use pre-resolved selection
.get_job_def_for_op_selection(self.solid_selection)
)
return (
self.repository.get_definition().get_pipeline(self.pipeline_name)
# pipelines use post-resolved selection
.get_pipeline_subset_def(self.solids_to_execute)
)
def get_reconstructable_repository(self):
return self.repository
def _subset_for_execution(
self,
solids_to_execute: Optional[Optional[FrozenSet[str]]],
solid_selection: Optional[List[str]],
) -> "ReconstructablePipeline":
# no selection
if solid_selection is None and solids_to_execute is None:
return ReconstructablePipeline(
repository=self.repository,
pipeline_name=self.pipeline_name,
)
from dagster.core.definitions import JobDefinition, PipelineDefinition
pipeline_def = self.get_definition()
if isinstance(pipeline_def, JobDefinition):
# when subselecting a job
# * job subselection depend on solid_selection rather than solids_to_execute
# * we'll resolve the op selection later in the stack
if solid_selection is None:
# when the pre-resolution info is unavailable (e.g. subset from existing run),
# we need to fill the solid_selection in order to pass the value down to deeper stack.
solid_selection = list(solids_to_execute) if solids_to_execute else None
return ReconstructablePipeline(
repository=self.repository,
pipeline_name=self.pipeline_name,
solid_selection_str=seven.json.dumps(solid_selection),
solids_to_execute=None,
)
elif isinstance(pipeline_def, PipelineDefinition):
# when subselecting a pipeline
# * pipeline subselection depend on solids_to_excute rather than solid_selection
# * we resolve a list of solid selection queries to a frozenset of qualified solid names
# e.g. ['foo_solid+'] to {'foo_solid', 'bar_solid'}
if solid_selection and solids_to_execute is None:
# when post-resolution query is unavailable, resolve the query
solids_to_execute = parse_solid_selection(pipeline_def, solid_selection)
return ReconstructablePipeline(
repository=self.repository,
pipeline_name=self.pipeline_name,
solid_selection_str=seven.json.dumps(solid_selection) if solid_selection else None,
solids_to_execute=frozenset(solids_to_execute) if solids_to_execute else None,
)
else:
raise Exception(f"Unexpected pipeline/job type {pipeline_def.__class__.__name__}")
def subset_for_execution(
self, solid_selection: Optional[List[str]]
) -> "ReconstructablePipeline":
# take a list of unresolved selection queries
check.opt_list_param(solid_selection, "solid_selection", of_type=str)
return self._subset_for_execution(solids_to_execute=None, solid_selection=solid_selection)
def subset_for_execution_from_existing_pipeline(
self, solids_to_execute: Optional[FrozenSet[str]]
) -> "ReconstructablePipeline":
# take a frozenset of resolved solid names from an existing pipeline
# so there's no need to parse the selection
check.opt_set_param(solids_to_execute, "solids_to_execute", of_type=str)
return self._subset_for_execution(solids_to_execute=solids_to_execute, solid_selection=None)
def describe(self):
return '"{name}" in repository ({repo})'.format(
repo=self.repository.pointer.describe, name=self.pipeline_name
)
@staticmethod
def for_file(python_file, fn_name):
return bootstrap_standalone_recon_pipeline(
FileCodePointer(python_file, fn_name, os.getcwd())
)
@staticmethod
def for_module(module, fn_name):
return bootstrap_standalone_recon_pipeline(ModuleCodePointer(module, fn_name, os.getcwd()))
def to_dict(self):
return pack_value(self)
@staticmethod
def from_dict(val):
check.dict_param(val, "val")
inst = unpack_value(val)
check.invariant(
isinstance(inst, ReconstructablePipeline),
"Deserialized object is not instance of ReconstructablePipeline, got {type}".format(
type=type(inst)
),
)
return inst
def get_python_origin(self):
return PipelinePythonOrigin(self.pipeline_name, self.repository.get_python_origin())
def get_python_origin_id(self):
return self.get_python_origin().get_id()
[docs] def get_module(self) -> Optional[str]:
"""Return the module the pipeline is found in, the origin is a module code pointer"""
pointer = self.get_python_origin().get_repo_pointer()
if isinstance(pointer, ModuleCodePointer):
return pointer.module
return None
[docs]def reconstructable(target):
"""
Create a :py:class:`~dagster.core.definitions.reconstructable.ReconstructablePipeline` from a
function that returns a :py:class:`~dagster.PipelineDefinition`/:py:class:`~dagster.JobDefinition`,
or a function decorated with :py:func:`@pipeline <dagster.pipeline>`/:py:func:`@job <dagster.job>`.
When your pipeline/job must cross process boundaries, e.g., for execution on multiple nodes or
in different systems (like ``dagstermill``), Dagster must know how to reconstruct the pipeline/job
on the other side of the process boundary.
Passing a job created with ``~dagster.GraphDefinition.to_job`` to ``reconstructable()``,
requires you to wrap that job's definition in a module-scoped function, and pass that function
instead:
.. code-block:: python
from dagster import graph, reconstructable
@graph
def my_graph():
...
def define_my_job():
return my_graph.to_job()
reconstructable(define_my_job)
This function implements a very conservative strategy for reconstruction, so that its behavior
is easy to predict, but as a consequence it is not able to reconstruct certain kinds of pipelines
or jobs, such as those defined by lambdas, in nested scopes (e.g., dynamically within a method
call), or in interactive environments such as the Python REPL or Jupyter notebooks.
If you need to reconstruct objects constructed in these ways, you should use
:py:func:`~dagster.reconstructable.build_reconstructable_job` instead, which allows you to
specify your own reconstruction strategy.
Examples:
.. code-block:: python
from dagster import job, reconstructable
@job
def foo_job():
...
reconstructable_foo_job = reconstructable(foo_job)
@graph
def foo():
...
def make_bar_job():
return foo.to_job()
reconstructable_bar_job = reconstructable(make_bar_job)
"""
from dagster.core.definitions import JobDefinition, PipelineDefinition
if not seven.is_function_or_decorator_instance_of(target, PipelineDefinition):
if isinstance(target, JobDefinition):
raise DagsterInvariantViolationError(
"Reconstructable target was not a function returning a job definition, or a job "
"definition produced by a decorated function. If your job was constructed using "
"``GraphDefinition.to_job``, you must wrap the ``to_job`` call in a function at "
"module scope, ie not within any other functions. "
"To learn more, check out the docs on ``reconstructable``: "
"https://docs.dagster.io/_apidocs/execution#dagster.reconstructable"
)
raise DagsterInvariantViolationError(
"Reconstructable target should be a function or definition produced "
"by a decorated function, got {type}.".format(type=type(target)),
)
if seven.is_lambda(target):
raise DagsterInvariantViolationError(
"Reconstructable target can not be a lambda. Use a function or "
"decorated function defined at module scope instead, or use "
"build_reconstructable_job."
)
if seven.qualname_differs(target):
raise DagsterInvariantViolationError(
'Reconstructable target "{target.__name__}" has a different '
'__qualname__ "{target.__qualname__}" indicating it is not '
"defined at module scope. Use a function or decorated function "
"defined at module scope instead, or use build_reconstructable_job.".format(
target=target
)
)
try:
if (
hasattr(target, "__module__")
and hasattr(target, "__name__")
and inspect.getmodule(target).__name__ != "__main__"
):
return ReconstructablePipeline.for_module(target.__module__, target.__name__)
except:
pass
python_file = get_python_file_from_target(target)
if not python_file:
raise DagsterInvariantViolationError(
"reconstructable() can not reconstruct jobs or pipelines defined in interactive "
"environments like <stdin>, IPython, or Jupyter notebooks. "
"Use a pipeline defined in a module or file instead, or use build_reconstructable_job."
)
pointer = FileCodePointer(
python_file=python_file, fn_name=target.__name__, working_directory=os.getcwd()
)
return bootstrap_standalone_recon_pipeline(pointer)
[docs]@experimental
def build_reconstructable_job(
reconstructor_module_name,
reconstructor_function_name,
reconstructable_args=None,
reconstructable_kwargs=None,
reconstructor_working_directory=None,
):
"""
Create a :py:class:`dagster.core.definitions.reconstructable.ReconstructablePipeline`.
When your job must cross process boundaries, e.g., for execution on multiple nodes or in
different systems (like ``dagstermill``), Dagster must know how to reconstruct the job
on the other side of the process boundary.
This function allows you to use the strategy of your choice for reconstructing jobs, so
that you can reconstruct certain kinds of jobs that are not supported by
:py:func:`~dagster.reconstructable`, such as those defined by lambdas, in nested scopes (e.g.,
dynamically within a method call), or in interactive environments such as the Python REPL or
Jupyter notebooks.
If you need to reconstruct jobs constructed in these ways, use this function instead of
:py:func:`~dagster.reconstructable`.
Args:
reconstructor_module_name (str): The name of the module containing the function to use to
reconstruct the job.
reconstructor_function_name (str): The name of the function to use to reconstruct the
job.
reconstructable_args (Tuple): Args to the function to use to reconstruct the job.
Values of the tuple must be JSON serializable.
reconstructable_kwargs (Dict[str, Any]): Kwargs to the function to use to reconstruct the
job. Values of the dict must be JSON serializable.
Examples:
.. code-block:: python
# module: mymodule
from dagster import JobDefinition, job, build_reconstructable_job
class JobFactory:
def make_job(*args, **kwargs):
@job
def _job(...):
...
return _job
def reconstruct_job(*args):
factory = JobFactory()
return factory.make_job(*args)
factory = JobFactory()
foo_job_args = (...,...)
foo_job_kwargs = {...:...}
foo_job = factory.make_job(*foo_job_args, **foo_job_kwargs)
reconstructable_foo_job = build_reconstructable_job(
'mymodule',
'reconstruct_job',
foo_job_args,
foo_job_kwargs,
)
"""
check.str_param(reconstructor_module_name, "reconstructor_module_name")
check.str_param(reconstructor_function_name, "reconstructor_function_name")
check.opt_str_param(
reconstructor_working_directory, "reconstructor_working_directory", os.getcwd()
)
reconstructable_args = list(check.opt_tuple_param(reconstructable_args, "reconstructable_args"))
reconstructable_kwargs = list(
(
[key, value]
for key, value in check.opt_dict_param(
reconstructable_kwargs, "reconstructable_kwargs", key_type=str
).items()
)
)
reconstructor_pointer = ModuleCodePointer(
reconstructor_module_name,
reconstructor_function_name,
working_directory=reconstructor_working_directory,
)
pointer = CustomPointer(reconstructor_pointer, reconstructable_args, reconstructable_kwargs)
pipeline_def = pipeline_def_from_pointer(pointer)
return ReconstructablePipeline(
repository=ReconstructableRepository(pointer), # creates ephemeral repo
pipeline_name=pipeline_def.name,
)
# back compat, in case users have imported these directly
build_reconstructable_pipeline = build_reconstructable_job
build_reconstructable_target = build_reconstructable_job
def bootstrap_standalone_recon_pipeline(pointer):
# So this actually straps the the pipeline for the sole
# purpose of getting the pipeline name. If we changed ReconstructablePipeline
# to get the pipeline on demand in order to get name, we could avoid this.
pipeline_def = pipeline_def_from_pointer(pointer)
return ReconstructablePipeline(
repository=ReconstructableRepository(pointer), # creates ephemeral repo
pipeline_name=pipeline_def.name,
)
def _check_is_loadable(definition):
from dagster.core.asset_defs import AssetGroup
from .graph_definition import GraphDefinition
from .pipeline_definition import PipelineDefinition
from .repository_definition import RepositoryDefinition
if not isinstance(
definition, (PipelineDefinition, RepositoryDefinition, GraphDefinition, AssetGroup)
):
raise DagsterInvariantViolationError(
(
"Loadable attributes must be either a JobDefinition, GraphDefinition, "
f"PipelineDefinition, AssetGroup, or RepositoryDefinition. Got {repr(definition)}."
)
)
return definition
def load_def_in_module(module_name, attribute, working_directory):
return def_from_pointer(CodePointer.from_module(module_name, attribute, working_directory))
def load_def_in_package(package_name, attribute, working_directory):
return def_from_pointer(
CodePointer.from_python_package(package_name, attribute, working_directory)
)
def load_def_in_python_file(python_file, attribute, working_directory):
return def_from_pointer(CodePointer.from_python_file(python_file, attribute, working_directory))
def def_from_pointer(
pointer: CodePointer,
) -> Union["PipelineDefinition", "RepositoryDefinition", "GraphDefinition"]:
target = pointer.load_target()
from dagster.core.asset_defs.asset_group import AssetGroup
from .graph_definition import GraphDefinition
from .pipeline_definition import PipelineDefinition
from .repository_definition import RepositoryDefinition
if isinstance(
target, (PipelineDefinition, RepositoryDefinition, GraphDefinition, AssetGroup)
) or not callable(target):
return _check_is_loadable(target)
# if its a function invoke it - otherwise we are pointing to a
# artifact in module scope, likely decorator output
if seven.get_args(target):
raise DagsterInvariantViolationError(
"Error invoking function at {target} with no arguments. "
"Reconstructable target must be callable with no arguments".format(
target=pointer.describe()
)
)
return _check_is_loadable(target())
def pipeline_def_from_pointer(pointer: CodePointer) -> "PipelineDefinition":
from .pipeline_definition import PipelineDefinition
target = def_from_pointer(pointer)
if isinstance(target, PipelineDefinition):
return target
raise DagsterInvariantViolationError(
"CodePointer ({str}) must resolve to a JobDefinition (or PipelineDefinition for legacy code). "
"Received a {type}".format(str=pointer.describe(), type=type(target))
)
@overload
# NOTE: mypy can't handle these overloads but pyright can
def repository_def_from_target_def( # type: ignore
target: Union["RepositoryDefinition", "PipelineDefinition", "GraphDefinition", "AssetGroup"]
) -> "RepositoryDefinition":
...
@overload
def repository_def_from_target_def(target: object) -> None:
...
def repository_def_from_target_def(target: object) -> Optional["RepositoryDefinition"]:
from dagster.core.asset_defs.asset_group import AssetGroup
from .graph_definition import GraphDefinition
from .pipeline_definition import PipelineDefinition
from .repository_definition import CachingRepositoryData, RepositoryDefinition
# special case - we can wrap a single pipeline in a repository
if isinstance(target, (PipelineDefinition, GraphDefinition)):
# consider including pipeline name in generated repo name
return RepositoryDefinition(
name=get_ephemeral_repository_name(target.name),
repository_data=CachingRepositoryData.from_list([target]),
)
elif isinstance(target, AssetGroup):
return RepositoryDefinition(
name="__repository__", repository_data=CachingRepositoryData.from_list([target])
)
elif isinstance(target, RepositoryDefinition):
return target
else:
return None
def repository_def_from_pointer(pointer: CodePointer) -> "RepositoryDefinition":
target = def_from_pointer(pointer)
repo_def = repository_def_from_target_def(target)
if not repo_def:
raise DagsterInvariantViolationError(
"CodePointer ({str}) must resolve to a "
"RepositoryDefinition, JobDefinition, or PipelineDefinition. "
"Received a {type}".format(str=pointer.describe(), type=type(target))
)
return repo_def
