feat: paas-service support py3.11 (TencentBlueKing#193)

Author: narasux

sdks/paas-service/CHANGES.md

@@ -1,11 +1,15 @@
 # 版本历史
-# 1.1.6
+
+## 2.0.0
+- 支持 Python 3.11，移除对 Python 3.6, 3.7 的支持
+
+## 1.1.6
 - Loosen the version restriction on sub-dep `pyjwt`
 
-# 1.1.5
+## 1.1.5
 - 支持通过 name 查询 service instance
 
-# 1.1.4
+## 1.1.4
 - 版权申明格式修改
 
 ## 1.1.3

sdks/paas-service/paas_service/__init__.py

@@ -16,6 +16,6 @@
 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__ = '1.1.6'
+__version__ = '2.0.0'
 
 default_app_config = 'paas_service.apps.PaaSServiceConfig'

sdks/paas-service/paas_service/auth/backends.py

@@ -31,7 +31,7 @@
 
 
 class AuthFailedError(Exception):
-    """Raised when one authenticater fails"""
+    """Raised when one authenticator fails"""
 
 
 class InstanceAuthFailed(Exception):
@@ -66,8 +66,8 @@ def __init__(self, client: Client, extra_payload: Dict):
         self.extra_payload = extra_payload
 
 
-class JWTClientAuthenticater:
-    """Authenticater using JWT clients"""
+class JWTClientAuthenticator:
+    """Authenticator using JWT clients"""
 
     def __init__(self):
         try:
@@ -112,7 +112,7 @@ def parse(self, token: str) -> Tuple[Dict, Client]:
 
     @staticmethod
     def _validate_payload(client: Dict, payload: Dict) -> bool:
-        """Validates given JWT payload, a valid payload must contains at least 2 fields:
+        """Validates given JWT payload, a valid payload must contain at least 2 fields:
         'iss' and 'expires_at'.
         """
         expires_at = payload.get('expires_at')
@@ -136,21 +136,21 @@ class InstanceAuthBackend:
     TOKEN_KEY = 'token'
 
     def __init__(self):
-        self.authenticaters = [JWTClientAuthenticater()]
+        self.authenticators = [JWTClientAuthenticator()]
 
     def get_token(self, request: WSGIRequest):
         return request.GET.get(self.TOKEN_KEY, None)
 
     def invoke(self, request: WSGIRequest) -> ServiceInstance:
-        """Invoke currrent bakend
+        """Invoke current backend
 
         :raises: InstanceAuthFailed
         """
         token = self.get_token(request)
         if not token:
             raise InstanceAuthFailed('token parameter is missing')
 
-        for auth in self.authenticaters:
+        for auth in self.authenticators:
             try:
                 result = auth.authenticate(token)
                 break
@@ -189,7 +189,7 @@ def sign_role_aware_token(client_name: str, role_name: str) -> str:
 
 
 def _sign_token(client_name: str, additional_payload: Dict) -> str:
-    """Sign a new JWT token using given client's crendentials, this token can be used
+    """Sign a new JWT token using given client's credentials, this token can be used
     for an InstanceAuthBackend's authentication process.
 
     :returns: a JWT token which will expires after 3600 seconds
@@ -199,6 +199,6 @@ def _sign_token(client_name: str, additional_payload: Dict) -> str:
         if client_name == client_data['iss']:
             payload = {'iss': client_name, 'expires_at': int(time.time()) + 3600}
             payload.update(additional_payload)
-            return jwt.encode(payload, key=client_data['key'], algorithm=client_data['algorithm']).decode()
+            return jwt.encode(payload, key=client_data['key'], algorithm=client_data['algorithm'])
     else:
         raise ValueError(f'client name {client_name} is invalid')

sdks/paas-service/paas_service/auth/middleware.py

@@ -19,13 +19,13 @@
 import logging
 from typing import Optional
 
-from .backends import AuthFailedError, JWTClientAuthenticater
+from .backends import AuthFailedError, JWTClientAuthenticator
 
 logger = logging.getLogger(__name__)
 
 
 class VerifiedClientMiddleware(object):
-    """This middleware will inject request.verifed_client if current request has a valid
+    """This middleware will inject request.verified_client if current request has a valid
     signed JWT token in request headers
     """
 
@@ -52,7 +52,7 @@ def __call__(self, request):
         request.client = None
         if token:
             try:
-                ret = JWTClientAuthenticater().authenticate(token=token)
+                ret = JWTClientAuthenticator().authenticate(token=token)
                 request.client = ret.client
             except AuthFailedError:
                 pass

sdks/paas-service/paas_service/urls.py

@@ -16,65 +16,65 @@
 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 django.conf.urls import url
+from django.urls import re_path
 
 from . import views
 
-urlpatterns = [url(r"^authenticate/$", views.AuthenticationViewSet.as_view(), name='authenticate')]
+urlpatterns = [re_path(r"^authenticate/$", views.AuthenticationViewSet.as_view(), name='authenticate')]
 
 urlpatterns += [
-    url(r'^meta_info/$', views.SvcBasicViewSet.as_view({'get': 'get_meta_info'}), name='api.services.get_meta_info'),
-    url(
+    re_path(r'^meta_info/$', views.SvcBasicViewSet.as_view({'get': 'get_meta_info'}), name='api.services.get_meta_info'),
+    re_path(
         r'^services/$',
         views.ServiceManageViewSet.as_view({'get': 'list', 'post': 'create'}),
         name='api.services.index',
     ),
-    url(
+    re_path(
         r'^services/(?P<service_id>[0-9a-f-]{32,36})/$',
         views.ServiceManageViewSet.as_view({'put': 'update'}),
         name='api.services.update',
     ),
-    url(
+    re_path(
         r'^services/(?P<service_id>[0-9a-f-]{32,36})/instances/(?P<instance_id>[0-9a-f-]{32,36})/$',
         views.SvcInstanceViewSet.as_view({'post': 'provision'}),
         name='api.services.instances_creation',
     ),
-    url(
+    re_path(
         r'^services/(?P<service_id>[0-9a-f-]{32,36})/instances/$',
         views.SvcInstanceViewSet.as_view({'get': 'retrieve_by_fields'}),
         name='api.services.instances_retrieve_by_fields',
     ),
-    url(
+    re_path(
         r'^services/(?P<service_id>[0-9a-f-]{32,36})/client-side-instances/(?P<instance_id>[0-9a-f-]{32,36})/$',
         views.ClientSideSvcInstanceViewSet.as_view({'post': 'create'}),
         name='api.services.client_side_instances_creation',
     ),
-    url(
+    re_path(
         r'^plans/$',
         views.PlanManageViewSet.as_view({'post': 'create'}),
         name='api.plans.index',
     ),
-    url(
+    re_path(
         r'^plans/(?P<plan_id>[0-9a-f-]{32,36})/$',
         views.PlanManageViewSet.as_view({'put': 'update'}),
         name='api.plans.update',
     ),
-    url(
+    re_path(
         r'^instances/(?P<instance_id>[0-9a-f-]{32,36})/$',
         views.SvcInstanceViewSet.as_view({'get': 'retrieve', 'patch': 'update', 'delete': 'destroy'}),
         name='api.services.instance',
     ),
-    url(
+    re_path(
         r'^instances/(?P<instance_id>[0-9a-f-]{32,36})/async_delete$',
         views.SvcInstanceViewSet.as_view({'delete': 'async_destroy'}),
         name='api.services.instance.async_destroy',
     ),
-    url(
+    re_path(
         r'^client-side-instances/(?P<instance_id>[0-9a-f-]{32,36})/',
         views.ClientSideSvcInstanceViewSet.as_view({'delete': 'destroy'}),
         name='api.services.client_side_instance.destroy',
     ),
-    url(
+    re_path(
         r'^instances/(?P<instance_id>[0-9a-f-]{32,36})/config/$',
         views.SvcInstanceConfigViewSet.as_view({'get': 'retrieve', 'put': 'update'}),
         name='api.services.instance_config',

sdks/paas-service/paas_service/views.py

@@ -80,14 +80,14 @@ def list(self, request):
     def update(self, request, service_id):
         service = get_object_or_404(Service, pk=service_id)
         slz = serializers.ServiceUpsertSLZ(data=request.data, instance=service, partial=True)
-        slz.is_valid(True)
+        slz.is_valid(raise_exception=True)
         slz.save()
         return Response(status=status.HTTP_204_NO_CONTENT)
 
     @verified_client_role_require('internal_platform')
     def create(self, request):
         slz = serializers.ServiceUpsertSLZ(data=request.data)
-        slz.is_valid(True)
+        slz.is_valid(raise_exception=True)
         slz.save()
         return Response(status=status.HTTP_201_CREATED)
 
@@ -104,16 +104,16 @@ class PlanManageViewSet(viewsets.ViewSet):
     @verified_client_role_require('internal_platform')
     def create(self, request):
         slz = serializers.PlanUpsertSLZ(data=request.data)
-        slz.is_valid(True)
+        slz.is_valid(raise_exception=True)
         slz.save()
         return Response(status=status.HTTP_201_CREATED)
 
     @verified_client_role_require('internal_platform')
     def update(self, request, plan_id):
         plan = get_object_or_404(Plan, pk=plan_id)
         slz = serializers.PlanUpsertSLZ(data=request.data, instance=plan, partial=True)
-        slz.is_valid(True)
-        plan = slz.save()
+        slz.is_valid(raise_exception=True)
+        slz.save()
         return Response(status=status.HTTP_204_NO_CONTENT)
 
     @verified_client_role_require('internal_platform')