Merge branch 'main' into cli

Author: Gerit Wagner

search_query/constants.py

@@ -28,6 +28,7 @@ class TokenTypes(Enum):
     SEARCH_TERM = "SEARCH_TERM"
     PARENTHESIS_OPEN = "PARENTHESIS_OPEN"
     PARENTHESIS_CLOSED = "PARENTHESIS_CLOSED"
+    UNKNOWN = "UNKNOWN"
 
 
 @dataclass

search_query/linter.py

@@ -7,7 +7,7 @@
 import search_query.parser
 from search_query.constants import Colors
 from search_query.constants import ExitCodes
-from search_query.search_file import SearchFile
+from search_query.search_file import load_search_file
 from search_query.utils import format_query_string_pos
 
 
@@ -29,7 +29,7 @@ def pre_commit_hook() -> int:
     file_path = sys.argv[1]
 
     try:
-        search_file = SearchFile(file_path)
+        search_file = load_search_file(file_path)
         platform = search_query.parser.get_platform(search_file.platform)
     except Exception as e:  # pylint: disable=broad-except
         print(e)
@@ -45,7 +45,7 @@ def pre_commit_hook() -> int:
     linter_messages = run_linter(
         search_file.search_string,
         platform=search_file.platform,
-        search_field_general=search_file.search_field_general,
+        search_field_general=search_file.search_field,
     )
 
     if linter_messages:

search_query/not_query.py

@@ -6,6 +6,8 @@
 from search_query.query import Query
 from search_query.query import SearchField
 
+# pylint: disable=duplicate-code
+
 
 class NotQuery(Query):
     """NOT Query"""

search_query/parser_ebsco.py

@@ -159,7 +159,7 @@ def tokenize(self) -> None:
         validator.check_search_field_general(strict=self.mode)
 
         previous_token_type = None
-        token_type = None
+        token_type = TokenTypes.UNKNOWN
 
         for match in re.finditer(self.pattern, self.query_str):
             value = match.group()

search_query/parser_validation.py

@@ -9,6 +9,9 @@
 from search_query.constants import QueryErrorCode
 from search_query.constants import TokenTypes
 
+if typing.TYPE_CHECKING:
+    import search_query.parser_ebsco
+
 
 # Could indeed be a general Validator class
 class QueryStringValidator:
@@ -141,7 +144,7 @@ def filter_search_field(self, strict: bool) -> None:
 
     def validate_token_position(
         self,
-        token_type: str,
+        token_type: TokenTypes,
         previous_token_type: typing.Optional[TokenTypes],
         position: typing.Optional[tuple[int, int]],
     ) -> None:

search_query/search_file.py

@@ -21,6 +21,7 @@ def __init__(
         authors: Optional[list[dict]] = None,
         record_info: Optional[dict] = None,
         date: Optional[dict] = None,
+        search_field: Optional[str] = None,
         filepath: Optional[str | Path] = None,
         **kwargs: dict,
     ) -> None:
@@ -29,6 +30,7 @@ def __init__(
         self.authors = authors or []
         self.record_info = record_info or {}
         self.date = date or {}
+        self.search_field = search_field or ""
         self._filepath = Path(filepath) if filepath else None
 
         for key, value in kwargs.items():
@@ -101,4 +103,4 @@ def load_search_file(filepath: str | Path) -> SearchFile:
         platform=data.pop("platform"),
         filepath=path,
         **data,
-    )
+    )

test/test_search_file.py

@@ -2,14 +2,12 @@
 """Tests for SearchFile parser."""
 from __future__ import annotations
 
-from search_query.search_file import SearchFile
+from search_query.search_file import load_search_file
 
 
 def test_search_history_file_parser() -> None:
     """Test SearchFile parser."""
 
-    file_path = "test/search_history_file_1.json"
-
-    result = SearchFile(file_path)
+    result = load_search_file("test/search_history_file_1.json")
 
     assert hasattr(result, "parsed")