Skip to content

types

RequestConfig

Bases: TypedDict

A custom dict type for keyword arguments configuring OpenAPI requests made with the lakeFS SDK.

Source code in src/lakefs_spec/types.py
class RequestConfig(TypedDict, total=False):
    """A custom dict type for keyword arguments configuring OpenAPI requests
    made with the lakeFS SDK."""

    headers: dict[str, Any]
    content_type: str
    request_auth: str
    request_timeout: int | tuple[int, int]
    preload_content: bool
    return_http_data_only: bool

MergeKwargs

Bases: TypedDict

Options to control the merge of a transaction branch into the base branch.

This is essentially the lakefs_sdk.Merge model, without the optionals.

Source code in src/lakefs_spec/types.py
class MergeKwargs(TypedDict, total=False):
    """Options to control the merge of a transaction branch into the base branch.

    This is essentially the `lakefs_sdk.Merge` model, without the optionals.
    """

    message: str
    metadata: dict[str, str]
    strategy: Literal["dest-wins", "source-wins"]
    force: bool
    allow_empty: bool
    squash_merge: bool