Skip to content

Bulk action typing does not allow TypedDict #2523

Open

Description

@floxay

Elasticsearch version (bin/elasticsearch --version): -

elasticsearch-py version (elasticsearch.__versionstr__): 8.13.0

Description of the problem including expected versus actual behavior:
Currently bulk actions are typed with Dict;

_TYPE_BULK_ACTION = Union[bytes, str, Dict[str, Any]]
_TYPE_BULK_ACTION_HEADER = Dict[str, Any]
_TYPE_BULK_ACTION_BODY = Union[None, bytes, Dict[str, Any]]
_TYPE_BULK_ACTION_HEADER_AND_BODY = Tuple[
_TYPE_BULK_ACTION_HEADER, _TYPE_BULK_ACTION_BODY
]
this however does not allow the usage of TypedDicts.

For example, the relevant part of the signature of elasticsearch.helpers.actions.bulk currently looks like this;

def bulk(
client: Elasticsearch,
actions: Iterable[_TYPE_BULK_ACTION],
If we have a TypedDict for actions defined:

class Action(TypedDict):
	_op_type: str
	_index: str
	...

and we try to pass a list[Action] to actions then Mypy will complain:
Argument "actions" to "bulk" has incompatible type "list[Action]"; expected "Iterable[bytes | str | dict[str, Any]]"

Changing Dict to Mapping would resolve this issue.

Activity

  1. lh0156 commented on Jul 26, 2026

    @lh0156

    Implemented in draft PR #3496: #3496. The change broadens bulk action inputs to Mapping, materializes a dict before existing mutation logic, and adds sync/async strict-mypy fixtures plus a MappingProxyType regression test.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions