Repository navigation
Badly formatted output when running post-write hooks #1261
Description
Describe the bug
There is a small output bug when running alembic revision ... with a post-write hook. The name of the hook is not correctly displayed:
$ alembic revision -m 'my new revision'
Generating myrepo/migrations/versions/202306151538_my_new_revision.py_ ... done
Running post write hook {name!r} ... # Display bug HERE
reformatted myrepo/migrations/versions/202306151538_my_new_revision.py
All done! ✨ 🍰 ✨
1 file reformatted.
doneHappy to fix, if approved!
Expected behavior
This output
$ alembic revision -m 'my new revision'
Generating myrepo/migrations/versions/202306151538_my_new_revision.py_ ... done
Running post write hook black ... # Display bug HERE
reformatted myrepo/migrations/versions/202306151538_my_new_revision.py
All done! ✨ 🍰 ✨
1 file reformatted.
donewhen black hook is configured.
To Reproduce
$ mkdir testdir
$ cd testdir
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install alembicUncomment default post_write_hooks parameters in alembic.ini
[post_write_hooks]
black.type = console_scripts
black.entrypoint = black
black.options = -l 79 REVISION_SCRIPT_FILENAMEThen run revision command
alembic revision -m 'my new revision'Error
# Command output
Generating workspace/testdir/migrations/versions/324b3e655f54_my_new_revision.py ... done
Running post write hook {name!r} ...
...Versions.
- OS: macOS
- Python: 3.11
- Alembic: 1.11.1
- SQLAlchemy: 2.0.16
- Database: PostgreSQL 15.3
- DBAPI: N/A
Additional context
Bug seems to be here:
alembic/alembic/script/write_hooks.py
Line 88 in 79738c9
Have a nice day!
Activity
CaselIT commentedon Jun 15, 2023
Hi,
duh. thanks for noticing. strange that no linted said anything about it.
Care to create a PR for it?
duc00 commentedon Jun 17, 2023
Sure!
sqla-tester commentedon Jun 17, 2023
Mathieu Défosse has proposed a fix for this issue in the main branch:
Fixed CLI output when running post_write hooks https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/4731
Fixed CLI output when running post_write hooks