swh.objstorage.proxies.readonly module

class swh.objstorage.proxies.readonly.ReadOnlyProxyObjStorage(storage: ObjStorageInterface | Dict, **kwargs)

Bases: ObjStorage

Filter that disable write operation of the storage.

Writes will always succeed without doing any actual write operations.

name: str = 'read-only'

Default objstorage name; can be overloaded at instantiation time giving a ‘name’ argument to the constructor

get(obj_id, *args, **kwargs)

Retrieve the content of a given object.

Parameters:

obj_id – object id.

Returns:

the content of the requested object as bytes.

Raises:

ObjNotFoundError – if the requested object is missing.

check(obj_id, *args, **kwargs)

Check if a content is found and recompute its hash to check integrity.

check_config(*, check_write)

Check whether the object storage is properly configured.

Parameters:

• check_write (bool) – if True, check if writes to the object storage

• succeed. (can)

Returns:

True if the configuration check worked, False if ‘check_write’ is True and the object storage is actually read only, and an exception if the check failed.

add(*args, **kwargs)

Add a new object to the object storage.

Parameters:

• content – object’s raw content to add in storage.

• obj_id – either dict of checksums, or single checksum of [bytes] using [ID_HASH_ALGO] algorithm. It is trusted to match the bytes.

• check_presence (bool) – indicate if the presence of the content should be verified before adding the file.

Returns:

the id (bytes) of the object into the storage.

restore(*args, **kwargs)

Restore a content that have been corrupted.

This function is identical to add but does not check if the object id is already in the file system. The default implementation provided by the current class is suitable for most cases.

Parameters:

• content – object’s raw content to add in storage

• obj_id – dict of hashes of the content (or only the sha1, for legacy clients)

delete(*args, **kwargs)

Delete an object.

Parameters:

obj_id – object identifier.

Raises:

ObjNotFoundError – if the requested object is missing.