Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multi mode search system #232

Merged
merged 8 commits into from
Jun 3, 2024
Merged

Multi mode search system #232

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2c6778f
multi search mode system
YoyloNerd May 31, 2024
b02778c
better wording
YoyloNerd May 31, 2024
4a581f5
Update start_win.bat
YoyloNerd Jun 1, 2024
ff3eddd
Fix home_ui.py using PySide6 instead of PyQt5
YoyloNerd Jun 1, 2024
64c890f
Refresh search on mode change
YoyloNerd Jun 1, 2024
532cf2e
Search mode selections naming fix
YoyloNerd Jun 3, 2024
5472c71
converted SearchMode from constants to enums
YoyloNerd Jun 3, 2024
f201f80
Merge remote-tracking branch 'upstream/main'
YoyloNerd Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion start_win.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
@echo off
.venv\Scripts\python.exe .\TagStudio\tag_studio.py --ui qt %*
.\venv\Scripts\python.exe .\TagStudio\tag_studio.py --ui qt %*
2 changes: 2 additions & 0 deletions tagstudio/src/core/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@
TEXT_FIELDS = ["text_line", "text_box"]
DATE_FIELDS = ["datetime"]

SEARCH_MODES = ["AND", "OR"]

TAG_COLORS = [
"",
"black",
Expand Down
96 changes: 63 additions & 33 deletions tagstudio/src/core/library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
TEXT_FIELDS,
TS_FOLDER_NAME,
VERSION,
SEARCH_MODES,
)

TYPE = ["file", "meta", "alt", "mask"]
Expand Down Expand Up @@ -1290,7 +1291,12 @@
return -1

def search_library(
self, query: str = None, entries=True, collations=True, tag_groups=True
self,
query: str = None,
entries=True,
collations=True,
tag_groups=True,
search_mode: int = 0, # index of SEARCH_MODES
) -> list[tuple[ItemType, int]]:
"""
Uses a search query to generate a filtered results list.
Expand All @@ -1300,7 +1306,7 @@
# self.filtered_entries.clear()
results: list[tuple[ItemType, int]] = []
collations_added = []

print(f"Searching Library with query: {query} search_mode: {search_mode}")
if query:
# start_time = time.time()
query = query.strip().lower()
Expand All @@ -1320,6 +1326,7 @@

# Preprocess the Tag terms.
if query_words:
print(query_words, self._tag_strings_to_id_map)
for i, term in enumerate(query_words):
for j, term in enumerate(query_words):
if (
Expand All @@ -1328,6 +1335,8 @@
in self._tag_strings_to_id_map
):
all_tag_terms.append(" ".join(query_words[i : j + 1]))
print(all_tag_terms)

# This gets rid of any accidental term inclusions because they were words
# in another term. Ex. "3d" getting added in "3d art"
for i, term in enumerate(all_tag_terms):
Expand All @@ -1338,7 +1347,7 @@
all_tag_terms.remove(all_tag_terms[i])
break

# print(all_tag_terms)
print(all_tag_terms)

# non_entry_count = 0
# Iterate over all Entries =============================================================
Expand Down Expand Up @@ -1403,36 +1412,8 @@
# elif query in entry.filename.lower():
# self.filtered_entries.append(index)
elif entry_tags:
# For each verified, extracted Tag term.
failure_to_union_terms = False
for term in all_tag_terms:
# If the term from the previous loop was already verified:
if not failure_to_union_terms:
cluster: set = set()
# Add the immediate associated Tags to the set (ex. Name, Alias hits)
# Since this term could technically map to multiple IDs, iterate over it
# (You're 99.9999999% likely to just get 1 item)
for id in self._tag_strings_to_id_map[term]:
cluster.add(id)
cluster = cluster.union(
set(self.get_tag_cluster(id))
)
# print(f'Full Cluster: {cluster}')
# For each of the Tag IDs in the term's ID cluster:
for t in cluster:
# Assume that this ID from the cluster is not in the Entry.
# Wait to see if proven wrong.
failure_to_union_terms = True
# If the ID actually is in the Entry,
if t in entry_tags:
# There wasn't a failure to find one of the term's cluster IDs in the Entry.
# There is also no more need to keep checking the rest of the terms in the cluster.
failure_to_union_terms = False
# print(f'FOUND MATCH: {t}')
break
# print(f'\tFailure to Match: {t}')
# If there even were tag terms to search through AND they all match an entry
if all_tag_terms and not failure_to_union_terms:
# function to add entry to results
def add_entry(entry: Entry):
# self.filter_entries.append()
# self.filtered_file_list.append(file)
# results.append((SearchItemType.ENTRY, entry.id))
Expand All @@ -1457,6 +1438,55 @@
if not added:
results.append((ItemType.ENTRY, entry.id))

if SEARCH_MODES[search_mode] == "AND": # Include all terms
# For each verified, extracted Tag term.
failure_to_union_terms = False
for term in all_tag_terms:
# If the term from the previous loop was already verified:
if not failure_to_union_terms:
cluster: set = set()
# Add the immediate associated Tags to the set (ex. Name, Alias hits)
# Since this term could technically map to multiple IDs, iterate over it
# (You're 99.9999999% likely to just get 1 item)
for id in self._tag_strings_to_id_map[term]:
cluster.add(id)
cluster = cluster.union(
set(self.get_tag_cluster(id))
)
# print(f'Full Cluster: {cluster}')
# For each of the Tag IDs in the term's ID cluster:
for t in cluster:
# Assume that this ID from the cluster is not in the Entry.
# Wait to see if proven wrong.
failure_to_union_terms = True
# If the ID actually is in the Entry,
if t in entry_tags:
# There wasn't a failure to find one of the term's cluster IDs in the Entry.
# There is also no more need to keep checking the rest of the terms in the cluster.
failure_to_union_terms = False
print(f"FOUND MATCH: {t}")
break
# print(f'\tFailure to Match: {t}')
# # failure_to_union_terms is used to determine if all terms in the query were found in the entry.
# # If there even were tag terms to search through AND they all match an entry
if all_tag_terms and not failure_to_union_terms:
add_entry(entry)

if SEARCH_MODES[search_mode] == "OR": # Include any terms
# For each verified, extracted Tag term.
for term in all_tag_terms:
cluster: set = set()
# Add the immediate associated Tags to the set (ex. Name, Alias hits)
# Since this term could technically map to multiple IDs, iterate over it
# (You're 99.9999999% likely to just get 1 item)
for id in self._tag_strings_to_id_map[term]:
# If the ID actually is in the Entry,
if id in entry_tags:

Check failure on line 1484 in tagstudio/src/core/library.py

View workflow job for this annotation

GitHub Actions / Run MyPy 

[mypy] reported by reviewdog 🐶
Name "cluster" already defined on line 1453  [no-redef]

Raw Output:
/home/runner/work/TagStudio/TagStudio/tagstudio/src/core/library.py:1484:33: error: Name "cluster" already defined on line 1453  [no-redef]
# check if result already contains the entry
if (ItemType.ENTRY, entry.id) not in results:
add_entry(entry)
break

# sys.stdout.write(
# f'\r[INFO][FILTER]: {len(self.filtered_file_list)} matches found')
# sys.stdout.flush()
Expand Down
64 changes: 52 additions & 12 deletions tagstudio/src/qt/main_window.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
from PySide6.QtWidgets import (QComboBox, QFrame, QGridLayout,
QHBoxLayout, QVBoxLayout, QLayout, QLineEdit, QMainWindow,
QPushButton, QScrollArea, QSizePolicy,
QStatusBar, QWidget, QSplitter)
QStatusBar, QWidget, QSplitter, QCheckBox,
QSpacerItem)
from src.qt.pagination import Pagination


Expand Down Expand Up @@ -52,6 +53,36 @@ def setupUi(self, MainWindow):
self.gridLayout.setObjectName(u"gridLayout")
self.horizontalLayout = QHBoxLayout()
self.horizontalLayout.setObjectName(u"horizontalLayout")

# ComboBox goup for search type and thumbnail size
self.horizontalLayout_3 = QHBoxLayout()
self.horizontalLayout_3.setObjectName("horizontalLayout_3")

# left side spacer
spacerItem = QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
self.horizontalLayout_3.addItem(spacerItem)

# Search type selector
self.comboBox_2 = QComboBox(self.centralwidget)
self.comboBox_2.setMinimumSize(QSize(165, 0))
self.comboBox_2.setObjectName("comboBox_2")
self.comboBox_2.addItem("")
self.comboBox_2.addItem("")
self.horizontalLayout_3.addWidget(self.comboBox_2)

# Thumbnail Size placeholder
self.comboBox = QComboBox(self.centralwidget)
self.comboBox.setObjectName(u"comboBox")
sizePolicy = QSizePolicy(QSizePolicy.Minimum, QSizePolicy.Fixed)
sizePolicy.setHorizontalStretch(0)
sizePolicy.setVerticalStretch(0)
sizePolicy.setHeightForWidth(
self.comboBox.sizePolicy().hasHeightForWidth())
self.comboBox.setSizePolicy(sizePolicy)
self.comboBox.setMinimumWidth(128)
self.comboBox.setMaximumWidth(128)
self.horizontalLayout_3.addWidget(self.comboBox)
self.gridLayout.addLayout(self.horizontalLayout_3, 5, 0, 1, 1)

self.splitter = QSplitter()
self.splitter.setObjectName(u"splitter")
Expand Down Expand Up @@ -138,18 +169,18 @@ def setupUi(self, MainWindow):
self.horizontalLayout_2.addWidget(self.searchButton)
self.gridLayout.addLayout(self.horizontalLayout_2, 3, 0, 1, 1)

self.comboBox = QComboBox(self.centralwidget)
self.comboBox.setObjectName(u"comboBox")
sizePolicy = QSizePolicy(QSizePolicy.Minimum, QSizePolicy.Fixed)
sizePolicy.setHorizontalStretch(0)
sizePolicy.setVerticalStretch(0)
sizePolicy.setHeightForWidth(
self.comboBox.sizePolicy().hasHeightForWidth())
self.comboBox.setSizePolicy(sizePolicy)
self.comboBox.setMinimumWidth(128)
self.comboBox.setMaximumWidth(128)
# self.comboBox = QComboBox(self.centralwidget)
# self.comboBox.setObjectName(u"comboBox")
# sizePolicy = QSizePolicy(QSizePolicy.Minimum, QSizePolicy.Fixed)
# sizePolicy.setHorizontalStretch(0)
# sizePolicy.setVerticalStretch(0)
# sizePolicy.setHeightForWidth(
# self.comboBox.sizePolicy().hasHeightForWidth())
# self.comboBox.setSizePolicy(sizePolicy)
# self.comboBox.setMinimumWidth(128)
# self.comboBox.setMaximumWidth(128)

self.gridLayout.addWidget(self.comboBox, 4, 0, 1, 1, Qt.AlignRight)
# self.gridLayout.addWidget(self.comboBox, 4, 0, 1, 1, Qt.AlignRight)

self.gridLayout_2.setContentsMargins(6, 6, 6, 6)

Expand Down Expand Up @@ -181,15 +212,24 @@ def setupUi(self, MainWindow):
def retranslateUi(self, MainWindow):
MainWindow.setWindowTitle(QCoreApplication.translate(
"MainWindow", u"MainWindow", None))
# Navigation buttons
self.backButton.setText(
QCoreApplication.translate("MainWindow", u"<", None))
self.forwardButton.setText(
QCoreApplication.translate("MainWindow", u">", None))

# Search field
self.searchField.setPlaceholderText(
QCoreApplication.translate("MainWindow", u"Search Entries", None))
self.searchButton.setText(
QCoreApplication.translate("MainWindow", u"Search", None))

# Search type selector
self.comboBox_2.setItemText(0, QCoreApplication.translate("MainWindow", "And (includes all tags)"))
self.comboBox_2.setItemText(1, QCoreApplication.translate("MainWindow", "Or (includes any tag)"))
YoyloNerd marked this conversation as resolved.
Show resolved Hide resolved
self.comboBox.setCurrentText("")

# Tumbnail size selector
self.comboBox.setPlaceholderText(
QCoreApplication.translate("MainWindow", u"Thumbnail Size", None))
# retranslateUi
Expand Down
14 changes: 13 additions & 1 deletion tagstudio/src/qt/ts_qt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
QSplashScreen,
QMenu,
QMenuBar,
QComboBox,
)
from humanfriendly import format_timespan

Expand All @@ -66,6 +67,7 @@
VIDEO_TYPES,
IMAGE_TYPES,
LIBRARY_FILENAME,
SEARCH_MODES,
COLLAGE_FOLDER_NAME,
BACKUP_FOLDER_NAME,
TS_FOLDER_NAME,
Expand Down Expand Up @@ -176,6 +178,8 @@ def __init__(self, core: TagStudioCore, args):
self.nav_frames: list[NavigationState] = []
self.cur_frame_idx: int = -1

self.search_mode: int = 0 # index of SEARCH_MODES

# self.main_window = None
# self.main_window = Ui_MainWindow()

Expand Down Expand Up @@ -558,6 +562,10 @@ def init_library_window(self):
search_field.returnPressed.connect(
lambda: self.filter_items(self.main_window.searchField.text())
)
search_type_selector: QComboBox = self.main_window.comboBox_2
search_type_selector.currentIndexChanged.connect(
lambda: self.set_search_type(search_type_selector.currentIndex())
)

back_button: QPushButton = self.main_window.backButton
back_button.clicked.connect(self.nav_back)
Expand Down Expand Up @@ -1317,6 +1325,10 @@ def get_frame_contents(self, index=0, query: str = ""):
len(self.frame_dict[query]),
)

def set_search_type(self, mode: int = 0):
print(SEARCH_MODES[mode])
self.search_mode = mode

def filter_items(self, query: str = ""):
if self.lib:
# logging.info('Filtering...')
Expand All @@ -1328,7 +1340,7 @@ def filter_items(self, query: str = ""):

# self.filtered_items = self.lib.search_library(query)
# 73601 Entries at 500 size should be 246
all_items = self.lib.search_library(query)
all_items = self.lib.search_library(query, search_mode=self.search_mode)
frames: list[list[tuple[ItemType, int]]] = []
frame_count = math.ceil(len(all_items) / self.max_results)
for i in range(0, frame_count):
Expand Down
Loading
Loading