Python version support (neo4j#67)

willtai · web-flow · commit 6d69a9575dcb · 2024-06-25T14:36:24.000+01:00
* Use tox for automated testing between python versions

* Resolve mypy errors

* Update poetry to use matrix's python version

* Remove Python 3.8 support

* Readded python 3.8

* Removed tox.ini for python version iterating

* Reverted to new type hints but added import __future__ annotations

* Use different python versions for PR unit test workflow

* Add missing imports for __future__.annotations

* Update CHANGELOG
diff --git a/.github/workflows/pr-e2e-tests.yaml b/.github/workflows/pr-e2e-tests.yaml
@@ -3,6 +3,8 @@ name: 'Neo4j-GenAI PR E2E Tests'
 on:
   pull_request:
     types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - main
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
@@ -13,6 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
         neo4j-version:
           - 5
         neo4j-edition:
@@ -47,18 +50,24 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
       - name: Install Poetry
         uses: snok/install-poetry@v1
         with:
           virtualenvs-create: true
           virtualenvs-in-project: true
           installer-parallel: true
+      - name: Set Python version for Poetry
+        run: poetry env use python${{ matrix.python-version }}
       - name: Load cached venv
         id: cached-poetry-dependencies
         uses: actions/cache@v4
         with:
           path: .venv
-          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+          key: ${{ runner.os }}-venv-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
       - name: Install dependencies
         if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
         run: poetry install --no-interaction --no-root
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -4,21 +4,30 @@ on: pull_request
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ]
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
       - name: Install Poetry
         uses: snok/install-poetry@v1
         with:
           virtualenvs-create: true
           virtualenvs-in-project: true
           installer-parallel: true
+      - name: Set Python version for Poetry
+        run: poetry env use python${{ matrix.python-version }}
       - name: Load cached venv
         id: cached-poetry-dependencies
         uses: actions/cache@v4
         with:
           path: .venv
-          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+          key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
       - name: Install dependencies
         if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
         run: poetry install --no-interaction --no-root
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 -   Introduced the GraphRAG object, enabling a full RAG (Retrieval-Augmented Generation) pipeline with context retrieval, prompt formatting, and answer generation.
 -   Added PromptTemplate and RagTemplate for customizable prompt generation.
 -   Added LLMInterface with implementation for OpenAI LLM.
+-   Updated project configuration to support multiple Python versions (3.8 to 3.12) in CI workflows.
 
 ### Changed
 -   Refactored import paths for retrievers to neo4j_genai.retrievers.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -97,7 +97,7 @@ def setup(app):
     "te": typing,
     # Type alias that's only defined and imported if `typing.TYPE_CHECKING`
     # is `True`.
-    "_TAuth": "typing.Tuple[typing.Any, typing.Any] | Auth | None",
+    "_TAuth": "typing.tuple[typing.Any, typing.Any] | Auth | None",
 }
 
 # Theme options are theme-specific and customize the look and feel of a theme
diff --git a/examples/hybrid_cypher_search.py b/examples/hybrid_cypher_search.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from neo4j import GraphDatabase
 
 from random import random
diff --git a/examples/hybrid_search.py b/examples/hybrid_search.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from neo4j import GraphDatabase
 
 from random import random
diff --git a/examples/similarity_search_for_text.py b/examples/similarity_search_for_text.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from neo4j import GraphDatabase
 from neo4j_genai.retrievers import VectorRetriever
 
diff --git a/examples/vector_cypher_retrieval.py b/examples/vector_cypher_retrieval.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from neo4j import GraphDatabase
 from neo4j_genai.retrievers import VectorCypherRetriever
 
diff --git a/examples/vector_search_with_filters.py b/examples/vector_search_with_filters.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from neo4j import GraphDatabase
 from neo4j_genai.retrievers import VectorRetriever
 
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,6 +33,7 @@ pydantic = "^2.6.3"
 weaviate-client = {version = "^4.6.1", optional = true}
 pinecone-client = {version = "^4.1.0", optional = true}
 types-mock = "^5.1.0.20240425"
+eval-type-backport = "^0.2.0"
 
 [tool.poetry.group.dev.dependencies]
 pylint = "^3.1.0"
@@ -50,13 +51,21 @@ langchain-community = "^0.2.0"
 requests = "^2.32.0"
 sphinx = { version = "^7.2.6", python = "^3.9" }
 langchain-huggingface = "^0.0.3"
+tox = "^4.15.1"
+numpy = [
+    {version = "^1.24.0", python = "<3.12"},
+    {version = "^1.26.0", python = ">=3.12"}
+]
+scipy = [
+    {version = "^1", python = "<3.12"},
+    {version = "^1.7.0", python = ">=3.12"}
+]
 
 [tool.poetry.extras]
 external_clients = ["weaviate-client", "pinecone-client"]
 
-
 [build-system]
-requires = ["poetry-core"]
+requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.pytest.ini_options]
diff --git a/src/neo4j_genai/embedder.py b/src/neo4j_genai/embedder.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 
 from abc import ABC, abstractmethod
 
diff --git a/src/neo4j_genai/embeddings/openai.py b/src/neo4j_genai/embeddings/openai.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from typing import Any
 from neo4j_genai.embedder import Embedder
 
diff --git a/src/neo4j_genai/exceptions.py b/src/neo4j_genai/exceptions.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from pydantic_core import ErrorDetails
 
 
diff --git a/src/neo4j_genai/filters.py b/src/neo4j_genai/filters.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 import re
 from typing import Any, Type, Union
 from collections import Counter
diff --git a/src/neo4j_genai/generation/graphrag.py b/src/neo4j_genai/generation/graphrag.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 import logging
 from typing import Optional, Any
 
diff --git a/src/neo4j_genai/generation/prompts.py b/src/neo4j_genai/generation/prompts.py
@@ -12,7 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-
+from __future__ import annotations
 from typing import Optional, Any
 from neo4j_genai.exceptions import PromptMissingInputError
 
diff --git a/src/neo4j_genai/generation/types.py b/src/neo4j_genai/generation/types.py
@@ -12,7 +12,8 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-from typing import Any
+from __future__ import annotations
+from typing import Any, Union
 from pydantic import BaseModel, ConfigDict, field_validator
 
 from neo4j_genai.generation.prompts import RagTemplate
@@ -44,6 +45,6 @@ class RagSearchModel(BaseModel):
 
 class RagResultModel(BaseModel):
     answer: str
-    retriever_result: RetrieverResult | None = None
+    retriever_result: Union[RetrieverResult, None] = None
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
diff --git a/src/neo4j_genai/indexes.py b/src/neo4j_genai/indexes.py
@@ -12,7 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-
+from __future__ import annotations
 import logging
 from typing import Literal
 
diff --git a/src/neo4j_genai/llm/base.py b/src/neo4j_genai/llm/base.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from abc import ABC, abstractmethod
 from typing import Optional, Any
 
diff --git a/src/neo4j_genai/llm/openai_llm.py b/src/neo4j_genai/llm/openai_llm.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from typing import Optional, Any
 
 from .base import LLMInterface
diff --git a/src/neo4j_genai/neo4j_queries.py b/src/neo4j_genai/neo4j_queries.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from typing import Optional, Any
 
 from neo4j_genai.types import SearchType
diff --git a/src/neo4j_genai/retrievers/base.py b/src/neo4j_genai/retrievers/base.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from abc import ABC, abstractmethod
 from typing import Optional, Callable, Any
 import neo4j
diff --git a/src/neo4j_genai/retrievers/external/pinecone/pinecone.py b/src/neo4j_genai/retrievers/external/pinecone/pinecone.py
@@ -12,7 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-
+from __future__ import annotations
 import logging
 from typing import Any, Callable, Optional
 
diff --git a/src/neo4j_genai/retrievers/external/pinecone/types.py b/src/neo4j_genai/retrievers/external/pinecone/types.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from typing import Any, Callable, Optional
 
 import neo4j
diff --git a/src/neo4j_genai/retrievers/external/utils.py b/src/neo4j_genai/retrievers/external/utils.py
@@ -12,7 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-
+from __future__ import annotations
 from typing import Optional
 
 from neo4j_genai.neo4j_queries import get_query_tail
diff --git a/src/neo4j_genai/retrievers/external/weaviate/types.py b/src/neo4j_genai/retrievers/external/weaviate/types.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from typing import Optional, Any, Callable
 
 import neo4j
diff --git a/src/neo4j_genai/retrievers/external/weaviate/weaviate.py b/src/neo4j_genai/retrievers/external/weaviate/weaviate.py
@@ -12,7 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-
+from __future__ import annotations
 import logging
 from typing import Any, Callable, Optional
 
@@ -171,7 +171,7 @@ def _get_search_results(
                 query_text=query_text,
                 weaviate_filters=weaviate_filters,
             )
-            query_text = validated_data.query_text
+            query_text = validated_data.query_text or ""
             query_vector = validated_data.query_vector
             top_k = validated_data.top_k
             weaviate_filters = validated_data.weaviate_filters
diff --git a/src/neo4j_genai/retrievers/hybrid.py b/src/neo4j_genai/retrievers/hybrid.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from typing import Optional, Any, Callable
 
 import neo4j
diff --git a/src/neo4j_genai/retrievers/text2cypher.py b/src/neo4j_genai/retrievers/text2cypher.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 import logging
 from typing import Optional
 
diff --git a/src/neo4j_genai/retrievers/vector.py b/src/neo4j_genai/retrievers/vector.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from typing import Optional, Any, Callable
 
 import neo4j
diff --git a/src/neo4j_genai/schema.py b/src/neo4j_genai/schema.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from typing import Any, Optional
 from neo4j.exceptions import ClientError
 
diff --git a/src/neo4j_genai/types.py b/src/neo4j_genai/types.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 from enum import Enum
 from typing import Any, Literal, Optional
 
diff --git a/src/neo4j_genai/utils.py b/src/neo4j_genai/utils.py
@@ -12,7 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-
+from __future__ import annotations
 from typing import Optional
 
 
diff --git a/tests/e2e/conftest.py b/tests/e2e/conftest.py
@@ -12,6 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from __future__ import annotations
 import random
 import string
 import uuid
diff --git a/tests/e2e/pinecone_e2e/populate_dbs.py b/tests/e2e/pinecone_e2e/populate_dbs.py
@@ -12,9 +12,9 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-
+from __future__ import annotations
 import os.path
-from typing import Any, List
+from typing import Any
 
 import neo4j
 from neo4j import GraphDatabase
@@ -45,7 +45,7 @@ def populate_dbs(
 
 
 def populate_pinecone(
-    pc_client: Pinecone, pc_question_objs: List[Any], index_name: str
+    pc_client: Pinecone, pc_question_objs: list[Any], index_name: str
 ) -> None:
     index = pc_client.Index(index_name)
     index.upsert(vectors=pc_question_objs)
diff --git a/tests/e2e/utils.py b/tests/e2e/utils.py
diff --git a/tests/e2e/weaviate_e2e/populate_dbs.py b/tests/e2e/weaviate_e2e/populate_dbs.py
diff --git a/tests/e2e/weaviate_e2e/test_weaviate_e2e.py b/tests/e2e/weaviate_e2e/test_weaviate_e2e.py
diff --git a/tests/unit/retrievers/test_base.py b/tests/unit/retrievers/test_base.py
diff --git a/tests/unit/retrievers/test_vector.py b/tests/unit/retrievers/test_vector.py
diff --git a/tests/unit/test_filters.py b/tests/unit/test_filters.py
diff --git a/tests/unit/test_indexes.py b/tests/unit/test_indexes.py
diff --git a/tests/unit/test_schema.py b/tests/unit/test_schema.py

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ def setup(app):`
`97`	`97`	`"te": typing,`
`98`	`98`	# Type alias that's only defined and imported if `typing.TYPE_CHECKING`
`99`	`99`	# is `True`.
`100`		`- "_TAuth": "typing.Tuple[typing.Any, typing.Any] \| Auth \| None",`
	`100`	`+ "_TAuth": "typing.tuple[typing.Any, typing.Any] \| Auth \| None",`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`# Theme options are theme-specific and customize the look and feel of a theme`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+from __future__ import annotations`
`1`	`2`	`from neo4j import GraphDatabase`
`2`	`3`
`3`	`4`	`from random import random`