fiddler-client 3.6.0.dev1__tar.gz → 3.7.0__tar.gz

{fiddler_client-3.6.0.dev1/fiddler_client.egg-info → fiddler_client-3.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 3.6.0.dev1
+Version: 3.7.0
 Summary: Python client for Fiddler Platform
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -30,7 +30,7 @@ publishing for use with our monitoring features.
 
 Requirements
 ------------
-Requires Python >= Python-3.6.3 and pip >= 19.0
+Requires Python >= Python-3.9 and pip >= 19.0
 
 Installation
 ------------
@@ -39,7 +39,7 @@ Installation
 
 API Example Usage
 -------------
-Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-the-fiddler-client). For examples of interacting with our APIs, please check out our [Quick Start Guide](https://docs.fiddler.ai/docs/quick-start) as well as the notebooks found on our [Examples Github](https://github.com/fiddler-labs/fiddler-examples).
+Documentation for the API can be found [here](https://docs.fiddler.ai). For examples of interacting with our APIs, please check out our [Quick Start Guide](https://docs.fiddler.ai/docs/quick-start) as well as the notebooks found on our [Examples Github](https://github.com/fiddler-labs/fiddler-examples).
 
 Version History
 -------------

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/PUBLIC.md

@@ -6,7 +6,7 @@ publishing for use with our monitoring features.
 
 Requirements
 ------------
-Requires Python >= Python-3.6.3 and pip >= 19.0
+Requires Python >= Python-3.9 and pip >= 19.0
 
 Installation
 ------------
@@ -15,7 +15,7 @@ Installation
 
 API Example Usage
 -------------
-Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-the-fiddler-client). For examples of interacting with our APIs, please check out our [Quick Start Guide](https://docs.fiddler.ai/docs/quick-start) as well as the notebooks found on our [Examples Github](https://github.com/fiddler-labs/fiddler-examples).
+Documentation for the API can be found [here](https://docs.fiddler.ai). For examples of interacting with our APIs, please check out our [Quick Start Guide](https://docs.fiddler.ai/docs/quick-start) as well as the notebooks found on our [Examples Github](https://github.com/fiddler-labs/fiddler-examples).
 
 Version History
 -------------

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/README.md

@@ -2,7 +2,80 @@
 
 A Python library for interacting with the Fiddler HTTP API.
 
-## Pre Release
+## Development
+
+Run unit tests:
+
+```
+$ make test
+...
+156 passed, 1 skipped in 0.59s
+```
+
+
+Run mypy, pylint, ruff, flake8:
+
+```
+$ make lint
+mypy fiddler
+Success: no issues found in 77 source files
+ruff check .
+All checks passed!
+pylint fiddler
+...
+flake8 fiddler
+```
+
+
+## Logging
+
+### Automatic log handler setup for ad-hoc scripts
+
+Consider this minimal Python program:
+
+```python
+import fiddler
+
+# The call to `init()` below detects that there is no root logger configured.
+# It automatically configures an outlet for log messages generated by this
+# library: they end up being written to stderr with a meaningful default log
+# format.
+fiddler.init(url="https://f.bar", token="x")
+```
+
+This feature can be disabled by passing `auto_attach_log_handler=False` to `init()`.
+
+### Full control in calling code: configure a root logger
+
+Any more complex Python program that uses this client library typically sets up the logging machinery in a custom way. Example:
+
+```python
+import logging
+import os
+
+import fiddler
+
+# Example for configuring a root logger, with a stream handler attached for
+# emission to stderr:
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s.%(msecs)03d %(levelname)s: %(message)s",
+    datefmt="%y%m%d-%H:%M:%S",
+)
+
+# Now, the call to init() below does not attach any additional log handlers.
+# Log messages emitted by this client library are simply propagated into the
+# root logger (and adhere to custom filtering and formatting rules).
+fiddler.init(url="https://f.bar", token="x")
+
+# Example for custom verbosity control: do not forward DEBUG+INFO level
+# messages from the 'fiddler' logger into the root logger.
+logging.getLogger('fiddler').setLevel(logging.WARNING)
+```
+
+## Releasing
+
+### Pre Release
 
 As we get ready for distribution of the updated python client we need to ensure that all the associated downstream artifacts are updated.
 
@@ -16,7 +89,7 @@ As we get ready for distribution of the updated python client we need to ensure
    - If it's a new feature appropriate care has to be taken to
    - Customer Success needs to sign off on the changes and they need to plan for customer update
 
-## Distribution
+### PyPI
 
 The Fiddler Python client is published as
 [`fiddler-client`](https://pypi.org/project/fiddler-client/) in the Python
@@ -42,7 +115,7 @@ Note: dev versions may be published from any branch at any time by using a
 `.devN` affix, as described in [PEP-440](https://peps.python.org/pep-0440/). For
 example: `1.4.3.dev5`.
 
-## Post Release
+### Post Release
 
 1. Inform on `#releases` slack channel of the python client release with release notes.
 1. Verify:

fiddler_client-3.7.0/fiddler/VERSION

@@ -0,0 +1 @@
+3.7.0

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/fiddler/__init__.py

@@ -67,7 +67,7 @@ from fiddler.version import __version__  # noqa
 conn: Connection | None = None
 
 
-def set_conn(conn_: Connection) -> None:
+def _set_conn(conn_: Connection) -> None:
     """Set global conn variable"""
     global conn
     conn = conn_

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/fiddler/configs.py

@@ -1,10 +1,10 @@
-DEFAULT_CONNECTION_TIMEOUT = 60  # In seconds
 MIN_SERVER_VERSION = '24.4.0'
 DEFAULT_PAGE_SIZE = 50
 
-# In seconds. For example, this generates a log message every N seconds.
-# Was once set to 3, and I think that was too frequent. If this needs to
-# be snappier, we can grow the interval.
+# In seconds. For example, this generates a log message every N seconds. Was
+# once set to 3, and I think that was too frequent. If this needs to be
+# snappier and apply to both, short-running jobs as well as long-running jobs:
+# we can grow the interval between polls.
 JOB_POLL_INTERVAL = 6
 JOB_WAIT_TIMEOUT = 1800
 

fiddler_client-3.7.0/fiddler/connection.py

@@ -0,0 +1,262 @@
+from __future__ import annotations
+
+import logging
+from functools import cached_property
+from uuid import UUID
+
+import fiddler.utils.logger
+from fiddler.configs import MIN_SERVER_VERSION
+from fiddler.constants.common import (
+    CLIENT_NAME,
+    FIDDLER_CLIENT_NAME_HEADER,
+    FIDDLER_CLIENT_VERSION_HEADER,
+)
+from fiddler.decorators import handle_api_error
+from fiddler.exceptions import IncompatibleClient
+from fiddler.libs.http_client import RequestClient
+from fiddler.schemas.server_info import ServerInfo, Version
+from fiddler.utils.version import match_semver
+from fiddler.version import __version__
+
+log = logging.getLogger(__name__)
+
+
+class Connection:
+    def __init__(  # pylint: disable=too-many-arguments
+        self,
+        url: str,
+        token: str,
+        proxies: dict | None = None,
+        timeout: float | tuple[float, float] | None = None,
+        verify: bool = True,
+        validate: bool = True,
+    ) -> None:
+        """
+        Initiate connection.
+
+        :param url:
+            The base URL to your Fiddler platform.
+        :param token:
+            An authentication token, obtained via the Fiddler UI.
+        :param proxies:
+            A dictionary mapping protocol to the URL of the proxy.
+        :param timeout:
+            Allows for overriding default HTTP request timeout settings.
+            Applies to all HTTP requests emitted with this connection object.
+            Can be a float or two floats, also see
+            https://requests.readthedocs.io/en/latest/user/advanced/#timeouts
+        :param verify:
+            Can be used to disable server's TLS certificate verification.
+            Certificate verification is enabled by default.
+        :param validate:
+            Whether to validate the server/client version compatibility. Some
+            features might not work as expected if this is turned off.
+        """
+
+        self.url = url
+        self.token = token
+        self.proxies = proxies
+        self.timeout = timeout
+        self.verify = verify
+
+        if not url:
+            raise ValueError('`url` is empty')
+
+        if not token:
+            raise ValueError('`token` is empty')
+
+        self.request_headers = {
+            'Authorization': f'Bearer {token}',
+            FIDDLER_CLIENT_NAME_HEADER: CLIENT_NAME,
+            FIDDLER_CLIENT_VERSION_HEADER: __version__,
+        }
+
+        if validate:
+            self._check_server_version()
+            self._check_version_compatibility()
+
+    @cached_property
+    def client(self) -> RequestClient:
+        """Request client instance"""
+        return RequestClient(
+            base_url=self.url,
+            headers=self.request_headers,
+            proxies=self.proxies,
+            verify=self.verify,
+        )
+
+    @cached_property
+    def server_info(self) -> ServerInfo:
+        """Server info instance"""
+        return self._get_server_info()
+
+    @cached_property
+    def server_version(self) -> Version:
+        """Server semver version"""
+        return self.server_info.server_version
+
+    @cached_property
+    def organization_name(self) -> str:
+        """Organization name"""
+        return self.server_info.organization.name
+
+    @cached_property
+    def organization_id(self) -> UUID:
+        """Organization id"""
+        return self.server_info.organization.id
+
+    @handle_api_error
+    def _get_server_info(self) -> ServerInfo:
+        """Get server info"""
+
+        # Tight-ish timeout.
+        response = self.client.get(url='/v3/server-info', timeout=(5, 15))
+
+        return ServerInfo(**response.json().get('data'))
+
+    @handle_api_error
+    def _check_version_compatibility(self) -> None:
+        """Check whether Client version is compatible with Fiddler Platform version"""
+
+        self.client.get(
+            url='/v3/version-compatibility',
+            params={
+                'client_version': __version__,
+                'client_name': CLIENT_NAME,
+            },
+            timeout=(5, 15),
+        )
+
+    def _check_server_version(self) -> None:
+        """Check whether Fiddler Platform version is compatible with Client version"""
+        if match_semver(self.server_version, f'>={MIN_SERVER_VERSION}'):
+            return
+
+        raise IncompatibleClient(server_version=str(self.server_version))
+
+
+class ConnectionMixin:
+    @classmethod
+    def _conn(cls) -> Connection:
+        """Fiddler connection instance"""
+        from fiddler import conn  # pylint: disable=import-outside-toplevel
+
+        assert conn is not None
+        return conn
+
+    @classmethod
+    def _client(cls) -> RequestClient:
+        """Request client instance"""
+        return cls._conn().client
+
+    @property
+    def organization_name(self) -> str:
+        """Organization name property"""
+        return self._conn().server_info.organization.name
+
+    @property
+    def organization_id(self) -> UUID:
+        """Organization id property"""
+        return self._conn().server_info.organization.id
+
+    @classmethod
+    def get_organization_name(cls) -> str:
+        """Organization name"""
+        return cls._conn().server_info.organization.name
+
+    @classmethod
+    def get_organization_id(cls) -> UUID:
+        """Organization id"""
+        return cls._conn().server_info.organization.id
+
+
+def init(  # pylint: disable=too-many-arguments
+    url: str,
+    token: str,
+    proxies: dict | None = None,
+    timeout: float | tuple[float, float] | None = None,
+    verify: bool = True,
+    validate: bool = True,
+    auto_attach_log_handler: bool = True,
+) -> None:
+    """
+    Initialize the client.
+
+    :param url:
+        The base URL to your Fiddler platform.
+    :param token:
+        An authentication token, obtained via the Fiddler UI (can be found on
+        the Credentials tab of the Settings page).
+    :param proxies:
+        A dictionary mapping protocol to the URL of the proxy.
+    :param timeout:
+        Allows for overriding default HTTP request timeout settings. Applies to
+        all HTTP requests emitted by this client. Can be a float or two floats,
+        also see
+        https://requests.readthedocs.io/en/latest/user/advanced/#timeouts. This
+        client library tries to implement meaningful default timeout settings.
+        If you find yourself having to set this parameter to address a problem
+        please also contact the Fiddler customer support.
+    :param verify:
+        Can be used to disable server's TLS certificate verification.
+        Certificate verification is enabled by default.
+    :param validate:
+        Whether to validate the server/client version compatibility. Some
+        features might not work as expected if this is turned off.
+    :param auto_attach_log_handler:
+        Defaults to `True`. Can be used to disable the mechanism by which this
+        library may attach a stream handler for emitting log messages to stderr
+        (see below for further details).
+
+
+    The Fiddler client library will see HTTP API calls fail due to for example
+    transient networking issues, temporary backend problems, or as of rate
+    limiting errors. These kinds of failures are retryable. It is a sensible
+    choice to retry any affected API call after a short waiting period.
+    Therefore, this client library implements an automatic retry strategy. Most
+    HTTP requests are retried for up to certain amount of time.
+
+    You can take control of this maximum retry duration by setting the
+    environment variable `FIDDLER_CLIENT_RETRY_MAX_DURATION_SECONDS` to a
+    numeric value. It currently defaults to 300 seconds which allows for
+    auto-healing smaller outages.
+
+    Note that this client library logs HTTP interaction (and retrying details)
+    on INFO level via Python's standard library logging module under the
+    'fiddler' namespace.
+
+    If you do not configure a root logger in your Python interpreter context
+    (done via e.g. `logging.basicConfig()`) then this library automatically
+    attaches a handler for its log messages to be emitted on `stderr`. This
+    behavior can be disabled by setting `auto_attach_log_handler=False`. For
+    fine-grained control, consider configuring handlers and formatters
+    yourself.
+
+    The Fiddler client library has AWS SageMaker partner application
+    authentication support. To enable that, install the SageMaker Python SDK
+    (`sagemaker` on PyPI). Then, before calling `fiddler.init()` set the
+    environment variable AWS_PARTNER_APP_AUTH to 'true' and also set
+    AWS_PARTNER_APP_ARN/AWS_PARTNER_APP_URL to meaningful values.
+    """
+    from fiddler import _set_conn  # pylint: disable=import-outside-toplevel
+
+    # If this library is imported into an interpreter that has a root logger
+    # configured (with handler(s) attached) then just propagate log messages
+    # into that hierarchy, and do not attach a handler to the 'fiddler' logger.
+    if not logging.getLogger().handlers and auto_attach_log_handler:
+        fiddler.utils.logger._attach_handler()
+        log.info(
+            'attached stderr handler to logger: auto_attach_log_handler=True, and root logger not configured'
+        )
+
+    # Singleton object in Python interpreter.
+    conn = Connection(
+        url=url,
+        token=token,
+        proxies=proxies,
+        timeout=timeout,
+        verify=verify,
+        validate=validate,
+    )
+
+    _set_conn(conn_=conn)

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/fiddler/constants/common.py

@@ -1,6 +1,4 @@
 CLIENT_NAME = 'python-sdk'
-LOGGER_NAME = 'fiddler'
-LOG_FORMAT = '%(asctime)s [%(name)s:%(lineno)d] %(levelname)s: %(message)s'
 TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S.%f'
 
 # Headers

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/fiddler/decorators.py

@@ -1,15 +1,16 @@
 from functools import wraps
 from http import HTTPStatus
+import logging
 from typing import Any, Callable, TypeVar, cast
 
 import requests
-import pydantic
+import pydantic.v1
 
 from fiddler.exceptions import ApiError, Conflict, HttpError, NotFound, Unsupported
 from fiddler.schemas.response import ErrorResponse
-from fiddler.utils.logger import get_logger
 
-logger = get_logger(__name__)
+
+logger = logging.getLogger(__name__)
 
 _WrappedFuncType = TypeVar(  # pylint: disable=invalid-name
     '_WrappedFuncType', bound=Callable[..., Any]
@@ -57,7 +58,7 @@ def handle_api_error(func: _WrappedFuncType) -> _WrappedFuncType:  # noqa: C901
             try:
                 # https://github.com/fiddler-labs/fiddler/issues/9314
                 error_resp = ErrorResponse(**http_exc.response.json())
-            except pydantic.ValidationError:
+            except pydantic.v1.ValidationError:
                 # We couldn't turn the HTTP error response into an object
                 # satisfying model='ErrorResponse'. Now, instead of exposing
                 # this to users as a pydantic.ValidationError (which is kinda

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/fiddler/entities/alert_rule.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import builtins
+import logging
 from datetime import datetime
 from typing import Any, Iterator
 from uuid import UUID
@@ -15,9 +16,9 @@ from fiddler.entities.model import ModelCompactMixin
 from fiddler.entities.project import ProjectCompactMixin
 from fiddler.schemas.alert_rule import AlertRuleResp, NotificationConfig
 from fiddler.schemas.filter_query import OperatorType, QueryCondition, QueryRule
-from fiddler.utils.logger import get_logger
 
-logger = get_logger(__name__)
+
+logger = logging.getLogger(__name__)
 
 
 class AlertRule(
@@ -235,6 +236,7 @@ class AlertRule(
         response = self._client().post(
             url=self._get_url(),
             data=payload,
+            headers={'Content-Type': 'application/json'},
         )
 
         self._refresh_from_response(response=response)
@@ -244,7 +246,7 @@ class AlertRule(
     def enable_notifications(self) -> None:
         """Enable notifications for an alert rule"""
         self._client().patch(
-            url=self._get_url(id_=self.id), data={'enable_notification': True}
+            url=self._get_url(id_=self.id), json={'enable_notification': True}
         )
         logger.info(
             'notifications have been enabled for alert rule with id: %s', self.id
@@ -254,7 +256,7 @@ class AlertRule(
     def disable_notifications(self) -> None:
         """Disable notifications for an alert rule"""
         self._client().patch(
-            url=self._get_url(id_=self.id), data={'enable_notification': False}
+            url=self._get_url(id_=self.id), json={'enable_notification': False}
         )
         logger.info(
             'Notifications have been disabled for alert rule with id: %s', self.id
@@ -293,6 +295,7 @@ class AlertRule(
         response = self._client().patch(
             url=self._get_notification_url(id_=self.id),
             data=payload,
+            headers={'Content-Type': 'application/json'},
         )
 
         return NotificationConfig(**response.json()['data'])

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/fiddler/entities/baseline.py

@@ -1,3 +1,5 @@
+# pylint: disable=E1101
+# E1101: Instance of 'FieldInfo' has no 'type' member (no-member)
 from __future__ import annotations
 
 from dataclasses import dataclass
@@ -17,9 +19,7 @@ from fiddler.schemas.filter_query import OperatorType, QueryCondition, QueryRule
 from fiddler.utils.helpers import raise_not_found
 
 
-class Baseline(
-    BaseEntity, ModelCompactMixin, ProjectCompactMixin, DatasetCompactMixin
-):  # pylint: disable=too-many-instance-attributes
+class Baseline(BaseEntity, ModelCompactMixin, ProjectCompactMixin, DatasetCompactMixin):  # pylint: disable=too-many-instance-attributes
     def __init__(  # pylint: disable=too-many-arguments
         self,
         name: str,
@@ -219,6 +219,7 @@ class Baseline(
         response = self._client().post(
             url=self._get_url(),
             data=payload,
+            headers={'Content-Type': 'application/json'},
         )
         self._refresh_from_response(response=response)
         return self

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/fiddler/entities/custom_expression.py

@@ -173,6 +173,7 @@ class CustomExpression(BaseEntity, ModelCompactMixin, ProjectCompactMixin):
         response = self._client().post(
             url=self._get_url(),
             data=payload,
+            headers={'Content-Type': 'application/json'},
         )
         self._refresh_from_response(response=response)
         return self

{fiddler_client-3.6.0.dev1 → fiddler_client-3.7.0}/fiddler/entities/events.py

@@ -5,6 +5,7 @@ import tempfile
 from pathlib import Path
 from typing import Any, Callable
 from uuid import UUID
+import logging
 
 import pandas as pd
 from requests import Response
@@ -18,9 +19,8 @@ from fiddler.entities.job import Job
 from fiddler.schemas.dataset import EnvType
 from fiddler.schemas.events import EventsSource, FileSource
 from fiddler.schemas.job import JobCompactResp
-from fiddler.utils.logger import get_logger
 
-logger = get_logger(__name__)
+logger = logging.getLogger(__name__)
 
 
 class EventPublisher(ConnectionMixin):
@@ -98,9 +98,10 @@ class EventPublisher(ConnectionMixin):
             temp_file.close()
             return job
 
-        except Exception:
+        except Exception as exc:  # pylint: disable=broad-exception-caught
             logger.warning(
-                'Failed to convert input dataframe to parquet format. Retrying as a CSV file.'
+                'Failed to convert input dataframe to parquet format. Retrying as a CSV file. Errors was: %s',
+                exc,
             )
 
         finally:
@@ -147,8 +148,12 @@ class EventPublisher(ConnectionMixin):
         dataset_name: str | None = None,
         update: bool = False,
     ) -> Job:
+        # This is meant to perform internal HTTP request retrying (is
+        # retry-safe).
         file = File(path=Path(source)).upload()
 
+        # What does it mean for `file.id` to be None? Note that sometimes a
+        # Python program is executed 'optimized' with assertions removed.
         assert file.id is not None
 
         response = self._publish_call(
@@ -157,6 +162,7 @@ class EventPublisher(ConnectionMixin):
             dataset_name=dataset_name,
             update=update,
         )
+
         job_compact = JobCompactResp(**response.json()['data']['job'])
         return Job.get(id_=job_compact.id)
 
@@ -171,6 +177,14 @@ class EventPublisher(ConnectionMixin):
             method = self._client().patch
         else:
             method = self._client().post
+
+        # TODO: Note(JP): we have to make this retry-safer in the backend by
+        # deduplicating on request body contents/hash. So that in the rare case
+        # when a retry is performed accidentally (non-authoritative error, such
+        # as a timeout error waiting for a resp) the backend does detect the
+        # duplication, and rejects the request with a conflict error (and the
+        # retry logic in the client must expect a conflict error upon attempts
+        # 2+, and should interpret such error as success).
         return method(
             url='/v3/events',
             data={
@@ -179,4 +193,5 @@ class EventPublisher(ConnectionMixin):
                 'env_type': environment,
                 'env_name': dataset_name,
             },
+            headers={'Content-Type': 'application/json'},
         )