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, source_tag=None, source_commit=None, source_branch=None, source_depth=None, source_submodules=None, source_checksum=None, ignore_patterns=None)[source]

Bases: FileSourceHandler

The plain file source handler.

Parameters:
  • source (str) –

  • part_src_dir (Path) –

  • cache_dir (Path) –

  • project_dirs (ProjectDirs) –

  • source_tag (Optional[str]) –

  • source_commit (Optional[str]) –

  • source_branch (Optional[str]) –

  • source_depth (Optional[int]) –

  • source_submodules (Optional[List[str]]) –

  • source_checksum (Optional[str]) –

  • ignore_patterns (Optional[List[str]]) –

provision(dst, keep=False, src=None)[source]

Process the source file to extract its payload.

Parameters:
  • dst (Path) –

  • keep (bool) –

  • src (Optional[Path]) –

Return type:

None