drop linter mode

Author: Gerit Wagner

docs/source/dev_docs/_autosummary/search_query.constants.rst

@@ -20,7 +20,6 @@ search\_query.constants
       Colors
       ExitCodes
       Fields
-      LinterMode
       ListToken
       ListTokenTypes
       OperatorNodeTokenTypes

docs/source/dev_docs/linter_development.rst

@@ -32,11 +32,3 @@ Best Practices
 
 .. literalinclude:: linter_skeleton.py
    :language: python
-
-
-Strict vs. Non-Strict Mode
----------------------------
-
-In non-strict mode (`mode="lenient"`), linters report errors but do not raise exceptions.
-In strict mode (`mode="strict"`), any linter message will cause an exception to be raised,
-which can be used for automated pipelines or validation gates.

docs/source/dev_docs/parser_skeleton.py

@@ -8,8 +8,8 @@ class CustomParser(QueryStringParser):
         [PARENTHESIS_REGEX, LOGIC_OPERATOR_REGEX, FIELD_REGEX, TERM_REGEX]
     )
 
-    def __init__(self, query_str, *, field_general="", mode=LinterMode.STRICT):
-        super().__init__(query_str, field_general=field_general, mode=mode)
+    def __init__(self, query_str, *, field_general=""):
+        super().__init__(query_str, field_general=field_general)
         self.linter = CustomLinter(self)
 
     def tokenize(self):

docs/source/index.rst

@@ -17,10 +17,6 @@
             onclick="window.open('https://github.com/CoLRev-Environment/search-query/releases/')">
    </div>
 
-..
-       <img src="https://mybinder.org/badge_logo.svg" alt="Binder"
-            onclick="window.open('https://mybinder.org/v2/gh/CoLRev-Environment/search-query/HEAD?labpath=docs%2Fsource%2Fdemo.ipynb')">
-
 **Search Query** is a Python package designed to **load**, **lint**, **translate**, **save**, **improve**, and **automate** academic literature search queries.
 It is extensible and currently supports PubMed, EBSCOHost, and Web of Science.
 The package can be used programmatically, through the command line, or as a pre-commit hook.
@@ -51,13 +47,6 @@ Creating a query programmatically is simple:
     work_synonyms = OrQuery(["work", "labor", "service"], field="abstract")
     query = AndQuery([digital_synonyms, work_synonyms])
 
-..
-    Parameters:
-
-    - list of strings or queries: strings that you want to include in the search query,
-    - ``field``: search field to which the query should be applied (available options: TODO — provide examples and link to docs)
-   Search strings can be either in string or list format.
-
 We can also parse a query from a string or a `JSON search file <#json-search-files>`_ (see the :doc:`overview of platform identifiers </platforms/platform_index>`):
 
 .. code-block:: python
@@ -97,27 +86,6 @@ Note how the syntax is translated and how the search for :literal:`Title/Abstrac
    # Output:
    # ((AB="digital health" OR TI="digital health") AND (AB="privacy" OR TI="privacy"))
 
-
-..
-   Beyond the instructive error message, additional information on the specific messages is available `here <messages/errors_index.html>`_.
-
-    Each query parser has a corresponding linter that checks for errors and warnings in the query.
-    To validate a JSON query file, run the linter:
-
-    .. code-block:: python
-
-        from search_query.linter import run_linter
-
-        messages = run_linter(search.search_string, platform=search.platform)
-        print(messages)
-
-    There are two modes:
-
-    - **Strict mode**: Forces the user to maintain clean, valid input but at the cost of convenience. This mode fails on fatal or error outcomes and prints warnings.
-    - **Non-strict mode**: Focuses on usability, automatically resolving common issues while maintaining transparency via warnings. This mode fails only on fatal outcomes. Auto-corrects errors as much as possible and prints a message (adds a fatal message if this is not possible). Prints warnings.
-
-    An additional "silent" option may be used to silence warnings.
-
 Demo
 ============
 
@@ -134,13 +102,6 @@ Below is a high-level overview of the core functionalities:
 
 .. image:: presentation.png
 
-..
-   Parser development
-   -------------------------
-
-   To develop a parser, see `dev-parser <dev_docs/parser.html>`_ docs.
-
-
 .. toctree::
    :hidden:
    :maxdepth: 3

search_query/constants.py

@@ -195,13 +195,6 @@ class Colors:
     END = "\033[0m"
 
 
-class LinterMode:
-    """Linter mode"""
-
-    STRICT = "strict"
-    NONSTRICT = "non-strict"
-
-
 class QueryErrorCode(Enum):
     """Error codes for the query parser"""
 

search_query/ebsco/parser.py

@@ -5,7 +5,6 @@
 import re
 import typing
 
-from search_query.constants import LinterMode
 from search_query.constants import PLATFORM
 from search_query.constants import Token
 from search_query.constants import TokenTypes
@@ -53,7 +52,6 @@ def __init__(
         query_str: str,
         *,
         field_general: str = "",
-        mode: str = LinterMode.STRICT,
         offset: typing.Optional[dict] = None,
         original_str: typing.Optional[str] = None,
         silent: bool = False,
@@ -62,7 +60,6 @@ def __init__(
         super().__init__(
             query_str,
             field_general=field_general,
-            mode=mode,
             offset=offset,
             original_str=original_str,
         )
@@ -413,13 +410,11 @@ def __init__(
         self,
         query_list: str,
         field_general: str = "",
-        mode: str = LinterMode.NONSTRICT,
     ) -> None:
         super().__init__(
             query_list=query_list,
             parser_class=EBSCOParser,
             field_general=field_general,
-            mode=mode,
         )
         self.linter = EBSCOListLinter(parser=self, string_parser_class=EBSCOParser)
 
@@ -440,7 +435,6 @@ def parse(self) -> Query:
             query_str=query_str,
             original_str=self.query_list,
             field_general=self.field_general,
-            mode=self.mode,
             offset=offset,
             silent=True,
         )

search_query/linter_base.py

@@ -155,8 +155,6 @@ def check_status(self) -> None:
         self.print_messages()
 
         if self.has_fatal_errors():
-            # OR any (code.is_error() for code in messages)
-            # and self.parser.mode == "strict":
             raise QuerySyntaxError(self)
 
     def has_fatal_errors(self) -> bool:
@@ -413,7 +411,7 @@ def check_boolean_operator_readability(
         for token in self.tokens:
             if token.type == TokenTypes.LOGIC_OPERATOR:
                 if token.value in faulty_operators:
-                    details = f"Please use AND, OR, NOT instead of {faulty_operators}"
+                    details = f"Use AND, OR, NOT instead of {faulty_operators}"
                     self.add_message(
                         QueryErrorCode.BOOLEAN_OPERATOR_READABILITY,
                         positions=[token.position],
@@ -956,10 +954,7 @@ def _check_date_filters_in_subquery(self, query: Query, level: int = 0) -> None:
 
         generic_fields = self.syntax_str_to_generic_field_set(query.field.value)
         if generic_fields & {Fields.YEAR_PUBLICATION}:
-            details = (
-                "Please double-check whether date filters "
-                "should apply to the entire query."
-            )
+            details = "Check whether date filters should apply to the entire query."
             positions = [(-1, -1)]
             if query.position and query.position is not None:
                 positions = [query.position]
@@ -997,7 +992,7 @@ def _check_journal_filters_in_subquery(self, query: Query, level: int = 0) -> No
         generic_fields = self.syntax_str_to_generic_field_set(query.field.value)
         if generic_fields & {Fields.JOURNAL, Fields.PUBLICATION_NAME}:
             details = (
-                "Please double-check whether journal/publication-name filters "
+                "Check whether journal/publication-name filters "
                 f"({query.field.value}) should apply to the entire query."
             )
             self.add_message(
@@ -1285,8 +1280,6 @@ def check_status(self) -> None:
         self.print_messages()
 
         if self.has_fatal_errors():
-            # OR any (code.is_error() for code in messages)
-            # and self.parser.mode == "strict":
             raise ListQuerySyntaxError(self)
 
 

search_query/parser.py

@@ -5,7 +5,6 @@
 import sys
 import typing
 
-from search_query.constants import LinterMode
 from search_query.constants import PLATFORM
 from search_query.ebsco.parser import EBSCOListParser
 from search_query.ebsco.parser import EBSCOParser
@@ -38,7 +37,6 @@ def parse(
     *,
     field_general: str = "",
     platform: str = PLATFORM.WOS.value,
-    mode: str = LinterMode.STRICT,
 ) -> Query:
     """Parse a query string."""
     platform = get_platform(platform)
@@ -51,7 +49,6 @@ def parse(
             query = LIST_PARSERS[platform](  # type: ignore
                 query_list=query_str,
                 field_general=field_general,
-                mode=mode,
             ).parse()
         except Exception:  # pylint: disable=broad-except
             sys.exit(1)
@@ -63,7 +60,7 @@ def parse(
     parser_class = PARSERS[platform]
     try:
         query = parser_class(
-            query_str, field_general=field_general, mode=mode
+            query_str, field_general=field_general
         ).parse()  # type: ignore
     except Exception:  # pylint: disable=broad-except
         sys.exit(1)

search_query/parser_base.py

@@ -8,7 +8,6 @@
 from abc import abstractmethod
 
 from search_query.constants import GENERAL_ERROR_POSITION
-from search_query.constants import LinterMode
 from search_query.constants import ListToken
 from search_query.constants import ListTokenTypes
 from search_query.constants import OperatorNodeTokenTypes
@@ -35,14 +34,12 @@ def __init__(
         query_str: str,
         *,
         field_general: str = "",
-        mode: str = LinterMode.STRICT,
         offset: typing.Optional[dict] = None,
         original_str: typing.Optional[str] = None,
         silent: bool = False,
     ) -> None:
         self.query_str = query_str
         self.tokens: list = []
-        self.mode = mode
         # The external fields (in the JSON file: "field")
         self.field_general = field_general
         self.silent = silent
@@ -213,14 +210,12 @@ def __init__(
         *,
         parser_class: type[QueryStringParser],
         field_general: str,
-        mode: str = LinterMode.STRICT,
     ) -> None:
         # Remove leading whitespaces/newlines from the query_list
         # to ensure correct token positions
         self.query_list = query_list.lstrip()
         self.parser_class = parser_class
         self.field_general = field_general
-        self.mode = mode
         self.query_dict: dict = {}
 
     def tokenize_list(self) -> None:

search_query/pubmed/parser.py

@@ -3,7 +3,6 @@
 import re
 import typing
 
-from search_query.constants import LinterMode
 from search_query.constants import Operators
 from search_query.constants import PLATFORM
 from search_query.constants import Token
@@ -48,7 +47,6 @@ def __init__(
         query_str: str,
         *,
         field_general: str = "",
-        mode: str = LinterMode.NONSTRICT,
         offset: typing.Optional[dict] = None,
         original_str: typing.Optional[str] = None,
         silent: bool = False,
@@ -57,7 +55,6 @@ def __init__(
         super().__init__(
             query_str=query_str,
             field_general=field_general,
-            mode=mode,
             offset=offset,
             original_str=original_str,
         )
@@ -298,13 +295,11 @@ def __init__(
         query_list: str,
         *,
         field_general: str = "",
-        mode: str = LinterMode.NONSTRICT,
     ) -> None:
         super().__init__(
             query_list,
             parser_class=PubmedParser,
             field_general=field_general,
-            mode=mode,
         )
         self.linter = PubmedQueryListLinter(self, PubmedParser)
 
@@ -321,7 +316,6 @@ def parse(self) -> Query:
             query_str=query_str,
             original_str=self.query_list,
             field_general=self.field_general,
-            mode=self.mode,
             offset=offset,
             silent=True,
         )