Skip to content

fix: align the pre-commit black hook with the formatting CI enforces#2303

Open
vignesh-nagarajan-vn wants to merge 1 commit into
microsoft:mainfrom
vignesh-nagarajan-vn:fix/pre-commit-black-rev
Open

fix: align the pre-commit black hook with the formatting CI enforces#2303
vignesh-nagarajan-vn wants to merge 1 commit into
microsoft:mainfrom
vignesh-nagarajan-vn:fix/pre-commit-black-rev

Conversation

@vignesh-nagarajan-vn

Copy link
Copy Markdown

CI checks formatting with the latest black (make black), but the
pre-commit config pinned black 23.7.0. The two disagree on
qlib/model/riskmodel/shrink.py, so on a clean checkout the documented
dev setup (pre-commit install) reformats a file the committer never
touched - the very first commit fails the hook or mutates unrelated
code.

  • Bump the black hook rev to 24.8.0, which agrees with CI's black on
    all 336 repo files and still supports Python 3.8, qlib's floor.
  • Comment the pin with the alignment constraint so it can't drift
    silently again.
  • Leave the flake8 pin untouched - no misbehavior observed there.

The pre-commit config pinned black 23.7.0, whose style disagrees with
the black that CI runs (`make black`, unpinned latest): on a clean
checkout it reformats qlib/model/riskmodel/shrink.py - a file the
committer never touched - so the documented dev setup (`pre-commit
install`, docs/developer/code_standard_and_dev_guide.rst) makes any
commit fail or mutate unrelated files.

Pin 24.8.0 instead: verified to leave all 336 repo files unchanged
(it agrees with CI's current black on this codebase) while still
supporting Python 3.8, qlib's documented floor. The flake8 pin is
left untouched - no misbehavior observed there.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant