craft_parts.sources.file_source module

Implement the plain file source handler.

class craft_parts.sources.file_source.FileSource(source, part_src_dir, *, cache_dir, project_dirs, ignore_patterns=None, **kwargs)

Bases: FileSourceHandler

The plain file source handler.

Parameters:

• source (str)

• part_src_dir (Path)

• cache_dir (Path)

• project_dirs (ProjectDirs)

• ignore_patterns (Optional[list[str]])

• kwargs (Any)

provision(dst, keep=False, src=None)

Process the source file to extract its payload.

Parameters:

• dst (Path)

• keep (bool)

• src (Optional[Path])

Return type:

None

source_model

alias of FileSourceModel

class craft_parts.sources.file_source.FileSourceModel(**data)

Bases: BaseFileSourceModel

Pydantic model for plain file source.

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {'alias_generator': <function get_model_config.<locals>.<lambda>>, 'extra': 'forbid', 'frozen': True, 'json_schema_extra': None}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

source: str

source_checksum: str | None

source_type: Literal['file']

The name of this source type.

Sources must define this with a type hint of a Literal type of its name and a value of its name.