1.16.16

flytekit.tools.ignore

Directory

Classes

Class Description
DockerIgnore Uses docker-py’s PatternMatcher to check whether a path is ignored.
FlyteIgnore Uses a.
GitIgnore Uses git cli (if available) to list all ignored files and compare with those.
Ignore Base for Ignores, implements core logic.
IgnoreGroup Groups multiple Ignores and checks a path against them.
StandardIgnore Retains the standard ignore functionality that previously existed.

Variables

Property Type Description
STANDARD_IGNORE_PATTERNS list

flytekit.tools.ignore.DockerIgnore

Uses docker-py’s PatternMatcher to check whether a path is ignored.

Parameters 

class DockerIgnore(
    root: pathlib.Path,
)
Parameter Type Description
root pathlib.Path

Methods

Method Description
is_ignored()
tar_filter()

is_ignored() 

def is_ignored(
    path: str,
) -> bool
Parameter Type Description
path str

tar_filter() 

def tar_filter(
    tarinfo: tarfile.TarInfo,
) -> typing.Optional[tarfile.TarInfo]
Parameter Type Description
tarinfo tarfile.TarInfo

flytekit.tools.ignore.FlyteIgnore

Uses a .flyteignore file to determine ignored files.

Parameters 

class FlyteIgnore(
    root: pathlib.Path,
)
Parameter Type Description
root pathlib.Path

Methods

Method Description
is_ignored()
tar_filter()

is_ignored() 

def is_ignored(
    path: str,
) -> bool
Parameter Type Description
path str

tar_filter() 

def tar_filter(
    tarinfo: tarfile.TarInfo,
) -> typing.Optional[tarfile.TarInfo]
Parameter Type Description
tarinfo tarfile.TarInfo

flytekit.tools.ignore.GitIgnore

Uses git cli (if available) to list all ignored files and compare with those.

Parameters 

class GitIgnore(
    root: pathlib.Path,
)
Parameter Type Description
root pathlib.Path

Methods

Method Description
is_ignored()
tar_filter()

is_ignored() 

def is_ignored(
    path: str,
) -> bool
Parameter Type Description
path str

tar_filter() 

def tar_filter(
    tarinfo: tarfile.TarInfo,
) -> typing.Optional[tarfile.TarInfo]
Parameter Type Description
tarinfo tarfile.TarInfo

flytekit.tools.ignore.Ignore

Base for Ignores, implements core logic. Children have to implement _is_ignored

Parameters 

class Ignore(
    root: str,
)
Parameter Type Description
root str

Methods

Method Description
is_ignored()
tar_filter()

is_ignored() 

def is_ignored(
    path: str,
) -> bool
Parameter Type Description
path str

tar_filter() 

def tar_filter(
    tarinfo: tarfile.TarInfo,
) -> typing.Optional[tarfile.TarInfo]
Parameter Type Description
tarinfo tarfile.TarInfo

flytekit.tools.ignore.IgnoreGroup

Groups multiple Ignores and checks a path against them. A file is ignored if any Ignore considers it ignored.

Parameters 

class IgnoreGroup(
    root: str,
    ignores: typing.List[typing.Type[flytekit.tools.ignore.Ignore]],
)
Parameter Type Description
root str
ignores typing.List[typing.Type[flytekit.tools.ignore.Ignore]]

Methods

Method Description
is_ignored()
list_ignored()
tar_filter()

is_ignored() 

def is_ignored(
    path: str,
) -> bool
Parameter Type Description
path str

list_ignored() 

def list_ignored()

tar_filter() 

def tar_filter(
    tarinfo: tarfile.TarInfo,
) -> typing.Optional[tarfile.TarInfo]
Parameter Type Description
tarinfo tarfile.TarInfo

flytekit.tools.ignore.StandardIgnore

Retains the standard ignore functionality that previously existed. Could in theory by fed with custom ignore patterns from cli.

Parameters 

class StandardIgnore(
    root: pathlib.Path,
    patterns: typing.Optional[typing.List[str]],
)
Parameter Type Description
root pathlib.Path
patterns typing.Optional[typing.List[str]]

Methods

Method Description
is_ignored()
tar_filter()

is_ignored() 

def is_ignored(
    path: str,
) -> bool
Parameter Type Description
path str

tar_filter() 

def tar_filter(
    tarinfo: tarfile.TarInfo,
) -> typing.Optional[tarfile.TarInfo]
Parameter Type Description
tarinfo tarfile.TarInfo