initial import

Gerit Wagner · Gerit Wagner · commit 1a3f5f4b73fa · 2025-04-06T11:07:04.000+02:00
diff --git a/docs/generate_indices.py b/docs/generate_indices.py
@@ -45,7 +45,7 @@ def generate_rst_file(error: QueryErrorCode) -> None:
         "",
         f"**Message**: ``{error.message}``",
         "",
-        f"**Scope**: {', '.join(error.scope)}",
+        f"**Scope**: {', '.join(str(e) for e in error.scope)}",
         "",
         error.docs.strip()
         if error.docs.strip()
diff --git a/docs/source/messages/E0004.rst b/docs/source/messages/E0004.rst
@@ -0,0 +1,14 @@
+.. _E0004:
+
+E0004 — invalid-character
+=========================
+
+**Error Code**: E0004
+
+**Message**: ``Search term contains invalid character``
+
+**Scope**: PLATFORM.PUBMED
+
+**Description**: Search term contains invalid character
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/E0005.rst b/docs/source/messages/E0005.rst
@@ -0,0 +1,14 @@
+.. _E0005:
+
+E0005 — query-starts-with-platform-identifier
+=============================================
+
+**Error Code**: E0005
+
+**Message**: ``Query starts with platform identifier``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Query starts with platform identifier
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/E0006.rst b/docs/source/messages/E0006.rst
@@ -0,0 +1,14 @@
+.. _E0006:
+
+E0006 — query-in-quotes
+=======================
+
+**Error Code**: E0006
+
+**Message**: ``The whole Search string is in quotes.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: The whole Search string is in quotes.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F0002.rst b/docs/source/messages/F0002.rst
@@ -9,8 +9,6 @@ F0002 — unbalanced-parentheses
 
 **Scope**: all
 
-**Description**: Unbalanced parentheses
-
 **Typical fix**: Check the parentheses in the query
 
 **Problematic query**:
diff --git a/docs/source/messages/F0004.rst b/docs/source/messages/F0004.rst
@@ -0,0 +1,14 @@
+.. _F0004:
+
+F0004 — invalid-operator-position
+=================================
+
+**Error Code**: F0004
+
+**Message**: ``Invalid operator position``
+
+**Scope**: PLATFORM.PUBMED
+
+**Description**: Invalid operator position
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F0005.rst b/docs/source/messages/F0005.rst
@@ -0,0 +1,14 @@
+.. _F0005:
+
+F0005 — invalid-search-field-position
+=====================================
+
+**Error Code**: F0005
+
+**Message**: ``Search field tags should directly follow search terms``
+
+**Scope**: PLATFORM.PUBMED
+
+**Description**: Search field tags should directly follow search terms
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F0006.rst b/docs/source/messages/F0006.rst
@@ -0,0 +1,14 @@
+.. _F0006:
+
+F0006 — nested-not-query
+========================
+
+**Error Code**: F0006
+
+**Message**: ``Nesting of NOT operator is not supported for this database``
+
+**Scope**: PLATFORM.PUBMED
+
+**Description**: Nesting of NOT operator is not supported for this database
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F0007.rst b/docs/source/messages/F0007.rst
@@ -0,0 +1,14 @@
+.. _F0007:
+
+F0007 — empty-parentheses
+=========================
+
+**Error Code**: F0007
+
+**Message**: ``Query contains empty parentheses``
+
+**Scope**: PLATFORM.PUBMED
+
+**Description**: Query contains empty parentheses
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1001.rst b/docs/source/messages/F1001.rst
@@ -0,0 +1,26 @@
+.. _F1001:
+
+F1001 — wildcard-in-year
+========================
+
+**Error Code**: F1001
+
+**Message**: ``Wildcard characters (*, ?, $) not supported in year search.``
+
+**Scope**: PLATFORM.WOS
+
+**Typical fix**: Replace with year range.
+
+**Problematic query**:
+
+.. code-block:: python
+
+    A AND year=201*
+
+**Correct query**:
+
+.. code-block:: python
+
+    A AND (year >= 2010 AND year < 2020)
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1002.rst b/docs/source/messages/F1002.rst
@@ -0,0 +1,14 @@
+.. _F1002:
+
+F1002 — unsupported-wildcard
+============================
+
+**Error Code**: F1002
+
+**Message**: ``Unsupported wildcard in search string.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Unsupported wildcard in search string.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1003.rst b/docs/source/messages/F1003.rst
@@ -0,0 +1,14 @@
+.. _F1003:
+
+F1003 — wildcard-short-length
+=============================
+
+**Error Code**: F1003
+
+**Message**: ``Right-hand wildcard must preceded by at least three characters.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Right-hand wildcard must preceded by at least three characters.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1004.rst b/docs/source/messages/F1004.rst
@@ -0,0 +1,14 @@
+.. _F1004:
+
+F1004 — wildcard-after-special-char
+===================================
+
+**Error Code**: F1004
+
+**Message**: ``Wildcard cannot be preceded by special characters.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Wildcard cannot be preceded by special characters.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1005.rst b/docs/source/messages/F1005.rst
@@ -0,0 +1,14 @@
+.. _F1005:
+
+F1005 — invalid-token-sequence-two-search-fields
+================================================
+
+**Error Code**: F1005
+
+**Message**: ``Invalid token sequence: two search fields in a row.``
+
+**Scope**: PLATFORM.EBSCO
+
+**Description**: Invalid token sequence: two search fields in a row.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1006.rst b/docs/source/messages/F1006.rst
@@ -0,0 +1,14 @@
+.. _F1006:
+
+F1006 — invalid-token-sequence-two-operators
+============================================
+
+**Error Code**: F1006
+
+**Message**: ``Invalid token sequence: two operators in a row.``
+
+**Scope**: PLATFORM.EBSCO
+
+**Description**: Invalid token sequence: two operators in a row.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1007.rst b/docs/source/messages/F1007.rst
@@ -0,0 +1,14 @@
+.. _F1007:
+
+F1007 — near-distance-too-large
+===============================
+
+**Error Code**: F1007
+
+**Message**: ``NEAR distance is too large (max: 15).``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: NEAR distance is too large (max: 15).
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1008.rst b/docs/source/messages/F1008.rst
@@ -0,0 +1,14 @@
+.. _F1008:
+
+F1008 — wildcard-standalone
+===========================
+
+**Error Code**: F1008
+
+**Message**: ``Wildcard cannot be standalone.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Wildcard cannot be standalone.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1009.rst b/docs/source/messages/F1009.rst
@@ -0,0 +1,14 @@
+.. _F1009:
+
+F1009 — invalid-token-sequence-missing-operator
+===============================================
+
+**Error Code**: F1009
+
+**Message**: ``Invalid token sequence: missing operator.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Invalid token sequence: missing operator.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1010.rst b/docs/source/messages/F1010.rst
@@ -0,0 +1,14 @@
+.. _F1010:
+
+F1010 — wildcard-left-short-length
+==================================
+
+**Error Code**: F1010
+
+**Message**: ``Left-hand wildcard must be preceded by at least three characters.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Left-hand wildcard must be preceded by at least three characters.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1011.rst b/docs/source/messages/F1011.rst
@@ -0,0 +1,14 @@
+.. _F1011:
+
+F1011 — isbn-format-invalid
+===========================
+
+**Error Code**: F1011
+
+**Message**: ``Invalid ISBN format.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Invalid ISBN format.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/F1012.rst b/docs/source/messages/F1012.rst
@@ -0,0 +1,14 @@
+.. _F1012:
+
+F1012 — doi-format-invalid
+==========================
+
+**Error Code**: F1012
+
+**Message**: ``Invalid DOI format.``
+
+**Scope**: PLATFORM.WOS
+
+**Description**: Invalid DOI format.
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/W0005.rst b/docs/source/messages/W0005.rst
@@ -0,0 +1,14 @@
+.. _W0005:
+
+W0005 — query-precedence-warning
+================================
+
+**Error Code**: W0005
+
+**Message**: ``AND operator used after OR operator in the same subquery``
+
+**Scope**: PLATFORM.PUBMED
+
+**Description**: AND operator used after OR operator in the same subquery
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/W1000.rst b/docs/source/messages/W1000.rst
@@ -0,0 +1,26 @@
+.. _W1000:
+
+W1000 — implicit-near-value
+===========================
+
+**Error Code**: W1000
+
+**Message**: ``The value of NEAR operator is implicit``
+
+**Scope**: PLATFORM.WOS
+
+**Typical fix**: The parser automatically sets implicit NEAR values to the default of 15.
+
+**Problematic query**:
+
+.. code-block:: python
+
+    A NEAR B
+
+**Correct query**:
+
+.. code-block:: python
+
+    A NEAR/15 B
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/W1001.rst b/docs/source/messages/W1001.rst
@@ -0,0 +1,26 @@
+.. _W1001:
+
+W1001 — year-span-violation
+===========================
+
+**Error Code**: W1001
+
+**Message**: ``Year span must be five or less.``
+
+**Scope**: PLATFORM.WOS
+
+**Typical fix**: The parser automatically sets the year span to 5.
+
+**Problematic query**:
+
+.. code-block:: python
+
+    A AND PY=2000-2020
+
+**Correct query**:
+
+.. code-block:: python
+
+    A AND PY=2015-2020
+
+**Back to**: :ref:`query-error-messages`
diff --git a/docs/source/messages/W1002.rst b/docs/source/messages/W1002.rst
diff --git a/docs/source/messages/W1003.rst b/docs/source/messages/W1003.rst
diff --git a/docs/source/messages/errors_index.rst b/docs/source/messages/errors_index.rst
diff --git a/search_query/constants.py b/search_query/constants.py
