Apply ruff formatting to codebase #207
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Format all Python files with ruff for consistent code style - Update CI workflow configuration - Maintain all existing functionality (237 tests pass)
- Remove unused imports (F401) in scripts and modules - Add __all__ lists to __init__.py files to document public API - Replace star import in test_equipment.py with explicit imports - Fix bare except clause in docs/source/conf.py (E722) - Remove unused local variables (F841) or add noqa for intentional ones - Add noqa comments for acceptable lint exceptions (E402, E741, F403) - All 237 tests pass (1 skipped)
Co-authored-by: rajeee <[email protected]>
## Summary This PR builds on top of PR #207 (ruff formatting) to also apply all ruff lint fixes to the codebase. - Remove unused imports (F401) in scripts and modules - Add `__all__` lists to `__init__.py` files to document public API and fix re-export warnings - Replace star import in `test_equipment.py` with explicit imports (fixes F403/F405) - Fix bare `except` clause in `docs/source/conf.py` (E722 -> `except Exception:`) - Remove unused local variables (F841) or add noqa for intentional ones - Add noqa comments for acceptable lint exceptions (E402, E741, F403) ### Lint Status Before: **107 errors** After: **0 errors** (all checks pass!) ### Test Status All 237 tests pass (1 skipped). ### How to run ```bash # Check for lint errors (should show 0 errors) ruff check . # Auto-fix any future lint issues ruff check --fix . ``` ### Notes - Some variables like `heating_des_init` and `cooling_des_init` in `ochre/utils/equipment.py` are kept with `# noqa: F841` because they're used dynamically by `eval()` when loading zone temperature files - The star import `from .Equipment import *` in `ochre/__init__.py` is kept for API compatibility with `# noqa: F403`
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
jmaguire1
reviewed
Feb 9, 2026
Collaborator
jmaguire1
left a comment
jmaguire1
left a comment
There was a problem hiding this comment.
I think we still want to investigate/fix the alerts that are coming up (most seem to be unused imports) before we merge this in. We also need to figure out why the CI is failing before we merge, it looks like it's having trouble checking out the repo?
Collaborator
Author
|
The tests are passing now - I just reran them. I think it was a temporary github.com access glitch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Linting vs. Formatting with Ruff
We have migrated to Ruff, which replaces several older tools with a single, faster engine.
ruff format .ruff check .(useruff check --fix .to automatically resolve simple issues)Current Policy
ruff format .before every commit.ruff check ochre/Models/StateSpaceModel.pycheck for lints in the StateSpaceModel.py file.Setting up Ruff
To ensure your environment is set up correctly to use the new tooling, please follow these steps:
Update your branch
Merge the latest
devbranch into your current feature branch to get the new configuration files.Install
uvif you don't already have it.We use
uvfor fast Python package management.You can install it from pip with:
curl -LsSf [https://astral.sh/uv/install.sh](https://astral.sh/uv/install.sh) | shSync Dependencies
If you already have a
.venvfolder in your project directory, please delete it first to ensure a clean install. Then run:Run Formatting
You can run Ruff directly using
uv(recommended) or by activating your environment.Option A (Recommended): Run via
uvuv run ruff format .Option B: Activate environment first