0.1.dev2192+g7c539c3.d20250403

flytekit.tools.repo

Directory

Errors

Exception Description
NoSerializableEntitiesError Common base class for all non-exit exceptions.

Methods

Method Description
find_common_root() Given an arbitrary list of folders and files, this function will use the script mode function to walk up.
list_packages_and_modules() This is a helper function that returns the input list of python packages/modules as a dot delinated list.
package() Package the given entities and the source code (if fast is enabled) into a package with the given name in output.
print_registration_status()
register() Temporarily, for fast register, specify both the fast arg as well as copy_style.
serialize_and_package() Fist serialize and then package all entities.
serialize_get_control_plane_entities() See :py:class:`flytekit.
serialize_load_only() See :py:class:`flytekit.
serialize_to_folder() Serialize the given set of python packages to a folder.

Methods

find_common_root()

def find_common_root(
    pkgs_or_mods: typing.Union[typing.Tuple[str], typing.List[str]],
) -> n: The common detected root path, the output of _find_project_root

Given an arbitrary list of folders and files, this function will use the script mode function to walk up the filesystem to find the first folder without an init file. If all the folders and files resolve to the same root folder, then that Path is returned. Otherwise an error is raised.

Parameter Type
pkgs_or_mods typing.Union[typing.Tuple[str], typing.List[str]]

list_packages_and_modules()

def list_packages_and_modules(
    project_root: pathlib._local.Path,
    pkgs_or_mods: typing.List[str],
) -> n: List of packages/modules, dot delineated.

This is a helper function that returns the input list of python packages/modules as a dot delinated list relative to the given project_root.

Parameter Type
project_root pathlib._local.Path
pkgs_or_mods typing.List[str]

package()

def package(
    serializable_entities: typing.List[typing.Union[flytekit.models.task.TaskSpec, flytekit.models.launch_plan.LaunchPlan, flytekit.models.admin.workflow.WorkflowSpec, flytekit.models.core.workflow.Node, flytekit.models.core.workflow.BranchNode, flytekit.models.core.workflow.ArrayNode]],
    source: str,
    output: str,
    deref_symlinks: bool,
    fast_options: typing.Optional[flytekit.tools.fast_registration.FastPackageOptions],
)

Package the given entities and the source code (if fast is enabled) into a package with the given name in output

Parameter Type
serializable_entities typing.List[typing.Union[flytekit.models.task.TaskSpec, flytekit.models.launch_plan.LaunchPlan, flytekit.models.admin.workflow.WorkflowSpec, flytekit.models.core.workflow.Node, flytekit.models.core.workflow.BranchNode, flytekit.models.core.workflow.ArrayNode]]
source str
output str
deref_symlinks bool
fast_options typing.Optional[flytekit.tools.fast_registration.FastPackageOptions] 
def print_registration_status(
    i: flytekit.models.core.identifier.Identifier,
    success: bool,
    activation: bool,
    dry_run: bool,
    console_url: str,
    verbosity: int,
)
Parameter Type
i flytekit.models.core.identifier.Identifier
success bool
activation bool
dry_run bool
console_url str
verbosity int

register()

def register(
    project: str,
    domain: str,
    image_config: flytekit.configuration.ImageConfig,
    output: str,
    destination_dir: str,
    service_account: str,
    raw_data_prefix: str,
    version: typing.Optional[str],
    deref_symlinks: bool,
    package_or_module: typing.Tuple[str],
    remote: flytekit.remote.remote.FlyteRemote,
    copy_style: <enum 'CopyFileDetection'>,
    env: typing.Optional[typing.Dict[str, str]],
    dry_run: bool,
    activate_launchplans: bool,
    skip_errors: bool,
    show_files: bool,
    verbosity: int,
)

Temporarily, for fast register, specify both the fast arg as well as copy_style. fast == True with copy_style == None means use the old fast register tar’ring method.

Parameter Type
project str
domain str
image_config flytekit.configuration.ImageConfig
output str
destination_dir str
service_account str
raw_data_prefix str
version typing.Optional[str]
deref_symlinks bool
package_or_module typing.Tuple[str]
remote flytekit.remote.remote.FlyteRemote
copy_style <enum 'CopyFileDetection'>
env typing.Optional[typing.Dict[str, str]]
dry_run bool
activate_launchplans bool
skip_errors bool
show_files bool
verbosity int

serialize_and_package()

def serialize_and_package(
    pkgs: typing.List[str],
    settings: flytekit.configuration.SerializationSettings,
    source: str,
    output: str,
    deref_symlinks: bool,
    options: typing.Optional[flytekit.core.options.Options],
    fast_options: typing.Optional[flytekit.tools.fast_registration.FastPackageOptions],
)

Fist serialize and then package all entities Temporarily for fast package, specify both the fast arg as well as copy_style. fast == True with copy_style == None means use the old fast register tar’ring method.

Parameter Type
pkgs typing.List[str]
settings flytekit.configuration.SerializationSettings
source str
output str
deref_symlinks bool
options typing.Optional[flytekit.core.options.Options]
fast_options typing.Optional[flytekit.tools.fast_registration.FastPackageOptions]

serialize_get_control_plane_entities()

def serialize_get_control_plane_entities(
    settings: flytekit.configuration.SerializationSettings,
    local_source_root: typing.Optional[str],
    options: typing.Optional[flytekit.core.options.Options],
    is_registration: bool,
) -> typing.List[typing.Union[flytekit.models.task.TaskSpec, flytekit.models.launch_plan.LaunchPlan, flytekit.models.admin.workflow.WorkflowSpec, flytekit.models.core.workflow.Node, flytekit.models.core.workflow.BranchNode, flytekit.models.core.workflow.ArrayNode]]

See :py:class:flytekit.models.core.identifier.ResourceType to match the trailing index in the file name with the entity type.

Parameter Type
settings flytekit.configuration.SerializationSettings
local_source_root typing.Optional[str]
options typing.Optional[flytekit.core.options.Options]
is_registration bool

serialize_load_only()

def serialize_load_only(
    pkgs: typing.List[str],
    settings: flytekit.configuration.SerializationSettings,
    local_source_root: typing.Optional[str],
)

See :py:class:flytekit.models.core.identifier.ResourceType to match the trailing index in the file name with the entity type.

Parameter Type
pkgs typing.List[str]
settings flytekit.configuration.SerializationSettings
local_source_root typing.Optional[str]

serialize_to_folder()

def serialize_to_folder(
    pkgs: typing.List[str],
    settings: flytekit.configuration.SerializationSettings,
    local_source_root: typing.Optional[str],
    folder: str,
    options: typing.Optional[flytekit.core.options.Options],
)

Serialize the given set of python packages to a folder

Parameter Type
pkgs typing.List[str]
settings flytekit.configuration.SerializationSettings
local_source_root typing.Optional[str]
folder str
options typing.Optional[flytekit.core.options.Options]

flytekit.tools.repo.NoSerializableEntitiesError

Common base class for all non-exit exceptions.