[Feature] Code style and CI process updates (#39)

* style: update something

* docs: update README.md

* docs: update PR template

* docs: update samples

Author: cnzakii

.flake8

@@ -1,5 +1,7 @@
 ## What is the purpose of the change
 
+<!-- Please provide the Issue number and link corresponding to the PR. -->
+ISSUE: [#issue_number](issue_link)
 
 
 ## Brief changelog

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+name: License Template Check
+
+on: [push, pull_request]
+
+
+jobs:
+  license-check:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+      - name: Check License Header
+        run:  bash ./scripts/check_license.sh

.github/workflows/license-check.yaml

@@ -0,0 +1,18 @@
+name: Lint Python Code
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install ruff
+      - name: Run Ruff
+        run: ruff check --output-format=github . --config=pyproject.toml

.github/workflows/python-lint-and-license-check.yml

@@ -0,0 +1,24 @@
+# This file is used to ignore files and directories from the license scan
+# Note: these patterns are applied to single files or directories, not full paths
+
+# file extensions
+.*md
+.*proto
+
+# files
+.asf.yaml
+LICENSE
+NOTICE
+README.md
+requirements.txt
+rat-report.txt
+
+# directories
+.vscode
+.idea
+.github
+.gitignore
+.license-ignore
+./samples/proto/*
+
+

.github/workflows/python-lint.yaml

@@ -1,6 +1,8 @@
-# Apache Dubbo for python
+# Apache Dubbo for Python
 
 ![License](https://img.shields.io/github/license/apache/dubbo-python)
+![GitHub last commit](https://img.shields.io/github/last-commit/apache/dubbo-python)
+![GitHub branch check runs](https://img.shields.io/github/check-runs/apache/dubbo-python/main)
 
 ---
 
@@ -21,7 +23,7 @@ Visit [the official website](https://dubbo.apache.org/) for more information.
 ## Features
 
 - **Service Discovery**: Zookeeper
-- **Load Balance**: Random
+- **Load Balance**: Random, CPU
 - **RPC Protocols**: Triple(gRPC compatible and HTTP-friendly)
 - **Transport**: asyncio(uvloop)
 - **Serialization**: Customizable(protobuf, json...)

.github/workflows/unittest.yml

@@ -17,6 +17,5 @@
 from .bootstrap import Dubbo
 from .client import Client
 from .server import Server
-from .__version__ import __version__
 
 __all__ = ["Dubbo", "Client", "Server"]

.license-ignore

@@ -40,7 +40,6 @@
 
 
 class Client:
-
     def __init__(self, reference: ReferenceConfig, dubbo: Optional[Dubbo] = None):
         self._initialized = False
         self._global_lock = threading.RLock()

.licenserc.yaml

@@ -15,3 +15,5 @@
 # limitations under the License.
 
 from ._interfaces import Cluster, Directory, LoadBalance
+
+__all__ = ["Cluster", "Directory", "LoadBalance"]

README.md

@@ -39,7 +39,6 @@ def __init__(self, directory, url: URL):
             self._load_balance.set_monitor(directory)
 
     def invoke(self, invocation) -> Result:
-
         # get the invokers
         invokers = self._directory.list(invocation)
         if not invokers:

dubbo/__init__.py

@@ -172,5 +172,7 @@ def get_cpu_usage(interval) -> bytes:
         :return: The CPU usage.
         :rtype: bytes
         """
-        float_value = CpuUtils.get_total_cpu_usage(interval=int(interval.decode("utf-8")))
+        float_value = CpuUtils.get_total_cpu_usage(
+            interval=int(interval.decode("utf-8"))
+        )
         return str(float_value).encode("utf-8")

dubbo/client.py

@@ -17,4 +17,6 @@
 from dubbo.extension.extension_loader import ExtensionError
 from dubbo.extension.extension_loader import ExtensionLoader as _ExtensionLoader
 
+__all__ = ["ExtensionError", "extensionLoader"]
+
 extensionLoader = _ExtensionLoader()

dubbo/cluster/__init__.py

@@ -15,3 +15,5 @@
 # limitations under the License.
 
 from ._interfaces import AbstractLoadBalance, LoadBalance
+
+__all__ = ["AbstractLoadBalance", "LoadBalance"]

dubbo/cluster/failfast_cluster.py

@@ -24,7 +24,6 @@
 
 
 class Invocation(abc.ABC):
-
     @abc.abstractmethod
     def get_service_name(self) -> str:
         """
@@ -103,7 +102,6 @@ def invoke(self, invocation: Invocation) -> Result:
 
 
 class Protocol(abc.ABC):
-
     @abc.abstractmethod
     def export(self, url: URL):
         """

dubbo/cluster/monitor/cpu.py

@@ -43,7 +43,6 @@
 
 
 class TripleServerCall(ServerCall, ServerStream.Listener):
-
     def __init__(
         self,
         stream: ServerStream,
@@ -172,7 +171,6 @@ def __init__(
         client_stream: bool,
         server_stream: bool,
     ):
-
         self._server_call: TripleServerCall = server_call
         self._func = func
 

dubbo/extension/__init__.py

@@ -241,7 +241,6 @@ def _process_payload(self) -> None:
         self._state = HEADER
 
     class Listener(abc.ABC):
-
         @abc.abstractmethod
         def on_message(self, message: bytes):
             """

dubbo/loadbalance/__init__.py

@@ -16,6 +16,7 @@
 
 import functools
 import uuid
+from collections.abc import Iterable
 from concurrent.futures import ThreadPoolExecutor
 from typing import Dict, Optional
 
@@ -63,7 +64,7 @@ def export(self, url: URL):
 
         service_handler = url.attributes[common_constants.SERVICE_HANDLER_KEY]
 
-        if iter(service_handler):
+        if isinstance(service_handler, Iterable):
             for handler in service_handler:
                 self._path_resolver[handler.service_name] = handler
         else:

dubbo/protocol/_interfaces.py

@@ -41,7 +41,6 @@
 
 
 class TripleServerStream(ServerStream):
-
     def __init__(self, stream: Http2Stream):
         self._stream = stream
 

dubbo/protocol/triple/call/server_call.py

@@ -24,7 +24,6 @@
 
 
 class RpcCallable(abc.ABC):
-
     @abc.abstractmethod
     def __call__(self, *args, **kwargs):
         """
@@ -34,7 +33,6 @@ def __call__(self, *args, **kwargs):
 
 
 class RpcCallableFactory(abc.ABC):
-
     @abc.abstractmethod
     def get_callable(self, invoker: Invoker, url: URL) -> RpcCallable:
         """

dubbo/protocol/triple/coders.py

@@ -39,7 +39,6 @@ def notify(self, urls: List[URL]) -> None:
 
 
 class Registry(Node, abc.ABC):
-
     @abc.abstractmethod
     def register(self, url: URL) -> None:
         """
@@ -94,7 +93,6 @@ def lookup(self, url: URL) -> None:
 
 
 class RegistryFactory(abc.ABC):
-
     @abc.abstractmethod
     def get_registry(self, url: URL) -> Registry:
         """