Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Capturing Ctrl-c in ruby

I was passed a long running legacy ruby program, which has numerous occurrences of

begin   #dosomething rescue Exception => e   #halt the exception's progress end 

throughout it.

Without tracking down every single possible exception these each could be handling (at least not immediately), I'd still like to be able to shut it down at times with CtrlC.

And I'd like to do so in a way which only adds to the code (so I don't affect the existing behavior, or miss an otherwise caught exception in the middle of a run.)

[CtrlC is SIGINT, or SystemExit, which appears to be equivalent to SignalException.new("INT") in Ruby's exception handling system. class SignalException < Exception, which is why this problem comes up.]

The code I would like to have written would be:

begin   #dosomething rescue SignalException => e   raise e rescue Exception => e   #halt the exception's progress end 

EDIT: This code works, as long as you get the class of the exception you want to trap correct. That's either SystemExit, Interrupt, or IRB::Abort as below.

like image 229
Tim Snowhite Avatar asked Jan 18 '10 21:01

Tim Snowhite


1 Answers

The problem is that when a Ruby program ends, it does so by raising SystemExit. When a control-C comes in, it raises Interrupt. Since both SystemExit and Interrupt derive from Exception, your exception handling is stopping the exit or interrupt in its tracks. Here's the fix:

Wherever you can, change

rescue Exception => e   # ... end 

to

rescue StandardError => e   # ... end 

for those you can't change to StandardError, re-raise the exception:

rescue Exception => e   # ...   raise end 

or, at the very least, re-raise SystemExit and Interrupt

rescue SystemExit, Interrupt   raise rescue Exception => e   #... end 

Any custom exceptions you have made should derive from StandardError, not Exception.

like image 164
Wayne Conrad Avatar answered Sep 21 '22 20:09

Wayne Conrad