arthur-client 1.4.0__py3-none-any.whl → 1.4.1186__py3-none-any.whl

arthur/common/exceptions.py

@@ -1,183 +0,0 @@
-import functools
-import inspect
-
-
-# Base Error
-class ArthurError(Exception):
-    """
-    Base Error for Arthur SDK. This class should not be used directly, Arthur exceptions should inherit from either
-    ArthurUserError or ArthurUnexpectedError.
-    """
-    pass
-
-
-# Two Secondary Errors which differentiate between exceptions that are the user's fault and Arthur's fault
-class ArthurUserError(ArthurError):
-    """
-    Exception raised due to incorrect user input to the Arthur SDK. Can be used directly but children are preferred.
-    """
-    pass
-
-
-class ArthurUnexpectedError(ArthurError):
-    """
-    Exception raised when user input is correct but an error occurs. Can be used directly but children are preferred.
-    """
-    pass
-
-
-class ArthurDownloadError(ArthurError):
-    """
-    Exception raised when failing to download from an external source e.g. S3.
-    """
-    pass
-
-
-# User Exceptions
-class MissingParameterError(ArthurUserError):
-    """
-    Exception raised when parameters supplied to the Arthur SDK are missing.
-    """
-    pass
-
-
-class UserValueError(ArthurUserError, ValueError):
-    """
-    Exception raised when a user supplies an invalid value to the Arthur SDK.
-    """
-    pass
-
-
-class UserTypeError(ArthurUserError, TypeError):
-    """
-    Exception raised when a user supplies an argument of the incorrect type to the Arthur SDK.
-    """
-    pass
-
-
-class MethodNotApplicableError(ArthurUserError):
-    """
-    Exception raised when the method called is not valid for the resource.
-    """
-    pass
-
-
-class ResponseClientError(ArthurUserError):
-    """
-    Exception raised when a 4XX response is received from the API.
-    """
-    pass
-
-
-class UnauthorizedError(ResponseClientError):
-    """
-    Exception raised when a 401 Unauthorized response is received from the API.
-    """
-    pass
-
-
-class PaymentRequiredError(ResponseClientError):
-    """
-    Exception raised when a 402 response is received from the API due to a user trying to access features not available
-    in their plan.
-    """
-    pass
-
-
-class ForbiddenError(ResponseClientError):
-    """
-    Exception raised when a 403 Forbidden response is received from the API.
-    """
-    pass
-
-
-class NotFoundError(ResponseClientError):
-    """
-    Exception raised when a 404 Not Found response is received from the API.
-    """
-    pass
-
-
-# Arthur Unexpected Exceptions
-class ExpectedParameterNotFoundError(ArthurUnexpectedError):
-    """
-    Exception raised when a field or property should be available from Arthur but is unexpectedly missing.
-    """
-    pass
-
-
-class UnexpectedValueError(ArthurUnexpectedError, ValueError):
-    """
-
-    Exception raised when a value is unexpected.
-    """
-    pass
-
-
-class UnexpectedTypeError(ArthurUnexpectedError, TypeError):
-    """
-
-    Exception raised when a value is unexpected.
-    """
-    pass
-
-
-class ResponseServerError(ArthurUnexpectedError):
-    """
-    Exception raised when a 5XX response is received from the API.
-    """
-
-
-class ResponseRedirectError(ArthurUnexpectedError):
-    """
-    Exception raised when a 3XX response is unexpectedly received from the API.
-    """
-
-
-def arthur_excepted(message=None):
-    """
-    Decorator to wrap user-facing Arthur functions with exception handling that describes to the user whether the error
-    is their fault or is our fault and should be reported.
-    :param message: an optional message to prefix the error with, should describe the failure e.g. "failed to send
-    inferences" or "an error occurred while creating the model."
-    :return: the decorator function
-    """
-    if message is None:
-        prefix = ""
-    else:
-        prefix = message + " because "
-
-    def decorator_arthur_excepted(func):
-        @functools.wraps(func)
-        def wrapper_arthur_excepted(*args, **kwargs):
-            # ensure all required parameters are present: check manually because TypeErrors from internal calls
-            #  should not be UserErrors
-            try:
-                inspect.signature(func).bind(*args, **kwargs)
-                success = True
-                err_msg = None
-            except TypeError as e:
-                success = False
-                err_msg = str(e)
-            if not success:
-                raise MissingParameterError(err_msg)
-
-            # call the function
-            try:
-                return func(*args, **kwargs)
-            # if it is a known error, simply re-raise
-            except ArthurError as e:
-                raise e
-            # otherwise wrap it in a message saying it's not the user's fault
-            except Exception as e:
-                raise ArthurUnexpectedError(prefix + f"there was an unexpected exception: {str(e)}\n"
-                                                     f"See the stacktrace above for details. "
-                                                     f"Please consider submitting this stack trace in its entirety, "
-                                                     f"and an explanation of the cause, to Arthur support.") from e
-
-        return wrapper_arthur_excepted
-
-    return decorator_arthur_excepted
-
-# TODO: TU-96 can we add custom linting steps to check that base exceptions aren't raised/caught and only arthur
-#  exceptions are used?

arthur/common/log.py

@@ -1,79 +0,0 @@
-
-import logging
-import sys
-from typing import Optional
-
-DEFAULT_LOG_LEVEL = logging.INFO
-
-# define formatters
-
-# e.g.: 17:31:27 - arthur - info message
-LITE_FORMATTER = logging.Formatter('%(asctime)s - arthur - %(message)s', "%H:%M:%S")
-# e.g.: 2022-10-13 17:31:27,703 - arthur.core.data_service - ERROR - error message
-FULL_FORMATTER = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
-
-
-# adapted from https://stackoverflow.com/a/16066513
-class InfoFilter(logging.Filter):
-    """
-    A logging filter to only log messages that are debug or info level (i.e. never log warning or error messages)
-    """
-    def filter(self, rec):
-        return rec.levelno in (logging.DEBUG, logging.INFO)
-
-
-def initialize_logging(name: Optional[str] = "arthur"):
-    """Creates a parent 'arthur' logger with a console output and INFO level.
-    """
-    # fetch logger and set default level
-    arthur_logger = logging.getLogger(name)
-    arthur_logger.setLevel(DEFAULT_LOG_LEVEL)
-
-    # create handlers
-
-    # stderr handler always uses the full formatter and logs to the "standard error" stream: this shows up as red text
-    #  in jupyter notebooks. it logs warning and error messages in this way
-    stderr_handler = logging.StreamHandler()
-    stderr_handler.setLevel(logging.WARNING)
-    stderr_handler.setFormatter(FULL_FORMATTER)
-
-    # stdout handler by default uses the lite formatter and logs to the "standard out" stream: this shows up as regular
-    #  text in jupyter notebooks. it logs debug and info messages, but the debug messages don't make it through the
-    #  'arthur' logger log level set at the top of this function in practice
-    stdout_handler = logging.StreamHandler(sys.stdout)
-    stdout_handler.setLevel(logging.DEBUG)
-    stdout_handler.addFilter(InfoFilter())
-    stdout_handler.setFormatter(LITE_FORMATTER)
-
-    # add handlers to logger
-    arthur_logger.handlers = []
-    arthur_logger.addHandler(stdout_handler)
-    arthur_logger.addHandler(stderr_handler)
-
-
-def _set_arthur_log_level(level: int):
-    logging.getLogger("arthur").setLevel(level)
-
-
-def enable_debug_logging():
-    """Enables debug logging for the arthur package. Note that log messages may be dropped while this function is
-     being executed.
-    """
-    # recreate single handler to output everything to stderr
-    stderr_handler = logging.StreamHandler()
-    stderr_handler.setLevel(logging.DEBUG)
-    stderr_handler.setFormatter(FULL_FORMATTER)
-
-    # set new handler to be the only one
-    logger = logging.getLogger("arthur")
-    logger.handlers = []
-    logger.addHandler(stderr_handler)
-
-    _set_arthur_log_level(logging.DEBUG)
-
-
-def disable_debug_logging():
-    """Disables debug logging for the arthur package.  Note that log messages may be dropped while this function is
-     being executed.
-    """
-    initialize_logging()

arthur_client-1.4.0.dist-info/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Arthur
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

arthur_client-1.4.0.dist-info/METADATA

@@ -1,49 +0,0 @@
-Metadata-Version: 2.1
-Name: arthur-client
-Version: 1.4.0
-Summary: Arthur API Python Client
-Author-email: Arthur <info@arthur.ai>
-License: MIT
-Project-URL: Arthur Homepage, https://arthur.ai
-Project-URL: Documentation, https://docs.arthur.ai
-Keywords: api arthur ArthurAI client ml model monitoring llm
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests <3,>=2.13.0
-Requires-Dist: requests-toolbelt <1,>=0.9
-Requires-Dist: pydantic <2,>=1.10
-Requires-Dist: pyjwt <3,>=2.6
-Requires-Dist: urllib3 <2
-Requires-Dist: pytz >=2022.7
-
-# Arthur Client
-
-This library provides a lightweight Python API for interacting with [Arthur's REST API](https://docs.arthur.ai/reference/getting-started-with-your-api).  
-
-### Example: Fetch Models
-
-```python
-from typing import List
-from arthur.client.rest import ArthurClient
-from arthur.client.rest.models.models import ModelResponse
-
-# create client
-client = ArthurClient(url="https://app.arthur.ai",
-                      login="<my_username>")
-# enter your password when prompted
-
-# fetch first page of models
-models_p1: List[ModelResponse] = client.models.get_paginated_models(page=1, page_size=10).data
-
-# print model names
-print(f"Found {len(models_p1)} models on first page: {', '.join([m.display_name for m in models_p1])}")
-```
-

arthur_client-1.4.0.dist-info/RECORD

@@ -1,58 +0,0 @@
-arthur/client/__init__.py,sha256=hLwS66smzK1qUEyhyvXqZ_2L47IKkM7fjVNj7L2d24k,57
-arthur/client/helpers.py,sha256=toTAqb-r8SuvXXyy4ohef_2DOEyp8V7SidXL9W3gbxA,1457
-arthur/client/types.py,sha256=GufCfBBWoTe9MiH2NVSELgh-kJOvuj1-SiPcW0LKqGI,234
-arthur/client/version.py,sha256=5Kyme7PuChQ8sJDf7U9uYmEiGoTA5UG2jpJr9b3g7mU,49
-arthur/client/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arthur/client/auth/helpers.py,sha256=zIfbUh6JqyXGs6cq26xjY0M4nQfcU5YWUwLO_h0G534,4987
-arthur/client/auth/refresh.py,sha256=Zn56iptWjnLGT0DIRsBSoRIBUPOB-7dLqVG-FZYW9yo,2681
-arthur/client/http/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arthur/client/http/helper.py,sha256=gflUKxI7WgfR4AAcXOJFD7V5q3n5cF0kQoA_OVkXC50,1605
-arthur/client/http/requests.py,sha256=sPIEfzNddFvqgYxnrfK5ayjM-Xo668ofh4tjj2Qn8Ac,29697
-arthur/client/http/validation.py,sha256=Kao7RWdAfZPhoAYKMus0zOtdEWWYxND2spdfjJeqLpo,8175
-arthur/client/rest/__init__.py,sha256=LA1HL5LlXNw2zck-rWpCKU1lgsgWJa_fKovE2SmgIJE,346
-arthur/client/rest/client.py,sha256=Hg_YkiNHKF8rrGgRqxH4alTnVYcX13Vkj5PSMTqn3Pk,7003
-arthur/client/rest/admin/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/admin/client.py,sha256=lRLBkR8NiGQumqhJBFGsZM_eRIXyRFgljU6kJwPTwAU,10629
-arthur/client/rest/admin/models.py,sha256=mvQVIFz9Zt2weXEw7OVTPQNcfuPXzRC_YWOuUu_JlVY,15398
-arthur/client/rest/alerts/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/alerts/client.py,sha256=-RAhKM05GUhw307b-f0ept4Fy6n3SwF3onXbAYCXLA8,20399
-arthur/client/rest/alerts/models.py,sha256=n-hV2UUbN8ZgEZQnUJDY4wzNR4Axpn3IHw7j0IcQayw,19582
-arthur/client/rest/bench/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/bench/client.py,sha256=eRVemQiqYvXqntjKzyICdvrPgbzXD780LXDfHHQBYRs,8558
-arthur/client/rest/bench/models.py,sha256=XdwAJPSytjjxHnCJeP0guLnkDast53-imAQxvEJmQws,5328
-arthur/client/rest/common/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/common/client.py,sha256=wd24QtCkGKvzbWVhKxwUYxZsoaN6YU-NheQIv6k6YHo,701
-arthur/client/rest/common/models.py,sha256=vXN_CA5Q3DEwPLv1BiKA3HpExVP16FJKvPumpesNhJs,10006
-arthur/client/rest/enrichments/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/enrichments/client.py,sha256=U8LOVm_MXZMqmtoqx6ASEK2Nl-19CZbEyEQlPqpl4xI,12252
-arthur/client/rest/enrichments/models.py,sha256=1MSiiUyCZ99X9jpqpZZKXg4LjVh0stiXmasygHMVxSI,14382
-arthur/client/rest/inferences/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/inferences/client.py,sha256=r38R6SZmz3MEwSlev56DBuwaDccWsaXGZjZOP-Q8pSU,10013
-arthur/client/rest/inferences/models.py,sha256=UgfPjj425JZ5kiWJ59CTDVEIG06Kc6At4V4ux99JDzA,12571
-arthur/client/rest/insights/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/insights/client.py,sha256=8ok5oDzdBeytwMAjuSuyTI8xh_C72w1czo3mpxO7GVw,6364
-arthur/client/rest/insights/models.py,sha256=zhsmChgqIykmPxfH6YmZB3xhsg1olYjFVJ07G6Rbi5M,4263
-arthur/client/rest/metrics/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/metrics/client.py,sha256=jjynBs2qi1b0x3wGwruKpDn9RJ_FuTZ3Y54kjh-eme0,9819
-arthur/client/rest/metrics/models.py,sha256=BeEr58HpNfgYrOEDZw5GDUnaqnTL7PfkR5EQIN0QZhc,8267
-arthur/client/rest/model_groups/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/model_groups/client.py,sha256=A4_n_G-dejm4Ln5d6qAS83I6xAqz9qbUn0SXteoTxhI,5020
-arthur/client/rest/model_groups/models.py,sha256=FFAjdV3mLozVUlnIk0nnYjpXfDxI9WFq8I00VvoQ3RU,2151
-arthur/client/rest/models/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/models/client.py,sha256=AB1pIDD3TphjloDa5dBMwe8Nxhqen4hJ_veKJQrw2DM,19785
-arthur/client/rest/models/models.py,sha256=uHd-0utKgsKq-pEtRbMAXltE891nFD-f89QUzjOZ9po,17733
-arthur/client/rest/query/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/query/client.py,sha256=EIpEqcn7m-a3Ku3KO95NINdx83ggfOmGdin0Z0oHH3E,4125
-arthur/client/rest/query/models.py,sha256=f-nWdd3LXJW6SVtPiNmYW3XzhjuqyvlxoiCl0w-Z0Yw,4223
-arthur/client/rest/users/__init__.py,sha256=FdmrkBO-lbpLjMuaRZBDGhEnapOBYLP6U7j0-PqKpKw,42
-arthur/client/rest/users/client.py,sha256=LN0j0tJtVWs1lUtwTSKXX5gobMmgWvm8oYQIIAUsHjw,5130
-arthur/client/rest/users/models.py,sha256=7RE44h8sbv_KKxew85V3ms9MzqmUH4IFWKrA60kkUSw,8943
-arthur/common/__init__.py,sha256=ZPrXCVGLk4xZJQhuxYHKQYWUOpa3uHsqhf0T8qzgpjQ,68
-arthur/common/constants.py,sha256=4_o_WDbtoOJ7kANCV28HdFbDJDO90k2TGULHxjqeSao,159
-arthur/common/exceptions.py,sha256=m_lGhrb-EoMZCq6XjYPJLQEfAhYkE7h0Wuz0bNMtV4c,5230
-arthur/common/log.py,sha256=oDB_teFV-pdDfcM3VGSSWYSOu6Iag_3RyzRDWBcIcOM,2851
-arthur_client-1.4.0.dist-info/LICENSE,sha256=a0qChOPgo0vduazUlCCpPkJ4A7nOtvBTbbvNh6qDmhw,1063
-arthur_client-1.4.0.dist-info/METADATA,sha256=ZVSBU6vLC1Eh0t8GUrWB8T7_gbuXkmmhO4Hq16-qTpA,1737
-arthur_client-1.4.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-arthur_client-1.4.0.dist-info/top_level.txt,sha256=u8s5CFDcE7LoZePEhTOipwnPqeiXh4_hYXJp7vg5BLQ,7
-arthur_client-1.4.0.dist-info/RECORD,,

arthur_client-1.4.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-arthur