looker-sdk 24.16.2__py3-none-any.whl → 24.18.0__py3-none-any.whl

looker_sdk/version.py

@@ -20,4 +20,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-__version__ = "24.16.2"
+__version__ = "24.18.0"

{looker_sdk-24.16.2.dist-info → looker_sdk-24.18.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: looker-sdk
-Version: 24.16.2
+Version: 24.18.0
 Summary: Looker REST API
 Home-page: https://pypi.python.org/pypi/looker_sdk
 Author: Looker Data Sciences, Inc.

looker_sdk-24.18.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+looker_sdk/__init__.py,sha256=0UOw2v-BP1bNoBIIm-BnyKUpGQB3Zx-JZRmpYyLiIuY,2589
+looker_sdk/error.py,sha256=XTKuy1zEyhSVd-VCWHKB2zVjj0X7VUzVwq9y9L22Bo0,4941
+looker_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+looker_sdk/version.py,sha256=yXV-fBxVicsLoKDd9IOghQocwVxB_xDkPB65URlYiF0,1156
+looker_sdk-24.18.0.dist-info/LICENSE.txt,sha256=N4Rmmbuo5EryYSCXcvjuXL1ZXwyXanRzuGP-dJzwsoE,1094
+looker_sdk-24.18.0.dist-info/METADATA,sha256=dICNCD4P_hznPEaK-jOitIUoitWyMiFR91ufqVT7HP0,7022
+looker_sdk-24.18.0.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+looker_sdk-24.18.0.dist-info/top_level.txt,sha256=xviIw22PmtLgfOpj_Hhv_CyPTEHXPD3dJdzYTlloICU,11
+looker_sdk-24.18.0.dist-info/RECORD,,

{looker_sdk-24.16.2.dist-info → looker_sdk-24.18.0.dist-info}/top_level.txt

@@ -1,2 +1 @@
 looker_sdk
-tests

looker_sdk/rtl/__init__.py

@@ -1,22 +0,0 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2019 Looker Data Sciences, Inc.
-#
-# 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.
-

looker_sdk/rtl/api_methods.py

@@ -1,247 +0,0 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2019 Looker Data Sciences, Inc.
-#
-# 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.
-
-"""Functionality for making authenticated API calls
-"""
-import datetime
-import json
-from typing import Any, MutableMapping, Optional, Sequence, Type, Union
-import urllib.parse
-
-from looker_sdk import error
-from looker_sdk.rtl import model
-from looker_sdk.rtl import serialize
-from looker_sdk.rtl import transport
-from looker_sdk.rtl import auth_session
-
-
-TBody = Optional[
-    Union[
-        str,
-        MutableMapping[str, str],
-        Sequence[str],
-        Sequence[int],
-        model.Model,
-        Sequence[model.Model],
-    ]
-]
-TStructure = Optional[Union[Any, Type[str], serialize.TStructure]]
-TReturn = Optional[Union[str, bytes, serialize.TDeserializeReturn]]
-TQueryParams = MutableMapping[
-    str, Union[None, bool, str, int, Sequence[int], Sequence[str], datetime.datetime]
-]
-
-
-class APIMethods:
-    """Functionality for making authenticated API calls"""
-
-    def __init__(
-        self,
-        auth: auth_session.AuthSession,
-        deserialize: serialize.TDeserialize,
-        serialize: serialize.TSerialize,
-        transport: transport.Transport,
-        api_version: str,
-    ):
-        self.auth = auth
-        self.api_path = urllib.parse.urljoin(
-            auth.settings.base_url, f"/api/{api_version}/"
-        )
-        self.deserialize = deserialize
-        self.serialize = serialize
-        self.transport = transport
-
-    def _path(self, path: str) -> str:
-        if path[0] == "/":
-            path = path[1:]
-        return urllib.parse.urljoin(self.api_path, path)
-
-    def __enter__(self) -> "APIMethods":
-        return self
-
-    def __exit__(self, *exc) -> None:
-        self.auth.logout()
-
-    def _return(self, response: transport.Response, structure: TStructure) -> TReturn:
-        encoding = response.encoding
-        if not response.ok:
-            value = response.value.decode(encoding=encoding)
-            sdk_error: error.SDKError
-            try:
-                sdk_error = self.deserialize(data=value, structure=error.SDKError)  # type: ignore
-                helper = error.ErrorDocHelper()
-                (sdk_error.error_doc_url, sdk_error.error_doc) = (
-                    helper.parse_and_lookup(sdk_error.documentation_url)
-                )
-                for e in sdk_error.errors:
-                    (e.error_doc_url, e.error_doc) = helper.parse_and_lookup(
-                        e.documentation_url
-                    )
-            except serialize.DeserializeError:
-                raise error.SDKError(value)
-            raise sdk_error
-        ret: TReturn
-        if structure is None:
-            ret = None
-        elif response.response_mode == transport.ResponseMode.BINARY:
-            ret = response.value
-        else:
-            value = response.value.decode(encoding=encoding)
-            if structure is Union[str, bytes] or structure is str or value == "":  # type: ignore
-                ret = value
-            else:
-                # ignore type: mypy bug doesn't recognized kwarg
-                # `structure` to partial func
-                ret = self.deserialize(data=value, structure=structure)  # type: ignore
-        return ret
-
-    def _convert_query_params(
-        self, query_params: TQueryParams
-    ) -> MutableMapping[str, str]:
-        params: MutableMapping[str, str] = {}
-        for k, v in query_params.items():
-            if v is None:
-                continue
-            if isinstance(v, datetime.datetime):
-                params[k] = f'{v.isoformat(timespec="minutes")}Z'
-            elif isinstance(v, str):
-                params[k] = v
-            elif isinstance(v, model.DelimSequence):
-                params[k] = str(v)
-            else:
-                params[k] = json.dumps(v)
-        return params
-
-    @staticmethod
-    def encode_path_param(value: str) -> str:
-        if value == urllib.parse.unquote(value):
-            value = urllib.parse.quote(value, safe="")
-        return value
-
-    def get(
-        self,
-        path: str,
-        structure: TStructure,
-        query_params: Optional[TQueryParams] = None,
-        transport_options: Optional[transport.TransportOptions] = None,
-    ) -> TReturn:
-        """GET method"""
-        params = self._convert_query_params(query_params) if query_params else None
-        response = self.transport.request(
-            transport.HttpMethod.GET,
-            self._path(path),
-            query_params=params,
-            body=None,
-            authenticator=self.auth.authenticate,
-            transport_options=transport_options,
-        )
-        return self._return(response, structure)
-
-    def _get_serialized(self, body: TBody) -> Optional[bytes]:
-        serialized: Optional[bytes]
-        if isinstance(body, str):
-            serialized = body.encode("utf-8")
-        elif isinstance(body, (list, dict, model.Model)):
-            serialized = self.serialize(api_model=body)  # type: ignore
-        else:
-            serialized = None
-        return serialized
-
-    def post(
-        self,
-        path: str,
-        structure: TStructure,
-        query_params: Optional[TQueryParams] = None,
-        body: TBody = None,
-        transport_options: Optional[transport.TransportOptions] = None,
-    ) -> TReturn:
-        """POST method"""
-        params = self._convert_query_params(query_params) if query_params else None
-        serialized = self._get_serialized(body)
-        response = self.transport.request(
-            transport.HttpMethod.POST,
-            self._path(path),
-            query_params=params,
-            body=serialized,
-            authenticator=self.auth.authenticate,
-            transport_options=transport_options,
-        )
-        return self._return(response, structure)
-
-    def patch(
-        self,
-        path: str,
-        structure: TStructure,
-        query_params: Optional[TQueryParams] = None,
-        body: TBody = None,
-        transport_options: Optional[transport.TransportOptions] = None,
-    ) -> TReturn:
-        """PATCH method"""
-        params = self._convert_query_params(query_params) if query_params else None
-        serialized = self._get_serialized(body)
-        response = self.transport.request(
-            transport.HttpMethod.PATCH,
-            self._path(path),
-            query_params=params,
-            body=serialized,
-            authenticator=self.auth.authenticate,
-            transport_options=transport_options,
-        )
-        return self._return(response, structure)
-
-    def put(
-        self,
-        path: str,
-        structure: TStructure = None,
-        query_params: Optional[TQueryParams] = None,
-        body: TBody = None,
-        transport_options: Optional[transport.TransportOptions] = None,
-    ) -> TReturn:
-        """PUT method"""
-        params = self._convert_query_params(query_params) if query_params else None
-        serialized = self._get_serialized(body)
-        response = self.transport.request(
-            transport.HttpMethod.PUT,
-            self._path(path),
-            query_params=params,
-            body=serialized,
-            authenticator=self.auth.authenticate,
-            transport_options=transport_options,
-        )
-        return self._return(response, structure)
-
-    def delete(
-        self,
-        path: str,
-        structure: TStructure = None,
-        query_params: Optional[TQueryParams] = None,
-        transport_options: Optional[transport.TransportOptions] = None,
-    ) -> TReturn:
-        """DELETE method"""
-        response = self.transport.request(
-            transport.HttpMethod.DELETE,
-            self._path(path),
-            body=None,
-            authenticator=self.auth.authenticate,
-            transport_options=transport_options,
-        )
-        return self._return(response, structure)

looker_sdk/rtl/api_settings.py

@@ -1,194 +0,0 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2019 Looker Data Sciences, Inc.
-#
-# 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.
-
-"""Load settings from .ini file and create an ApiSettings object
-with the settings as attributes
-"""
-import configparser as cp
-import os
-import sys
-from typing import Dict, Optional, Set, cast
-import warnings
-
-from looker_sdk.rtl import transport
-
-if sys.version_info >= (3, 8):
-    from typing import Protocol, TypedDict
-else:
-    from typing_extensions import Protocol, TypedDict
-from typing_extensions import Required
-
-
-class SettingsConfig(TypedDict, total=False):
-    client_id: Required[str]
-    client_secret: Required[str]
-    base_url: str
-    verify_ssl: str
-    timeout: str
-    redirect_uri: str
-    looker_url: str
-
-
-class PApiSettings(transport.PTransportSettings, Protocol):
-    def read_config(self) -> SettingsConfig:
-        ...
-
-
-_DEFAULT_INIS = ["looker.ini", "../looker.ini"]
-
-
-class ApiSettings(PApiSettings):
-    deprecated_settings: Set[str] = {"api_version", "embed_secret", "user_id"}
-
-    def __init__(
-        self,
-        *,
-        filename: str = _DEFAULT_INIS[0],
-        section: Optional[str] = None,
-        sdk_version: Optional[str] = "",
-        env_prefix: Optional[str] = None,
-    ):
-        """Configure using a config file and/or environment variables.
-
-        Environment variables will override config file settings. Neither
-        is necessary but some combination must supply the minimum to
-        instantiate ApiSettings.
-
-        ENV variables map like this:
-            <package-prefix>_BASE_URL -> base_url
-            <package-prefix>_VERIFY_SSL -> verify_ssl
-
-        Args:
-            filename (str): config file. If specified, the file must exist.
-                If not specified and the default value of "looker.ini" does not
-                exist then no error is raised.
-            section (str): section in config file. If not supplied default to
-                reading first section.
-        """
-        if not os.path.isfile(filename):
-            if filename and filename not in _DEFAULT_INIS:
-                raise FileNotFoundError(f"No config file found: '{filename}'")
-
-        self.filename = filename
-        self.section = section
-        self.env_prefix = env_prefix
-        data = self.read_config()
-        verify_ssl = data.get("verify_ssl")
-        if verify_ssl is None:
-            self.verify_ssl = True
-        else:
-            self.verify_ssl = self._bool(verify_ssl)
-        self.base_url = data.get("base_url", "")
-        self.timeout = int(data.get("timeout", 120))
-        self.headers = {"Content-Type": "application/json"}
-        self.agent_tag = f"{transport.AGENT_PREFIX}"
-        if sdk_version:
-            self.agent_tag += f" {sdk_version}"
-
-    def read_config(self) -> SettingsConfig:
-        cfg_parser = cp.ConfigParser()
-        data: SettingsConfig = {
-            "client_id": "",
-            "client_secret": "",
-        }
-        try:
-            config_file = open(self.filename)
-        except FileNotFoundError:
-            pass
-        else:
-            cfg_parser.read_file(config_file)
-            config_file.close()
-            # If section is not specified, use first section in file
-            section = self.section or cfg_parser.sections()[0]
-            if not cfg_parser.has_section(section):
-                raise cp.NoSectionError(section)
-            self._override_settings(data, dict(cfg_parser[section]))
-
-        if self.env_prefix:
-            self._override_settings(data, self._override_from_env())
-        return self._clean_input(data)
-
-    @staticmethod
-    def _bool(val: str) -> bool:
-        if val.lower() in ("yes", "y", "true", "t", "1"):
-            converted = True
-        elif val.lower() in ("", "no", "n", "false", "f", "0"):
-            converted = False
-        else:
-            raise TypeError
-        return converted
-
-    def _override_settings(
-        self, data: SettingsConfig, overrides: Dict[str, str]
-    ) -> SettingsConfig:
-        # https://github.com/python/mypy/issues/6262
-        for setting in SettingsConfig.__annotations__.keys(): # type: ignore
-            if setting in overrides:
-                data[setting] = overrides[setting] # type: ignore
-        return data
-
-    def _override_from_env(self) -> Dict[str, str]:
-        overrides = {}
-        base_url = os.getenv(f"{self.env_prefix}_BASE_URL")
-        if base_url:
-            overrides["base_url"] = base_url
-
-        verify_ssl = os.getenv(f"{self.env_prefix}_VERIFY_SSL")
-        if verify_ssl:
-            overrides["verify_ssl"] = verify_ssl
-
-        timeout = os.getenv(f"{self.env_prefix}_TIMEOUT")
-        if timeout:
-            overrides["timeout"] = timeout
-
-        client_id = os.getenv(f"{self.env_prefix}_CLIENT_ID")
-        if client_id:
-            overrides["client_id"] = client_id
-
-        client_secret = os.getenv(f"{self.env_prefix}_CLIENT_SECRET")
-        if client_secret:
-            overrides["client_secret"] = client_secret
-
-        return overrides
-
-    def _clean_input(self, data: SettingsConfig) -> SettingsConfig:
-        """Remove surrounding quotes and discard empty strings.
-        """
-        cleaned = {}
-        for setting, value in data.items():
-            if setting in self.deprecated_settings:
-                warnings.warn(
-                    message=DeprecationWarning(
-                        f"'{setting}' config setting is deprecated"
-                    )
-                )
-            if not isinstance(value, str):
-                continue
-            # Remove empty setting values
-            if value in ['""', "''", ""]:
-                continue
-            # Strip quotes from setting values
-            elif value.startswith(('"', "'")) or value.endswith(('"', "'")):
-                cleaned[setting] = value.strip("\"'")
-            else:
-                cleaned[setting] = value
-        return cast(SettingsConfig, cleaned)