add pre-commit

.github/workflows/checks.yml

@@ -0,0 +1,19 @@
+name: checks
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.9"
+    - uses: pre-commit/[email protected]
+      with:
+        extra_args: --all-files

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.2.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-case-conflict
+  - id: check-executables-have-shebangs
+  - id: check-symlinks
+  - id: check-merge-conflict
+  - id: check-yaml
+  - id: check-added-large-files
+- repo: https://github.com/pre-commit/mirrors-clang-format
+  rev: v16.0.6
+  hooks:
+  - id: clang-format
+- repo: https://github.com/psf/black
+  rev: 24.4.2
+  hooks:
+  - id: black
+    language_version: python3.9
+exclude: |
+  (?x)^(
+      .*\.ipynb|
+      build/.*|
+      external/.*|
+      src/sgl/python/py_doc.h
+  )$

.vscode-default/launch.json

@@ -71,7 +71,9 @@
             "windows": {
                 "program": "${config:python.defaultInterpreterPath}"
             },
-            "args": [ "${workspaceFolder}/scripts/internal/python/simple.py" ],
+            "args": [
+                "${workspaceFolder}/scripts/internal/python/simple.py"
+            ],
             "stopAtEntry": false,
             "cwd": "${command:cmake.launchTargetDirectory}",
             "environment": [

docs/src/basic_tutorials.rst

@@ -8,4 +8,3 @@ Basic Tutorials
 
     tutorials/image_io_and_manipulation
     tutorials/compute_shader
-

examples/print/print.py

@@ -3,10 +3,15 @@
 
 EXAMPLE_DIR = Path(__file__).parent
 
-device = sgl.Device(enable_print=True, compiler_options={"include_paths": [EXAMPLE_DIR]})
+device = sgl.Device(
+    enable_print=True,
+    compiler_options={
+        "include_paths": [EXAMPLE_DIR],
+    },
+)
 
 program = device.load_program("print.slang", ["main"])
 kernel = device.create_compute_kernel(program)
-kernel.dispatch(thread_count=[2,2,1])
+kernel.dispatch(thread_count=[2, 2, 1])
 
 device.flush_print()

setup.py

@@ -21,11 +21,11 @@
 SOURCE_DIR = Path(__file__).parent.resolve()
 
 if sys.platform.startswith("win"):
-    PLATFORM="windows"
+    PLATFORM = "windows"
 elif sys.platform.startswith("linux"):
-    PLATFORM="linux"
+    PLATFORM = "linux"
 elif sys.platform.startswith("darwin"):
-    PLATFORM="macos"
+    PLATFORM = "macos"
 else:
     raise Exception(f"Unsupported platform: {sys.platform}")
 
@@ -41,6 +41,7 @@
     "macos": "macos-clang",
 }[PLATFORM]
 
+
 # A CMakeExtension needs a sourcedir instead of a file list.
 # The name must be the _single_ output extension from the CMake build.
 # If you need multiple extensions, see scikit-build.
@@ -66,6 +67,7 @@ def build_extension(self, ext: CMakeExtension) -> None:
         env = os.environ.copy()
         if os.name == "nt":
             import setuptools.msvc
+
             env = setuptools.msvc.msvc14_get_vc_env("x64")
 
         build_dir = str(SOURCE_DIR / "build/pip")

src/sgl/device/tests/__init__.py

@@ -1,2 +1 @@
 # SPDX-License-Identifier: Apache-2.0
-

src/sgl/device/tests/slang/test_float16.py

@@ -13,7 +13,9 @@
 
 
 @pytest.mark.parametrize("view", ["uav", "srv"])
-@pytest.mark.parametrize("shader_model", helpers.all_shader_models_from(sgl.ShaderModel.sm_6_2))
+@pytest.mark.parametrize(
+    "shader_model", helpers.all_shader_models_from(sgl.ShaderModel.sm_6_2)
+)
 @pytest.mark.parametrize("device_type", helpers.DEFAULT_DEVICE_TYPES)
 def test_float16(device_type, shader_model, view):
     device = helpers.get_device(device_type)

tools/pymacro.py

@@ -8,26 +8,30 @@
 from enum import Enum
 from io import StringIO
 
+
 class Capturing(list):
     def __enter__(self):
         self._stdout = sys.stdout
         sys.stdout = self._stringio = StringIO()
         return self
+
     def __exit__(self, *args):
         self.extend(self._stringio.getvalue().splitlines())
-        del self._stringio    # free up some memory
+        del self._stringio  # free up some memory
         sys.stdout = self._stdout
 
 
 HEADER_START_RE = re.compile(r"^\s*\/\*\s*<<<PYMACRO\s*$")
 HEADER_END_RE = re.compile(r"^\s*>>>\s*\*\/\s*$")
 FOOTER_RE = re.compile(r"^\s*\/\*\s+<<<PYMACROEND>>>\s*\*\/\s*$")
 
+
 class State(Enum):
     IDLE = 1
     HEADER = 2
     CONTENT = 3
 
+
 def process_file(path: Path):
 
     state = State.IDLE
@@ -42,15 +46,15 @@ def process_file(path: Path):
         if state == State.IDLE:
             lines_out.append(line)
             m = HEADER_START_RE.match(line)
-            if (m):
+            if m:
                 # header_line_index = line_index
                 script_lines = []
                 state = State.HEADER
                 # print("header_start", header_line_index, m)
         elif state == State.HEADER:
             lines_out.append(line)
             m = HEADER_END_RE.match(line)
-            if (m):
+            if m:
                 # content_line_index = line_index
                 state = State.CONTENT
                 # print("content_start", content_line_index, m)
@@ -65,7 +69,7 @@ def process_file(path: Path):
                 script_lines.append(line)
         elif state == State.CONTENT:
             m = FOOTER_RE.match(line)
-            if (m):
+            if m:
                 lines_out.append(line)
                 # footer_line_index = line_index
                 state = State.IDLE
@@ -74,7 +78,8 @@ def process_file(path: Path):
     print("replaced\n\n")
     print("".join(lines_out))
 
-    open(path,"w").writelines(lines_out)
+    open(path, "w").writelines(lines_out)
+
 
 for path in sys.argv[1:]:
     process_file(path)

tools/run_clang_format.py

@@ -63,6 +63,7 @@
 DEFAULT_SLANG_EXTENSIONS = "slang,slangh"
 DEFAULT_CLANG_FORMAT_IGNORE = ".clang-format-ignore"
 
+
 class ExitStatus:
     SUCCESS = 0
     DIFF = 1
@@ -94,6 +95,7 @@ def excludes_from_file(ignore_file):
             raise
     return [excludes, whitelist]
 
+
 def is_child(path, files):
     if path in files:
         return True
@@ -103,6 +105,7 @@ def is_child(path, files):
             return True
     return False
 
+
 def list_files(files, recursive=False, extensions=None, exclude=None, whitelist=None):
     if extensions is None:
         extensions = []
@@ -442,7 +445,7 @@ def main():
         recursive=args.recursive,
         exclude=excludes,
         extensions=args.extensions.split(","),
-        whitelist=whitelist
+        whitelist=whitelist,
     )
 
     if not files: