Supports typing around documents with Mapping

[geeksambhu]

Pull Request

Related issue

Fixes #888

What does this PR do?

• This PR changes the type hinting for documents in function parameters of functions like update_documents with typing.Mapping.

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

[sanders41]

Thanks for this @geeksambhu

There are a few more places we can make this same update in both index.py and client.py where the parameter types are Dict[str, Any]. I believe the parameter names for these will all be either options or parameters but there could be some more I'm not thinking about.

[sanders41]

Don't worry about the failed tests, they are all because codecov had an issue uploading and not because of any changes you made. They will pass (or I will get them to pass with a re-run) with the next round of updates.

[geeksambhu]

@sanders41 I have added Mapping type for options and parameters in client & index, However, there are other Dict[str, Any] types in parameters such as body, queries, search_rules. Do we need to update these parameters as well?

[sanders41]

Anything in any of the files in models can stay Dict[str, Any], if you found some outside there (which I think you did) let's go ahead and change them.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fb501e7) 100.00% compared to head (0167a68) 100.00%.
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #896   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines          748       748           
=========================================
  Hits           748       748           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[geeksambhu]

@sanders41, FYI: I updated some function parameters with MutableMapping type as these parameters were modified within the method/function body.

[sanders41]

@sanders41, FYI: I updated some function parameters with MutableMapping type as these parameters were modified within the method/function body.

Perfect!

[sanders41]

LGTM!

[sanders41]

bors merge

[meili-bors]

Build succeeded:

• integration-tests (3.10)
• integration-tests (3.11)
• integration-tests (3.12)
• integration-tests (3.8)
• integration-tests (3.9)
• mypy
• pylint