Skip to content

Ruff precommit #235

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
paigewilliams merged 12 commits into from
Mar 25, 2026
Merged

Ruff precommit #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3b4309d
add pre-commit-config
paigewilliams Nov 7, 2025
dab42df
test commit
paigewilliams Nov 7, 2025
f41646e
move .pre-commit-config to root
paigewilliams Nov 7, 2025
0d8e4e6
ruff format
paigewilliams Nov 7, 2025
4ce53c3
Merge branch 'develop' into ruff-precommit
paigewilliams Mar 10, 2026
e5eab79
test commit
paigewilliams Mar 10, 2026
ea62d24
another test
paigewilliams Mar 10, 2026
2d239fe
try again
paigewilliams Mar 10, 2026
9d10da7
test again again
paigewilliams Mar 11, 2026
a890d52
remove test print statement
paigewilliams Mar 11, 2026
e3005f5
Merge branch 'develop' into ruff-precommit
paigewilliams Mar 25, 2026
62231c6
add requirements_dev.txt and pin ruff version for continuity with CI
paigewilliams Mar 25, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ jobs:

- name: Install Python dependencies
run: |
python -m pip install -r TEKDB/requirements.txt
python -m pip install -r TEKDB/requirements.txt -r TEKDB/requirements_dev.txt

Comment on lines +55 to 56
Copy link

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

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

CI is now installing all dev-only dependencies (including pre-commit, ipdb, ipython) just to run ruff. This adds unnecessary packages and can slow/fail CI in ways unrelated to tests/linting. Consider installing only Ruff in this workflow (e.g., python -m pip install ruff==...) or splitting a smaller requirements_ci.txt that contains only CI tools.

Suggested change
python -m pip install -r TEKDB/requirements.txt -r TEKDB/requirements_dev.txt
python -m pip install -r TEKDB/requirements.txt
- name: Install Ruff
run: |
python -m pip install ruff

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Collaborator Author

@paigewilliams paigewilliams Mar 25, 2026

Choose a reason for hiding this comment

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

ignoring this because I want to install the same version of ruff as what is in requirements_dev.txt

- name: Run Ruff
run: cd TEKDB && ruff check . --output-format=github
Expand Down
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
@@ -0,0 +1,8 @@
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.15.5
hooks:
- id: ruff-check
args: [ --fix ]
# Run the formatter.
- id: ruff-format
Comment on lines +2 to +8
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

The Ruff version used by this pre-commit hook is pinned via rev, but CI currently runs ruff check from the version installed via TEKDB/requirements.txt. If these drift, developers may get different fixes/formatting locally than what CI expects. Consider aligning the versions by pinning ruff in requirements.txt to the same version as the hook (or updating CI to run pre-commit run --all-files).

Suggested change
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.15.5
hooks:
- id: ruff-check
args: [ --fix ]
# Run the formatter.
- id: ruff-format
- repo: local
hooks:
- id: ruff-check
name: ruff-check
entry: ruff
language: system
types: [python]
args: [ --fix ]
# Run the formatter.
- id: ruff-format
name: ruff-format
entry: ruff
language: system
types: [python]
args: [ format ]

Copilot uses AI. Check for mistakes.
8 changes: 1 addition & 7 deletions TEKDB/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,5 @@ testresources
twisted>=22.4.0
urllib3>=1.26.5

#OPTIONAL, BUT LOVELY FOR DEBUGGING
ipdb
ipython

# Serve static files in production containers
whitenoise>=6.0.0,<7.0.0
# FORMATTING AND LINTING
ruff
whitenoise>=6.0.0,<7.0.0
8 changes: 8 additions & 0 deletions TEKDB/requirements_dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# packages to install when developing locally
# these are not required for production, but are useful for development and testing
pre-commit
ruff==0.15.7

# OPTIONAL, BUT LOVELY FOR DEBUGGING
Copy link
Copy Markdown
Member

@rhodges rhodges Mar 25, 2026

Choose a reason for hiding this comment

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

These could be removed. It'd make copilot happier and speed up the CI process. If we want these locally for dev they're super easy to install. The committed code should never need ipdb (or ipython) to run.

Copy link
Copy Markdown
Member

@rhodges rhodges Mar 25, 2026

Choose a reason for hiding this comment

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

"These" meaning ipdb and ipython under the 'Optional' quote in line 6. This display makes it look like I suggest axing pre-commit and ruff (I'm not).

ipdb
ipython
Loading