bkflow-sdk 0.0.42__py2.py3-none-any.whl

bkflow/__init__.py

@@ -0,0 +1,11 @@
+"""
+Tencent is pleased to support the open source community by making 蓝鲸智云 - PaaS平台 (BlueKing - PaaS System) available.
+Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://opensource.org/licenses/MIT
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+"""
+__version__ = "0.0.42"

bkflow/client/__init__.py

@@ -0,0 +1,10 @@
+"""
+Tencent is pleased to support the open source community by making 蓝鲸智云 - PaaS平台 (BlueKing - PaaS System) available.
+Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://opensource.org/licenses/MIT
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+"""

bkflow/client/apis/__init__.py

@@ -0,0 +1,10 @@
+"""
+Tencent is pleased to support the open source community by making 蓝鲸智云 - PaaS平台 (BlueKing - PaaS System) available.
+Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://opensource.org/licenses/MIT
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+"""

bkflow/client/apis/bkflow.py

@@ -0,0 +1,348 @@
+"""
+TencentBlueKing is pleased to support the open source community by making
+蓝鲸流程引擎服务 (BlueKing Flow Engine Service) available.
+Copyright (C) 2024 THL A29 Limited,
+a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at http://opensource.org/licenses/MIT
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+
+We undertake not to change the open source license (MIT license) applicable
+
+to the current version of the project delivered to anyone in the future.
+"""
+
+from bkflow.config.default import bkflow_sdk_settings
+
+from ..base import RequestAPI
+
+
+class CollectionsBKFlow:
+    def __init__(self, client):
+        self.client = client
+        self.host = bkflow_sdk_settings.BKFLOW_SDK_APIGW_HOST
+        self.apply_token = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/space/{space_id}/apply_token/",
+            description="申请访问token",
+        )
+        self.admin_create_template = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/template/admin/create_default_template/{space_id}/",
+            description="Admin创建流程",
+        )
+        self.create_template = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/space/{space_id}/create_template/",
+            description="后台创建流程",
+        )
+        self.copy_template = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/template/admin/template_copy/",
+            description="创建流程",
+        )
+        self.list_templates = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/space/{space_id}/get_template_list/",
+            description="获取模板列表",
+        )
+        self.fetch_template = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/",
+            description="获取流程详情",
+            token_required=True,
+        )
+        self.update_template = RequestAPI(
+            client=self.client,
+            method="PUT",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/",
+            description="更新模板",
+            token_required=True,
+        )
+        self.delete_template = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/space/{space_id}/delete_template/{template_id}/",
+            description="删除模板",
+        )
+        self.system_variables = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/variable/system_variable/",
+            description="获取系统变量",
+            token_required=True,
+        )
+        self.get_space_related_configs = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/get_space_related_configs/",
+            description="获取空间相关配置",
+            token_required=True,
+        )
+        self.list_inner_plugins = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/plugin/",
+            description="获取插件",
+            token_required=True,
+        )
+        self.get_inner_plugin_detail = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/plugin/{code}/",
+            description="获取插件详情",
+            token_required=True,
+        )
+        self.list_plugin_tags = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/plugin_service/tags/",
+            description="获取第三方插件Tags",
+        )
+        self.list_plugin = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/bk_plugin/",
+            description="获取第三方插件",
+        )
+        self.get_plugin_meta = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/plugin_service/meta/",
+            description="获取第三方插件元信息",
+        )
+        self.get_plugin_app_detail = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/plugin_service/app_detail/",
+            description="获取插件服务App详情",
+        )
+        self.get_service_plugin_detail = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/plugin_service/detail/",
+            description="获取第三方插件详情",
+        )
+        self.analysis_constants_ref = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/template/analysis_constants_ref/",
+            description="变量引用统计",
+            token_required=True,
+        )
+        self.list_decision = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/decision_table/user/",
+            description="获取用户决策表插件列表",
+            token_required=True,
+        )
+        self.uniform_api = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/plugin_query/uniform_api/category_list/{space_id}/",
+            description="获取uniform_api插件列表",
+            token_required=True,
+        )
+        self.create_task = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/space/{space_id}/create_task/",
+            description="创建任务",
+        )
+        self.front_operate_task = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/task/operate_task/{task_id}/{action}/",
+            description="操作任务",
+            token_required=True,
+        )
+        self.operation_record = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/get_template_operation_record/",
+            description="操作记录",
+            token_required=True,
+        )
+        self.variable_class_list = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/variable/",
+            description="自定义变量列表",
+        )
+        self.variable_class_detail = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/variable/{variable_id}/",
+            description="自定义变量详情",
+        )
+        self.check_variable_key = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/variable/check_variable_key/",
+            description="检查变量key是否规范合法",
+        )
+        self.get_constant_preview_result = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/template/variable/get_constant_preview_result/",
+            description="流程常量预览结果",
+        )
+        self.get_task_mock_data = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/task/get_task_mock_data/{task_id}/",
+            description="获取任务的mock数据",
+            token_required=True,
+        )
+        self.get_task_list = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/space/{space_id}/get_task_list/",
+            description="获取任务列表",
+        )
+        self.get_task_states = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/space/{space_id}/task/{task_id}/get_task_states/",
+            description="获取任务状态",
+        )
+        self.get_task_detail = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/space/{space_id}/task/{task_id}/get_task_detail/",
+            description="获取任务详情",
+        )
+        self.get_tasks_states = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/space/{space_id}/get_tasks_states/",
+            description="批量获取任务状态",
+        )
+        self.get_template_detail = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/space/{space_id}/template/{template_id}/get_template_detail/",
+            description="获取模板详情",
+        )
+        self.operate_task = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/space/{space_id}/task/{task_id}/operate_task/{operation}/",
+            description="操作任务",
+        )
+        self.get_draft_template = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/get_draft_template/",
+            description="获取草稿模板",
+            token_required=True,
+        )
+        self.calculate_version = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/calculate_version/",
+            description="计算版本号",
+            token_required=True,
+        )
+        self.release_template = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/space/{space_id}/template/{template_id}/release_template/",
+            description="发布模板",
+        )
+        self.front_release_template = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/release_template/",
+            description="发布模板(用于画布对接)",
+            token_required=True,
+        )
+        self.rollback_template = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/space/{space_id}/template/{template_id}/rollback_template/",
+            description="回滚模板",
+        )
+        self.front_rollback_template = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/rollback_template/",
+            description="回滚模板(用于画布对接)",
+            token_required=True,
+        )
+        self.preview_task_tree = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/template/{template_id}/preview_task_tree/",
+            description="预览任务树",
+            token_required=True,
+        )
+        self.list_snapshot = RequestAPI(
+            client=self.client,
+            method="GET",
+            host=self.host,
+            path="/{stage}/sdk/template/snapshot/list_snapshot/",
+            description="获取模板快照列表",
+            token_required=True,
+        )
+        self.delete_snapshot = RequestAPI(
+            client=self.client,
+            method="POST",
+            host=self.host,
+            path="/{stage}/sdk/template/snapshot/{snapshot_id}/delete_snapshot/",
+            description="删除模板快照",
+            token_required=True,
+        )

bkflow/client/base.py

@@ -0,0 +1,124 @@
+"""
+Tencent is pleased to support the open source community by making 蓝鲸智云 - PaaS平台 (BlueKing - PaaS System) available.
+Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://opensource.org/licenses/MIT
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+"""
+import logging
+
+from bkflow.common.exceptions import APIException
+from bkflow.config.default import API_TOKEN_HEADER_KEY
+from bkflow.interface.utils import get_space_id
+
+logger = logging.getLogger(__name__)
+
+
+def render_string(tmpl, context):
+    return tmpl.format(**context)
+
+
+class RequestAPI:
+    """Single request api"""
+
+    HTTP_STATUS_OK = 200
+
+    def __init__(self, client, method, host=None, path=None, description="", token_required=False):
+        self.host = host
+        self.path = path
+        self.client = client
+        self.method = method
+        self.token_required = token_required
+
+    def __call__(self, *args, path_params=None, headers=None, **kwargs):
+        try:
+            return self._call(*args, path_params=path_params, headers=headers, **kwargs)
+        except APIException as e:
+            # Combine log message
+            log_message = [
+                e.error_message,
+            ]
+            log_message.append("url=%s" % e.url)
+            if e.resp:
+                log_message.append("content=%s" % e.resp.text)
+
+            logger.exception("\n".join(log_message))
+
+            # Try return error message from remote service
+            if e.resp is not None:
+                try:
+                    return e.resp.json()
+                except Exception:
+                    pass
+            return {"result": False, "message": e.error_message, "data": None}
+
+    def _call(self, *args, path_params=None, headers=None, space_id=None, **kwargs):
+        if not path_params:
+            path_params = {"stage": self.client.stage, "bk_apigw_ver": self.client.bk_apigw_ver}
+        else:
+            path_params.update({"stage": self.client.stage, "bk_apigw_ver": self.client.bk_apigw_ver})
+
+        params, data = {}, {}
+        for arg in args:
+            if isinstance(arg, dict):
+                params.update(arg)
+        params.update(kwargs)
+
+        # 获取 space_id（如果未通过关键字参数传递，则自动获取）
+        space_id = params.get("space_id") or path_params.get("space_id")
+        if space_id is None:
+            # 尝试从 params 中获取 scope_type 和 scope_value
+            scope_type = params.get("scope_type")
+            scope_value = params.get("scope_value")
+            space_id = get_space_id(scope_type=scope_type, scope_value=scope_value)
+
+        # 如果路径中包含 {space_id}，添加到 path_params
+        if "{space_id}" in self.path and "space_id" not in path_params:
+            path_params["space_id"] = space_id
+
+        if self.token_required:
+            if not headers or API_TOKEN_HEADER_KEY not in headers:
+                raise APIException(f"当前接口需要token，请在请求头中添加${API_TOKEN_HEADER_KEY}")
+
+        if self.method in ["POST", "PUT", "PATCH", "DELETE"]:
+            data = params
+            params = None
+            # 对于 POST/PUT/PATCH/DELETE 请求，如果路径中不包含 {space_id}，添加到 data 中
+            if "{space_id}" not in self.path and "space_id" not in data:
+                data["space_id"] = space_id
+        else:
+            # 对于 GET/HEAD 请求，如果路径中不包含 {space_id}，添加到 params 中
+            if "{space_id}" not in self.path and "space_id" not in params:
+                params["space_id"] = space_id
+        path = self.path
+        # Request remote server
+        if path_params:
+            try:
+                path = render_string(path, path_params)
+            except KeyError as e:
+                raise APIException(f"{e} is not in path_params")
+        url = self.host.rstrip("/") + path
+        try:
+            # Pass headers to client.request if provided
+            request_kwargs = {}
+            if headers:
+                request_kwargs["headers"] = headers
+            resp = self.client.request(method=self.method, url=url, params=params, data=data, **request_kwargs)
+        except Exception as e:
+            logger.exception("Error occurred when requesting method=%s, url=%s", self.method, url)
+            raise APIException("API调用出错, Exception: %s" % str(e), url=url)
+
+        # Parse result
+        if resp and resp.status_code != self.HTTP_STATUS_OK:
+            message = "请求出现错误，请求HTTP状态码：%s" % resp.status_code
+            raise APIException(message, resp=resp, url=url)
+
+        # Response format json or text
+        try:
+            response = resp.json()
+            return response
+        except Exception:
+            raise APIException("返回数据格式不正确，统一为json", resp=resp, url=url)