Merge pull request #6 from ExplorerRay/lint

Ensure pylint Github action pass

Author: congwang-mk

.github/workflows/pylint.yml

@@ -1,23 +1,36 @@
 name: Pylint
 
-on: [push]
+on:
+  push:
+  pull_request:
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10"]
     steps:
     - uses: actions/checkout@v4
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
+
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+        virtualenvs-path: .venv
+        installer-parallel: true
+
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install pylint
+        poetry install --no-interaction
+
     - name: Analysing the code with pylint
       run: |
+        source .venv/bin/activate
         pylint $(git ls-files '*.py')

.gitignore

@@ -0,0 +1 @@
+__pycache__/

pyproject.toml

@@ -11,7 +11,7 @@ readme = "README.md"
 packages = [{include = "kerf", from = "src"}]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9"
 pylibfdt = "^1.7.0"
 click = "^8.0.0"
 pyyaml = "^6.0"
@@ -29,10 +29,9 @@ pylint = "^3.0.0"
 kerf = "kerf.cli:main"
 
 [tool.pylint.main]
-py-version = "3.8"
+py-version = "3.9"
 jobs = 0
 ignore-patterns = ["^\\.#"]
-suggestion-mode = true
 
 [tool.pylint.messages_control]
 disable = [
@@ -44,7 +43,18 @@ disable = [
     "too-many-locals",
     "too-many-branches",
     "too-many-statements",
-    "invalid-name",
+    "line-too-long",
+    "duplicate-code",
+    "too-many-nested-blocks",
+    "too-many-positional-arguments",
+    "too-many-return-statements",
+    "too-many-instance-attributes",
+    "too-many-lines",
+    "fixme",
+    "import-outside-toplevel",
+    "broad-exception-caught",
+    "no-value-for-parameter",
+    "redefined-builtin",
 ]
 
 [tool.pylint.format]

setup.py

@@ -26,7 +26,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, capture_output=True, text=True)
+        subprocess.run(cmd, shell=True, check=True, capture_output=True, text=True)
         print(f"✓ {description} completed successfully")
         return True
     except subprocess.CalledProcessError as e:
@@ -43,46 +43,47 @@ def main():
     """Set up the development environment."""
     print("Setting up kerf development environment...")
     print("=" * 50)
-    
+
     # Check if we're in the right directory
     if not Path("pyproject.toml").exists():
         print("Error: pyproject.toml not found. Please run this script from the project root.")
         return 1
-    
+
     # Install dependencies
     print("\n1. Installing dependencies...")
     if not run_command("pip install -e .", "Installing kerf in development mode"):
         return 1
-    
+
     # Install development dependencies
     print("\n2. Installing development dependencies...")
-    if not run_command("pip install pytest pytest-cov black flake8 mypy", "Installing dev dependencies"):
+    cmd = "pip install pytest pytest-cov black flake8 mypy"
+    if not run_command(cmd, "Installing dev dependencies"):
         return 1
-    
+
     # Run tests
     print("\n3. Running tests...")
     if not run_command("python -m pytest tests/", "Running test suite"):
         return 1
-    
+
     # Check code formatting
     print("\n4. Checking code formatting...")
     if not run_command("black --check src/kerf/", "Checking code formatting"):
         print("  Note: Run 'black src/kerf/' to fix formatting issues")
-    
+
     # Run linting
     print("\n5. Running linting...")
     if not run_command("flake8 src/kerf/", "Running flake8 linting"):
         print("  Note: Fix linting issues before committing")
-    
+
     print("\n" + "=" * 50)
     print("✓ Development environment setup complete!")
     print("\nNext steps:")
     print("1. Run 'python -m pytest tests/' to test the implementation")
     print("2. Run 'kerf --help' to see available commands")
     print("3. Try: kerf dtc --input=examples/system.dts --output-dir=build/")
-    
+
     return 0
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     sys.exit(main())

src/kerf/__init__.py

@@ -15,7 +15,8 @@
 """
 kerf: Multikernel Management System
 
-A comprehensive multikernel management system designed to orchestrate and manage multiple kernel instances on a single host.
+A comprehensive multikernel management system designed to orchestrate
+and manage multiple kernel instances on a single host.
 """
 
 __version__ = "0.1.0"
@@ -48,26 +49,26 @@
 
 __all__ = [
     # Core classes
-    'DeviceTreeManager',
-    'BaselineManager',
-    'OverlayGenerator',
+    "DeviceTreeManager",
+    "BaselineManager",
+    "OverlayGenerator",
     # Models
-    'InstanceState',
+    "InstanceState",
     # Exceptions
-    'KerfError',
-    'ValidationError',
-    'ParseError',
-    'ResourceConflictError',
-    'ResourceExhaustionError',
-    'InvalidReferenceError',
-    'KernelInterfaceError',
-    'ResourceError',
+    "KerfError",
+    "ValidationError",
+    "ParseError",
+    "ResourceConflictError",
+    "ResourceExhaustionError",
+    "InvalidReferenceError",
+    "KernelInterfaceError",
+    "ResourceError",
     # Resource utilities
-    'get_available_cpus',
-    'get_allocated_cpus',
-    'get_allocated_memory_regions',
-    'find_available_memory_base',
-    'validate_cpu_allocation',
-    'validate_memory_allocation',
-    'find_next_instance_id',
+    "get_available_cpus",
+    "get_allocated_cpus",
+    "get_allocated_memory_regions",
+    "find_available_memory_base",
+    "validate_cpu_allocation",
+    "validate_memory_allocation",
+    "find_next_instance_id",
 ]

src/kerf/baseline.py

@@ -85,9 +85,7 @@ def validate_baseline(self, tree: GlobalDeviceTree) -> None:
 
         # Baseline must contain resources
         if not tree.hardware:
-            raise ValidationError(
-                "Baseline device tree must contain hardware resources section."
-            )
+            raise ValidationError("Baseline device tree must contain hardware resources section.")
 
         # Validate resources structure
         if not tree.hardware.cpus:
@@ -124,27 +122,26 @@ def write_baseline(self, tree: GlobalDeviceTree) -> None:
         try:
             dtb_data = self.extractor.generate_global_dtb(tree)
         except Exception as e:
-            raise KernelInterfaceError(
-                f"Failed to generate baseline device tree blob: {e}"
-            ) from e
+            raise KernelInterfaceError(f"Failed to generate baseline device tree blob: {e}") from e
 
         # The kernfs write operation is handled atomically by the kernel
         try:
-            with open(self.baseline_path, 'wb') as f:
+            with open(self.baseline_path, "wb") as f:
                 f.write(dtb_data)
                 f.flush()
                 os.fsync(f.fileno())
 
             if not self.baseline_path.exists():
                 raise KernelInterfaceError(
-                    f"Baseline DTB write completed but file does not exist at {self.baseline_path}. "
-                    f"Kernel may have rejected the write operation."
+                    f"Baseline DTB write completed but file does not exist at "
+                    f"{self.baseline_path}. "
+                    "Kernel may have rejected the write operation."
                 )
             file_size = self.baseline_path.stat().st_size
             if file_size == 0:
                 raise KernelInterfaceError(
-                    f"Baseline DTB written but file is empty. "
-                    f"Kernel may have rejected the DTB format."
+                    "Baseline DTB written but file is empty. "
+                    "Kernel may have rejected the DTB format."
                 )
 
         except OSError as e:
@@ -170,13 +167,12 @@ def read_baseline(self) -> GlobalDeviceTree:
                     "Initialize it first with 'kerf init'."
                 )
 
-            with open(self.baseline_path, 'rb') as f:
+            with open(self.baseline_path, "rb") as f:
                 dtb_data = f.read()
 
             if not dtb_data:
                 raise KernelInterfaceError(
-                    f"Root device tree is empty. "
-                    "Initialize it first with 'kerf init'."
+                    "Root device tree is empty. Initialize it first with 'kerf init'."
                 )
 
             tree = self.parser.parse_dtb_from_bytes(dtb_data)
@@ -188,7 +184,4 @@ def read_baseline(self) -> GlobalDeviceTree:
                 f"Failed to read root device tree from {self.baseline_path}: {e}"
             ) from e
         except ParseError as e:
-            raise ParseError(
-                f"Failed to parse root device tree: {e}"
-            ) from e
-
+            raise ParseError(f"Failed to parse root device tree: {e}") from e

src/kerf/cli.py

@@ -30,12 +30,12 @@
 
 @click.group()
 @click.version_option(version="0.1.0", prog_name="kerf")
-@click.option('--debug', is_flag=True, help='Enable debug mode')
+@click.option("--debug", is_flag=True, help="Enable debug mode")
 @click.pass_context
 def main(ctx, debug):
     """kerf: Multikernel Management System - Device Tree Foundation."""
     ctx.ensure_object(dict)
-    ctx.obj['debug'] = debug
+    ctx.obj["debug"] = debug
 
 
 # Add subcommands
@@ -50,5 +50,5 @@ def main(ctx, debug):
 main.add_command(show)
 
 
-if __name__ == '__main__':
-    main()
+if __name__ == "__main__":
+    main()

src/kerf/create/__init__.py

@@ -15,4 +15,3 @@
 """
 Create kernel instance command.
 """
-