Add typo tolerance settings #443

alallema · 2022-04-20T08:06:45Z

This PR introduces the new setting: typoTolerance

new methods:
index.get_typo_tolerance()
index.update_typo_tolerance(params)
index.reset_typo_tolerance()

bidoubiwa

I think a tests is missing in SettingsTest.py

bidoubiwa · 2022-04-25T10:41:07Z

meilisearch/index.py

@@ -289,7 +289,7 @@ def add_documents(
        self,
        documents: List[Dict[str, Any]],
        primary_key: Optional[str] = None,
-    ) -> Dict[str, int]:
+    ) -> Dict[str, Any]:


There is no type definition in python ?

What do you mean? Something like:
Dict[str, str|int]:

It receives a Task so it could be int, str, or even Dict.

Something like

Type: { uid: Int, indexUid: string }

etc

There is a TypedDict, but it is first available in Python 3.8. You can do it all the way back to Python 3.6 by using Pydantic classes instead of dictionaries, but that would be a big change.

Pydantic is how I do it so if you do decide to go this direction feel free to grab my models and use them here https://github.com/sanders41/meilisearch-python-async/tree/main/meilisearch_python_async/models

@bidoubiwa, yes we could create a task class to use on the prototype on all these functions you can create an issue about it! If that what you meant
And yes, if we do, of course, we will be inspired by your models @sanders41 thank you very much for the reference.

This could represent a breaking change for the user in any form?

@brunoocasali it depends on how you look at it. Really Dict[str, int] has been wrong since tasks were introduced and I am thinking @alallema is first to notice and made the correction here. So really it was breaking in a previous release and a bug fix here.

The reason this was easy to miss is a dictionary is returned, but mypy has no way to know what the dictionary will be with the current implementation. Since all it knows you you said you are returning a dictionary and one is being returned it assumes you have the rest correct. The point @bidoubiwa brings up would prevent this from happening because at that point mypy would know exactly what to expect in the return values.

I made an issue #449

meilisearch/index.py

tests/settings/test_settings.py

tests/settings/test_settings_typo_tolerance_meilisearch.py

brunoocasali · 2022-04-25T17:06:19Z

meilisearch/index.py

@@ -289,7 +289,7 @@ def add_documents(
        self,
        documents: List[Dict[str, Any]],
        primary_key: Optional[str] = None,
-    ) -> Dict[str, int]:
+    ) -> Dict[str, Any]:


This could represent a breaking change for the user in any form?

tests/settings/test_settings_typo_tolerance_meilisearch.py

brunoocasali · 2022-04-25T17:08:50Z

tests/settings/test_settings_typo_tolerance_meilisearch.py

+    """Tests updating typo_tolerance."""
+    index = empty_index()
+    response = index.update_typo_tolerance(NEW_TYPO_TOLERANCE)
+    assert isinstance(response, dict)


Can you apply some testing practices like the ones we discuss here? meilisearch/integration-guides#153

Did you mean to just add some spaces between the different steps or also the naming? Also, I know I had to apply these testing practices but these new tests are in the same format that all the others. I had some trouble doing something different in just one place in a repository even if it's not really good practice.

I see your point of view, and I totally agree with it in most cases, but in this particular case, you could do that without creating a mess with different styles.

brunoocasali · 2022-04-25T17:12:07Z

meilisearch/index.py

@@ -1168,6 +1152,67 @@ def reset_sortable_attributes(self) -> Dict[str, int]:
            self.__settings_url_for(self.config.paths.sortable_attributes),
        )

+    # TYPO TOLERANCE SUB-ROUTES


Does it seem a responsibility for a settings.py file, don't you think?

@brunoocasali Yes, I thought the same thing about adding another settings in the index.py file but isn't it better to do it during the rest of maintenance in a separate PR? Or do you prefer I modify it in this PR?

I don't see a problem if you track that change, like, add the new configurations in a new file, and then create an index to address the following changes in the new place.

bidoubiwa

LGTM 🔥

439: Changes related to the next Meilisearch release (v0.27.0) r=curquiza a=meili-bot Related to this issue: meilisearch/integration-guides#190 This PR: - gathers the changes related to the next Meilisearch release (v0.27.0) so that this package is ready when the official release is out. - should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases). - might eventually contain test failures until the Meilisearch v0.27.0 is out. ⚠️ This PR should NOT be merged until the next release of Meilisearch (v0.27.0) is out. _This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._ Done: - #440 - #443 - #444 - #445 - #450 Co-authored-by: meili-bot <[email protected]> Co-authored-by: Bruno Casali <[email protected]> Co-authored-by: alallema <[email protected]> Co-authored-by: Amélie <[email protected]>

456: Update version for the next release (v0.18.3) r=curquiza a=alallema This version makes this package compatible with Meilisearch v0.27.0🎉 Check out the changelog of [Meilisearch v0.27.0](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.27.0) for more information about the changes. ## 🚀 Enhancements - Add new methods for the new typo tolerance settings #443 `@alallema` `index.get_typo_tolerance()` `index.update_typo_tolerance(params)` `index.reset_typo_tolerance()` - Ensure nested field support #444 `@alallema` - Add new search parameters highlightPreTag, highlightPostTag and cropMarker #445 `@alallema` Co-authored-by: alallema <[email protected]>

alallema added 2 commits April 20, 2022 10:06

Add typo tolerance settings

88093dc

Fix tests

f0eca61

alallema requested review from bidoubiwa and brunoocasali April 20, 2022 10:15

alallema mentioned this pull request Apr 20, 2022

Changes related to the next Meilisearch release (v0.27.0) #439

Merged

alallema added the enhancement New feature or request label Apr 21, 2022

Fix field naming in typo tolerance

db06fc6

bidoubiwa suggested changes Apr 25, 2022

View reviewed changes

alallema added 2 commits April 25, 2022 15:25

Add typo tolerance check in general settings tests

21b221b

Typo

b17f1a8

alallema requested review from sanders41 and bidoubiwa April 25, 2022 15:04

sanders41 reviewed Apr 25, 2022

View reviewed changes

alallema added 2 commits April 25, 2022 17:50

Correct defaut by default

1530d5e

Add test to check the value in typo tolerance setting

96cbf24

brunoocasali reviewed Apr 25, 2022

View reviewed changes

Improve tests typo tolerance

91b4265

bidoubiwa mentioned this pull request Apr 25, 2022

Add more precise typing #449

Closed

alallema requested a review from brunoocasali April 26, 2022 12:29

alallema added 2 commits April 28, 2022 11:46

Add space to tests for readability

cb7f921

Improve test readability

9d008a7

bidoubiwa approved these changes Apr 28, 2022

View reviewed changes

alallema merged commit 5b28d58 into bump-meilisearch-v0.27.0 Apr 28, 2022

alallema deleted the typo-tolerance branch April 28, 2022 14:41

alallema mentioned this pull request May 5, 2022

Update version for the next release (v0.18.3) #456

Merged

sanders41 mentioned this pull request Feb 5, 2023

Update the return type of methods #676

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add typo tolerance settings #443

Add typo tolerance settings #443

alallema commented Apr 20, 2022 •

edited

Loading

bidoubiwa left a comment •

edited

Loading

bidoubiwa Apr 25, 2022 •

edited

Loading

alallema Apr 25, 2022

alallema Apr 25, 2022

bidoubiwa Apr 25, 2022

sanders41 Apr 25, 2022 •

edited

Loading

alallema Apr 25, 2022 •

edited

Loading

brunoocasali Apr 25, 2022

sanders41 Apr 25, 2022

bidoubiwa Apr 25, 2022

brunoocasali Apr 25, 2022

brunoocasali Apr 25, 2022

alallema Apr 26, 2022

brunoocasali May 2, 2022

brunoocasali Apr 25, 2022

alallema Apr 26, 2022

brunoocasali May 2, 2022

bidoubiwa left a comment

Add typo tolerance settings #443

Add typo tolerance settings #443

Conversation

alallema commented Apr 20, 2022 • edited Loading

bidoubiwa left a comment • edited Loading

Choose a reason for hiding this comment

bidoubiwa Apr 25, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sanders41 Apr 25, 2022 • edited Loading

Choose a reason for hiding this comment

alallema Apr 25, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bidoubiwa left a comment

Choose a reason for hiding this comment

alallema commented Apr 20, 2022 •

edited

Loading

bidoubiwa left a comment •

edited

Loading

bidoubiwa Apr 25, 2022 •

edited

Loading

sanders41 Apr 25, 2022 •

edited

Loading

alallema Apr 25, 2022 •

edited

Loading