swh.vault.cookers package

Submodules

• swh.vault.cookers.base module
  • PolicyError
  • BundleTooLargeError
  • BytesIOBundleSizeLimit
    • BytesIOBundleSizeLimit.write()
  • BaseVaultCooker
    • BaseVaultCooker.SUPPORTED_OBJECT_TYPES
    • BaseVaultCooker.BUNDLE_TYPE
    • BaseVaultCooker.check_object_type()
    • BaseVaultCooker.check_exists()
    • BaseVaultCooker.prepare_bundle()
    • BaseVaultCooker.cache_type_key()
    • BaseVaultCooker.write()
    • BaseVaultCooker.cook()
• swh.vault.cookers.directory module
  • DirectoryCooker
    • DirectoryCooker.BUNDLE_TYPE
    • DirectoryCooker.SUPPORTED_OBJECT_TYPES
    • DirectoryCooker.check_exists()
    • DirectoryCooker.prepare_bundle()
• swh.vault.cookers.git_bare module
  • RootObjectType
    • RootObjectType.DIRECTORY
    • RootObjectType.REVISION
    • RootObjectType.RELEASE
    • RootObjectType.SNAPSHOT
  • assert_never()
  • GitBareCooker
    • GitBareCooker.BUNDLE_TYPE
    • GitBareCooker.SUPPORTED_OBJECT_TYPES
    • GitBareCooker.use_fsck
    • GitBareCooker.obj_type
    • GitBareCooker.check_exists()
    • GitBareCooker.prepare_bundle()
    • GitBareCooker.init_git()
    • GitBareCooker.create_object_dirs()
    • GitBareCooker.repack()
    • GitBareCooker.git_fsck()
    • GitBareCooker.write_refs()
    • GitBareCooker.write_archive()
    • GitBareCooker.object_exists()
    • GitBareCooker.write_object()
    • GitBareCooker.push_subgraph()
    • GitBareCooker.load_objects()
    • GitBareCooker.push_revision_subgraph()
    • GitBareCooker.push_snapshot_subgraph()
    • GitBareCooker.load_revisions()
    • GitBareCooker.write_revision_node()
    • GitBareCooker.load_releases()
    • GitBareCooker.push_releases_subgraphs()
    • GitBareCooker.write_release_node()
    • GitBareCooker.load_directories()
    • GitBareCooker.load_directory()
    • GitBareCooker.load_content()
    • GitBareCooker.write_content()
• swh.vault.cookers.revision_flat module
  • RevisionFlatCooker
    • RevisionFlatCooker.BUNDLE_TYPE
    • RevisionFlatCooker.SUPPORTED_OBJECT_TYPES
    • RevisionFlatCooker.check_exists()
    • RevisionFlatCooker.prepare_bundle()
• swh.vault.cookers.revision_gitfast module
  • RevisionGitfastCooker
    • RevisionGitfastCooker.BUNDLE_TYPE
    • RevisionGitfastCooker.SUPPORTED_OBJECT_TYPES
    • RevisionGitfastCooker.check_exists()
    • RevisionGitfastCooker.prepare_bundle()
    • RevisionGitfastCooker.write_cmd()
    • RevisionGitfastCooker.fastexport()
    • RevisionGitfastCooker.mark()
• swh.vault.cookers.utils module
  • revision_log()

Module contents

swh.vault.cookers.get_cooker_cls(bundle_type: str, object_type: ObjectType)

swh.vault.cookers.check_config(cfg: Dict[str, Any]) → Dict[str, Any]

Ensure the configuration is ok to run a vault worker, and propagate defaults

Raises:

• EnvironmentError if the configuration is not for remote instance –

• ValueError if one of the following keys is missing – vault, storage

Returns:

New configuration dict to instantiate a vault worker instance

swh.vault.cookers.get_cooker(bundle_type: str, swhid: CoreSWHID)

Instantiate a cooker class of type bundle_type.

Returns:

Cooker class in charge of cooking the bundle_type with id swhid.

Raises:

• ValueError in case of a missing top-level vault key configuration or a storage – key.

• EnvironmentError in case the vault configuration reference a non remote class. –