looker-sdk 24.2.0__py3-none-any.whl → 24.4.0__py3-none-any.whl

looker_sdk/error.py

@@ -21,33 +21,128 @@
 # THE SOFTWARE.
 
 import attr
-from typing  import Optional, Sequence
+from typing import cast, Dict, Optional, Sequence, Tuple
+import requests
+import json
+import re
 
 """API error class
 """
 
+
 @attr.s(auto_attribs=True, kw_only=True)
-class ErrorDetail():
+class ErrorDetail:
     """Error detail:
-        documentation_url: documentation link
-        field: field with error
-        code: error code
-        message: error info message
+    documentation_url: documentation link
+    field: field with error
+    code: error code
+    message: error info message
+    error_doc_url: URL that may point to additional useful information
+    error_doc: Markdown doc that may contain additional useful information
     """
+
     documentation_url: str
     field: Optional[str] = ""
     code: Optional[str] = ""
     message: Optional[str] = ""
+    error_doc_url: str = ""
+    error_doc: str = ""
+
+    def __str__(self):
+        return f"""
+        *****
+        documentation_url: {self.documentation_url}
+        field:             {self.field}
+        code:              {self.code}
+        message:           {self.message}
+        error_doc_url:     {self.error_doc_url}
+        """
 
 
 @attr.s(auto_attribs=True)
 class SDKError(Exception):
     """API error class:
-        message: main error info message
-        errors: array of error details
-        documentation_url: documentation link
+    message: main error info message
+    errors: array of error details
+    documentation_url: documentation link
+    error_doc_url: URL that may point to additional useful information
+    error_doc: Markdown doc that may contain additional useful information
     """
 
     message: str
-    errors: Optional[Sequence[ErrorDetail]] = attr.ib(default=[], kw_only=True)
-    documentation_url: Optional[str] = attr.ib(default="", kw_only=True)
+    errors: Sequence[ErrorDetail] = attr.ib(default=[], kw_only=True)
+    documentation_url: str = attr.ib(default="", kw_only=True)
+    error_doc_url: str = ""
+    error_doc: str = ""
+
+    def __str__(self):
+        sep = "****\n"
+        return f"""
+    message:           {self.message}
+    documentation_url: {self.documentation_url}
+    error_doc_url:     {self.error_doc_url}
+    error details:
+    {sep.join(self.errors)}
+    """
+
+
+"""Error Doc Helper class
+"""
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class ErrorDocHelper:
+    """Error Doc Helper:
+    error_doc_url: link
+    """
+
+    ERROR_CODES_URL: str = "https://static-a.cdn.looker.app/errorcodes/"
+    lookup_dict: Dict[str, Dict[str, str]] = {}
+    RE_PATTERN: str = (
+        """(https://docs\.looker\.com/r/err/|https://cloud\.google\.com/looker/docs/r/err/)(.*)/(\d{3})(.*)"""
+    )
+    pattern = re.compile(RE_PATTERN, flags=re.IGNORECASE)
+
+    def get_index(self, url: str = ERROR_CODES_URL) -> None:
+        r = requests.get(f"{url}index.json")
+        self.lookup_dict = json.loads(r.text)
+
+    def lookup(
+        self, url: str = ERROR_CODES_URL, code: str = "", path: str = ""
+    ) -> Tuple[str, str]:
+        if len(self.lookup_dict) == 0:
+            self.get_index(url=url)
+
+        error_doc_url: str = ""
+        error_doc: str = ""
+        if path:
+            try:
+                error_doc_url = self.lookup_dict[f"{code}{path}"]["url"]
+            except KeyError:
+                error_doc = f"### No documentation found for {code}{path}"
+        if not error_doc_url:
+            try:
+                error_doc_url = self.lookup_dict[code]["url"]
+            except KeyError:
+                if not error_doc:
+                    error_doc = f"### No documentation found for {code}"
+
+        if error_doc_url:
+            r = requests.get(f"{self.ERROR_CODES_URL}{error_doc_url}")
+            error_doc = r.text
+
+        return (f"{self.ERROR_CODES_URL}{error_doc_url}", error_doc)
+
+    def parse_and_lookup(
+        self, error_url: str, url: str = ERROR_CODES_URL
+    ) -> Tuple[str, str]:
+        m = re.search(self.RE_PATTERN, error_url)
+        if not m:
+            return ("", "")
+
+        code: str = cast(Tuple[str, str, str, str], m.groups())[2]
+        path: str = cast(Tuple[str, str, str, str], m.groups())[3]
+        try:
+            return self.lookup(url=url, code=code, path=path)
+        except requests.exceptions.RequestException:
+            return ("", "")

looker_sdk/rtl/api_methods.py

@@ -87,7 +87,15 @@ class APIMethods:
             value = response.value.decode(encoding=encoding)
             sdk_error: error.SDKError
             try:
-                sdk_error = self.deserialize(data=value, structure=error.SDKError) # type: ignore
+                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

looker_sdk/sdk/api40/models.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 #
 
-# 339 API models: 256 Spec, 0 Request, 61 Write, 22 Enum
+# 340 API models: 257 Spec, 0 Request, 61 Write, 22 Enum
 
 
 # NOTE: Do not edit this file generated by Looker SDK Codegen for API 4.0
@@ -5778,65 +5778,17 @@ InvestigativeContentType.__new__ = model.safe_enum__new__  # type: ignore
 class JsonBi(model.Model):
     """
     Attributes:
-        big_query_metadata:
-        fields:
-        pivots: Pivots
-        has_subtotals: If the query has subtotals
-        has_totals: If the query has totals
-        columns_truncated: If the query results hit the maximum column limit and additional columns were truncated
-        filter_expression: Filter expression applied to the query results
-        filters: Filters applied to the query results
-        sql: Raw sql query. Null if user does not have permission to view sql
-        data: Json query results
+        metadata:
+        rows: Json query results
     """
 
-    big_query_metadata: "JsonBiBigQueryMetadata"
-    fields: "JsonBiFields"
-    pivots: Sequence["JsonBiPivots"]
-    has_subtotals: bool
-    has_totals: bool
-    columns_truncated: str
-    filter_expression: str
-    filters: MutableMapping[str, Any]
-    sql: str
-    data: Sequence[str]
-    __annotations__ = {
-        "big_query_metadata": ForwardRef("JsonBiBigQueryMetadata"),
-        "fields": ForwardRef("JsonBiFields"),
-        "pivots": Sequence["JsonBiPivots"],
-        "has_subtotals": bool,
-        "has_totals": bool,
-        "columns_truncated": str,
-        "filter_expression": str,
-        "filters": MutableMapping[str, Any],
-        "sql": str,
-        "data": Sequence[str],
-    }
+    metadata: "JsonBiMetadata"
+    rows: Sequence[str]
+    __annotations__ = {"metadata": ForwardRef("JsonBiMetadata"), "rows": Sequence[str]}
 
-    def __init__(
-        self,
-        *,
-        big_query_metadata: "JsonBiBigQueryMetadata",
-        fields: "JsonBiFields",
-        pivots: Sequence["JsonBiPivots"],
-        has_subtotals: bool,
-        has_totals: bool,
-        columns_truncated: str,
-        filter_expression: str,
-        filters: MutableMapping[str, Any],
-        sql: str,
-        data: Sequence[str]
-    ):
-        self.big_query_metadata = big_query_metadata
-        self.fields = fields
-        self.pivots = pivots
-        self.has_subtotals = has_subtotals
-        self.has_totals = has_totals
-        self.columns_truncated = columns_truncated
-        self.filter_expression = filter_expression
-        self.filters = filters
-        self.sql = sql
-        self.data = data
+    def __init__(self, *, metadata: "JsonBiMetadata", rows: Sequence[str]):
+        self.metadata = metadata
+        self.rows = rows
 
 
 @attr.s(auto_attribs=True, init=False)
@@ -5941,6 +5893,66 @@ class JsonBiFields(model.Model):
         self.pivots = pivots
 
 
+@attr.s(auto_attribs=True, init=False)
+class JsonBiMetadata(model.Model):
+    """
+    Attributes:
+        big_query_metadata:
+        fields:
+        pivots: Pivots
+        has_subtotals: If the query has subtotals
+        has_totals: If the query has totals
+        columns_truncated: If the query results hit the maximum column limit and additional columns were truncated
+        filter_expression: Filter expression applied to the query results
+        filters: Filters applied to the query results
+        sql: Raw sql query. Null if user does not have permission to view sql
+    """
+
+    big_query_metadata: "JsonBiBigQueryMetadata"
+    fields: "JsonBiFields"
+    pivots: Sequence["JsonBiPivots"]
+    has_subtotals: bool
+    has_totals: bool
+    columns_truncated: str
+    filter_expression: str
+    filters: MutableMapping[str, Any]
+    sql: str
+    __annotations__ = {
+        "big_query_metadata": ForwardRef("JsonBiBigQueryMetadata"),
+        "fields": ForwardRef("JsonBiFields"),
+        "pivots": Sequence["JsonBiPivots"],
+        "has_subtotals": bool,
+        "has_totals": bool,
+        "columns_truncated": str,
+        "filter_expression": str,
+        "filters": MutableMapping[str, Any],
+        "sql": str,
+    }
+
+    def __init__(
+        self,
+        *,
+        big_query_metadata: "JsonBiBigQueryMetadata",
+        fields: "JsonBiFields",
+        pivots: Sequence["JsonBiPivots"],
+        has_subtotals: bool,
+        has_totals: bool,
+        columns_truncated: str,
+        filter_expression: str,
+        filters: MutableMapping[str, Any],
+        sql: str
+    ):
+        self.big_query_metadata = big_query_metadata
+        self.fields = fields
+        self.pivots = pivots
+        self.has_subtotals = has_subtotals
+        self.has_totals = has_totals
+        self.columns_truncated = columns_truncated
+        self.filter_expression = filter_expression
+        self.filters = filters
+        self.sql = sql
+
+
 @attr.s(auto_attribs=True, init=False)
 class JsonBiPivots(model.Model):
     """

looker_sdk/sdk/constants.py

@@ -20,5 +20,5 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-sdk_version = "24.2"
+sdk_version = "24.4"
 environment_prefix = "LOOKERSDK"

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.2.0"
+__version__ = "24.4.0"

{looker_sdk-24.2.0.dist-info → looker_sdk-24.4.0.dist-info}/METADATA

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

{looker_sdk-24.2.0.dist-info → looker_sdk-24.4.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
 looker_sdk/__init__.py,sha256=0UOw2v-BP1bNoBIIm-BnyKUpGQB3Zx-JZRmpYyLiIuY,2589
-looker_sdk/error.py,sha256=pBhLKh99WNBiz99O___ERcmC-aB89XGe5uQAHKwQ94c,1941
+looker_sdk/error.py,sha256=4HKjj1f9pZ73USBSMoV5SOFbl8p4VyBBywKUWQGmdiw,4920
 looker_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-looker_sdk/version.py,sha256=IsxnWc-urtenbKPSRL8Ojh5y98vsbEzP-PQDf3uAPX8,1155
+looker_sdk/version.py,sha256=VK50Bg5ftY_S2Mph7SAlt0BZn44HzNunxRW3dOGJ9lo,1155
 looker_sdk/rtl/__init__.py,sha256=hgj6CO_Du2XcJ4bRYbhaVS3dvLxjCqPQDR8KwD9IPTQ,1132
-looker_sdk/rtl/api_methods.py,sha256=k3PJMu8iDtn8GRhMPllnNV5W2j8v9YbLx0ZKXVYPCD8,8468
+looker_sdk/rtl/api_methods.py,sha256=J-dm7UMyJajsJDCB0JMpGUmp80I8oPMs7cggdIaCWng,8862
 looker_sdk/rtl/api_settings.py,sha256=0QbmNhfgjBJNnr1CNEMxCHoiu908jT8amAtSAha1xS8,6953
 looker_sdk/rtl/auth_session.py,sha256=lLhj7dZfBOtzqUYeAds8x-7DOkp1q-hEWKzw9heqetA,13064
 looker_sdk/rtl/auth_token.py,sha256=dRHNmwZPczYZ1KhRQbfye60rpGhHQN8TSofprMOjG3A,3635
@@ -14,10 +14,10 @@ looker_sdk/rtl/requests_transport.py,sha256=2lckuJyjeySAuAn7v-RA_xTjjWe53uCCLSWg
 looker_sdk/rtl/serialize.py,sha256=Arm26aGLOhW-uUW4qgV1tTna83A3gNMYcF9YwRvf0gQ,4418
 looker_sdk/rtl/transport.py,sha256=zNCaGmmJBtF87iLS6xtSTwiyEXP0BDdMJafPn0_tIrk,3911
 looker_sdk/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-looker_sdk/sdk/constants.py,sha256=tX_oaNye7IOcfmXaRTQWMOjgurF6XGb2LJ3-oam6XWs,1186
+looker_sdk/sdk/constants.py,sha256=wjstQ4zDIQ4E_HAeleue9bmO0BuL0gYML-jRw2BSxdc,1186
 looker_sdk/sdk/api40/__init__.py,sha256=Dvx1t9vDBvgEl-p1eeP7ebEC6Q6wb6rASPi7nx3z7dg,18
 looker_sdk/sdk/api40/methods.py,sha256=sS2M9ASLWTTT_538NT9vATS9WQdkmUoH0Q6JsxuSWS8,511713
-looker_sdk/sdk/api40/models.py,sha256=h-Iyuy0-K-OioCZNTcA9I3r_UQwIyozGMr09FUUGd9w,621915
+looker_sdk/sdk/api40/models.py,sha256=RpgOyk0KTOwZPiYNxsSMa2TikwTrsN3ikx-kN5iYAGg,622211
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/conftest.py,sha256=ZLymw2rfMVus_CRBbbcxpK3_rEpMJRMQX9A5m2aQgQs,3895
 tests/integration/__init__.py,sha256=K4tvUu8CgFRwtDhDNixHKDDb8uubXgevQBq8JmZvf8Y,63
@@ -31,8 +31,8 @@ tests/rtl/test_auth_token.py,sha256=Ep4u0ushHqKiIkGgw-XVn1lSzPeH6pVmDB2bw-MXNAo,
 tests/rtl/test_requests_transport.py,sha256=mSsxudpAkKe-uSVOIzDrV0XCFlj_ACt6T1yzbUbuwG0,5442
 tests/rtl/test_serialize.py,sha256=1SC8jigZFFL3mrU2oSTnc2nbDxXve224_r3GaxEeU90,25917
 tests/rtl/test_transport.py,sha256=tI83LYOeuWEmkngXyRqMjW-pv-ipLPLj4t0hGD8zqL8,1555
-looker_sdk-24.2.0.dist-info/LICENSE.txt,sha256=N4Rmmbuo5EryYSCXcvjuXL1ZXwyXanRzuGP-dJzwsoE,1094
-looker_sdk-24.2.0.dist-info/METADATA,sha256=YIbb-w4JPJs3tr9ZC929OXdeXfdRhhRQLnMC0hu_HfI,7027
-looker_sdk-24.2.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-looker_sdk-24.2.0.dist-info/top_level.txt,sha256=tDPNJRQM_A_Oncxlgxwvnzq7hZDWZaadt_nR8DmORTI,17
-looker_sdk-24.2.0.dist-info/RECORD,,
+looker_sdk-24.4.0.dist-info/LICENSE.txt,sha256=N4Rmmbuo5EryYSCXcvjuXL1ZXwyXanRzuGP-dJzwsoE,1094
+looker_sdk-24.4.0.dist-info/METADATA,sha256=1y4XLvsFSmaZupccJqvMRiTs25mTkJ5BW2lD-43WQgQ,7027
+looker_sdk-24.4.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+looker_sdk-24.4.0.dist-info/top_level.txt,sha256=tDPNJRQM_A_Oncxlgxwvnzq7hZDWZaadt_nR8DmORTI,17
+looker_sdk-24.4.0.dist-info/RECORD,,

{looker_sdk-24.2.0.dist-info → looker_sdk-24.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any