Changeset View
Changeset View
Standalone View
Standalone View
swh/vault/cookers/base.py
| Show First 20 Lines • Show All 55 Lines • ▼ Show 20 Lines | class BaseVaultCooker(metaclass=abc.ABCMeta): | ||||
| To define a new cooker, inherit from this class and override: | To define a new cooker, inherit from this class and override: | ||||
| - CACHE_TYPE_KEY: key to use for the bundle to reference in cache | - CACHE_TYPE_KEY: key to use for the bundle to reference in cache | ||||
| - def cook(): cook the object into a bundle | - def cook(): cook the object into a bundle | ||||
| """ | """ | ||||
| CACHE_TYPE_KEY = None # type: Optional[str] | CACHE_TYPE_KEY = None # type: Optional[str] | ||||
| def __init__( | def __init__( | ||||
| self, obj_type, obj_id, backend, storage, max_bundle_size=MAX_BUNDLE_SIZE | self, | ||||
| obj_type, | |||||
| obj_id, | |||||
| backend, | |||||
| storage, | |||||
| graph=None, | |||||
| max_bundle_size=MAX_BUNDLE_SIZE, | |||||
| ): | ): | ||||
| """Initialize the cooker. | """Initialize the cooker. | ||||
| The type of the object represented by the id depends on the | The type of the object represented by the id depends on the | ||||
| concrete class. Very likely, each type of bundle will have its | concrete class. Very likely, each type of bundle will have its | ||||
| own cooker class. | own cooker class. | ||||
| Args: | Args: | ||||
| obj_type: type of the object to be cooked into a bundle (directory, | obj_type: type of the object to be cooked into a bundle (directory, | ||||
| revision_flat or revision_gitfast; see | revision_flat or revision_gitfast; see | ||||
| swh.vault.cooker.COOKER_TYPES). | swh.vault.cooker.COOKER_TYPES). | ||||
| obj_id: id of the object to be cooked into a bundle. | obj_id: id of the object to be cooked into a bundle. | ||||
| backend: the vault backend (swh.vault.backend.VaultBackend). | backend: the vault backend (swh.vault.backend.VaultBackend). | ||||
| """ | """ | ||||
| self.obj_type = obj_type | self.obj_type = obj_type | ||||
| self.obj_id = hashutil.hash_to_bytes(obj_id) | self.obj_id = hashutil.hash_to_bytes(obj_id) | ||||
| self.backend = backend | self.backend = backend | ||||
| self.storage = storage | self.storage = storage | ||||
| self.graph = graph | |||||
| self.max_bundle_size = max_bundle_size | self.max_bundle_size = max_bundle_size | ||||
| @abc.abstractmethod | @abc.abstractmethod | ||||
| def check_exists(self): | def check_exists(self): | ||||
| """Checks that the requested object exists and can be cooked. | """Checks that the requested object exists and can be cooked. | ||||
| Override this in the cooker implementation. | Override this in the cooker implementation. | ||||
| """ | """ | ||||
| ▲ Show 20 Lines • Show All 50 Lines • Show Last 20 Lines | |||||