refator: [blue-krill] upgrade pyproject.toml to follow PEP 621 standard & update license header (TencentBlueKing#215)

Author: piglei

.github/workflows/blue-krill.yml

@@ -22,21 +22,11 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.11
-      - name: Format with isort
+      - name: Check with ruff
         working-directory: sdks/blue-krill
         run: |
-          pip install isort==5.12.0
-          isort . --settings-path=pyproject.toml
-      - name: Format with black
-        working-directory: sdks/blue-krill
-        run: |
-          pip install black==23.7.0 click==8.1.6
-          black . --config=pyproject.toml
-      - name: Lint with flake8
-        working-directory: sdks/blue-krill
-        run: |
-          pip install flake8==4.0.1 pyproject-flake8==0.0.1a5
-          pflake8 . --config=pyproject.toml
+          pip install ruff==0.9.6
+          ruff check --config ../../pyproject.toml
       - name: Lint with mypy
         working-directory: sdks/blue-krill
         run: |
@@ -46,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11"]
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -55,10 +45,6 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Set up Poetry
-        uses: abatilo/actions-poetry@v2.3.0
-        with:
-          poetry-version: 1.5.1
       - name: Start Redis Container
         uses: supercharge/redis-github-action@1.4.0
         if: runner.os == 'Linux'
@@ -68,29 +54,26 @@ jobs:
         if: runner.os == 'Linux'
         run: |
           echo "REDIS_URL=redis://localhost:6379/0" >> $GITHUB_ENV
-      - name: Install dependencies
-        working-directory: sdks/blue-krill
-        run: |
-          poetry export --without-hashes --dev -o requirements-dev.txt
-          python -m pip install --upgrade pip
-          python -m pip install -r requirements-dev.txt
-          python -m pip install tox-gh-actions==2.8.1
-      - name: Run test with tox targets for ${{ matrix.python-version }}
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install Nox
+        run:  uv pip install --system nox
+      - name: Run tests on ${{ matrix.os }}
         working-directory: sdks/blue-krill
-        run: tox
+        run: nox --non-interactive --error-on-missing-interpreter --session "tests(python='${{ matrix.python-version }}')" -- --full-trace
   build:
     runs-on: macos-latest
     if: github.event.release && contains(github.event.release.tag_name, 'blue-krill')
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: 3.11
       - name: Set up Poetry
         uses: abatilo/actions-poetry@v2.3.0
         with:
-          poetry-version: 1.5.1
+          poetry-version: 2.1.1
       - name: Build blue-krill
         run: |
           cd sdks/blue-krill

pyproject.toml

@@ -13,6 +13,11 @@ ruff = "^0.1.7"
 [tool.ruff]
 line-length = 119
 
+# 添加需要额外忽略的目录，比如 Django 自动生成的 migrations 目录
+extend-exclude = ["*/migrations"]
+
+[tool.ruff.lint]
+
 # 每个规则集的具体内容请参考：https://docs.astral.sh/ruff/rules/
 select = [
   "E",
@@ -32,6 +37,7 @@ select = [
   "PT",
 ]
 
+
 # 理论上来说，ignore 规则列表中的条目越少越好。但在实际项目中，选择性地忽略某些规则常常是必须的。
 # 下面收集了常见的待忽略规则集，并将其分为两类：“推荐忽略”和“谨慎忽略”。“推荐忽略”类中所包含的规
 # 则，所有项目建议默认启用。“谨慎忽略”类中的规则，项目可酌情添加。
@@ -94,13 +100,10 @@ ignore = [
   "PLW0603",
 ]
 
-# 添加需要额外忽略的目录，比如 Django 自动生成的 migrations 目录
-extend-exclude = ["*/migrations"]
-
 [tool.ruff.format]
 quote-style = "double"
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 # 总是显式制定 import section 的顺序
 section-order = [
   "future",

sdks/blue-krill/blue_krill/__init__.py

@@ -1,11 +1,18 @@
 # -*- coding: utf-8 -*-
-"""
- * TencentBlueKing is pleased to support the open source community by making 蓝鲸智云-蓝鲸 PaaS 平台(BlueKing-PaaS) available.
- * Copyright (C) 2017-2021 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.
-"""
+# TencentBlueKing is pleased to support the open source community by making
+# 蓝鲸智云 - PaaS 平台 (BlueKing - PaaS System) available.
+# Copyright (C) 2017 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.
+
 __version__ = "2.0.7"

sdks/blue-krill/blue_krill/async_utils/__init__.py

@@ -1,10 +1,17 @@
 # -*- coding: utf-8 -*-
-"""
- * TencentBlueKing is pleased to support the open source community by making 蓝鲸智云-蓝鲸 PaaS 平台(BlueKing-PaaS) available.
- * Copyright (C) 2017-2021 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.
-"""
+# TencentBlueKing is pleased to support the open source community by making
+# 蓝鲸智云 - PaaS 平台 (BlueKing - PaaS System) available.
+# Copyright (C) 2017 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.
+

sdks/blue-krill/blue_krill/async_utils/django_utils.py

@@ -1,13 +1,20 @@
 # -*- coding: utf-8 -*-
-"""
- * TencentBlueKing is pleased to support the open source community by making 蓝鲸智云-蓝鲸 PaaS 平台(BlueKing-PaaS) available.
- * Copyright (C) 2017-2021 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.
-"""
+# TencentBlueKing is pleased to support the open source community by making
+# 蓝鲸智云 - PaaS 平台 (BlueKing - PaaS System) available.
+# Copyright (C) 2017 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.
+
 
 import logging
 from functools import partial
@@ -24,7 +31,7 @@ def apply_async_on_commit(celery_task, using: Optional[str] = None, *args, **kwa
     it will trigger the task on transaction commit when it is in a atomic block.
     """
 
-    fn = partial(celery_task.apply_async, ignore_result=True, *args, **kwargs)
+    fn = partial(celery_task.apply_async, ignore_result=True, *args, **kwargs)  # noqa: B026
 
     connection = transaction.get_connection(using)
     if connection.in_atomic_block:

sdks/blue-krill/blue_krill/async_utils/poll_task.py

@@ -1,13 +1,20 @@
 # -*- coding: utf-8 -*-
-"""
- * TencentBlueKing is pleased to support the open source community by making 蓝鲸智云-蓝鲸 PaaS 平台(BlueKing-PaaS) available.
- * Copyright (C) 2017-2021 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.
-"""
+# TencentBlueKing is pleased to support the open source community by making
+# 蓝鲸智云 - PaaS 平台 (BlueKing - PaaS System) available.
+# Copyright (C) 2017 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.
+
 
 import logging
 import time
@@ -41,7 +48,7 @@ def __init__(self, status: PollingStatus, data: Optional[Any] = None):
         self.data = data
 
     def __str__(self):
-        return f'stauts={self.status} data={self.data}'
+        return f"stauts={self.status} data={self.data}"
 
     @classmethod
     def doing(cls, *args, **kwargs):
@@ -73,7 +80,7 @@ class TaskPoller(ABC):
     :param metadata: metadata object of current poller
     """
 
-    _registered_pollers: Dict[str, Type['TaskPoller']] = {}
+    _registered_pollers: Dict[str, Type["TaskPoller"]] = {}
 
     max_retries_on_error = 10
     overall_timeout_seconds = 3600 * 24 * 7
@@ -87,7 +94,7 @@ def __init_subclass__(cls, *args, **kwargs):
         cls._registered_pollers[cls.__name__] = cls
 
     @classmethod
-    def get_poller_cls(cls, name: str) -> Type['TaskPoller']:
+    def get_poller_cls(cls, name: str) -> Type["TaskPoller"]:
         return cls._registered_pollers[name]
 
     @classmethod
@@ -145,10 +152,10 @@ def exceeded_max_retries(self) -> bool:
         return (self.metadata.retries + 1) > self.max_retries_on_error
 
     def __str__(self):
-        return '<%s: params=%s>' % (self.__class__.__name__, self.params)
+        return "<%s: params=%s>" % (self.__class__.__name__, self.params)
 
     @classmethod
-    def get_async_task(self) -> Any:
+    def get_async_task(cls) -> Any:
         """Return the async celery task object for polling in backend"""
         return check_status_until_finished
 
@@ -182,10 +189,10 @@ def is_exception(self):
         return self.status.is_exception()
 
     def to_dict(self):
-        return {'status': self.status.value, 'message': self.message, 'data': self.data}
+        return {"status": self.status.value, "message": self.message, "data": self.data}
 
     def __str__(self):
-        return '<%s: %s is_exception=%s>' % (self.__class__.__name__, self.to_dict(), self.is_exception)
+        return "<%s: %s is_exception=%s>" % (self.__class__.__name__, self.to_dict(), self.is_exception)
 
 
 class CallbackHandler(ABC):
@@ -194,13 +201,13 @@ class CallbackHandler(ABC):
     :params: params of current polling result
     """
 
-    _registered_handlers: Dict[str, Type['CallbackHandler']] = {}
+    _registered_handlers: Dict[str, Type["CallbackHandler"]] = {}
 
     def __init_subclass__(cls, *args, **kwargs):
         cls._registered_handlers[cls.__name__] = cls
 
     @classmethod
-    def get_handler_cls(cls, name: str) -> Type['CallbackHandler']:
+    def get_handler_cls(cls, name: str) -> Type["CallbackHandler"]:
         return cls._registered_handlers[name]
 
     @abstractmethod
@@ -220,7 +227,7 @@ def handle(self, result: CallbackResult, poller: TaskPoller):
         pass
 
 
-@shared_task(acks_late=True, name='poll_task.check_status_until_finished')
+@shared_task(acks_late=True, name="poll_task.check_status_until_finished")
 def check_status_until_finished(poller_name: str, handler_name: str, params: Dict, queue: Optional[str] = None):
     """Main async task for polling
 
@@ -232,9 +239,9 @@ def check_status_until_finished(poller_name: str, handler_name: str, params: Dic
     req = check_status_until_finished.request
     metadata = PollingMetadata(
         retries=req.retries,
-        query_started_at=req.get('query_started_at', time.time()),
-        queried_count=req.get('queried_count', 0),
-        last_polling_data=req.get('last_polling_data'),
+        query_started_at=req.get("query_started_at", time.time()),
+        queried_count=req.get("queried_count", 0),
+        last_polling_data=req.get("last_polling_data"),
     )
 
     # Make handler and poller by name
@@ -250,18 +257,18 @@ def check_status_until_finished(poller_name: str, handler_name: str, params: Dic
     if next_metadata:
         # Start next polling
         countdown = poller.get_retry_delay()
-        logger.debug('Will retry query status for %s after %s seconds. metadata=%s', poller, countdown, metadata)
+        logger.debug("Will retry query status for %s after %s seconds. metadata=%s", poller, countdown, metadata)
         poller.get_async_task().subtask(
             args=(poller_name, handler_name, params),
-            kwargs={'queue': queue},
+            kwargs={"queue": queue},
             countdown=countdown,
             retries=next_metadata.retries,
             queue=queue,
         ).apply_async(
             headers={
-                'queried_count': next_metadata.queried_count,
-                'query_started_at': next_metadata.query_started_at,
-                'last_polling_data': next_metadata.last_polling_data,
+                "queried_count": next_metadata.queried_count,
+                "query_started_at": next_metadata.query_started_at,
+                "last_polling_data": next_metadata.last_polling_data,
             }
         )
 
@@ -280,7 +287,7 @@ def __init__(self, poller: TaskPoller, handler_cls: Type[CallbackHandler]):
     def run(self) -> Optional[PollingMetadata]:
         """Start schedule process"""
         if self.poller.exceeded_timeout():
-            logger.info('exceeded total timeout, ts_query_started=%s' % self.poller.metadata.query_started_at)
+            logger.info("exceeded total timeout, ts_query_started=%s", self.poller.metadata.query_started_at)
             self._callback_timeout()
             return None
 
@@ -314,10 +321,10 @@ def _safe_query(poller: TaskPoller) -> PollingResult:
         try:
             polling_result = poller.query()
         except Exception as e:
-            logger.exception('Exception when query status, poll_class=%s' % poller)
+            logger.exception("Exception when query status, poll_class=%s", poller)
             raise PollingQueryError(str(e))
 
-        logger.debug('Query status result, poll_class=%s, polling result: %s' % (poller, polling_result))
+        logger.debug("Query status result, poll_class=%s, polling result: %s", poller, polling_result)
         return polling_result
 
     def _callback(self, result: CallbackResult):
@@ -326,10 +333,10 @@ def _callback(self, result: CallbackResult):
 
     def _callback_timeout(self):
         """Callback handler with timeout result"""
-        ret = CallbackResult(status=CallbackStatus.TIMEOUT, message='exceeded total timeout')
+        ret = CallbackResult(status=CallbackStatus.TIMEOUT, message="exceeded total timeout")
         self.handler_cls().handle(ret, self.poller)
 
     def _callback_exception(self, e: Exception):
         """Callback handler when exceeds max retries"""
-        ret = CallbackResult(status=CallbackStatus.EXCEPTION, message=f'exception: {e}')
+        ret = CallbackResult(status=CallbackStatus.EXCEPTION, message=f"exception: {e}")
         self.handler_cls().handle(ret, self.poller)