pytest_keyboard_interrupt hook is also called with --maxfail

[blueyed]

When using -x / --maxfail the Interrupted exception is thrown, and gets handled in the same place as KeyboardInterrupt (

pytest/_pytest/main.py

Lines 99 to 106 in 86ec3f3

	except KeyboardInterrupt:
	excinfo = _pytest._code.ExceptionInfo()
	if initstate < 2 and isinstance(
	excinfo.value, pytest.exit.Exception):
	sys.stderr.write('{0}: {1}\n'.format(
	excinfo.typename, excinfo.value.msg))
	config.hook.pytest_keyboard_interrupt(excinfo=excinfo)
	session.exitstatus = EXIT_INTERRUPTED

), because it is a subclass.

Therefore I think the hook name is confusing / misleading.
If this behavior is intentional, it should get added to the documentation at least.

I have noticed this, because pytest-testmon uses this hook to not save its data: https://github.com/tarpas/pytest-testmon/blob/55c89bb3df65c94e226ead8dd465f3dd5bb8927b/testmon/pytest_testmon.py#L173-L174
Here a check using excinfo.typename could be added to handle 'Interrupted' different from 'KeyboardInterrupt'.

btw: is there a way to import the Interrupted class from pytest?

[The-Compiler]

FWIW, Interrupted being a subclass of KeyboardInterrupt sounds weird to me...

[nicoddemus]

I agree. I think that we should:

1. Subclass Interrupted from something else (RuntimeError?)
2. Make Interrupted part of the public API so plugins can raise or catch it; perhaps by making it available in the pytest namespace? Also, how about renaming it to SessionInterrupt?

This has to be done carefully, because there are a number of places which handle KeyboardInterrupt on pytest's code base that will have to be changed to also handle SessionInterrupt.

I also noticed that Exit also subclasses KeyboardInterrupt.

[The-Compiler]

1. Subclass Interrupted from something else (RuntimeError?)

If you do except RuntimeError:, would you expect Interrupted to be caught (I don't)? If not, it should simply subclass Exception.

[nicoddemus]

Good point!