swh.objstorage.objstorage module#

swh.objstorage.objstorage.timed(f)[source]#

A simple decorator used to add statsd probes on main ObjStorage methods (add, get and __contains__)

swh.objstorage.objstorage.objid_to_default_hex(obj_id: HashDict, algo: Literal['sha1', 'sha256']) → str[source]#

Converts multi-hashes to the hexadecimal representation of the given hash algo.

swh.objstorage.objstorage.objid_for_content(content: bytes) → HashDict[source]#

Compute the content’s hashes.

Parameters:
Returns:

A dict mapping algo name to hash value

class swh.objstorage.objstorage.NullCompressor[source]#

Bases: object

compress(data)[source]#
flush()[source]#
class swh.objstorage.objstorage.NullDecompressor[source]#

Bases: object

decompress(data: bytes) → bytes[source]#
property unused_data: bytes#
class swh.objstorage.objstorage.ObjStorage(*, allow_delete: bool = False, primary_hash: Literal['sha1', 'sha256'] | None = None, batch_with_threads: bool = False, max_batch_workers: int = 10, **kwargs)[source]#

Bases: ObjStorageInterface

Abstract base class for an object storage backend.

It notably adds default implementation for the add_batch() and get_batch() methods, by calling add() or get() method in a loop. By setting the batch_with_threads constructor parameter to True (default is False), those calls are made concurrently using a pool of threads as it can improve performance depending on the final object storage backend implementation (the swh.objstorage.backends.pathslicing.PathSlicingObjStorage backend performs faster with threaded batch operations for instance). The maximum number of threads in the pool can be adjusted with the max_batch_workers constructor parameter, default is 10.

compression: Literal['bz2', 'lzma', 'gzip', 'zlib', 'none'] = 'none'#
primary_hash: Literal['sha1', 'sha256'] | None = None#
name: str = 'objstorage'#

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

map_contents: Callable#
add_batch(contents: Iterable[Tuple[HashDict, bytes]], check_presence: bool = True) → Dict[source]#

Add a batch of new objects to the object storage.

Parameters:

contents – list of pairs of composite object ids and object contents

Returns:

the summary of objects added to the storage (count of object, count of bytes object)

restore(content: bytes, obj_id: HashDict) → None[source]#

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)

get_batch(obj_ids: Iterable[HashDict]) → Iterator[bytes | None][source]#

Retrieve objects’ raw content in bulk from storage.

Note: This function does have a default implementation in ObjStorage that is suitable for most cases.

For object storages that needs to do the minimal number of requests possible (ex: remote object storages), that method can be overridden to perform a more efficient operation.

Parameters:

obj_ids – list of object ids.

Returns:

list of resulting contents, or None if the content could not be retrieved. Do not raise any exception as a fail for one content will not cancel the whole request.

abstract delete(obj_id: HashDict)[source]#

Delete an object.

Parameters:

obj_id – object identifier.

Raises:

ObjNotFoundError – if the requested object is missing.

download_url(obj_id: HashDict, content_disposition: str | None = None, expiry: timedelta | None = None) → str | None[source]#

Get a direct download link for the object if the obstorage backend supports such feature.

Some objstorage backends, typically cloud based ones like azure or s3, can provide a direct download link for a stored object.

Parameters:

  • obj_id – object identifier

  • content_disposition – set Content-Disposition header for the generated URL response if the objstorage backend supports it

  • expiry – the duration after which the URL expires if the objstorage backend supports it, if not provided the URL expires 24 hours after its creation

Returns:

Direct download URL for the object or None if the objstorage backend does

not support such feature.

abstract get(obj_id: HashDict) → bytes[source]#

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: HashDict) → None[source]#

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

compress(data: bytes) → bytes[source]#
decompress(data: bytes, hex_obj_id: str) → bytes[source]#