Merge branch 'main' of github.com:pinecone-io/pinecone-python-client-internal into ch9770

Author: rajat08

.github/workflows/alpha-release.yaml

@@ -0,0 +1,29 @@
+name: (alpha) Pypi
+# upload package to test Pypi
+
+on:
+  push:
+    tags:
+      - '**-alpha'
+
+env:
+  TEST_PYPI_URL: https://test.pypi.org/legacy/
+  TEST_PYPI_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD }}
+
+jobs:
+  pypi:
+    timeout-minutes: 30
+    name: pypi
+    runs-on: self-hosted
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: 3.7
+
+    - name: Build Python client
+      run: make package
+
+    - name: Upload Python client to Pypi
+      run: export TWINE_REPOSITORY_URL=${{ env.TEST_PYPI_URL }} && make upload PYPI_PASSWORD=${{ env.TEST_PYPI_PASSWORD }}

.github/workflows/release.yaml

@@ -0,0 +1,38 @@
+name: Pypi
+# upload package to Pypi
+on:
+  push:
+    tags:
+      - '**-release'
+
+env:
+  PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+
+jobs:
+
+  pypi:
+    timeout-minutes: 30
+    name: pypi
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+
+    - uses: actions/checkout@v2
+      with:
+        repository: pinecone-io/pinecone-python-client
+        ref: ''
+        token: ${{ secrets.PAT }}
+        path: pinecone-python-client
+
+    - name: Set Python client production environment
+      run: make set-production
+
+    - name: Build Python client
+      run: make package
+
+    - name: Upload Python client to Pypi
+      run: make upload PYPI_PASSWORD=${{ env.PYPI_PASSWORD }}

CHANGELOG.md

@@ -6,6 +6,14 @@
 - `pinecone.init()` can now be used to set the pinecone logger's log level.
 - The python client `pinecone.config.OpenApiConfiguration` object now uses the certifi package's SSL CA bundle by default. This should fix HTTPS connection errors in certain environments depending on their default CA bundle, including some Google Colab notebooks. 
 
+## [2.0.1] - 2021-10-06
+### Added
+- New `timeout` parameter to the `pinecone.create_index()` and the `pinecone.delete_index()` call.
+  - `timeout` allows you to set how many seconds you want to wait for `create_index()` and `delete_index()` to complete. If `None`, wait indefinitely; if `>=0`, time out after this many seconds; if `-1`, return immediately and do not wait. Defaults to `None`.
+
+### Changed
+- Updates the default openapi_config object to use the certifice ssl_ca_cert bundle.
+
 ## [2.0.0] - 2020-10-04
 ### Added
 - New major release!

pinecone/__version__

@@ -1 +1 @@
-2.0.0
+2.0.1

pinecone/config.py

@@ -23,14 +23,11 @@
 
 
 def _set_sentry_tags(config: dict):
-    if config['disable_error_reporting']:
-        sentry_sdk.init()
-    else:
-        sentry_sdk.set_tag("package_version", CLIENT_VERSION)
-        sentry_tag_names = ('environment', 'project_name', 'controller_host', 'username', 'user_label')
-        for key, val in config.items():
-            if key in sentry_tag_names:
-                sentry_sdk.set_tag(key, val)
+    sentry_sdk.set_tag("package_version", CLIENT_VERSION)
+    sentry_tag_names = ('environment', 'project_name', 'controller_host', 'username', 'user_label')
+    for key, val in config.items():
+        if key in sentry_tag_names:
+            sentry_sdk.set_tag(key, val)
 
 
 class ConfigBase(NamedTuple):
@@ -39,7 +36,6 @@ class ConfigBase(NamedTuple):
     project_name: str = ""
     controller_host: str = ""
     log_level: str = ""
-    disable_error_reporting: bool = False
     openapi_config: OpenApiConfiguration = None
 
 
@@ -55,7 +51,6 @@ class _CONFIG:
     """
 
     def __init__(self):
-        self._loguru_handler_id = None
         self.reset()
 
     def validate(self):
@@ -131,21 +126,13 @@ def reset(self, config_file=None, **kwargs):
                 or os.getenv("PINECONE_LOGGING")
                 or file_config.pop("log_level", None)
         )
-        if log_level or not self._loguru_handler_id:
-            logger.remove(self._loguru_handler_id)
-            self._loguru_handler_id = logger.add(sys.stdout, enqueue=True, level=(log_level or "ERROR"))
+        if log_level:
+            logger.remove()
+            logger.add(sys.stdout, enqueue=True, level=(log_level or "ERROR"))
         config = config._replace(log_level=log_level)
         self._config = config
 
         # Sentry
-        disable_error_reporting = (
-                kwargs.pop("disable_error_reporting", False)
-                or os.getenv("PINECONE_ERROR_REPORTING")
-                or file_config.pop("disable_error_reporting", False)
-                or False
-        )
-        config = config._replace(disable_error_reporting=disable_error_reporting)
-        self._config = config
         _set_sentry_tags({**whoami_response._asdict(), **self._config._asdict()})
 
     def _preprocess_and_validate_config(self, config: dict) -> dict:
@@ -203,14 +190,10 @@ def OPENAPI_CONFIG(self):
     def LOG_LEVEL(self):
         return self._config.log_level
 
-    @property
-    def DISABLE_ERROR_REPORTING(self):
-        return self._config.disable_error_reporting
-
 
 @sentry
 def init(api_key: str = None, host: str = None, environment: str = None, project_name: str = None,
-         log_level: str = None, openapi_config: OpenApiConfiguration = None, disable_error_reporting: bool = None,
+         log_level: str = None, openapi_config: OpenApiConfiguration = None,
          config: str = "~/.pinecone", **kwargs):
     """Initializes the Pinecone client.
 
@@ -219,17 +202,20 @@ def init(api_key: str = None, host: str = None, environment: str = None, project
     :param environment: Optional. Deployment environment.
     :param project_name: Optional. Pinecone project name. Overrides the value that is otherwise looked up and used from the Pinecone backend.
     :param log_level: Optional. Set Pinecone log level.
-    :param disable_error_reporting: Optional. Don't sent client errors to Pinecone.
     :param openapi_config: Optional. Set OpenAPI client configuration.
     :param config: Optional. An INI configuration file.
     """
     Config.reset(project_name=project_name, api_key=api_key, controller_host=host, environment=environment,
-                 log_level=log_level, openapi_config=openapi_config, disable_error_reporting=disable_error_reporting,
+                 log_level=log_level, openapi_config=openapi_config,
                  config_file=config, **kwargs)
     if not bool(Config.API_KEY):
         logger.warning("API key is required.")
 
 
+logger.remove()
+logger.add(sys.stdout, enqueue=True, level=(
+        os.getenv("PINECONE_LOG_LEVEL") or os.getenv("PINECONE_LOGGING") or "ERROR"))
+
 Config = _CONFIG()
 
 # Init

pinecone/index.py

@@ -2,7 +2,7 @@
 # Copyright (c) 2020-2021 Pinecone Systems Inc. All right reserved.
 #
 
-from collections import Iterable
+from collections.abc import Iterable
 
 from pinecone import Config
 from pinecone.core.client import ApiClient, Configuration

test-requirements.txt

@@ -4,3 +4,4 @@ pytest-cov==2.10.1
 pytest-mock==3.6.1
 tox==3.20.1
 pytest-timeout==1.4.2
+urllib3_mock==0.3.3

tests/integ/__init__.py

@@ -0,0 +1,59 @@
+import pytest
+from urllib3_mock import Responses
+
+import pinecone
+from pinecone import ApiTypeError
+
+responses = Responses('requests.packages.urllib3')
+
+
+@responses.activate
+def test_unrecognized_response_field():
+    # unrecognized response fields are okay, shouldn't raise an exception
+    pinecone.init('example-api-key', environment='example-environment')
+
+    # responses.add('GET', '/actions/whoami',  # fixme: requests-based, so mock fails?
+    #               body='{"project_name": "example-project", "user_label": "example-label", "user_name": "test"}',
+    #               status=200, content_type='application/json')
+    responses.add('DELETE', '/vectors/delete',
+                  body='{"deleted_count": 2, "unexpected_key": "xyzzy"}',
+                  status=200, content_type='application/json')
+
+    index = pinecone.Index('example-index')
+    resp = index.delete(ids=['vec1', 'vec2'])
+
+    # assert len(responses.calls) == 1
+    # assert responses.calls[0].request.url == '/vectors/delete?ids=vec1&ids=vec2'
+    # assert responses.calls[0].request.host == 'example-index-unknown.svc.example-environment.pinecone.io'
+    # assert responses.calls[0].request.scheme == 'https'
+
+    assert resp.deleted_count == 2
+
+
+@responses.activate
+def test_missing_response_field():
+    # unrecognized response fields are okay, shouldn't raise an exception
+    pinecone.init('example-api-key', environment='example-environment')
+    responses.add('DELETE', '/vectors/delete',
+                  body='{}',
+                  status=200, content_type='application/json')
+    index = pinecone.Index('example-index')
+    # this should not raise
+    index.delete(ids=['vec1', 'vec2'])
+
+
+
+@responses.activate
+def test_malformed_response_wrong_type():
+    # unrecognized response fields are okay, shouldn't raise an exception
+    pinecone.init('example-api-key', environment='example-environment')
+
+    responses.add('DELETE', '/vectors/delete',
+                  body='{"deleted_count": "foobar"}',
+                  status=200, content_type='application/json')
+
+    index = pinecone.Index('example-index')
+
+    with pytest.raises(ApiTypeError) as exc_info:
+        resp = index.delete(ids=['vec1', 'vec2'])
+        assert resp.deleted_count == 2

tests/integ/test_index.py

@@ -19,6 +19,13 @@ deps=
 commands =
   pytest --cov=pinecone --timeout=120 tests/unit {posargs}
 
+[gh-actions]
+python =
+    3.6: py36
+    3.7: py37
+    3.8: py38
+    3.9: py39
+
 [flake8]
 max-line-length = 120
 extend-ignore = E203