automain not compatible with PDB / PUDB debuggers

Phenomenon

When I write the script with automain and run it with $ python -m pdb script.py,the debugger does not open the post-mortem analyzer even if there is an error.

Why this may be an issue

Without using automain, the use of python <scriptname.py> with ‘param=“value”’ seems to be restricted.

MnWE (minimal not-working example)

from sacred import Experiment
ex = Experiment()
@ex.automain
def main():
    raise Exception()

Run this with $ python -m pdb <scriptname.py> and you can observe that the PDB does not start.

MWE (minimal working example)

from sacred import Experiment
ex = Experiment()
@ex.main
def main():
    raise Exception()

if __name__ == '__main__':    
    ex.run()

Run this with $ python -m pdb <scriptname.py> and you can observe that the PDB starts.

[Qwlouse]

Hi @diadochos, This questions seems to pop up rather regularly. It is due to the default stacktrace filtering sacred does to remove the internal clutter due to decorated functions. You can disable this with with the --debug / -d flag. FYI: you can also use the -D flag to attach a post-mortem debugger. See debugging section in the docs.

Maybe the documentation about debugging should be more prominent / extensive. What do you think? Would a top-level debugging section have helped you?

[yulonglin]

For the sake of clarity, to disable Sacred stacktrace filtering you run this: python -m pdb <scriptname.py> -d or python -m pdb <scriptname.py> --debug

And to add a post-mortem debugger you run this: python -m pdb <scriptname.py> -D or python -m pdb <scriptname.py> --pdb

As specified in the CLI guide in the docs