Package reference

• craft_parts package
  • Subpackages
    • craft_parts.executor package
      • Submodules
        • craft_parts.executor.collisions module
          • check_for_stage_collisions()
          • paths_collide()
        • craft_parts.executor.environment module
          • expand_environment()
          • generate_step_environment()
        • craft_parts.executor.executor module
          • ExecutionContext
            • ExecutionContext.execute()
          • Executor
            • Executor.clean()
            • Executor.epilogue()
            • Executor.execute()
            • Executor.prologue()
        • craft_parts.executor.filesets module
          • Fileset
            • Fileset.combine()
            • Fileset.entries
            • Fileset.excludes
            • Fileset.includes
            • Fileset.name
            • Fileset.remove()
          • migratable_filesets()
        • craft_parts.executor.migration module
          • clean_shared_area()
          • clean_shared_overlay()
          • filter_dangling_whiteouts()
          • migrate_files()
        • craft_parts.executor.organize module
          • organize_files()
        • craft_parts.executor.part_handler module
          • PartHandler
            • PartHandler.clean_step()
            • PartHandler.run_action()
        • craft_parts.executor.step_handler module
          • StepContents
            • StepContents.dirs
            • StepContents.files
          • StepHandler
            • StepHandler.run_builtin()
            • StepHandler.run_scriptlet()
      • Module contents
    • craft_parts.overlays package
      • Submodules
        • craft_parts.overlays.chroot module
          • chroot()
        • craft_parts.overlays.errors module
          • OverlayChrootExecutionError
            • OverlayChrootExecutionError.brief
          • OverlayError
            • OverlayError.brief
          • OverlayMountError
            • OverlayMountError.brief
          • OverlayUnmountError
            • OverlayUnmountError.brief
        • craft_parts.overlays.layers module
          • LayerHash
            • LayerHash.for_part()
            • LayerHash.hex()
            • LayerHash.load()
            • LayerHash.save()
          • LayerStateManager
            • LayerStateManager.compute_layer_hash()
            • LayerStateManager.get_layer_hash()
            • LayerStateManager.get_overlay_hash()
            • LayerStateManager.set_layer_hash()
        • craft_parts.overlays.overlay_fs module
          • OverlayFS
            • OverlayFS.mount()
            • OverlayFS.unmount()
          • is_opaque_dir()
          • is_whiteout_file()
        • craft_parts.overlays.overlay_manager module
          • LayerMount
            • LayerMount.install_packages()
          • OverlayManager
            • OverlayManager.base_layer_dir
            • OverlayManager.download_packages()
            • OverlayManager.install_packages()
            • OverlayManager.mkdirs()
            • OverlayManager.mount_layer()
            • OverlayManager.mount_pkg_cache()
            • OverlayManager.refresh_packages_list()
            • OverlayManager.unmount()
          • PackageCacheMount
            • PackageCacheMount.download_packages()
            • PackageCacheMount.refresh_packages_list()
        • craft_parts.overlays.overlays module
          • is_oci_opaque_dir()
          • is_oci_whiteout_file()
          • oci_opaque_dir()
          • oci_whited_out_file()
          • oci_whiteout()
          • visible_in_layer()
      • Module contents
    • craft_parts.packages package
      • Submodules
        • craft_parts.packages.apt_cache module
          • AptCache
            • AptCache.configure_apt()
            • AptCache.fetch_archives()
            • AptCache.get_installed_packages()
            • AptCache.get_installed_version()
            • AptCache.get_packages_marked_for_installation()
            • AptCache.is_package_valid()
            • AptCache.mark_packages()
            • AptCache.unmark_packages()
          • LogProgress
            • LogProgress.fail()
            • LogProgress.fetch()
        • craft_parts.packages.base module
          • BaseRepository
            • BaseRepository.configure()
            • BaseRepository.download_packages()
            • BaseRepository.fetch_stage_packages()
            • BaseRepository.get_installed_packages()
            • BaseRepository.get_package_libraries()
            • BaseRepository.get_packages_for_source_type()
            • BaseRepository.install_packages()
            • BaseRepository.is_package_installed()
            • BaseRepository.refresh_packages_list()
            • BaseRepository.stage_packages_filters
            • BaseRepository.unpack_stage_packages()
          • DummyRepository
            • DummyRepository.configure()
            • DummyRepository.download_packages()
            • DummyRepository.fetch_stage_packages()
            • DummyRepository.get_installed_packages()
            • DummyRepository.get_package_libraries()
            • DummyRepository.get_packages_for_source_type()
            • DummyRepository.install_packages()
            • DummyRepository.is_package_installed()
            • DummyRepository.refresh_packages_list()
            • DummyRepository.unpack_stage_packages()
          • get_pkg_name_parts()
          • mark_origin_stage_package()
          • read_origin_stage_package()
          • write_origin_stage_package()
        • craft_parts.packages.deb module
          • Ubuntu
            • Ubuntu.configure()
            • Ubuntu.download_packages()
            • Ubuntu.fetch_stage_packages()
            • Ubuntu.get_installed_packages()
            • Ubuntu.get_package_libraries()
            • Ubuntu.get_packages_for_source_type()
            • Ubuntu.install_packages()
            • Ubuntu.is_package_installed()
            • Ubuntu.refresh_packages_list()
            • Ubuntu.unpack_stage_packages()
          • get_cache_dirs()
          • get_packages_in_base()
          • process_run()
        • craft_parts.packages.deb_package module
          • DebPackage
            • DebPackage.arch
            • DebPackage.from_unparsed()
            • DebPackage.name
            • DebPackage.version
        • craft_parts.packages.dnf module
          • DNFRepository
            • DNFRepository.get_packages_for_source_type()
          • process_run()
        • craft_parts.packages.errors module
          • BuildPackageNotFound
            • BuildPackageNotFound.brief
          • BuildPackagesNotInstalled
            • BuildPackagesNotInstalled.brief
          • ChiselError
            • ChiselError.brief
          • FileProviderNotFound
            • FileProviderNotFound.brief
          • PackageBackendNotSupported
            • PackageBackendNotSupported.brief
          • PackageBroken
            • PackageBroken.brief
          • PackageFetchError
            • PackageFetchError.brief
          • PackageListRefreshError
            • PackageListRefreshError.brief
          • PackageNotFound
            • PackageNotFound.brief
          • PackagesDownloadError
            • PackagesDownloadError.brief
          • PackagesError
            • PackagesError.brief
          • PackagesNotFound
            • PackagesNotFound.brief
          • SnapDownloadError
            • SnapDownloadError.brief
          • SnapGetAssertionError
            • SnapGetAssertionError.brief
          • SnapInstallError
            • SnapInstallError.brief
          • SnapRefreshError
            • SnapRefreshError.brief
          • SnapUnavailable
            • SnapUnavailable.brief
          • SnapdConnectionError
            • SnapdConnectionError.brief
          • UnpackError
            • UnpackError.brief
        • craft_parts.packages.normalize module
          • fix_pkg_config()
          • normalize()
        • craft_parts.packages.platform module
          • is_deb_based()
          • is_dnf_based()
          • is_yum_based()
        • craft_parts.packages.snaps module
          • SnapPackage
            • SnapPackage.download()
            • SnapPackage.get_current_channel()
            • SnapPackage.get_local_snap_info()
            • SnapPackage.get_store_snap_info()
            • SnapPackage.has_assertions()
            • SnapPackage.in_store
            • SnapPackage.install()
            • SnapPackage.installed
            • SnapPackage.is_classic()
            • SnapPackage.is_snap_installed()
            • SnapPackage.is_valid()
            • SnapPackage.is_valid_snap()
            • SnapPackage.refresh()
          • download_snaps()
          • get_assertion()
          • get_installed_snaps()
          • get_snapd_socket_path_template()
          • install_snaps()
        • craft_parts.packages.yum module
          • YUMRepository
            • YUMRepository.configure()
            • YUMRepository.download_packages()
            • YUMRepository.get_installed_packages()
            • YUMRepository.get_package_libraries()
            • YUMRepository.get_packages_for_source_type()
            • YUMRepository.install_packages()
            • YUMRepository.is_package_installed()
            • YUMRepository.refresh_packages_list()
          • process_run()
      • Module contents
    • craft_parts.plugins package
      • Submodules
        • craft_parts.plugins.ant_plugin module
          • AntPlugin
            • AntPlugin.get_build_commands()
            • AntPlugin.get_build_environment()
            • AntPlugin.get_build_packages()
            • AntPlugin.get_build_snaps()
            • AntPlugin.properties_class
            • AntPlugin.validator_class
          • AntPluginEnvironmentValidator
            • AntPluginEnvironmentValidator.validate_environment()
          • AntPluginProperties
            • AntPluginProperties.ant_build_file
            • AntPluginProperties.ant_build_targets
            • AntPluginProperties.ant_properties
            • AntPluginProperties.source
            • AntPluginProperties.unmarshal()
        • craft_parts.plugins.autotools_plugin module
          • AutotoolsPlugin
            • AutotoolsPlugin.get_build_commands()
            • AutotoolsPlugin.get_build_environment()
            • AutotoolsPlugin.get_build_packages()
            • AutotoolsPlugin.get_build_snaps()
            • AutotoolsPlugin.properties_class
          • AutotoolsPluginProperties
            • AutotoolsPluginProperties.autotools_bootstrap_parameters
            • AutotoolsPluginProperties.autotools_configure_parameters
            • AutotoolsPluginProperties.source
            • AutotoolsPluginProperties.unmarshal()
        • craft_parts.plugins.base module
          • JavaPlugin
            • JavaPlugin.properties_class
          • Plugin
            • Plugin.get_build_commands()
            • Plugin.get_build_environment()
            • Plugin.get_build_packages()
            • Plugin.get_build_snaps()
            • Plugin.get_out_of_source_build()
            • Plugin.get_pull_commands()
            • Plugin.properties_class
            • Plugin.set_action_properties()
            • Plugin.supports_strict_mode
            • Plugin.validator_class
          • PluginModel
          • extract_plugin_properties()
        • craft_parts.plugins.cmake_plugin module
          • CMakePlugin
            • CMakePlugin.get_build_commands()
            • CMakePlugin.get_build_environment()
            • CMakePlugin.get_build_packages()
            • CMakePlugin.get_build_snaps()
            • CMakePlugin.get_out_of_source_build()
            • CMakePlugin.properties_class
          • CMakePluginProperties
            • CMakePluginProperties.cmake_generator
            • CMakePluginProperties.cmake_parameters
            • CMakePluginProperties.source
            • CMakePluginProperties.unmarshal()
        • craft_parts.plugins.dotnet_plugin module
          • DotPluginEnvironmentValidator
            • DotPluginEnvironmentValidator.validate_environment()
          • DotnetPlugin
            • DotnetPlugin.get_build_commands()
            • DotnetPlugin.get_build_environment()
            • DotnetPlugin.get_build_packages()
            • DotnetPlugin.get_build_snaps()
            • DotnetPlugin.properties_class
            • DotnetPlugin.validator_class
          • DotnetPluginProperties
            • DotnetPluginProperties.dotnet_build_configuration
            • DotnetPluginProperties.dotnet_self_contained_runtime_identifier
            • DotnetPluginProperties.source
            • DotnetPluginProperties.unmarshal()
        • craft_parts.plugins.dump_plugin module
          • DumpPlugin
            • DumpPlugin.get_build_commands()
            • DumpPlugin.get_build_environment()
            • DumpPlugin.get_build_packages()
            • DumpPlugin.get_build_snaps()
            • DumpPlugin.get_pull_commands()
            • DumpPlugin.properties_class
            • DumpPlugin.supports_strict_mode
          • DumpPluginProperties
            • DumpPluginProperties.unmarshal()
        • craft_parts.plugins.go_plugin module
          • GoPlugin
            • GoPlugin.get_build_commands()
            • GoPlugin.get_build_environment()
            • GoPlugin.get_build_packages()
            • GoPlugin.get_build_snaps()
            • GoPlugin.properties_class
            • GoPlugin.validator_class
          • GoPluginEnvironmentValidator
            • GoPluginEnvironmentValidator.validate_environment()
          • GoPluginProperties
            • GoPluginProperties.go_buildtags
            • GoPluginProperties.go_generate
            • GoPluginProperties.source
            • GoPluginProperties.unmarshal()
        • craft_parts.plugins.make_plugin module
          • MakePlugin
            • MakePlugin.get_build_commands()
            • MakePlugin.get_build_environment()
            • MakePlugin.get_build_packages()
            • MakePlugin.get_build_snaps()
            • MakePlugin.properties_class
          • MakePluginProperties
            • MakePluginProperties.make_parameters
            • MakePluginProperties.source
            • MakePluginProperties.unmarshal()
        • craft_parts.plugins.maven_plugin module
          • MavenPlugin
            • MavenPlugin.get_build_commands()
            • MavenPlugin.get_build_environment()
            • MavenPlugin.get_build_packages()
            • MavenPlugin.get_build_snaps()
            • MavenPlugin.properties_class
            • MavenPlugin.validator_class
          • MavenPluginEnvironmentValidator
            • MavenPluginEnvironmentValidator.validate_environment()
          • MavenPluginProperties
            • MavenPluginProperties.maven_parameters
            • MavenPluginProperties.source
            • MavenPluginProperties.unmarshal()
        • craft_parts.plugins.meson_plugin module
          • MesonPlugin
            • MesonPlugin.get_build_commands()
            • MesonPlugin.get_build_environment()
            • MesonPlugin.get_build_packages()
            • MesonPlugin.get_build_snaps()
            • MesonPlugin.get_out_of_source_build()
            • MesonPlugin.properties_class
            • MesonPlugin.validator_class
          • MesonPluginEnvironmentValidator
            • MesonPluginEnvironmentValidator.validate_environment()
          • MesonPluginProperties
            • MesonPluginProperties.meson_parameters
            • MesonPluginProperties.source
            • MesonPluginProperties.unmarshal()
        • craft_parts.plugins.nil_plugin module
          • NilPlugin
            • NilPlugin.get_build_commands()
            • NilPlugin.get_build_environment()
            • NilPlugin.get_build_packages()
            • NilPlugin.get_build_snaps()
            • NilPlugin.get_pull_commands()
            • NilPlugin.properties_class
            • NilPlugin.supports_strict_mode
          • NilPluginProperties
            • NilPluginProperties.unmarshal()
        • craft_parts.plugins.npm_plugin module
          • NpmPlugin
            • NpmPlugin.get_build_commands()
            • NpmPlugin.get_build_environment()
            • NpmPlugin.get_build_packages()
            • NpmPlugin.get_build_snaps()
            • NpmPlugin.properties_class
            • NpmPlugin.validator_class
          • NpmPluginEnvironmentValidator
            • NpmPluginEnvironmentValidator.validate_environment()
          • NpmPluginProperties
            • NpmPluginProperties.node_version_defined()
            • NpmPluginProperties.npm_include_node
            • NpmPluginProperties.npm_node_version
            • NpmPluginProperties.source
            • NpmPluginProperties.unmarshal()
        • craft_parts.plugins.plugins module
          • extract_part_properties()
          • get_plugin()
          • get_plugin_class()
          • get_registered_plugins()
          • register()
          • unregister_all()
        • craft_parts.plugins.properties module
          • PluginProperties
            • PluginProperties.get_build_properties()
            • PluginProperties.get_pull_properties()
            • PluginProperties.marshal()
            • PluginProperties.unmarshal()
          • PluginPropertiesModel
            • PluginPropertiesModel.Config
              • PluginPropertiesModel.Config.alias_generator()
              • PluginPropertiesModel.Config.allow_mutation
              • PluginPropertiesModel.Config.extra
              • PluginPropertiesModel.Config.validate_assignment
        • craft_parts.plugins.python_plugin module
          • PythonPlugin
            • PythonPlugin.get_build_commands()
            • PythonPlugin.get_build_environment()
            • PythonPlugin.get_build_packages()
            • PythonPlugin.get_build_snaps()
            • PythonPlugin.properties_class
          • PythonPluginProperties
            • PythonPluginProperties.python_constraints
            • PythonPluginProperties.python_packages
            • PythonPluginProperties.python_requirements
            • PythonPluginProperties.source
            • PythonPluginProperties.unmarshal()
        • craft_parts.plugins.rust_plugin module
          • RustPlugin
            • RustPlugin.get_build_commands()
            • RustPlugin.get_build_environment()
            • RustPlugin.get_build_packages()
            • RustPlugin.get_build_snaps()
            • RustPlugin.get_pull_commands()
            • RustPlugin.properties_class
            • RustPlugin.validator_class
          • RustPluginEnvironmentValidator
            • RustPluginEnvironmentValidator.validate_environment()
          • RustPluginProperties
            • RustPluginProperties.after
            • RustPluginProperties.rust_channel
            • RustPluginProperties.rust_features
            • RustPluginProperties.rust_no_default_features
            • RustPluginProperties.rust_path
            • RustPluginProperties.rust_use_global_lto
            • RustPluginProperties.source
            • RustPluginProperties.unmarshal()
        • craft_parts.plugins.scons_plugin module
          • SConsPlugin
            • SConsPlugin.get_build_commands()
            • SConsPlugin.get_build_environment()
            • SConsPlugin.get_build_packages()
            • SConsPlugin.get_build_snaps()
            • SConsPlugin.properties_class
            • SConsPlugin.validator_class
          • SConsPluginEnvironmentValidator
            • SConsPluginEnvironmentValidator.validate_environment()
          • SConsPluginProperties
            • SConsPluginProperties.scons_parameters
            • SConsPluginProperties.source
            • SConsPluginProperties.unmarshal()
        • craft_parts.plugins.validator module
          • COMMAND_NOT_FOUND
          • PluginEnvironmentValidator
            • PluginEnvironmentValidator.validate_dependency()
            • PluginEnvironmentValidator.validate_environment()
      • Module contents
        • Plugin
          • Plugin.get_build_commands()
          • Plugin.get_build_environment()
          • Plugin.get_build_packages()
          • Plugin.get_build_snaps()
          • Plugin.get_out_of_source_build()
          • Plugin.get_pull_commands()
          • Plugin.properties_class
          • Plugin.set_action_properties()
          • Plugin.supports_strict_mode
          • Plugin.validator_class
        • PluginEnvironmentValidator
          • PluginEnvironmentValidator.validate_dependency()
          • PluginEnvironmentValidator.validate_environment()
        • PluginModel
        • PluginProperties
          • PluginProperties.get_build_properties()
          • PluginProperties.get_pull_properties()
          • PluginProperties.marshal()
          • PluginProperties.unmarshal()
        • extract_part_properties()
        • extract_plugin_properties()
        • get_plugin()
        • get_plugin_class()
        • get_registered_plugins()
        • register()
        • unregister_all()
    • craft_parts.sources package
      • Submodules
        • craft_parts.sources.base module
          • FileSourceHandler
            • FileSourceHandler.download()
            • FileSourceHandler.provision()
            • FileSourceHandler.pull()
          • SourceHandler
            • SourceHandler.check_if_outdated()
            • SourceHandler.get_outdated_files()
            • SourceHandler.pull()
            • SourceHandler.update()
        • craft_parts.sources.cache module
          • FileCache
            • FileCache.cache()
            • FileCache.clean()
            • FileCache.get()
        • craft_parts.sources.checksum module
          • split_checksum()
          • verify_checksum()
        • craft_parts.sources.deb_source module
          • DebSource
            • DebSource.provision()
        • craft_parts.sources.errors module
          • ChecksumMismatch
            • ChecksumMismatch.brief
          • IncompatibleSourceOptions
            • IncompatibleSourceOptions.brief
          • InvalidRpmPackage
            • InvalidRpmPackage.brief
          • InvalidSnapPackage
            • InvalidSnapPackage.brief
          • InvalidSourceOption
            • InvalidSourceOption.brief
          • InvalidSourceOptions
            • InvalidSourceOptions.brief
          • InvalidSourceType
            • InvalidSourceType.brief
          • NetworkRequestError
            • NetworkRequestError.brief
          • PullError
            • PullError.brief
          • SourceError
            • SourceError.brief
          • SourceNotFound
            • SourceNotFound.brief
          • SourceUpdateUnsupported
            • SourceUpdateUnsupported.brief
          • VCSError
            • VCSError.brief
        • craft_parts.sources.file_source module
          • FileSource
            • FileSource.provision()
        • craft_parts.sources.git_source module
          • GitSource
            • GitSource.check_command_installed()
            • GitSource.generate_version()
            • GitSource.is_local()
            • GitSource.pull()
            • GitSource.version()
        • craft_parts.sources.local_source module
          • LocalSource
            • LocalSource.check_if_outdated()
            • LocalSource.get_outdated_files()
            • LocalSource.pull()
            • LocalSource.update()
        • craft_parts.sources.rpm_source module
          • RpmSource
            • RpmSource.provision()
        • craft_parts.sources.snap_source module
          • SnapSource
            • SnapSource.provision()
        • craft_parts.sources.sources module
          • get_source_handler()
          • get_source_type_from_uri()
        • craft_parts.sources.tar_source module
          • TarSource
            • TarSource.provision()
        • craft_parts.sources.zip_source module
          • ZipSource
            • ZipSource.provision()
      • Module contents
    • craft_parts.state_manager package
      • Submodules
        • craft_parts.state_manager.build_state module
          • BuildState
            • BuildState.assets
            • BuildState.overlay_hash
            • BuildState.project_options_of_interest()
            • BuildState.properties_of_interest()
            • BuildState.unmarshal()
        • craft_parts.state_manager.overlay_state module
          • OverlayState
            • OverlayState.part_properties
            • OverlayState.project_options
            • OverlayState.project_options_of_interest()
            • OverlayState.properties_of_interest()
            • OverlayState.unmarshal()
        • craft_parts.state_manager.prime_state module
          • PrimeState
            • PrimeState.dependency_paths
            • PrimeState.primed_stage_packages
            • PrimeState.project_options_of_interest()
            • PrimeState.properties_of_interest()
            • PrimeState.unmarshal()
        • craft_parts.state_manager.pull_state module
          • PullState
            • PullState.assets
            • PullState.outdated_dirs
            • PullState.outdated_files
            • PullState.project_options_of_interest()
            • PullState.properties_of_interest()
            • PullState.unmarshal()
        • craft_parts.state_manager.reports module
          • Dependency
            • Dependency.part_name
            • Dependency.step
          • DirtyReport
            • DirtyReport.reason()
          • OutdatedReport
            • OutdatedReport.reason()
        • craft_parts.state_manager.stage_state module
          • StageState
            • StageState.overlay_hash
            • StageState.project_options_of_interest()
            • StageState.properties_of_interest()
            • StageState.unmarshal()
        • craft_parts.state_manager.state_manager module
          • StateManager
            • StateManager.check_if_dirty()
            • StateManager.check_if_outdated()
            • StateManager.clean_part()
            • StateManager.get_outdated_dirs()
            • StateManager.get_outdated_files()
            • StateManager.get_step_state_overlay_hash()
            • StateManager.has_step_run()
            • StateManager.mark_step_updated()
            • StateManager.project_vars()
            • StateManager.set_state()
            • StateManager.should_step_run()
            • StateManager.update_state_timestamp()
        • craft_parts.state_manager.states module
          • get_overlay_migration_state_path()
          • get_step_state_path()
          • load_overlay_migration_state()
          • load_step_state()
          • remove()
        • craft_parts.state_manager.step_state module
          • MigrationState
            • MigrationState.directories
            • MigrationState.files
            • MigrationState.marshal()
            • MigrationState.unmarshal()
            • MigrationState.write()
          • StepState
            • StepState.Config
              • StepState.Config.alias_generator()
              • StepState.Config.allow_mutation
              • StepState.Config.allow_population_by_field_name
              • StepState.Config.extra
              • StepState.Config.validate_assignment
            • StepState.diff_project_options_of_interest()
            • StepState.diff_properties_of_interest()
            • StepState.part_properties
            • StepState.project_options
            • StepState.project_options_of_interest()
            • StepState.properties_of_interest()
            • StepState.unmarshal()
          • validate_hex_string()
      • Module contents
    • craft_parts.utils package
      • Submodules
        • craft_parts.utils.deb_utils module
          • extract_deb()
        • craft_parts.utils.file_utils module
          • NonBlockingRWFifo
            • NonBlockingRWFifo.close()
            • NonBlockingRWFifo.path
            • NonBlockingRWFifo.read()
            • NonBlockingRWFifo.write()
          • calculate_hash()
          • copy()
          • create_similar_directory()
          • link()
          • link_or_copy()
          • link_or_copy_tree()
        • craft_parts.utils.formatting_utils module
          • humanize_list()
        • craft_parts.utils.os_utils module
          • OsRelease
            • OsRelease.id()
            • OsRelease.name()
            • OsRelease.version_id()
          • TimedWriter
            • TimedWriter.write_text()
          • get_bin_paths()
          • get_include_paths()
          • get_library_paths()
          • get_pkg_config_paths()
          • get_system_info()
          • is_dumb_terminal()
          • is_inside_container()
          • is_snap()
          • mount()
          • mount_overlayfs()
          • process_run()
          • umount()
        • craft_parts.utils.partition_utils module
          • validate_partition_names()
        • craft_parts.utils.path_utils module
          • PartitionPathPair
            • PartitionPathPair.partition
            • PartitionPathPair.path
          • get_partition_and_path()
          • get_partitioned_path()
        • craft_parts.utils.url_utils module
          • download_request()
          • get_url_scheme()
          • is_url()
      • Module contents
        • Singleton
        • package_name()
  • Submodules
    • craft_parts.actions module
      • Action
        • Action.action_type
        • Action.part_name
        • Action.project_vars
        • Action.properties
        • Action.reason
        • Action.step
      • ActionProperties
        • ActionProperties.changed_dirs
        • ActionProperties.changed_files
      • ActionType
        • ActionType.REAPPLY
        • ActionType.RERUN
        • ActionType.RUN
        • ActionType.SKIP
        • ActionType.UPDATE
    • craft_parts.callbacks module
      • CallbackHook
        • CallbackHook.function
        • CallbackHook.step_list
      • get_stage_packages_filters()
      • register_configure_overlay()
      • register_epilogue()
      • register_post_step()
      • register_pre_step()
      • register_prologue()
      • register_stage_packages_filter()
      • run_configure_overlay()
      • run_epilogue()
      • run_post_step()
      • run_pre_step()
      • run_prologue()
      • unregister_all()
    • craft_parts.ctl module
      • CraftCtl
        • CraftCtl.run()
      • main()
    • craft_parts.dirs module
      • ProjectDirs
        • ProjectDirs.get_prime_dir()
        • ProjectDirs.get_stage_dir()
    • craft_parts.errors module
      • CallbackRegistrationError
        • CallbackRegistrationError.brief
      • CopyFileNotFound
        • CopyFileNotFound.brief
      • CopyTreeError
        • CopyTreeError.brief
      • DebError
        • DebError.brief
      • FeatureError
        • FeatureError.brief
      • FileOrganizeError
        • FileOrganizeError.brief
      • FilesetConflict
        • FilesetConflict.brief
      • FilesetError
        • FilesetError.brief
      • InvalidAction
        • InvalidAction.brief
      • InvalidApplicationName
        • InvalidApplicationName.brief
      • InvalidArchitecture
        • InvalidArchitecture.brief
      • InvalidControlAPICall
        • InvalidControlAPICall.brief
      • InvalidPartName
        • InvalidPartName.brief
      • InvalidPartitionError
        • InvalidPartitionError.brief
      • InvalidPlugin
        • InvalidPlugin.brief
      • OsReleaseCodenameError
        • OsReleaseCodenameError.brief
      • OsReleaseIdError
        • OsReleaseIdError.brief
      • OsReleaseNameError
        • OsReleaseNameError.brief
      • OsReleaseVersionIdError
        • OsReleaseVersionIdError.brief
      • OverlayPackageNotFound
        • OverlayPackageNotFound.brief
      • OverlayPermissionError
        • OverlayPermissionError.brief
      • OverlayPlatformError
        • OverlayPlatformError.brief
      • PartDependencyCycle
        • PartDependencyCycle.brief
      • PartFilesConflict
        • PartFilesConflict.brief
      • PartSpecificationError
        • PartSpecificationError.brief
        • PartSpecificationError.from_validation_error()
      • PartitionError
        • PartitionError.brief
      • PartitionWarning
        • PartitionWarning.brief
      • PartsError
        • PartsError.brief
        • PartsError.details
        • PartsError.resolution
      • PluginBuildError
        • PluginBuildError.brief
      • PluginCleanError
        • PluginCleanError.brief
      • PluginEnvironmentValidationError
        • PluginEnvironmentValidationError.brief
      • PluginNotStrict
        • PluginNotStrict.brief
      • PluginPullError
        • PluginPullError.brief
      • ScriptletRunError
        • ScriptletRunError.brief
      • StageFilesConflict
        • StageFilesConflict.brief
      • StagePackageNotFound
        • StagePackageNotFound.brief
      • UndefinedPlugin
        • UndefinedPlugin.brief
      • XAttributeError
        • XAttributeError.brief
      • XAttributeTooLong
        • XAttributeTooLong.brief
    • craft_parts.features module
      • Features
        • Features.enable_overlay
        • Features.enable_partitions
        • Features.reset()
    • craft_parts.infos module
      • PartInfo
        • PartInfo.get_project_var()
        • PartInfo.part_build_dir
        • PartInfo.part_build_subdir
        • PartInfo.part_cache_dir
        • PartInfo.part_install_dir
        • PartInfo.part_name
        • PartInfo.part_src_dir
        • PartInfo.part_src_subdir
        • PartInfo.part_state_dir
        • PartInfo.project_info
        • PartInfo.set_project_var()
      • ProjectInfo
        • ProjectInfo.application_name
        • ProjectInfo.arch_build_for
        • ProjectInfo.arch_build_on
        • ProjectInfo.arch_triplet
        • ProjectInfo.arch_triplet_build_for
        • ProjectInfo.arch_triplet_build_on
        • ProjectInfo.base
        • ProjectInfo.cache_dir
        • ProjectInfo.custom_args
        • ProjectInfo.dirs
        • ProjectInfo.get_project_var()
        • ProjectInfo.host_arch
        • ProjectInfo.is_cross_compiling
        • ProjectInfo.parallel_build_count
        • ProjectInfo.partitions
        • ProjectInfo.project_name
        • ProjectInfo.project_options
        • ProjectInfo.project_vars_part_name
        • ProjectInfo.set_project_var()
        • ProjectInfo.strict_mode
        • ProjectInfo.target_arch
      • ProjectVar
        • ProjectVar.updated
        • ProjectVar.value
      • StepInfo
    • craft_parts.lifecycle_manager module
      • LifecycleManager
        • LifecycleManager.action_executor()
        • LifecycleManager.clean()
        • LifecycleManager.get_primed_stage_packages()
        • LifecycleManager.get_pull_assets()
        • LifecycleManager.plan()
        • LifecycleManager.project_info
        • LifecycleManager.refresh_packages_list()
        • LifecycleManager.reload_state()
    • craft_parts.main module
      • main()
    • craft_parts.parts module
      • Part
        • Part.base_prime_dir
        • Part.base_stage_dir
        • Part.check_partition_usage()
        • Part.dependencies
        • Part.has_overlay
        • Part.overlay_dir
        • Part.part_base_install_dir
        • Part.part_build_dir
        • Part.part_build_subdir
        • Part.part_cache_dir
        • Part.part_install_dir
        • Part.part_install_dirs
        • Part.part_layer_dir
        • Part.part_packages_dir
        • Part.part_run_dir
        • Part.part_snaps_dir
        • Part.part_src_dir
        • Part.part_src_subdir
        • Part.part_state_dir
        • Part.parts_dir
        • Part.prime_dir
        • Part.prime_dirs
        • Part.stage_dir
        • Part.stage_dirs
      • PartSpec
        • PartSpec.Config
          • PartSpec.Config.alias_generator()
          • PartSpec.Config.allow_mutation
          • PartSpec.Config.extra
          • PartSpec.Config.validate_assignment
        • PartSpec.after
        • PartSpec.build_attributes
        • PartSpec.build_environment
        • PartSpec.build_packages
        • PartSpec.build_snaps
        • PartSpec.disable_parallel
        • PartSpec.get_scriptlet()
        • PartSpec.has_overlay
        • PartSpec.marshal()
        • PartSpec.organize_files
        • PartSpec.overlay_files
        • PartSpec.overlay_packages
        • PartSpec.overlay_script
        • PartSpec.override_build
        • PartSpec.override_prime
        • PartSpec.override_pull
        • PartSpec.override_stage
        • PartSpec.permissions
        • PartSpec.plugin
        • PartSpec.prime_files
        • PartSpec.source
        • PartSpec.source_branch
        • PartSpec.source_checksum
        • PartSpec.source_commit
        • PartSpec.source_depth
        • PartSpec.source_subdir
        • PartSpec.source_submodules
        • PartSpec.source_tag
        • PartSpec.source_type
        • PartSpec.stage_files
        • PartSpec.stage_packages
        • PartSpec.stage_snaps
        • PartSpec.unmarshal()
        • PartSpec.validate_overlay_feature()
        • PartSpec.validate_relative_path_list()
        • PartSpec.validate_root()
      • get_parts_with_overlay()
      • has_overlay_visibility()
      • part_by_name()
      • part_dependencies()
      • part_has_overlay()
      • part_list_by_name()
      • sort_parts()
      • validate_part()
      • validate_partition_usage()
    • craft_parts.permissions module
      • Permissions
        • Permissions.applies_to()
        • Permissions.apply_permissions()
        • Permissions.group
        • Permissions.mode
        • Permissions.mode_octal
        • Permissions.owner
        • Permissions.path
        • Permissions.validate_root()
      • apply_permissions()
      • filter_permissions()
      • permissions_are_compatible()
    • craft_parts.sequencer module
      • Sequencer
        • Sequencer.plan()
        • Sequencer.reload_state()
    • craft_parts.steps module
      • Step
        • Step.BUILD
        • Step.OVERLAY
        • Step.PRIME
        • Step.PULL
        • Step.STAGE
        • Step.next_steps()
        • Step.previous_steps()
      • dependency_prerequisite_step()
    • craft_parts.xattrs module
      • read_xattr()
      • write_xattr()
  • Module contents
    • Action
      • Action.action_type
      • Action.part_name
      • Action.project_vars
      • Action.properties
      • Action.reason
      • Action.step
    • ActionProperties
      • ActionProperties.changed_dirs
      • ActionProperties.changed_files
    • ActionType
      • ActionType.REAPPLY
      • ActionType.RERUN
      • ActionType.RUN
      • ActionType.SKIP
      • ActionType.UPDATE
    • Features
      • Features.enable_overlay
      • Features.enable_partitions
      • Features.reset()
    • LifecycleManager
      • LifecycleManager.action_executor()
      • LifecycleManager.clean()
      • LifecycleManager.get_primed_stage_packages()
      • LifecycleManager.get_pull_assets()
      • LifecycleManager.plan()
      • LifecycleManager.project_info
      • LifecycleManager.refresh_packages_list()
      • LifecycleManager.reload_state()
    • Part
      • Part.base_prime_dir
      • Part.base_stage_dir
      • Part.check_partition_usage()
      • Part.dependencies
      • Part.has_overlay
      • Part.overlay_dir
      • Part.part_base_install_dir
      • Part.part_build_dir
      • Part.part_build_subdir
      • Part.part_cache_dir
      • Part.part_install_dir
      • Part.part_install_dirs
      • Part.part_layer_dir
      • Part.part_packages_dir
      • Part.part_run_dir
      • Part.part_snaps_dir
      • Part.part_src_dir
      • Part.part_src_subdir
      • Part.part_state_dir
      • Part.parts_dir
      • Part.prime_dir
      • Part.prime_dirs
      • Part.stage_dir
      • Part.stage_dirs
    • PartInfo
      • PartInfo.get_project_var()
      • PartInfo.part_build_dir
      • PartInfo.part_build_subdir
      • PartInfo.part_cache_dir
      • PartInfo.part_install_dir
      • PartInfo.part_name
      • PartInfo.part_src_dir
      • PartInfo.part_src_subdir
      • PartInfo.part_state_dir
      • PartInfo.project_info
      • PartInfo.set_project_var()
    • PartsError
      • PartsError.brief
      • PartsError.details
      • PartsError.resolution
    • ProjectDirs
      • ProjectDirs.get_prime_dir()
      • ProjectDirs.get_stage_dir()
    • ProjectInfo
      • ProjectInfo.application_name
      • ProjectInfo.arch_build_for
      • ProjectInfo.arch_build_on
      • ProjectInfo.arch_triplet
      • ProjectInfo.arch_triplet_build_for
      • ProjectInfo.arch_triplet_build_on
      • ProjectInfo.base
      • ProjectInfo.cache_dir
      • ProjectInfo.custom_args
      • ProjectInfo.dirs
      • ProjectInfo.get_project_var()
      • ProjectInfo.host_arch
      • ProjectInfo.is_cross_compiling
      • ProjectInfo.parallel_build_count
      • ProjectInfo.partitions
      • ProjectInfo.project_name
      • ProjectInfo.project_options
      • ProjectInfo.project_vars_part_name
      • ProjectInfo.set_project_var()
      • ProjectInfo.strict_mode
      • ProjectInfo.target_arch
    • Step
      • Step.BUILD
      • Step.OVERLAY
      • Step.PRIME
      • Step.PULL
      • Step.STAGE
      • Step.next_steps()
      • Step.previous_steps()
    • StepInfo
    • expand_environment()
    • part_has_overlay()
    • validate_part()