estel/dify
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

chore(api/core): apply ruff reformatting (#7624)

Browse Source
This commit is contained in:
Bowen Liang
2024-09-10 17:00:20 +08:00
committed by GitHub
parent 178730266d
commit 2cf1187b32
724 changed files with 21180 additions and 21123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

189
api/core/tools/tool/api_tool.py
View File

@@ -12,8 +12,8 @@ from core.tools.errors import ToolInvokeError, ToolParameterValidationError, Too
from core.tools.tool.tool import Tool
API_TOOL_DEFAULT_TIMEOUT = (
int(getenv('API_TOOL_DEFAULT_CONNECT_TIMEOUT', '10')),
int(getenv('API_TOOL_DEFAULT_READ_TIMEOUT', '60'))
int(getenv("API_TOOL_DEFAULT_CONNECT_TIMEOUT", "10")),
int(getenv("API_TOOL_DEFAULT_READ_TIMEOUT", "60")),
)
@@ -24,31 +24,32 @@ class ApiTool(Tool):
Api tool
"""
def fork_tool_runtime(self, runtime: dict[str, Any]) -> 'Tool':
def fork_tool_runtime(self, runtime: dict[str, Any]) -> "Tool":
"""
fork a new tool with meta data
fork a new tool with meta data
:param meta: the meta data of a tool call processing, tenant_id is required
:return: the new tool
:param meta: the meta data of a tool call processing, tenant_id is required
:return: the new tool
"""
return self.__class__(
identity=self.identity.model_copy() if self.identity else None,
parameters=self.parameters.copy() if self.parameters else None,
description=self.description.model_copy() if self.description else None,
api_bundle=self.api_bundle.model_copy() if self.api_bundle else None,
runtime=Tool.Runtime(**runtime)
runtime=Tool.Runtime(**runtime),
)
def validate_credentials(self, credentials: dict[str, Any], parameters: dict[str, Any],
format_only: bool = False) -> str:
def validate_credentials(
self, credentials: dict[str, Any], parameters: dict[str, Any], format_only: bool = False
) -> str:
"""
validate the credentials for Api tool
validate the credentials for Api tool
"""
# assemble validate request and request parameters
# assemble validate request and request parameters
headers = self.assembling_request(parameters)
if format_only:
return ''
return ""
response = self.do_http_request(self.api_bundle.server_url, self.api_bundle.method, headers, parameters)
# validate response
@@ -61,30 +62,30 @@ class ApiTool(Tool):
headers = {}
credentials = self.runtime.credentials or {}
if 'auth_type' not in credentials:
raise ToolProviderCredentialValidationError('Missing auth_type')
if "auth_type" not in credentials:
raise ToolProviderCredentialValidationError("Missing auth_type")
if credentials['auth_type'] == 'api_key':
api_key_header = 'api_key'
if credentials["auth_type"] == "api_key":
api_key_header = "api_key"
if 'api_key_header' in credentials:
api_key_header = credentials['api_key_header']
if "api_key_header" in credentials:
api_key_header = credentials["api_key_header"]
if 'api_key_value' not in credentials:
raise ToolProviderCredentialValidationError('Missing api_key_value')
elif not isinstance(credentials['api_key_value'], str):
raise ToolProviderCredentialValidationError('api_key_value must be a string')
if "api_key_value" not in credentials:
raise ToolProviderCredentialValidationError("Missing api_key_value")
elif not isinstance(credentials["api_key_value"], str):
raise ToolProviderCredentialValidationError("api_key_value must be a string")
if 'api_key_header_prefix' in credentials:
api_key_header_prefix = credentials['api_key_header_prefix']
if api_key_header_prefix == 'basic' and credentials['api_key_value']:
credentials['api_key_value'] = f'Basic {credentials["api_key_value"]}'
elif api_key_header_prefix == 'bearer' and credentials['api_key_value']:
credentials['api_key_value'] = f'Bearer {credentials["api_key_value"]}'
elif api_key_header_prefix == 'custom':
if "api_key_header_prefix" in credentials:
api_key_header_prefix = credentials["api_key_header_prefix"]
if api_key_header_prefix == "basic" and credentials["api_key_value"]:
credentials["api_key_value"] = f'Basic {credentials["api_key_value"]}'
elif api_key_header_prefix == "bearer" and credentials["api_key_value"]:
credentials["api_key_value"] = f'Bearer {credentials["api_key_value"]}'
elif api_key_header_prefix == "custom":
pass
headers[api_key_header] = credentials['api_key_value']
headers[api_key_header] = credentials["api_key_value"]
needed_parameters = [parameter for parameter in self.api_bundle.parameters if parameter.required]
for parameter in needed_parameters:
@@ -98,13 +99,13 @@ class ApiTool(Tool):
def validate_and_parse_response(self, response: httpx.Response) -> str:
"""
validate the response
validate the response
"""
if isinstance(response, httpx.Response):
if response.status_code >= 400:
raise ToolInvokeError(f"Request failed with status code {response.status_code} and {response.text}")
if not response.content:
return 'Empty response from the tool, please check your parameters and try again.'
return "Empty response from the tool, please check your parameters and try again."
try:
response = response.json()
try:
@@ -114,21 +115,22 @@ class ApiTool(Tool):
except Exception as e:
return response.text
else:
raise ValueError(f'Invalid response type {type(response)}')
raise ValueError(f"Invalid response type {type(response)}")
@staticmethod
def get_parameter_value(parameter, parameters):
if parameter['name'] in parameters:
return parameters[parameter['name']]
elif parameter.get('required', False):
if parameter["name"] in parameters:
return parameters[parameter["name"]]
elif parameter.get("required", False):
raise ToolParameterValidationError(f"Missing required parameter {parameter['name']}")
else:
return (parameter.get('schema', {}) or {}).get('default', '')
return (parameter.get("schema", {}) or {}).get("default", "")
def do_http_request(self, url: str, method: str, headers: dict[str, Any],
parameters: dict[str, Any]) -> httpx.Response:
def do_http_request(
self, url: str, method: str, headers: dict[str, Any], parameters: dict[str, Any]
) -> httpx.Response:
"""
do http request depending on api bundle
do http request depending on api bundle
"""
method = method.lower()
@@ -138,29 +140,30 @@ class ApiTool(Tool):
cookies = {}
# check parameters
for parameter in self.api_bundle.openapi.get('parameters', []):
for parameter in self.api_bundle.openapi.get("parameters", []):
value = self.get_parameter_value(parameter, parameters)
if parameter['in'] == 'path':
path_params[parameter['name']] = value
if parameter["in"] == "path":
path_params[parameter["name"]] = value
elif parameter['in'] == 'query':
if value !='': params[parameter['name']] = value
elif parameter["in"] == "query":
if value != "":
params[parameter["name"]] = value
elif parameter['in'] == 'cookie':
cookies[parameter['name']] = value
elif parameter["in"] == "cookie":
cookies[parameter["name"]] = value
elif parameter['in'] == 'header':
headers[parameter['name']] = value
elif parameter["in"] == "header":
headers[parameter["name"]] = value
# check if there is a request body and handle it
if 'requestBody' in self.api_bundle.openapi and self.api_bundle.openapi['requestBody'] is not None:
if "requestBody" in self.api_bundle.openapi and self.api_bundle.openapi["requestBody"] is not None:
# handle json request body
if 'content' in self.api_bundle.openapi['requestBody']:
for content_type in self.api_bundle.openapi['requestBody']['content']:
headers['Content-Type'] = content_type
body_schema = self.api_bundle.openapi['requestBody']['content'][content_type]['schema']
required = body_schema.get('required', [])
properties = body_schema.get('properties', {})
if "content" in self.api_bundle.openapi["requestBody"]:
for content_type in self.api_bundle.openapi["requestBody"]["content"]:
headers["Content-Type"] = content_type
body_schema = self.api_bundle.openapi["requestBody"]["content"][content_type]["schema"]
required = body_schema.get("required", [])
properties = body_schema.get("properties", {})
for name, property in properties.items():
if name in parameters:
# convert type
@@ -169,63 +172,71 @@ class ApiTool(Tool):
raise ToolParameterValidationError(
f"Missing required parameter {name} in operation {self.api_bundle.operation_id}"
)
elif 'default' in property:
body[name] = property['default']
elif "default" in property:
body[name] = property["default"]
else:
body[name] = None
break
# replace path parameters
for name, value in path_params.items():
url = url.replace(f'{{{name}}}', f'{value}')
url = url.replace(f"{{{name}}}", f"{value}")
# parse http body data if needed, for GET/HEAD/OPTIONS/TRACE, the body is ignored
if 'Content-Type' in headers:
if headers['Content-Type'] == 'application/json':
if "Content-Type" in headers:
if headers["Content-Type"] == "application/json":
body = json.dumps(body)
elif headers['Content-Type'] == 'application/x-www-form-urlencoded':
elif headers["Content-Type"] == "application/x-www-form-urlencoded":
body = urlencode(body)
else:
body = body
if method in ('get', 'head', 'post', 'put', 'delete', 'patch'):
response = getattr(ssrf_proxy, method)(url, params=params, headers=headers, cookies=cookies, data=body,
timeout=API_TOOL_DEFAULT_TIMEOUT, follow_redirects=True)
if method in ("get", "head", "post", "put", "delete", "patch"):
response = getattr(ssrf_proxy, method)(
url,
params=params,
headers=headers,
cookies=cookies,
data=body,
timeout=API_TOOL_DEFAULT_TIMEOUT,
follow_redirects=True,
)
return response
else:
raise ValueError(f'Invalid http method {self.method}')
raise ValueError(f"Invalid http method {self.method}")
def _convert_body_property_any_of(self, property: dict[str, Any], value: Any, any_of: list[dict[str, Any]],
max_recursive=10) -> Any:
def _convert_body_property_any_of(
self, property: dict[str, Any], value: Any, any_of: list[dict[str, Any]], max_recursive=10
) -> Any:
if max_recursive <= 0:
raise Exception("Max recursion depth reached")
for option in any_of or []:
try:
if 'type' in option:
if "type" in option:
# Attempt to convert the value based on the type.
if option['type'] == 'integer' or option['type'] == 'int':
if option["type"] == "integer" or option["type"] == "int":
return int(value)
elif option['type'] == 'number':
if '.' in str(value):
elif option["type"] == "number":
if "." in str(value):
return float(value)
else:
return int(value)
elif option['type'] == 'string':
elif option["type"] == "string":
return str(value)
elif option['type'] == 'boolean':
if str(value).lower() in ['true', '1']:
elif option["type"] == "boolean":
if str(value).lower() in ["true", "1"]:
return True
elif str(value).lower() in ['false', '0']:
elif str(value).lower() in ["false", "0"]:
return False
else:
continue # Not a boolean, try next option
elif option['type'] == 'null' and not value:
elif option["type"] == "null" and not value:
return None
else:
continue # Unsupported type, try next option
elif 'anyOf' in option and isinstance(option['anyOf'], list):
elif "anyOf" in option and isinstance(option["anyOf"], list):
# Recursive call to handle nested anyOf
return self._convert_body_property_any_of(property, value, option['anyOf'], max_recursive - 1)
return self._convert_body_property_any_of(property, value, option["anyOf"], max_recursive - 1)
except ValueError:
continue # Conversion failed, try next option
# If no option succeeded, you might want to return the value as is or raise an error
@@ -233,23 +244,23 @@ class ApiTool(Tool):
def _convert_body_property_type(self, property: dict[str, Any], value: Any) -> Any:
try:
if 'type' in property:
if property['type'] == 'integer' or property['type'] == 'int':
if "type" in property:
if property["type"] == "integer" or property["type"] == "int":
return int(value)
elif property['type'] == 'number':
elif property["type"] == "number":
# check if it is a float
if '.' in str(value):
if "." in str(value):
return float(value)
else:
return int(value)
elif property['type'] == 'string':
elif property["type"] == "string":
return str(value)
elif property['type'] == 'boolean':
elif property["type"] == "boolean":
return bool(value)
elif property['type'] == 'null':
elif property["type"] == "null":
if value is None:
return None
elif property['type'] == 'object' or property['type'] == 'array':
elif property["type"] == "object" or property["type"] == "array":
if isinstance(value, str):
try:
# an array str like '[1,2]' also can convert to list [1,2] through json.loads
@@ -264,8 +275,8 @@ class ApiTool(Tool):
return value
else:
raise ValueError(f"Invalid type {property['type']} for property {property}")
elif 'anyOf' in property and isinstance(property['anyOf'], list):
return self._convert_body_property_any_of(property, value, property['anyOf'])
elif "anyOf" in property and isinstance(property["anyOf"], list):
return self._convert_body_property_any_of(property, value, property["anyOf"])
except ValueError as e:
return value