Add ruff lint #10

Author: shijiesheng

.github/workflows/ci_checks.yml

@@ -0,0 +1,36 @@
+name: CI Checks
+on:
+  push:
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v1
+      - name: Install dependencies
+        run: |
+          uv sync
+      - name: Ensure Proto Files changes are committed
+        run: |
+          uv run python scripts/generate_proto.py
+          if [ -n "$(git status --porcelain  2>&1)" ]; then
+            echo "There are file changes after generating proto files."
+            echo "Please run this command and commit the changes:"
+            echo "\tuv run python scripts/generate_proto.py"
+            git status --porcelain
+            git --no-pager diff
+            exit 1
+          fi
+      - name: Run Ruff linter
+        run: |
+          uv tool run ruff check

cadence/sample/grpc_usage_example.py

@@ -5,8 +5,7 @@
 """
 
 import grpc
-from google.protobuf import duration_pb2
-from cadence.api.v1 import service_workflow_grpc, service_workflow, workflow, common, tasklist
+from cadence.api.v1 import service_workflow_grpc, service_workflow, common
 
 
 def create_grpc_channel(server_address: str = "localhost:7833", use_ssl: bool = False) -> grpc.Channel:

cadence/sample/simple_usage_example.py

@@ -23,7 +23,7 @@ def example_workflow_execution():
     wf_exec.workflow_id = "my-workflow-123"
     wf_exec.run_id = "run-456"
 
-    print(f"Created workflow execution:")
+    print("Created workflow execution:")
     print(f"  - Workflow ID: {wf_exec.workflow_id}")
     print(f"  - Run ID: {wf_exec.run_id}")
 
@@ -34,7 +34,7 @@ def example_workflow_execution():
     wf_info.start_time.seconds = 1234567890
     wf_info.close_time.seconds = 1234567990
 
-    print(f"Created workflow execution info:")
+    print("Created workflow execution info:")
     print(f"  - Type: {wf_info.type.name}")
     print(f"  - Start Time: {wf_info.start_time.seconds}")
     print(f"  - Close Time: {wf_info.close_time.seconds}")
@@ -54,7 +54,7 @@ def example_domain_operations():
     domain_obj.status = domain.DOMAIN_STATUS_REGISTERED
     domain_obj.description = "My test domain"
 
-    print(f"Created domain:")
+    print("Created domain:")
     print(f"  - Name: {domain_obj.name}")
     print(f"  - Status: {domain_obj.status}")
     print(f"  - Description: {domain_obj.description}")
@@ -94,7 +94,7 @@ def example_serialization():
     """Example of serializing and deserializing protobuf objects."""
     print("\n=== Serialization Example ===")
 
-    from cadence.api.v1 import common, workflow
+    from cadence.api.v1 import common
 
     # Create a workflow execution
     wf_exec = common.WorkflowExecution()
@@ -109,7 +109,7 @@ def example_serialization():
     new_wf_exec = common.WorkflowExecution()
     new_wf_exec.ParseFromString(serialized)
 
-    print(f"Deserialized workflow execution:")
+    print("Deserialized workflow execution:")
     print(f"  - Workflow ID: {new_wf_exec.workflow_id}")
     print(f"  - Run ID: {new_wf_exec.run_id}")
 

pyproject.toml

@@ -156,4 +156,9 @@ exclude_lines = [
     "if __name__ == .__main__.:",
     "class .*\\bProtocol\\):",
     "@(abc.)?abstractmethod",
-] 
+]
+
+[tool.ruff]
+exclude = [
+    "cadence/api", # generated proto files
+]

scripts/dev.py

@@ -14,7 +14,7 @@ def run_command(cmd, description):
     """Run a command and handle errors."""
     print(f"Running: {description}")
     try:
-        result = subprocess.run(cmd, shell=True, check=True)
+        subprocess.run(cmd, shell=True, check=True)
         print(f"✓ {description} completed successfully")
         return True
     except subprocess.CalledProcessError as e:
@@ -50,12 +50,12 @@ def lint():
         ("uv run flake8 .", "Running flake8 linting"),
         ("uv run mypy .", "Running mypy type checking"),
     ]
-    
+
     success = True
     for cmd, desc in commands:
         if not run_command(cmd, desc):
             success = False
-    
+
     return success
 
 
@@ -65,12 +65,12 @@ def format():
         ("uv run black .", "Formatting code with black"),
         ("uv run isort .", "Sorting imports with isort"),
     ]
-    
+
     success = True
     for cmd, desc in commands:
         if not run_command(cmd, desc):
             success = False
-    
+
     return success
 
 
@@ -85,22 +85,17 @@ def clean():
         "htmlcov/",
         ".mypy_cache/",
     ]
-    
-    files_to_remove = [
-        "*.pyc",
-        "__pycache__",
-    ]
-    
+
     print("Cleaning build artifacts...")
-    
+
     # Remove directories
     for dir_pattern in dirs_to_remove:
         run_command(f"rm -rf {dir_pattern}", f"Removing {dir_pattern}")
-    
+
     # Remove Python cache files
     run_command("find . -type d -name __pycache__ -delete", "Removing __pycache__ directories")
     run_command("find . -type f -name '*.pyc' -delete", "Removing .pyc files")
-    
+
     print("✓ Clean completed")
 
 
@@ -135,12 +130,12 @@ def main():
     """Main function."""
     parser = argparse.ArgumentParser(description="Development script for Cadence Python client")
     parser.add_argument("command", choices=[
-        "install", "install-dev", "test", "test-cov", "lint", "format", 
+        "install", "install-dev", "test", "test-cov", "lint", "format",
         "clean", "build", "protobuf", "docs", "check"
     ], help="Command to run")
-    
+
     args = parser.parse_args()
-    
+
     # Map commands to functions
     commands = {
         "install": install,
@@ -155,13 +150,13 @@ def main():
         "docs": docs,
         "check": check,
     }
-    
+
     # Run the command
     success = commands[args.command]()
-    
+
     if not success:
         sys.exit(1)
 
 
 if __name__ == "__main__":
-    main() 
+    main()