summaryrefslogtreecommitdiff
path: root/searx/search/processors/abstract.py
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2022-08-01 16:42:33 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2022-08-01 16:42:33 +0200
commita2badb4fe47eaa6df26b7bc0ef601cb9179edc3a (patch)
tree92e576547a2844c765222afb30236a4f28bcc459 /searx/search/processors/abstract.py
parent1fbb514a4ead209c95b4ddca0430f754a4c11554 (diff)
[doc] add description of method EngineProcessor.get_params()
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'searx/search/processors/abstract.py')
-rw-r--r--searx/search/processors/abstract.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/searx/search/processors/abstract.py b/searx/search/processors/abstract.py
index d4822fc56..d74616db0 100644
--- a/searx/search/processors/abstract.py
+++ b/searx/search/processors/abstract.py
@@ -138,6 +138,13 @@ class EngineProcessor(ABC):
return False
def get_params(self, search_query, engine_category):
+ """Returns a set of *request params* or ``None`` if request is not supported.
+
+ Not supported conditions (``None`` is returned):
+
+ - A page-number > 1 when engine does not support paging.
+ - A time range when the engine does not support time range.
+ """
# if paging is not supported, skip
if search_query.pageno > 1 and not self.engine.paging:
return None