Switch off loguru as logging library

Author: benjaminran

pinecone/config.py

@@ -1,26 +1,30 @@
 #
 # Copyright (c) 2020-2021 Pinecone Systems Inc. All right reserved.
 #
-import sys
+import logging
 from typing import NamedTuple
 import os
 
 import certifi
-from loguru import logger
 import requests
 import sentry_sdk
 import configparser
 
 from pinecone.core.client.exceptions import ApiKeyError
 from pinecone.core.api_action import ActionAPI, WhoAmIResponse
-from pinecone.core.utils.constants import CLIENT_VERSION
+from pinecone.core.utils import warn_deprecated
+from pinecone.core.utils.constants import CLIENT_VERSION, PARENT_LOGGER_NAME, DEFAULT_PARENT_LOGGER_LEVEL
 from pinecone.core.utils.sentry import sentry_decorator as sentry
 from pinecone.core.client.configuration import Configuration as OpenApiConfiguration
 
 __all__ = [
-    "Config", "logger", "init"
+    "Config", "init"
 ]
 
+_logger = logging.getLogger(__name__)
+_parent_logger = logging.getLogger(PARENT_LOGGER_NAME)
+_parent_logger.setLevel(DEFAULT_PARENT_LOGGER_LEVEL)
+
 
 def _set_sentry_tags(config: dict):
     sentry_sdk.set_tag("package_version", CLIENT_VERSION)
@@ -35,7 +39,6 @@ class ConfigBase(NamedTuple):
     api_key: str = ""
     project_name: str = ""
     controller_host: str = ""
-    log_level: str = ""
     openapi_config: OpenApiConfiguration = None
 
 
@@ -119,19 +122,6 @@ def reset(self, config_file=None, **kwargs):
         config = config._replace(openapi_config=openapi_config)
         self._config = config
 
-        # Set log level
-        log_level = (
-                kwargs.pop("log_level", None)
-                or os.getenv("PINECONE_LOG_LEVEL")
-                or os.getenv("PINECONE_LOGGING")
-                or file_config.pop("log_level", None)
-        )
-        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
         _set_sentry_tags({**whoami_response._asdict(), **self._config._asdict()})
 
@@ -188,7 +178,15 @@ def OPENAPI_CONFIG(self):
 
     @property
     def LOG_LEVEL(self):
-        return self._config.log_level
+        """
+        Deprecated since v2.0.2 [Will be removed in v3.0.0]; use the standard logging module logger "pinecone" instead.
+        """
+        warn_deprecated(
+            description='LOG_LEVEL is deprecated. Use the standard logging module logger "pinecone" instead.',
+            deprecated_in='2.0.2',
+            removal_in='3.0.0'
+        )
+        return logging.getLevelName(logging.getLogger('pinecone').level)
 
 
 @sentry
@@ -201,20 +199,19 @@ def init(api_key: str = None, host: str = None, environment: str = None, project
     :param host: Optional. Controller host.
     :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 openapi_config: Optional. Set OpenAPI client configuration.
     :param config: Optional. An INI configuration file.
+    :param log_level: Deprecated since v2.0.2 [Will be removed in v3.0.0]; use the standard logging module to manage logger "pinecone" instead.
     """
     Config.reset(project_name=project_name, api_key=api_key, controller_host=host, environment=environment,
-                 log_level=log_level, openapi_config=openapi_config,
-                 config_file=config, **kwargs)
-    if not bool(Config.API_KEY):
-        logger.warning("API key is required.")
-
+                 openapi_config=openapi_config, config_file=config, **kwargs)
+    if log_level:
+        warn_deprecated(
+            description='log_level is deprecated. Use the standard logging module to manage logger "pinecone" instead.',
+            deprecated_in='2.0.2',
+            removal_in='3.0.0'
+        )
 
-logger.remove()
-logger.add(sys.stdout, enqueue=True, level=(
-        os.getenv("PINECONE_LOG_LEVEL") or os.getenv("PINECONE_LOGGING") or "ERROR"))
 
 Config = _CONFIG()
 

pinecone/core/grpc/index_grpc.py

@@ -1,14 +1,13 @@
 #
 # Copyright (c) 2020-2021 Pinecone Systems Inc. All right reserved.
 #
-
+import logging
 from abc import ABC, abstractmethod
 from functools import wraps
 from typing import NamedTuple, Optional, Dict
 
 import grpc
 
-from pinecone import logger
 from pinecone.config import Config
 from pinecone.core.grpc.protos.vector_column_service_pb2_grpc import VectorColumnServiceStub
 from pinecone.core.grpc.protos import vector_service_pb2, vector_column_service_pb2
@@ -19,6 +18,9 @@
 from pinecone.core.utils.constants import MAX_MSG_SIZE, REQUEST_ID, CLIENT_VERSION
 
 
+_logger = logging.getLogger(__name__)
+
+
 class GRPCClientConfig(NamedTuple):
     """
     GRPC client configuration options.
@@ -91,7 +93,7 @@ def _gen_channel(self, options=None):
             default_options['grpc.ssl_target_name_override'] = target.split(':')[0]
         user_provided_options = options or {}
         _options = tuple((k, v) for k, v in {**default_options, **user_provided_options}.items())
-        logger.debug('creating new channel with endpoint {} options {} and config {}',
+        _logger.debug('creating new channel with endpoint %s options %s and config %s',
                      target, _options, self.grpc_client_config)
         if not self.grpc_client_config.secure:
             channel = grpc.insecure_channel(target, options=_options)

pinecone/core/grpc/retry.py

@@ -3,13 +3,15 @@
 #
 
 import abc
+import logging
 import random
 import time
 from typing import Optional, Tuple, NamedTuple
 
 import grpc
 
-from pinecone import logger
+
+_logger = logging.getLogger(__name__)
 
 
 class SleepPolicy(abc.ABC):
@@ -31,7 +33,7 @@ def __init__(self, *, init_backoff_ms: int, max_backoff_ms: int, multiplier: int
     def sleep(self, try_i: int):
         sleep_range = min(self.init_backoff * self.multiplier ** try_i, self.max_backoff)
         sleep_ms = random.randint(0, sleep_range)
-        logger.debug(f"gRPC retry. Sleeping for {sleep_ms}ms")
+        _logger.debug(f"gRPC retry. Sleeping for {sleep_ms}ms")
         time.sleep(sleep_ms / 1000)
 
 

pinecone/core/utils/__init__.py

@@ -3,6 +3,7 @@
 #
 import re
 import uuid
+import warnings
 from pathlib import Path
 from typing import List
 
@@ -67,3 +68,8 @@ def get_user_agent():
     user_agent_details = {'requests': requests.__version__, 'urllib3': urllib3.__version__}
     user_agent = '{} ({})'.format(client_id, ', '.join([f'{k}:{v}' for k, v in user_agent_details.items()]))
     return user_agent
+
+
+def warn_deprecated(description: str = '', deprecated_in: str = None, removal_in: str = None):
+    message = f'DEPRECATED since v{deprecated_in} [Will be removed in v{removal_in}]: {description}'
+    warnings.warn(message, DeprecationWarning)

pinecone/core/utils/constants.py

@@ -7,6 +7,9 @@
 
 from pinecone.core.utils import get_environment, get_version
 
+PARENT_LOGGER_NAME = 'pinecone'
+DEFAULT_PARENT_LOGGER_LEVEL = 'ERROR'
+
 MAX_MSG_SIZE = 128 * 1024 * 1024
 
 MAX_ID_LENGTH = int(os.environ.get("PINECONE_MAX_ID_LENGTH", default="64"))

pinecone/core/utils/sentry.py

@@ -1,6 +1,7 @@
 #
 # Copyright (c) 2020-2021 Pinecone Systems Inc. All right reserved.
 #
+import logging
 
 import dns.resolver
 import sentry_sdk
@@ -10,7 +11,9 @@
 from functools import wraps
 
 from pinecone.core.utils.constants import PACKAGE_ENVIRONMENT, SENTRY_DSN_TXT_RECORD
-from pinecone.config import logger
+
+
+_logger = logging.getLogger(__name__)
 
 
 def sentry_decorator(func):
@@ -35,7 +38,7 @@ def init_sentry():
     The Sentry DSN is stored as a txt record.
     """
     if not sentry_sdk.Hub.current.client:
-        logger.info("Sentry is not initialized.")
+        _logger.info("Sentry is not initialized.")
         # sentry is not initialized
         sentry_dsn = None
         try:
@@ -44,7 +47,7 @@ def init_sentry():
                 sentry_dsn = json.loads(res.to_text())
                 break
         except Exception:
-            logger.warning("Unable to resolve Sentry DSN.")
+            _logger.warning("Unable to resolve Sentry DSN.")
         if sentry_dsn:
             debug = os.getenv("SENTRY_DEBUG") == "True"
             sentry_sdk.init(dsn=sentry_dsn, debug=debug, environment=PACKAGE_ENVIRONMENT, traces_sample_rate=0.1)

tests/unit/test_config.py

@@ -1,23 +1,14 @@
 import pinecone
-from pinecone.config import logger, Config
+from pinecone.config import Config
 
 
-def test_update_log_level():
-    default_level = 'ERROR'
-    assert list(logger._core.handlers.values())[0].levelno == logger.level(default_level).no
-    new_level = 'INFO'
-    pinecone.init(log_level=new_level)
-    assert list(logger._core.handlers.values())[0].levelno == logger.level(new_level).no
-
-
-def test_multi_init():
+def _test_multi_init():
     env = 'test-env'
-    level = 'INFO'
-    # first init() sets log level
-    pinecone.init(log_level=level)
+    api_key = 'foobar'
+    # first init() sets api_key
+    pinecone.init(api_key=api_key)
     assert Config.ENVIRONMENT == 'us-west1-gcp'
-    assert list(logger._core.handlers.values())[0].levelno == logger.level(level).no
-    # next init() shouldn't clobber log level
+    # next init() shouldn't clobber api_key
     pinecone.init(environment=env)
     assert Config.ENVIRONMENT == env
-    assert list(logger._core.handlers.values())[0].levelno == logger.level(level).no
+    assert Config.API_KEY == api_key