Techsystech
/
server-tools
mirror of https://github.com/OCA/server-tools.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

base_search_fuzzy: correct patching, remove similarity order 

- [Server-wide patching should be done in `post_load` hook][1], and there's where it's done now.
- Remove similarity order, as it had no use in the wild and was buggy.
- Refactor monkey patch to remove some nonsense.
- Move tests to at_install mode, now that the patch is installed correctly.

@Tecnativa TT31444
pull/2530/head
Jairo Llopis 2021-08-19 13:34:38 +01:00 committed by Daniel Reis
parent bc1f0422d0
commit 52bfe5b2e5
9 changed files with 50 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
base_search_fuzzy/README.rst
View File

@ -70,14 +70,6 @@ Usage
``self.env.cr.execute("SELECT set_limit(0.2);")``
#. Another interesting feature is the use of ``similarity(column, 'text')``
function in the ``order`` parameter to order by similarity. This module just
contains a basic implementation which doesn't perform validations and has to
start with this function. For example you can define the function as
followed:
``similarity(%s.name, 'John Mil') DESC" % self.env['res.partner']._table``
For further questions read the Documentation of the
`pg_trgm <https://www.postgresql.org/docs/current/static/pgtrgm.html>`_ module.

1
base_search_fuzzy/__init__.py
View File

@ -3,3 +3,4 @@
# Copyright 2020 NextERP SRL.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from . import models
from .hooks import post_load

3
base_search_fuzzy/__manifest__.py
View File

@ -5,7 +5,7 @@
"name": "Fuzzy Search",
"summary": "Fuzzy search with the PostgreSQL trigram extension",
"category": "Uncategorized",
"version": "14.0.1.0.0",
"version": "14.0.1.0.1",
"website": "https://github.com/OCA/server-tools",
"author": "bloopark systems GmbH & Co. KG, "
"ForgeFlow, "
@ -16,4 +16,5 @@
"data": ["views/trgm_index.xml", "security/ir.model.access.csv"],
"demo": ["demo/res_partner_demo.xml", "demo/TrgmIndex_demo.xml"],
"installable": True,
"post_load": "post_load",
}

45
base_search_fuzzy/hooks.py 100644
View File

@ -0,0 +1,45 @@
# Copyright 2016 Eficent Business and IT Consulting Services S.L.
# Copyright 2016 Serpent Consulting Services Pvt. Ltd.
# Copyright 2017 LasLabs Inc.
# Copyright 2021 Tecnativa - Jairo Llopis
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
from functools import wraps
from odoo.osv import expression
def patch_leaf_trgm(original):
@wraps(original)
def _wrapper(self, leaf, model, alias):
left, operator, right = leaf
# No overload for other operators...
if operator != "%":
# Except translation "inselect" queries
if operator == "inselect":
right = (right[0].replace(" % ", " %% "), right[1])
leaf = (left, operator, right)
return original(self, leaf, model, alias)
# The field must exist
if left not in model._fields:
raise ValueError(
"Invalid field {!r} in domain term {!r}".format(left, leaf)
)
# Generate correct WHERE clause part
query = '("{}"."{}" %% {})'.format(
alias,
left,
model._fields[left].column_format,
)
params = [right]
return query, params
return _wrapper
def post_load():
"""Patch expression generators to enable the fuzzy search operator."""
expression.TERM_OPERATORS += ("%",)
expression.expression._expression__leaf_to_sql = patch_leaf_trgm(
expression.expression._expression__leaf_to_sql
)

1
base_search_fuzzy/models/__init__.py
View File

@ -2,6 +2,5 @@
# Copyright 2016 Serpent Consulting Services Pvt. Ltd.
# Copyright 2020 NextERP SRL.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from . import ir_model
from . import trgm_index
from . import query

86
base_search_fuzzy/models/ir_model.py
View File

@ -1,86 +0,0 @@
# Copyright 2016 ForgeFlow S.L.
# Copyright 2016 Serpent Consulting Services Pvt. Ltd.
# Copyright 2017 LasLabs Inc.
# Copyright 2020 NextERP SRL.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
import logging
from odoo import _, api, models
from odoo.osv import expression
_logger = logging.getLogger(__name__)
def patch_leaf_trgm(method):
def decorate_leaf_to_sql(self, leaf, model, alias):
left, operator, right = leaf
table_alias = '"%s"' % alias
if operator == "%":
sql_operator = "%%"
params = []
if left in model._fields:
column = "{}.{}".format(table_alias, expression._quote(left))
query = "({} {} {})".format(
column,
sql_operator,
model._fields[left].column_format,
)
elif left in models.MAGIC_COLUMNS:
query = '({}."{}" {} %s)'.format(table_alias, left, sql_operator)
params = right
else: # Must not happen
raise ValueError(
_("Invalid field {!r} in domain term {!r}".format(left, leaf))
)
if left in model._fields:
params = str(right)
if isinstance(params, str):
params = [params]
return query, params
elif operator == "inselect":
right = (right[0].replace(" % ", " %% "), right[1])
leaf = (left, operator, right)
return method(self, leaf, model, alias)
decorate_leaf_to_sql.__decorated__ = True
return decorate_leaf_to_sql
def patch_generate_order_by(method):
@api.model
def decorate_generate_order_by(self, order_spec, query):
if order_spec and order_spec.startswith("similarity("):
return " ORDER BY " + order_spec
return method(self, order_spec, query)
decorate_generate_order_by.__decorated__ = True
return decorate_generate_order_by
class IrModel(models.Model):
_inherit = "ir.model"
def _register_hook(self):
# We have to prevent wrapping the function twice to avoid recursion
# errors
if not hasattr(expression.expression._expression__leaf_to_sql, "__decorated__"):
expression.expression._expression__leaf_to_sql = patch_leaf_trgm(
expression.expression._expression__leaf_to_sql
)
if "%" not in expression.TERM_OPERATORS:
expression.TERM_OPERATORS += ("%",)
if not hasattr(models.BaseModel._generate_order_by, "__decorated__"):
models.BaseModel._generate_order_by = patch_generate_order_by(
models.BaseModel._generate_order_by
)
return super()._register_hook()

8
base_search_fuzzy/readme/USAGE.rst
View File

@ -12,14 +12,6 @@
``self.env.cr.execute("SELECT set_limit(0.2);")``
#. Another interesting feature is the use of ``similarity(column, 'text')``
function in the ``order`` parameter to order by similarity. This module just
contains a basic implementation which doesn't perform validations and has to
start with this function. For example you can define the function as
followed:
``similarity(%s.name, 'John Mil') DESC" % self.env['res.partner']._table``
For further questions read the Documentation of the
`pg_trgm <https://www.postgresql.org/docs/current/static/pgtrgm.html>`_ module.

9
base_search_fuzzy/static/description/index.html
View File

@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
<title>Fuzzy Search</title>
<style type="text/css">
@ -424,13 +424,6 @@ limit (default: 0.3). NB: Currently you have to set the limit by executing
the following SQL statement:</p>
<p><tt class="docutils literal"><span class="pre">self.env.cr.execute(&quot;SELECT</span> <span class="pre">set_limit(0.2);&quot;)</span></tt></p>
</li>
<li><p class="first">Another interesting feature is the use of <tt class="docutils literal">similarity(column, 'text')</tt>
function in the <tt class="docutils literal">order</tt> parameter to order by similarity. This module just
contains a basic implementation which doesn’t perform validations and has to
start with this function. For example you can define the function as
followed:</p>
<p><tt class="docutils literal"><span class="pre">similarity(%s.name,</span> 'John Mil') DESC&quot; % <span class="pre">self.env['res.partner']._table</span></tt></p>
</li>
</ol>
<p>For further questions read the Documentation of the
<a class="reference external" href="https://www.postgresql.org/docs/current/static/pgtrgm.html">pg_trgm</a> module.</p>

10
base_search_fuzzy/tests/test_query_generation.py
View File

@ -2,10 +2,9 @@
# Copyright 2016 Serpent Consulting Services Pvt. Ltd.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo.osv import expression
from odoo.tests.common import TransactionCase, tagged
from odoo.tests.common import TransactionCase
@tagged("post_install", "-at_install")
class QueryGenerationCase(TransactionCase):
def setUp(self):
super(QueryGenerationCase, self).setUp()
@ -63,13 +62,6 @@ class QueryGenerationCase(TransactionCase):
complete_where,
)
def test_fuzzy_order_generation(self):
"""Check the generation of the where clause."""
order = "similarity(%s.name, 'test') DESC" % self.ResPartner._table
query = self.ResPartner._where_calc([("name", "%", "test")], active_test=False)
order_by = self.ResPartner._generate_order_by(order, query)
self.assertEqual(" ORDER BY %s" % order, order_by)
def test_fuzzy_search(self):
"""Test the fuzzy search itself."""
if self.TrgmIndex._trgm_extension_exists() != "installed":