Merge release-candidate/2025-01 (#455)

## Problem

In preparation to release v6, we need to merge recent changes in the
release-candidate/2025-01 branch.

## Solution

Merge conflicts seem limited to just a few things in the pyproject.toml
and poetry.lock file, as well as a few method signatures modified to
indicate `None` as return type. So I think this should go pretty
smoothly.

Author: jhamon

.github/actions/build-docs/action.yml

@@ -21,4 +21,4 @@ runs:
     - name: Build html documentation
       shell: bash
       run: |
-        poetry run pdoc pinecone '!pinecone.core' '!pinecone.utils' --favicon ./favicon-32x32.png --docformat google -o ./docs
+        poetry run pdoc pinecone '!pinecone.core' '!pinecone.utils' --favicon ./favicon-32x32.png --docformat google -o ./pdoc

.github/actions/setup-poetry/action.yml

@@ -13,6 +13,10 @@ inputs:
     description: 'Install typing dependencies (mypy, type stubs, etc)'
     required: true
     default: 'true'
+  include_asyncio:
+    description: 'Install asyncio dependencies'
+    required: true
+    default: 'false'
 
 runs:
   using: 'composite'
@@ -26,8 +30,10 @@ runs:
         INCLUDE_GRPC: ${{ inputs.include_grpc }}
         INCLUDE_DEV: ${{ inputs.include_dev }}
         INCLUDE_TYPES: ${{ inputs.include_types }}
+        INCLUDE_ASYNCIO: ${{ inputs.include_asyncio }}
       run: |
         GRPC_FLAG=$( [ "$INCLUDE_GRPC" = "true" ] && echo "--extras grpc" || echo "" )
+        ASYNCIO_FLAG=$( [ "$INCLUDE_ASYNCIO" = "true" ] && echo "--extras asyncio" || echo "" )
         DEV_FLAG=$( [ "$INCLUDE_DEV" = "false" ] && echo "--without dev" || echo "" )
         TYPING_FLAG=$( [ "$INCLUDE_TYPES" = "true" ] && echo "--with types" || echo "" )
-        poetry install $DEV_FLAG $TYPING_FLAG $GRPC_FLAG
+        poetry install $DEV_FLAG $TYPING_FLAG $GRPC_FLAG $ASYNCIO_FLAG

.github/actions/test-data-asyncio/action.yaml

@@ -0,0 +1,46 @@
+name: 'Test Asyncio'
+description: 'Runs tests on the Pinecone data plane'
+
+inputs:
+  spec:
+    description: 'The deploy spec of the index'
+    required: true
+  use_grpc:
+    description: 'Whether to use gRPC or REST'
+    required: true
+  freshness_timeout_seconds:
+    description: 'The number of seconds to wait for the index to become fresh'
+    required: false
+    default: '60'
+  PINECONE_API_KEY:
+    description: 'The Pinecone API key'
+    required: true
+  python_version:
+    description: 'The version of Python to use'
+    required: false
+    default: '3.9'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python_version }}
+
+    - name: Setup Poetry
+      uses: ./.github/actions/setup-poetry
+      with:
+        include_grpc: ${{ inputs.use_grpc }}
+        include_dev: 'true'
+        include_asyncio: 'true'
+
+    - name: Run data plane tests
+      id: data-plane-asyncio-tests
+      shell: bash
+      run: poetry run pytest tests/integration/data_asyncio -s -vv
+      env:
+        PINECONE_API_KEY: ${{ inputs.PINECONE_API_KEY }}
+        USE_GRPC: ${{ inputs.use_grpc }}
+        SPEC: ${{ inputs.spec }}
+        FRESHNESS_TIMEOUT_SECONDS: ${{ inputs.freshness_timeout_seconds }}

.github/actions/test-data-plane/action.yaml

@@ -1,13 +1,6 @@
 name: 'Test Data Plane'
 description: 'Runs tests on the Pinecone data plane'
 
-# - pod vs serverless
-# - grpc vs rest
-# - metric -> vector vs sparse vector
-# - namespace: default vs custom
-# - environment: free vs paid
-# - with metadata vs without metadata
-
 inputs:
   metric:
     description: 'The metric of the index'
@@ -59,13 +52,8 @@ runs:
     - name: Run data plane tests
       id: data-plane-tests
       shell: bash
-      run: poetry run pytest tests/integration/data --ddtrace
+      run: poetry run pytest tests/integration/data
       env:
-        DD_CIVISIBILITY_AGENTLESS_ENABLED: true
-        DD_API_KEY: ${{ inputs.DATADOG_API_KEY }}
-        DD_SITE: datadoghq.com
-        DD_ENV: ci
-        DD_SERVICE: pinecone-python-client
         PINECONE_API_KEY: ${{ inputs.PINECONE_API_KEY }}
         USE_GRPC: ${{ inputs.use_grpc }}
         METRIC: ${{ inputs.metric }}

.github/actions/test-dependency-asyncio-rest/action.yaml

@@ -0,0 +1,46 @@
+name: 'Test aiohttp dependencies'
+description: 'Runs asyncio sanity test with specific aiohttp dependencies'
+
+inputs:
+  PINECONE_API_KEY:
+    description: 'The Pinecone API key'
+    required: true
+  index_name:
+    description: 'The name of the index'
+    required: true
+  python_version:
+    description: 'The version of Python to use'
+    required: false
+    default: '3.9'
+  aiohttp_version:
+    description: 'The version of aiohttp to install'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python_version }}
+
+    - name: Setup Poetry
+      uses: ./.github/actions/setup-poetry
+      with:
+        include_grpc: false
+        include_types: false
+        include_asyncio: true
+
+    - name: 'Install aiohttp ${{ matrix.aiohttp-version }}'
+      run: 'poetry add aiohttp==${{ matrix.aiohttp-version }}'
+      shell: bash
+
+    - uses: nick-fields/retry@v3
+      with:
+        timeout_minutes: 5
+        max_attempts: 3
+        retry_on: error
+        command: poetry run pytest tests/dependency/asyncio-rest -s -v
+      env:
+        PINECONE_API_KEY: '${{ inputs.PINECONE_API_KEY }}'
+        INDEX_NAME: '${{ inputs.index_name }}'

.github/actions/test-dependency-grpc/action.yaml

@@ -60,7 +60,7 @@ runs:
         timeout_minutes: 5
         max_attempts: 3
         retry_on: error
-        command: poetry run pytest tests/dependency/grpc -s -v --ddtrace
+        command: poetry run pytest tests/dependency/grpc -s -v
       env:
         PINECONE_API_KEY: ${{ inputs.PINECONE_API_KEY }}
         INDEX_NAME: ${{ inputs.index_name }}

.github/actions/test-dependency-rest/action.yaml

@@ -39,7 +39,7 @@ runs:
         timeout_minutes: 5
         max_attempts: 3
         retry_on: error
-        command: poetry run pytest tests/dependency/rest -s -v --ddtrace
+        command: poetry run pytest tests/dependency/rest -s -v
       env:
         PINECONE_API_KEY: '${{ inputs.PINECONE_API_KEY }}'
         INDEX_NAME: '${{ inputs.index_name }}'

.github/workflows/alpha-release.yaml

@@ -24,22 +24,22 @@ on:
         default: 'rc1'
 
 jobs:
-  unit-tests:
-    uses: './.github/workflows/testing-unit.yaml'
-    secrets: inherit
-  integration-tests:
-      uses: './.github/workflows/testing-integration.yaml'
-      secrets: inherit
-  dependency-tests:
-    uses: './.github/workflows/testing-dependency.yaml'
-    secrets: inherit
+  # unit-tests:
+  #   uses: './.github/workflows/testing-unit.yaml'
+  #   secrets: inherit
+  # integration-tests:
+  #     uses: './.github/workflows/testing-integration.yaml'
+  #     secrets: inherit
+  # dependency-tests:
+  #   uses: './.github/workflows/testing-dependency.yaml'
+  #   secrets: inherit
 
   pypi:
     uses: './.github/workflows/publish-to-pypi.yaml'
-    needs: 
-      - unit-tests
-      - integration-tests
-      - dependency-tests
+    # needs:
+    #   - unit-tests
+    #   - integration-tests
+    #   - dependency-tests
     with:
       isPrerelease: true
       ref: ${{ inputs.ref }}
@@ -49,4 +49,3 @@ jobs:
     secrets:
       PYPI_USERNAME: __token__
       PYPI_PASSWORD: ${{ secrets.PROD_PYPI_PUBLISH_TOKEN }}
-

.github/workflows/build-and-publish-docs.yaml

@@ -24,7 +24,7 @@ jobs:
         env:
           SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
         with:
-          source-directory: docs
+          source-directory: pdoc
           destination-github-username: pinecone-io
           destination-repository-name: sdk-docs
           user-email: [email protected]

.github/workflows/lint.yaml

@@ -1,5 +1,6 @@
 name: "Lint"
-on: [pull_request]
+on:
+  workflow_call: {}
 
 jobs:
   lint:

.github/workflows/migration-paths.yaml

@@ -8,21 +8,29 @@ on:
   workflow_dispatch: {}
 
 jobs:
+  linting:
+    uses: './.github/workflows/lint.yaml'
+
   unit-tests:
     uses: './.github/workflows/testing-unit.yaml'
     secrets: inherit
+
   integration-tests:
       uses: './.github/workflows/testing-integration.yaml'
       secrets: inherit
+      needs: unit-tests
+
   dependency-tests:
     uses: './.github/workflows/testing-dependency.yaml'
     secrets: inherit
+    needs: unit-tests
+
   package:
     name: Check packaging
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.8, 3.12]
+        python-version: [3.9, 3.13]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
@@ -33,7 +41,7 @@ jobs:
         uses: ./.github/actions/setup-poetry
       - name: Package
         run: poetry build
-  
+
   build-docs:
     name: Build docs with pdoc
     runs-on: ubuntu-latest
@@ -43,4 +51,4 @@ jobs:
       - name: Build docs with pdoc
         uses: './.github/actions/build-docs'
         with:
-          python-version: 3.11
+          python-version: 3.11

.github/workflows/pr.yaml

@@ -74,7 +74,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.x
+          python-version: 3.12
 
       - name: Setup Poetry
         uses: ./.github/actions/setup-poetry
@@ -109,13 +109,13 @@ jobs:
         run: |
           # Add the original pinecone client version file to git
           # Even though Poetry is now the preferred means of working
-          # with this project, since this __version__ file has been the 
+          # with this project, since this __version__ file has been the
           # one source of truth for our release process. We need to maintain
           # both files for the time being, and they should always contain the
           # identical package version
           git add pinecone/__version__
           # Add also the pyproject.toml, which is Poetry's source of truth, so
-          # that we maintain the exact same version across the two files 
+          # that we maintain the exact same version across the two files
           git add pyproject.toml
           git commit -m "[skip ci] Bump version to ${{ steps.bump.outputs.VERSION_TAG }}"
 

.github/workflows/publish-to-pypi.yaml

@@ -0,0 +1,30 @@
+name: Dependency Testing (Asyncio)
+
+on:
+  workflow_call:
+    inputs:
+        index_name:
+          required: true
+          type: string
+
+jobs:
+  dependency-matrix-asyncio-rest:
+    name: Deps (Asyncio REST)
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version:
+          - 3.9
+          - 3.13
+        aiohttp_version:
+          - 3.9.0
+          - 3.11.5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/test-dependency-asyncio-rest
+        with:
+          python_version: '${{ matrix.python_version }}'
+          index_name: '${{ inputs.index_name }}'
+          PINECONE_API_KEY: '${{ secrets.PINECONE_API_KEY }}'
+          aiohttp_version: '${{ matrix.aiohttp_version }}'