buildstream package

Subpackages

• buildstream.sandbox package
  • Submodules
    • Sandbox - The build sandbox
    • SandboxCommandError
    • Sandbox
      • Sandbox.get_virtual_directory()
      • Sandbox.set_environment()
      • Sandbox.set_work_directory()
      • Sandbox.mark_directory()
      • Sandbox.run()
      • Sandbox.batch()
• buildstream.storage package
  • Submodules
    • Directory - Interfacing with files
      • Paths
    • DirectoryError
    • FileType
      • FileType.DIRECTORY
      • FileType.REGULAR_FILE
      • FileType.SYMLINK
    • FileStat
      • FileStat.file_type
      • FileStat.executable
      • FileStat.size
      • FileStat.mtime
    • Directory
      • Directory.open_directory()
      • Directory.import_files()
      • Directory.import_single_file()
      • Directory.export_to_tar()
      • Directory.list_relative_paths()
      • Directory.exists()
      • Directory.stat()
      • Directory.open_file()
      • Directory.file_digest()
      • Directory.readlink()
      • Directory.remove()
      • Directory.rename()
      • Directory.isfile()
      • Directory.isdir()
      • Directory.islink()

Submodules

• BuildElement - Abstract class for build elements
  • Built-in functionality
    • The strip-binaries variable
    • Location for staging dependencies
    • Location for running commands
    • Location for configuring the project
      • Separating source and build directories
    • Install Location
  • Abstract method implementations
    • Element.configure_sandbox()
    • Element.stage()
    • Element.assemble()
• BuildElement
  • BuildElement.configure()
  • BuildElement.configure_dependencies()
  • BuildElement.preflight()
  • BuildElement.get_unique_key()
  • BuildElement.configure_sandbox()
  • BuildElement.stage()
  • BuildElement.assemble()
  • BuildElement.generate_script()
• DownloadableFileSource - Abstract class for sources downloaded from a URI
• DownloadableFileSource
  • DownloadableFileSource.COMMON_CONFIG_KEYS
  • DownloadableFileSource.configure()
  • DownloadableFileSource.preflight()
  • DownloadableFileSource.get_unique_key()
  • DownloadableFileSource.is_cached()
  • DownloadableFileSource.load_ref()
  • DownloadableFileSource.get_ref()
  • DownloadableFileSource.set_ref()
  • DownloadableFileSource.track()
  • DownloadableFileSource.fetch()
• Element - Base element class
  • Abstract Methods
    • Build Phase
    • Miscellaneous
  • Class Reference
• ElementError
• DependencyConfiguration
  • DependencyConfiguration.element
  • DependencyConfiguration.path
  • DependencyConfiguration.config
• Element
  • Element.BST_ARTIFACT_VERSION
  • Element.BST_STRICT_REBUILD
  • Element.BST_FORBID_RDEPENDS
  • Element.BST_FORBID_BDEPENDS
  • Element.BST_FORBID_SOURCES
  • Element.BST_RUN_COMMANDS
  • Element.BST_ELEMENT_HAS_ARTIFACT
  • Element.project_name
  • Element.normal_name
  • Element.configure_dependencies()
  • Element.configure_sandbox()
  • Element.stage()
  • Element.assemble()
  • Element.generate_script()
  • Element.sources()
  • Element.dependencies()
  • Element.search()
  • Element.node_subst_vars()
  • Element.node_subst_sequence_vars()
  • Element.compute_manifest()
  • Element.get_artifact_name()
  • Element.stage_artifact()
  • Element.stage_dependency_artifacts()
  • Element.integrate()
  • Element.stage_sources()
  • Element.get_public_data()
  • Element.set_public_data()
  • Element.get_environment()
  • Element.get_variable()
  • Element.run_cleanup_commands()
• Exceptions - API for Error Handling
• ErrorDomain
  • ErrorDomain.PLUGIN
  • ErrorDomain.LOAD
  • ErrorDomain.IMPL
  • ErrorDomain.PLATFORM
  • ErrorDomain.SANDBOX
  • ErrorDomain.ARTIFACT
  • ErrorDomain.PIPELINE
  • ErrorDomain.UTIL
  • ErrorDomain.SOURCE
  • ErrorDomain.ELEMENT
  • ErrorDomain.APP
  • ErrorDomain.STREAM
  • ErrorDomain.VIRTUAL_FS
  • ErrorDomain.CAS
  • ErrorDomain.PROG_NOT_FOUND
  • ErrorDomain.REMOTE
  • ErrorDomain.PROFILE
• LoadErrorReason
  • LoadErrorReason.MISSING_FILE
  • LoadErrorReason.INVALID_YAML
  • LoadErrorReason.INVALID_DATA
  • LoadErrorReason.ILLEGAL_COMPOSITE
  • LoadErrorReason.CIRCULAR_DEPENDENCY
  • LoadErrorReason.UNRESOLVED_VARIABLE
  • LoadErrorReason.UNSUPPORTED_PROJECT
  • LoadErrorReason.UNSUPPORTED_PLUGIN
  • LoadErrorReason.EXPRESSION_FAILED
  • LoadErrorReason.USER_ASSERTION
  • LoadErrorReason.TRAILING_LIST_DIRECTIVE
  • LoadErrorReason.CONFLICTING_JUNCTION
  • LoadErrorReason.INVALID_JUNCTION
  • LoadErrorReason.SUBPROJECT_INCONSISTENT
  • LoadErrorReason.INVALID_SYMBOL_NAME
  • LoadErrorReason.MISSING_PROJECT_CONF
  • LoadErrorReason.LOADING_DIRECTORY
  • LoadErrorReason.PROJ_PATH_INVALID
  • LoadErrorReason.PROJ_PATH_INVALID_KIND
  • LoadErrorReason.RECURSIVE_INCLUDE
  • LoadErrorReason.CIRCULAR_REFERENCE_VARIABLE
  • LoadErrorReason.PROTECTED_VARIABLE_REDEFINED
  • LoadErrorReason.INVALID_DEPENDENCY_CONFIG
  • LoadErrorReason.LINK_FORBIDDEN_DEPENDENCIES
  • LoadErrorReason.CIRCULAR_REFERENCE
  • LoadErrorReason.BAD_ELEMENT_SUFFIX
  • LoadErrorReason.BAD_CHARACTERS_IN_NAME
• Node - Parsed YAML configuration
  • Node types
  • Class Reference
• MappingNode
  • MappingNode.clone()
  • MappingNode.get_bool()
  • MappingNode.get_enum()
  • MappingNode.get_int()
  • MappingNode.get_mapping()
  • MappingNode.get_node()
  • MappingNode.get_scalar()
  • MappingNode.get_sequence()
  • MappingNode.get_str()
  • MappingNode.get_str_list()
  • MappingNode.items()
  • MappingNode.keys()
  • MappingNode.safe_del()
  • MappingNode.strip_node_info()
  • MappingNode.validate_keys()
  • MappingNode.values()
• Node
  • Node.clone()
  • Node.from_dict()
  • Node.get_provenance()
  • Node.strip_node_info()
• ProvenanceInformation
• ScalarNode
  • ScalarNode.as_bool()
  • ScalarNode.as_enum()
  • ScalarNode.as_int()
  • ScalarNode.as_str()
  • ScalarNode.clone()
  • ScalarNode.is_none()
  • ScalarNode.strip_node_info()
• SequenceNode
  • SequenceNode.append()
  • SequenceNode.as_str_list()
  • SequenceNode.clone()
  • SequenceNode.mapping_at()
  • SequenceNode.node_at()
  • SequenceNode.scalar_at()
  • SequenceNode.sequence_at()
  • SequenceNode.strip_node_info()
• Plugin - Base plugin class
  • Abstract Methods
  • Configurable Warnings
  • Plugin Structure
  • Class Reference
• Plugin
  • Plugin.BST_MIN_VERSION
  • Plugin.BST_PLUGIN_DEPRECATED
  • Plugin.BST_PLUGIN_DEPRECATION_MESSAGE
  • Plugin.name
  • Plugin.configure()
  • Plugin.preflight()
  • Plugin.get_unique_key()
  • Plugin.get_kind()
  • Plugin.node_get_project_path()
  • Plugin.debug()
  • Plugin.status()
  • Plugin.info()
  • Plugin.warn()
  • Plugin.log()
  • Plugin.timed_activity()
  • Plugin.blocking_activity()
  • Plugin.call()
  • Plugin.check_output()
• ScriptElement - Abstract class for scripting elements
• ScriptElement
  • ScriptElement.BST_STRICT_REBUILD
  • ScriptElement.BST_FORBID_RDEPENDS
  • ScriptElement.BST_FORBID_SOURCES
  • ScriptElement.set_work_dir()
  • ScriptElement.set_install_root()
  • ScriptElement.set_root_read_only()
  • ScriptElement.layout_add()
  • ScriptElement.add_commands()
  • ScriptElement.preflight()
  • ScriptElement.get_unique_key()
  • ScriptElement.configure_sandbox()
  • ScriptElement.stage()
  • ScriptElement.assemble()
• setup()
• Source - Base source class
  • Built-in functionality
  • Abstract Methods
  • Working with the source ref
    • Loading and saving
    • Tracking new references
    • Managing internal state
    • Generating the unique key
  • Accessing previous sources
• SourceFetcher - Object for fetching individual URLs
  • Abstract Methods
  • Class Reference
• SourceError
• SourceFetcher
  • SourceFetcher.fetch()
  • SourceFetcher.mark_download_url()
• Source
  • Source.BST_REQUIRES_PREVIOUS_SOURCES_TRACK
  • Source.BST_REQUIRES_PREVIOUS_SOURCES_FETCH
  • Source.BST_REQUIRES_PREVIOUS_SOURCES_STAGE
  • Source.BST_STAGE_VIRTUAL_DIRECTORY
  • Source.COMMON_CONFIG_KEYS
  • Source.load_ref()
  • Source.get_ref()
  • Source.set_ref()
  • Source.track()
  • Source.fetch()
  • Source.stage()
  • Source.stage_directory()
  • Source.init_workspace()
  • Source.init_workspace_directory()
  • Source.get_source_fetchers()
  • Source.validate_cache()
  • Source.is_cached()
  • Source.get_mirror_directory()
  • Source.translate_url()
  • Source.mark_download_url()
  • Source.get_project_directory()
  • Source.tempdir()
  • Source.is_resolved()
• SourceMirror - Base source mirror class
  • Abstract Methods
  • Class Reference
• SourceMirrorError
• SourceMirror
  • SourceMirror.BST_MIN_VERSION
  • SourceMirror.set_supported_aliases()
  • SourceMirror.translate_url()
• Foundation types
• FastEnum
  • FastEnum.name
  • FastEnum.value
  • FastEnum.values()
• CoreWarnings
  • CoreWarnings.OVERLAPS
  • CoreWarnings.UNSTAGED_FILES
  • CoreWarnings.REF_NOT_IN_TRACK
  • CoreWarnings.UNALIASED_URL
• OverlapAction
  • OverlapAction.ERROR
  • OverlapAction.WARNING
  • OverlapAction.IGNORE
• SourceRef
• Utilities
• UtilError
• ProgramNotFoundError
• DirectoryExistsError
• FileListResult
  • FileListResult.overwritten
  • FileListResult.ignored
  • FileListResult.failed_attributes
  • FileListResult.files_written
• list_relative_paths()
• glob()
• sha256sum()
• safe_copy()
• safe_link()
• safe_remove()
• copy_files()
• link_files()
• get_host_tool()
• get_bst_version()
• move_atomic()
• save_file_atomic()
• get_umask()