From 5108fec38ae51f6f63900b14c914a1b8e0f8827d Mon Sep 17 00:00:00 2001 From: adrian-wojcik Date: Thu, 4 Apr 2024 10:02:35 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=A8=20Correct=20docstrings?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- viadot/flows/sap_rfc_to_adls.py | 4 ++-- viadot/sources/sap_rfc.py | 8 ++++---- viadot/tasks/sap_rfc.py | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/viadot/flows/sap_rfc_to_adls.py b/viadot/flows/sap_rfc_to_adls.py index d5f171ada..5a380bbaa 100644 --- a/viadot/flows/sap_rfc_to_adls.py +++ b/viadot/flows/sap_rfc_to_adls.py @@ -68,8 +68,8 @@ def __init__( rfc_unique_id=["VBELN", "LPRIO"], ... ) - sap_credentials (dict, optional): The credentials to use to authenticate with SAP. By default, they're taken from the local viadot config. - sap_credentials_key (str, optional): The key for sap credentials located in the local config for Azure Key Vault. Defaults to "SAP". + sap_credentials (dict, optional): The credentials to use to authenticate with SAP. Defaults to None. + sap_credentials_key (str, optional): The key for sap credentials located in the local config or Azure Key Vault. Defaults to "SAP". env (str, optional): The key for sap_credentials_key pointing to the SAP environment. Defaults to "DEV" output_file_extension (str, optional): Output file extension - to allow selection of .csv for data which is not easy to handle with parquet. Defaults to ".parquet". local_file_path (str, optional): Local destination path. Defaults to None. diff --git a/viadot/sources/sap_rfc.py b/viadot/sources/sap_rfc.py index 0ebad30f4..8d53bd230 100644 --- a/viadot/sources/sap_rfc.py +++ b/viadot/sources/sap_rfc.py @@ -253,8 +253,8 @@ def __init__( in case of too many columns for RFC function. According to SAP documentation, the limit is 512 characters. However, we observed SAP raising an exception even on a slightly lower number of characters, so we add a safety margin. Defaults to 400. - sap_credentials (dict, optional): The credentials to use to authenticate with SAP. By default, they're taken from the local viadot config. - sap_credentials_key (str, optional): The key for sap credentials located in the local config for Azure Key Vault. Defaults to "SAP". + sap_credentials (dict, optional): The credentials to use to authenticate with SAP. Defaults to None. + sap_credentials_key (str, optional): The key for sap credentials located in the local config or Azure Key Vault. Defaults to "SAP". env (str, optional): The key for sap_credentials_key pointing to the SAP environment. Defaults to "DEV". Raises: @@ -723,8 +723,8 @@ def __init__( 512 characters. However, we observed SAP raising an exception even on a slightly lower number of characters, so we add a safety margin. Defaults to 400. rfc_unique_id (List[str], optional): Reference columns to merge chunks Data Frames. These columns must to be unique. Defaults to None. - sap_credentials (dict, optional): The credentials to use to authenticate with SAP. By default, they're taken from the local viadot config. - sap_credentials_key (str, optional): The key for sap credentials located in the local config for Azure Key Vault. Defaults to "SAP". + sap_credentials (dict, optional): The credentials to use to authenticate with SAP. Defaults to None. + sap_credentials_key (str, optional): The key for sap credentials located in the local config or Azure Key Vault. Defaults to "SAP". env (str, optional): The key for sap_credentials_key pointing to the SAP environment. Defaults to "DEV". Raises: diff --git a/viadot/tasks/sap_rfc.py b/viadot/tasks/sap_rfc.py index 91c754678..2d47e573a 100644 --- a/viadot/tasks/sap_rfc.py +++ b/viadot/tasks/sap_rfc.py @@ -59,7 +59,7 @@ def __init__( 512 characters. However, we observed SAP raising an exception even on a slightly lower number of characters, so we add a safety margin. Defaults to 400. sap_credentials (dict, optional): The credentials to use to authenticate with SAP. By default, they're taken from the local viadot config. - sap_credentials_key (str, optional): The key for sap credentials located in the local config for Azure Key Vault. Defaults to "SAP". + sap_credentials_key (str, optional): The key for sap credentials located in the local config or Azure Key Vault. Defaults to "SAP". env (str, optional): The key for sap_credentials_key pointing to the SAP environment. Defaults to "DEV". By default, they're taken from the local viadot config. """ @@ -110,8 +110,8 @@ def run( multiple options are automatically tried. Defaults to None. replacement (str, optional): In case of sep is on a columns, set up a new character to replace inside the string to avoid flow breakdowns. Defaults to "-". - sap_credentials (dict, optional): The credentials to use to authenticate with SAP. By default, they're taken from the local viadot config. - sap_credentials_key (str, optional): The key for sap credentials located in the local config for Azure Key Vault. Defaults to "SAP". + sap_credentials (dict, optional): The credentials to use to authenticate with SAP. Defaults to None. + sap_credentials_key (str, optional): The key for sap credentials located in the local config or Azure Key Vault. Defaults to "SAP". env (str, optional): The key for sap_credentials_key pointing to the SAP environment. Defaults to "DEV". func (str, optional): SAP RFC function to use. Defaults to None. rfc_total_col_width_character_limit (int, optional): Number of characters by which query will be split in chunks