Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions pre_commit_hooks/debug_statement_hook.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,24 @@ def check_file(filename: str) -> int:
def main(argv: Sequence[str] | None = None) -> int:
parser = argparse.ArgumentParser()
parser.add_argument('filenames', nargs='*', help='Filenames to run')
parser.add_argument(
'--forbid',
type=str, action='append',
help='Extra module name(s) to forbid',
)
parser.add_argument(
'--allow',
type=str,
action='append',
help='Extra module name(s) to allow',
)
args = parser.parse_args(argv)

for name in args.forbid or ():
DEBUG_STATEMENTS.add(name)
for name in args.allow or ():
DEBUG_STATEMENTS.discard(name)

retv = 0
for filename in args.filenames:
retv |= check_file(filename)
Expand Down
14 changes: 14 additions & 0 deletions tests/debug_statement_hook_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,20 @@ def test_finds_breakpoint():
assert visitor.breakpoints == [Debug(1, 0, 'breakpoint', 'called')]


def test_allow(tmpdir):
f_py = tmpdir.join('f.py')
f_py.write('import q')
ret = main([str(f_py), '--allow', 'q'])
assert ret == 0


def test_forbid(tmpdir):
f_py = tmpdir.join('f.py')
f_py.write('import foo')
ret = main([str(f_py), '--forbid', 'foo'])
assert ret == 1


def test_returns_one_for_failing_file(tmpdir):
f_py = tmpdir.join('f.py')
f_py.write('def f():\n import pdb; pdb.set_trace()')
Expand Down