Section 3.2 How to Avoid Debugging
Perhaps the most important lesson in debugging is that it is largely avoidable – if you work carefully.
Understand the Problem You must have a firm grasp on what you are trying to accomplish but not necessarily how to do it. You do not need to understand the entire problem. But you must understand at least a portion of it and what the program should do in a specific circumstance – what output should be produced for some given input. This will allow you to test your progress. You can then identify if a solution is correct or whether there remains work to do or bugs to fix. This is probably the single biggest piece of advice for programmers at every level.
Start Small It is tempting to sit down and crank out an entire program at once. But, when the program – inevitably – does not work, you have a myriad of options for things that might be wrong. Where to start? Where to look first? How to figure out what went wrong? I'll get to that in the next section. So, start with something really small. Maybe just two lines and then make sure that runs. Hitting the run button is quick and easy. It gives you immediate feedback about whether what you have just done works or not. Another immediate benefit of having something small working is that you have something to turn in. Turning in a small, incomplete program, is almost always better than nothing.
Keep Improving It Once you have a small part of your program working, the next step is to figure out something small to add to it – how can you move closer to a correct solution. As you add to your program, you gain greater insight into the underlying problem you are trying to solve.
If you keep adding small pieces of the program one at a time, it is much easier to figure out what went wrong. (This of course means you must be able to recognize if there is an error. And that is done through testing.)
As long as you always test each new bit of code, it is most likely that any error is in the new code you have just added. Less new code means its easier to figure out where the problem is.
This notion of Get something working and keep improving it is a mantra that you can repeat throughout your career as a programmer. It's a great way to avoid the frustrations mentioned above. Think of it this way. Every time you have a little success, your brain releases a tiny bit of chemical that makes you happy. So, you can keep yourself happy and make programming more enjoyable by creating lots of small victories for yourself.
The technique of start small and keep improving is the basis of Agile software development. This practice is used widely in the industry.
Ok, let's look at an example. Let's solve the problem posed in question 3 at the end of the Simple Python Data chapter. Ask the user for the time now (in hours 0 - 23), and ask for the number of hours to wait. Your program should output what the time will be on the clock when the alarm goes off. For example, if
current_time is 8 and
wait_time is 5,
final_time should be 13 (1 pm).
So, where to start? The problem requires two pieces of input from the user, so let's start there and make sure we can get the data we need.
So far so good. Now let's take the next step. We need to figure out what the time will be after waiting
wait_time number of hours. A reasonable solution is to simply add
current_time and print out the result. So lets try that.
Hmm, when you run this example you see that something unexpected has happened. You would not realize this was an error unless you first knew what the program was supposed to do.
Python is stupid and does not know how to add properly.
- No, Python is probabaly not broken.
There is nothing wrong here.
- No, try adding the two numbers together yourself, you will definitely get a different result.
Python is doing string concatenation, not integer addition.
- Yes! Remember that input returns a string. Now we will need to convert the string to an integer
Which of the following best describes what is wrong with the previous example?
This error was probably pretty simple to spot, because we printed out the value of
final_time and it is easy to see that the numbers were just concatenated together rather than added.
So what do we do about the problem? We will need to convert both
int. At this stage of your programming development, it can be a good idea to include the type of the variable in the variable name itself. So let's look at another iteration of the program that does that, and the conversion to integer.
Now, that's a lot better, and in fact depending on the hours you chose, it may be exactly right. If you entered 8 for
current_time and 5 for
wait_time then 13 is correct. But if you entered 17 (5 pm) for
current_time and 9 for
wait_time then the result of 26 is not correct.
This illustrates an important aspect of testing: it is important to test your code on a range of inputs. It is especially important to test your code on boundary conditions. For this particular problem, you should test your program with
current_time of 0, 23, and some values in between. You should test your
wait_time for 0, and some larger values. What about negative numbers? Negative numbers don't make sense, and since we don't really have the tools to deal with telling the user when something is wrong we will not worry about that just yet.
So to account for those numbers that are bigger than 23, we need one final step: using the modulus operator.
Of course even in this simple progression, there are other ways you could have gone astray. We'll look at some of those and how you track them down in the next section.