- class starlark_tugger.FileManifest¶
FileManifesttype represents a set of files and their content.
FileManifestinstances are used to represent things like the final filesystem layout of an installed application.
FileManifestis a dict mapping relative paths to file content.
- add_manifest(manifest: FileManifest)¶
This method overlays another :py:class`FileManifest` on this one. If the other manifest provides a path already in this manifest, its content will be replaced by what is in the other manifest.
- add_file(content: FileContent, path: Optional[str] = None, directory: Optional[str] = None)¶
FileContentinstance to this manifest, optionally controlling its path within the manifest.
directoryare specified, the file will be materialized in the root directory of the manifest with the filename given by
pathis provided, it defines the exact path within the manifest to use.
directoryis provided, the manifest path is effectively computed the same as
An error occurs if both
- add_path(path: str, strip_prefix: str, force_read: bool = False)¶
This method adds a file on the filesystem to the manifest.
The following arguments are accepted:
The filesystem path to add.
The string prefix to strip from the path. The remaining path will be stored in the manifest.
Whether to read the file data into memory now.
This can be set when reading temporary files.
- get_file(path: str) Optional[FileContent] ¶
FileContentat a given path in the manifest, or
Noneif no such path exists in the manifest.
- install(path: str, replace: bool = True)¶
This method writes the content of the
FileManifestto a directory specified by
path. The path is evaluated relative to the path specified by
replaceis True (the default), the destination directory will be deleted and the final state of the destination directory should exactly match the state of the
Upon successful materialization of all files in the manifest, all written files will be assessed for code signing with the