swh.vault package

Subpackages:

• swh.vault.api package
  • swh.vault.api.client module
    • RemoteVaultClient
  • swh.vault.api.serializers module
  • swh.vault.api.server module
    • get_vault()
    • VaultServerApp
    • argument_error_handler()
    • my_error_handler()
    • index()
    • check_config()
    • make_app_from_configfile()
• swh.vault.cookers package
  • swh.vault.cookers.base module
    • PolicyError
    • BundleTooLargeError
    • BytesIOBundleSizeLimit
    • BaseVaultCooker
  • swh.vault.cookers.directory module
    • DirectoryCooker
  • swh.vault.cookers.git_bare module
    • RootObjectType
    • assert_never()
    • GitBareCooker
  • swh.vault.cookers.revision_flat module
    • RevisionFlatCooker
  • swh.vault.cookers.revision_gitfast module
    • RevisionGitfastCooker
  • swh.vault.cookers.utils module
    • revision_log()
  • get_cooker_cls()
  • check_config()
  • get_cooker()

Submodules:

• swh.vault.backend module
  • VaultDB
    • VaultDB.current_version
    • VaultDB.get_db()
    • VaultDB.put_db()
  • VaultBackend
    • VaultBackend.progress()
    • VaultBackend.create_task()
    • VaultBackend.add_notif_email()
    • VaultBackend.put_bundle()
    • VaultBackend.cook()
    • VaultBackend.batch_cook()
    • VaultBackend.batch_progress()
    • VaultBackend.is_available()
    • VaultBackend.fetch()
    • VaultBackend.download_url()
    • VaultBackend.update_access_ts()
    • VaultBackend.set_status()
    • VaultBackend.set_progress()
    • VaultBackend.send_notif()
    • VaultBackend.send_notification()
    • VaultBackend.cache_expire_oldest()
    • VaultBackend.cache_expire_until()
• swh.vault.cache module
  • VaultCache
    • VaultCache.add()
    • VaultCache.get()
    • VaultCache.download_url()
    • VaultCache.delete()
    • VaultCache.is_cached()
• swh.vault.cli module
  • SwhidParamType
    • SwhidParamType.name
    • SwhidParamType.convert()
  • main()
• swh.vault.cooking_tasks module
• swh.vault.exc module
  • NotFoundExc
• swh.vault.in_memory_backend module
  • InMemoryVaultBackend
    • InMemoryVaultBackend.fetch()
    • InMemoryVaultBackend.download_url()
    • InMemoryVaultBackend.cook()
    • InMemoryVaultBackend.progress()
    • InMemoryVaultBackend.set_progress()
    • InMemoryVaultBackend.set_status()
    • InMemoryVaultBackend.put_bundle()
    • InMemoryVaultBackend.send_notif()
    • InMemoryVaultBackend.batch_cook()
    • InMemoryVaultBackend.batch_progress()
• swh.vault.interface module
  • VaultInterface
    • VaultInterface.fetch()
    • VaultInterface.download_url()
    • VaultInterface.cook()
    • VaultInterface.progress()
    • VaultInterface.set_progress()
    • VaultInterface.set_status()
    • VaultInterface.put_bundle()
    • VaultInterface.send_notif()
    • VaultInterface.batch_cook()
    • VaultInterface.batch_progress()
• swh.vault.to_disk module
  • get_filtered_file_content()
  • DirectoryBuilder
    • DirectoryBuilder.build()

Module contents:

swh.vault.get_vault(cls: str = 'remote', **kwargs)

Get a vault object of class vault_class with arguments vault_args.

Parameters:

• cls – vault’s class, either ‘remote’ or ‘local’

• kwargs – arguments to pass to the class’ constructor

Returns:

an instance of VaultBackend (either local or remote)

Raises:

ValueError if passed an unknown storage class. –

swh.vault.register_tasks() → Dict[str, Any]