Skip to content

List

object_store_rs.list 

list(
    store: ObjectStore,
    prefix: str | None = None,
    *,
    offset: str | None = None,
    max_items: int | None = 2000
) -> List[ObjectMeta]

List all the objects with the given prefix.

Prefixes are evaluated on a path segment basis, i.e. foo/bar/ is a prefix of foo/bar/x but not of foo/bar_baz/x. List is recursive, i.e. foo/bar/more/x will be included.

Note: the order of returned ObjectMeta is not guaranteed

Note

In the future, we'd like to have list return an async iterable, just like get, so that we can stream the result of list, but we need some changes in the upstream object-store repo first.

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • prefix (str | None, default: None ) –

    The prefix within ObjectStore to use for listing. Defaults to None.

Other Parameters:

  • offset (str | None) –

    If provided, list all the objects with the given prefix and a location greater than offset. Defaults to None.

  • max_items (int | None) –

    The maximum number of items to return. Defaults to 2000.

Returns:

object_store_rs.list_async async 

list_async(
    store: ObjectStore,
    prefix: str | None = None,
    *,
    offset: str | None = None,
    max_items: int | None = 2000
) -> List[ObjectMeta]

Call list asynchronously.

Refer to the documentation for list.

object_store_rs.list_with_delimiter 

list_with_delimiter(
    store: ObjectStore, prefix: str | None = None
) -> ListResult

List objects with the given prefix and an implementation specific delimiter. Returns common prefixes (directories) in addition to object metadata.

Prefixes are evaluated on a path segment basis, i.e. foo/bar/ is a prefix of foo/bar/x but not of foo/bar_baz/x. List is not recursive, i.e. foo/bar/more/x will not be included.

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • prefix (str | None, default: None ) –

    The prefix within ObjectStore to use for listing. Defaults to None.

Returns:

object_store_rs.list_with_delimiter_async async 

list_with_delimiter_async(
    store: ObjectStore, prefix: str | None = None
) -> ListResult

Call list_with_delimiter asynchronously.

Refer to the documentation for list_with_delimiter.

object_store_rs.ObjectMeta

Bases: TypedDict

The metadata that describes an object.

e_tag instance-attribute 

e_tag: str | None

The unique identifier for the object

datatracker.ietf.org/doc/html/rfc9110#name-etag

last_modified instance-attribute 

last_modified: datetime

The last modified time

path instance-attribute 

path: str

The full path to the object

size instance-attribute 

size: int

The size in bytes of the object

version instance-attribute 

version: str | None

A version indicator for this object

object_store_rs.ListResult

Bases: TypedDict

Result of a list call that includes objects, prefixes (directories) and a token for the next set of results. Individual result sets may be limited to 1,000 objects based on the underlying object storage's limitations.

common_prefixes instance-attribute 

common_prefixes: List[str]

Prefixes that are common (like directories)

objects instance-attribute 

objects: List[ObjectMeta]

Object metadata for the listing