Display matched search term on results page #212

paigewilliams · 2025-11-07T00:55:06Z

Description

Adds a column to the search page for the team that had the highest similarity ranking. Also includes the field verbose name in the column values, such as "Alt Name: Filbert".

I used the SearchHeadline class from the Django full text search library. Suuuper helpful.

I thought about adding the column headers back, but I thought that having the verbose name in the column value helped give enough context into what the cell value meant. Open to feedback on this!

Tested downloading still works. ✅

Screenshots

paigewilliams · 2025-11-07T00:57:08Z

@rhodges @pollardld again, review isn't blocking but feedback is always appreciated! ⭐

Copilot

Pull Request Overview

This PR refactors the search functionality to display which specific field matched the search query. The main change involves renaming getResults to get_results to follow Python naming conventions, and implementing headline generation that shows users exactly where their search term was found in the results.

Renamed getResults to get_results for consistent snake_case naming
Added headline generation to show matched fields with highlighted search terms
Implemented helper functions to determine which attribute has the greatest similarity match

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
TEKDB/explore/views.py	Renamed function to snake_case, added helper functions for match attribute detection, field name resolution, and headline generation
TEKDB/explore/templates/results.html	Added new "Searched Result" column to display headlines, updated data bindings with CSS classes
TEKDB/explore/static/explore/css/results.css	Added styling for headline paragraph and highlight class
TEKDB/TEKDB/tests/test_models.py	Added comprehensive tests for new helper functions, updated function references, added test for resource search
TEKDB/TEKDB/models.py	Modified search to generate match and headline annotations for each field, restructured annotation building

Comments suppressed due to low confidence (1)

TEKDB/TEKDB/tests/test_models.py:300

assertTrue(a == b) cannot provide an informative message. Using assertEqual(a, b) instead will give more informative messages.

            self.assertTrue(len(unique_attributes) == pks[pk])

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-07T00:57:46Z

TEKDB/explore/views.py

+            current_model = field.related_model
+
+    return field.verbose_name.title() if field else field_path.replace("_", " ").title()
+


Missing blank line before function definition. PEP 8 requires two blank lines before top-level function definitions. Add an extra blank line before this function.

Suggested change

passes ruff check and format so 🤷🏻

Copilot is a nit picker! I take issue with the phrase 'PEP 8 requires'. S'cool to follow PEP 8, but Python doesn't bust your butt about this stuff.

TEKDB/explore/views.py

TEKDB/TEKDB/models.py

TEKDB/TEKDB/tests/test_models.py

paigewilliams · 2025-11-07T18:18:03Z

TEKDB/TEKDB/models.py

-        .distinct()
+        .order_by("pk", "-rank", "-similarity", sort_field)
+        # adding pk to distinct to prevent duplicate ids
+        .distinct("pk")


I added pk as an arg for distinct to prevent multiple of the same entry returning in the search results. The addition of **annotations in model.objects.annotate resulted multiple of the same entry returning in the search results because the annotations would have some differences. Without this change the PlacesTest.test_search_foreign_key_field failed. @rhodges @pollardld Any objections to this change?

Also, I'm not concerned about the change in ordering here because in get_results we return

sorted( resultlist, key=lambda res: (res["rank"], res["similarity"]), reverse=True )

I can't think of any reason to object.

Is there a reason "-rank" isn't the first item in order_by? Do I misremember sort ordering as from R -> L?

No objections to .distinct("pk") though, that makes total sense.

That's a bummer, because as I read it, given the following search results (made up) given the search term 'cheese':

{ name: 'cojack cheese', rank: 2, similarity: 0.7, pk: 1, }, { name: 'cheese', rank: 1, similarity: 1, pk: 2, }, { name: 'colby cheese', rank: 3, similarity: 0.6, pk: 3, },

This should return:

cheese

cojack cheese

colby cheese

But since "pk" is the first order by, the result order will be:

cojack cheese

cheese

colby cheese

Do you have testing in place to ensure that the results come back in the correct order? I might be totally missing something (like by 'distinct' on "pk" removes it from consideration in ordering somehow). It's also possible these results get re-sorted again later in the code making this order_by moot.

I was kinda treating this order_by as not a big deal because we have this line that sorts by rank and similarity, which is ultimately what the user sees. Does that suffice to you?

Perfect!

That means either:

Cool! Leave it as is. I'm happy with it.

You may wish to remove the other arguments (just order_by("pk")) since they'll be sorted later: why spend the compute power to sort them twice?

I'm going to leave it as is for now 👍🏻 thanks for the feedback!

paigewilliams · 2025-11-07T18:18:42Z

TEKDB/TEKDB/tests/test_models.py

        self.assertEqual(tribe_fk_search.count(), 13)
        self.assertTrue(25 in [x.pk for x in tribe_fk_search])

+    def test_search_model_set_reference(self):


broke out assertions into their own tests

paigewilliams · 2025-11-07T18:19:27Z

TEKDB/explore/views.py

        % query_value
    )

-    resultlist = getResults(query_string, categories)


it was bugging me that this was camel case not snake case

The more you know... https://peps.python.org/pep-0008/#function-and-variable-names

I am a 'case criminal'. I need to work on this.

rhodges

Really good stuff! Just fix the ordering (or help me understand why the 'pk' is okay in that tuple and specifically in that position) and it'll be there.

rhodges · 2025-11-07T21:33:27Z

TEKDB/TEKDB/models.py

-        .distinct()
+        .order_by("pk", "-rank", "-similarity", sort_field)
+        # adding pk to distinct to prevent duplicate ids
+        .distinct("pk")


Re-reading this, "pk" definitely either doesn't belong in the sort or needs to be at the end, otherwise your results will always be in order of 'oldest-first' (by record type)

rhodges · 2025-11-07T21:40:46Z

TEKDB/explore/views.py

        % query_value
    )

-    resultlist = getResults(query_string, categories)


The more you know... https://peps.python.org/pep-0008/#function-and-variable-names

I am a 'case criminal'. I need to work on this.

rhodges · 2025-11-07T21:44:00Z

TEKDB/explore/views.py

+            current_model = field.related_model
+
+    return field.verbose_name.title() if field else field_path.replace("_", " ").title()
+


Copilot is a nit picker! I take issue with the phrase 'PEP 8 requires'. S'cool to follow PEP 8, but Python doesn't bust your butt about this stuff.

rhodges

@paigewilliams explained the reason my concerns were unfounded. I'm sold on this now.

paigewilliams added 5 commits November 5, 2025 16:57

display term that matched in search in the table

42d483d

display verbose name for searched field

a7796d8

style results page

e6f6351

account for multiple matching attributes

35ef6f7

add tests for get_greatest_similarity_attribute

790bf01

paigewilliams requested review from Copilot, pollardld and rhodges November 7, 2025 00:55

paigewilliams self-assigned this Nov 7, 2025

Copilot AI reviewed Nov 7, 2025

View reviewed changes

paigewilliams added 4 commits November 7, 2025 09:27

fix tests

bd2210d

fix typo

d26ad70

ruff format

a70a291

add pk as arg for distinct to prevent duplicate entries in search result

27203f4

paigewilliams commented Nov 7, 2025

View reviewed changes

fix test now that search results are ordered by pk

ede6bcd

rhodges requested changes Nov 7, 2025

View reviewed changes

rhodges approved these changes Nov 7, 2025

View reviewed changes

paigewilliams merged commit cb548da into main Nov 7, 2025
2 checks passed

		current_model = field.related_model

		return field.verbose_name.title() if field else field_path.replace("_", " ").title()

Display matched search term on results page #212

Display matched search term on results page #212

Uh oh!

Conversation

paigewilliams commented Nov 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshots

Uh oh!

paigewilliams commented Nov 7, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

paigewilliams Nov 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rhodges left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rhodges left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

paigewilliams commented Nov 7, 2025 •

edited

Loading

paigewilliams Nov 7, 2025 •

edited

Loading