Allow --interactive for successful scripts

[cygnusv]

Describe

It would be great to allow interactive mode for non-failing scripts. For example, I have a script that performs common setup steps in a mainnet fork and I want to use the interactive console afterwards. Even with --interactive, I'm forced to add trivial errors to force the interactive mode to kick in, e.g.:

...
assert False, "Stop here"  # Force activation of interactive mode to inspect state after script

Specification

I don't have suggestion, but since it would be a breaking change, a different flag would be needed, e.g. --interactive-always or --force-interactive-

Dependencies

None.

[linear]

APE-2011

[fubuloubu]

I'll ask @antazoey to weigh in, but I consider this a bug myself. I expect --interactive to drop me into a session with the context of the end of the script, so that I can interact with things and inspect them to make sure they work correctly

If it were a flag more like how pytest's --pdb flag drops you into a debug session only if there's a failure, I'd understand. Seems like it's not meeting an expectation of how it should be working though in my opinion

[antazoey]

Yep, no I agree, I have had this thought myself as well. If the script is successful, we drop in at the end, else we drop in at error.. Some way of distinguishing the two states may be necessary though.

[fubuloubu]

Some way of distinguishing the two states may be necessary though.

Right now, it shows some stack trace when it drops you in, indicating an error. We can add something like "execution successful, entering interactive session" or something to give more positive indication that everything was fine if it gets to the end

[cygnusv]

I think I'd expect that the interactive session kicks in everytime the flag is active, silently if everything went fine, and with a stack trace in case of an error.

[fubuloubu]

I think I'd expect that the interactive session kicks in everytime the flag is active, silently if everything went fine, and with a stack trace in case of an error.

Sounds like we all agree!

If you feel confident/have the time @cygnusv, would appreciate you taking a stab at modifying how --interactive works so that it drops you into an interactive session without a failure in the script. I think this is the relevant section of the codebase:

ape/src/ape_run/_cli.py

Lines 238 to 240 in 076c7cd

	if not trace_frames:
	# Error from Ape internals; avoid launching console.
	sys.exit(1)

[cygnusv]

Challenge accepted

[fubuloubu]

okay, jfc

https://github.com/eth-brownie/brownie/blob/122aab40ed86f14e545e366d2658616a670459dc/brownie/project/scripts.py#L102-L136