Skip to content

[FEA] Add SPDX checker pre-commit hook #415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kkraus14 merged 9 commits into from
Aug 21, 2025
Merged

[FEA] Add SPDX checker pre-commit hook #415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
99748e4
Initial plan
Copilot Aug 21, 2025
6bbf76e
Add SPDX checker script, ignore file, and pre-commit hook configuration
Copilot Aug 21, 2025
81afe3c
Update .spdx-ignore to remove exclusions for files that have SPDX hea…
Copilot Aug 21, 2025
57dd95a
Remove exclusions for files with SPDX headers (conda meta.yaml and si…
Copilot Aug 21, 2025
ac71afb
Add missing files to .spdx-ignore to fix check-style failures
Copilot Aug 21, 2025
b8d175b
Changes before error encountered
Copilot Aug 21, 2025
94e3c87
Merge branch 'main' into copilot/fix-414
kkraus14 Aug 21, 2025
8bf69a1
Add SPDX identifiers to missing files for check-style compliance
Copilot Aug 21, 2025
3374514
Merge branch 'main' into copilot/fix-414
kkraus14 Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,11 @@ repos:
- id: ruff
args: [--fix]
- id: ruff-format
- repo: local
hooks:
- id: check-spdx
name: Check SPDX Headers
entry: python ./toolshed/check_spdx.py
language: python
additional_dependencies:
- pathspec==0.12.1
34 changes: 34 additions & 0 deletions .spdx-ignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
LICENSE
LICENSE.numba
*.html
*.json
*.md
*.png
*.svg
*.rst
*.txt
*.ptx
*.pyc
requirements*.txt

# Documentation build artifacts
docs/build/*

# Binary files
*.so
*.dll

# Build artifacts and egg-info
build/*
dist/*
*.egg-info/*

# Version files
numba_cuda/VERSION

# External CUDA SDK headers
numba_cuda/numba/cuda/include/*/cuda_*.h
numba_cuda/numba/cuda/include/*/cuda_*.hpp

# GitHub configuration files
.github/CODEOWNERS
3 changes: 3 additions & 0 deletions numba_cuda/numba/cuda/core/bytecode.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: BSD-2-Clause

from collections import namedtuple, OrderedDict
import dis
import inspect
Expand Down
3 changes: 3 additions & 0 deletions numba_cuda/numba/cuda/core/environment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: BSD-2-Clause

import weakref
import importlib

Expand Down
57 changes: 57 additions & 0 deletions toolshed/check_spdx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: BSD-2-Clause

import os
import sys

import pathspec

# Intentionally puzzling together EXPECTED_SPDX_BYTES so that we don't overlook
# if the identifiers are missing in this file.
EXPECTED_SPDX_BYTES = (
b"-".join((b"SPDX", b"License", b"Identifier: ")),
b"-".join((b"SPDX", b"FileCopyrightText: ")),
)
Comment on lines +9 to +14
Copy link
Contributor

@ashermancinelli ashermancinelli Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: It took me a few reads to understand this, would it make more sense to use a simple string?

EXPECTED_SPDX_BYTES = b'''
SPDX-License....
'''

Copy link
Contributor

@kkraus14 kkraus14 Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I vendored this from https://github.com/NVIDIA/cuda-python/blob/main/toolshed/check_spdx.py for now where happy to fix this in a follow up once it's in to prevent more conflicts 😆.

Copy link
Contributor

@ashermancinelli ashermancinelli Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, SGTM!


SPDX_IGNORE_FILENAME = ".spdx-ignore"


def load_spdx_ignore():
if os.path.exists(SPDX_IGNORE_FILENAME):
with open(SPDX_IGNORE_FILENAME, "r", encoding="utf-8") as f:
lines = f.readlines()
else:
lines = []
lines.append(SPDX_IGNORE_FILENAME + "\n")
return pathspec.PathSpec.from_lines("gitwildmatch", lines)


def has_spdx_or_is_empty(filepath):
with open(filepath, "rb") as f:
blob = f.read()
if len(blob.strip()) == 0:
return True
good = True
for expected_bytes in EXPECTED_SPDX_BYTES:
if expected_bytes not in blob:
print(f"MISSING {expected_bytes.decode()}{filepath!r}")
good = False
return good


def main(args):
assert args, "filepaths expected to be passed from pre-commit"

ignore_spec = load_spdx_ignore()

returncode = 0
for filepath in args:
if ignore_spec.match_file(filepath):
continue
if not has_spdx_or_is_empty(filepath):
returncode = 1
return returncode


if __name__ == "__main__":
sys.exit(main(sys.argv[1:]))