From ce48565e24feda8c527574f313da6d7083f7c57f Mon Sep 17 00:00:00 2001 From: Mara3l Date: Tue, 3 Oct 2023 08:47:08 +0200 Subject: [PATCH] PMK-1169: hiding .cn --- docs/content/en/docs/installation.md | 18 ++++-------------- gooddata-fdw/gooddata_fdw/filter.py | 2 +- gooddata-sdk/gooddata_sdk/insight.py | 4 ++-- gooddata-sdk/gooddata_sdk/support.py | 8 ++++---- 4 files changed, 11 insertions(+), 21 deletions(-) diff --git a/docs/content/en/docs/installation.md b/docs/content/en/docs/installation.md index b46e5765e..33de737ba 100644 --- a/docs/content/en/docs/installation.md +++ b/docs/content/en/docs/installation.md @@ -18,12 +18,12 @@ To install the `gooddata-sdk` Python SDK package, run the following command: pip3 install gooddata-sdk ``` -{{% alert color="warning" title="Known MacOS issue" %}} +{{% alert color="warning" title="Known macOS issue" %}} If you are getting the following message: __(Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE\_VERIFY\_FAILED] certificate verify failed: unable to get local issuer certificate (\_ssl.c:1129)')))__ -it is likely caused by Python and it occurs if you have installed Python directly from python.org. +it is likely caused by Python, and it occurs if you have installed Python directly from python.org. To mitigate, please istall your SSL certificates in __HD -> Applications -> Python -> Install Certificates.command__. {{% /alert %}} @@ -32,18 +32,8 @@ To make use of the package, you need a running instance of GoodData. If you do n ### Versioning -The Python SDK is versioned. The version you should be using depends on the type of GoodData distribution you are using. +The Python SDK is versioned and usually released in tandem with GoodData Cloud. #### GoodData Cloud -We recommend you always work with the newest (supported) Python available. - -#### GoodData.CN - -Here is a mapping table of compatibility, which version of Python SDK to use with each version of GoodData.CN - -| Gooddata.CN | Python SDK | -|---|---| -| v2.5 | v1.5 | -| v2.4 | v1.4 | -| v2.3 | v1.3 | +When working with GoodData Cloud, we recommend you always work with the newest Python SDK available. diff --git a/gooddata-fdw/gooddata_fdw/filter.py b/gooddata-fdw/gooddata_fdw/filter.py index 288c9cb3d..b51900dd2 100644 --- a/gooddata-fdw/gooddata_fdw/filter.py +++ b/gooddata-fdw/gooddata_fdw/filter.py @@ -59,7 +59,7 @@ def _qual_to_date_filter(filter_entity: Attribute, qual: Qual) -> Union[Filter, re_day = re.compile(r"(.*)\.[^.]+$") label = ObjId(re_day.sub(r"\1", filter_entity.label.id), "dataset") if isinstance(qual.operator, tuple): - # Can't be implemented by multiple filters, because GD.CN does not support OR between filters + # Can't be implemented by multiple filters, because local GoodData instance does not support OR between filters _log_debug("extract_filters_from_quals: IN (date1, date2, ..) is not supported") return None else: diff --git a/gooddata-sdk/gooddata_sdk/insight.py b/gooddata-sdk/gooddata_sdk/insight.py index 9d6086683..2847f4f9f 100644 --- a/gooddata-sdk/gooddata_sdk/insight.py +++ b/gooddata-sdk/gooddata_sdk/insight.py @@ -457,11 +457,11 @@ def __repr__(self) -> str: class InsightService: """ - Insight Service allows retrieval of insights from a GD.CN workspace. The insights are returned as instances of + Insight Service allows retrieval of insights from a local GD workspace. The insights are returned as instances of Insight which allows convenient introspection and necessary functions to convert the insight into a form where it can be sent for computation. - Note: the insights are created using GD.CN Analytical Designer or using GoodData.UI SDK. They are stored as + Note: the insights are created using GD Analytical Designer or using GoodData.UI SDK. They are stored as visualization objects with a free-form body. This body is specific for AD & SDK. The Insight wrapper exists to take care of these discrepancies. """ diff --git a/gooddata-sdk/gooddata_sdk/support.py b/gooddata-sdk/gooddata_sdk/support.py index 18d31cc48..5c0a9b498 100644 --- a/gooddata-sdk/gooddata_sdk/support.py +++ b/gooddata-sdk/gooddata_sdk/support.py @@ -16,7 +16,7 @@ def __init__(self, api_client: GoodDataApiClient) -> None: @property def is_available(self) -> bool: """ - Checks if GD.CN is available. + Checks if the GoodData instance is available. Can raise exceptions in case of authentication or authorization failure. :return: True - available, False - not available @@ -28,7 +28,7 @@ def is_available(self) -> bool: # do not consider invalid credentials or missing rights "not available" state raise except exceptions.ApiException: - # invalid response from GD.CN - GD.CN is still booting but endpoint is receiving connections already + # invalid response from GoodData - GoodData is still booting but endpoint is receiving connections already return False except urllib3_ex.MaxRetryError: # endpoint inactive - cannot connect @@ -36,7 +36,7 @@ def is_available(self) -> bool: def wait_till_available(self, timeout: int, sleep_time: float = 2.0) -> None: """ - Wait till GD.CN service is available. When timeout is: + Wait till GoodData service is available. When timeout is: - > 0 exception is raised after given number of seconds. - = 0 exception is raised whe service is not available immediately @@ -46,7 +46,7 @@ def wait_till_available(self, timeout: int, sleep_time: float = 2.0) -> None: Args: timeout: seconds to wait to service to be available (see method description for details) - sleep_time: seconds to wait between GD.CN availability tests + sleep_time: seconds to wait between availability tests """ start_time_sec = time.time() while True: