craft_parts.sources.zip_source module

Implement the zip file source handler.

class craft_parts.sources.zip_source.ZipSource(source, part_src_dir, *, cache_dir, project_dirs, source_checksum=None, command=None, ignore_patterns=None, **kwargs)

Bases: FileSourceHandler

The zip file source handler.

Parameters:

• source (Path | str)

• part_src_dir (Path)

• cache_dir (Path)

• project_dirs (ProjectDirs)

• source_checksum (str | None)

• command (str | None)

• ignore_patterns (list[str] | None)

• kwargs (Any)

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

Extract zip file contents to the part source dir.

Parameters:

• dst (Path)

• keep (bool)

• src (Path | None)

Return type:

None

source_model

alias of ZipSourceModel

class craft_parts.sources.zip_source.ZipSourceModel(**data)

Bases: BaseFileSourceModel

Pydantic model for a zip file source.

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {'alias_generator': <function get_model_config.<locals>.<lambda>>, 'extra': 'forbid', 'frozen': True, 'json_schema_extra': {'if': {'not': {'required': ['source-type']}}, 'then': {'properties': {'source': {'pattern': '\\.zip$'}}}}}

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

pattern: ClassVar[str | None] = '\\.zip$'

A regular expression for inferring this source type.

If pattern is None (the default), the source type cannot be inferred and must always be explicitly written in the source-type field of a part.

source_type: Literal['zip']

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.