Typing around documents should be `Mapping[]` not `Dict[]` about meilisearch-python HOT 7 CLOSED

Happy to when I find the time.

from meilisearch-python.

@nuschk, Can I work on this?

Yes, by all means, please do! I won't be having time for this in the next couple of days! Thank you!

from meilisearch-python.

I don't have any objections to making this change if you want to do a PR for it.

from meilisearch-python.

One note on this: List[Mapping[str, Any]] will cause type errors because List is invariant. So when a function returns List[Dict[str, Any]] and that passes to a parameter that takes List[Mapping[str, Any]] this will cause mypy to throw a type error. This can be fixed by using Sequence[Mapping[str, Any]].

from meilisearch-python.

Thank you. Yes.

The plan would actually be to type return values as precisely as we can (i.e. list[dict[str, Any||, while typing arguments as loose as possible.

Something like this:

def f(i: Sequence[Mapping[str, Any]]) -> list[dict[str, Any]]:
    ...

I will have to see how far that works, but this pattern usually seems to be working out fine through my own code.

from meilisearch-python.

The plan would actually be to type return values as precisely as we can (i.e. list[dict[str, Any||, while typing arguments as loose as possible.

Yes, I expect there will be no issues if we do it as you described.

from meilisearch-python.

@nuschk, Can I work on this?

from meilisearch-python.