Debugging: Difference between revisions

From Computer Science Wiki
No edit summary
No edit summary
 
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[File:square.png|right|frame|This a problem set for you to work through <ref>http://www.flaticon.com/</ref>]]
This is a problem set. Some of these are easy, others are far more difficult. The purpose of these problems sets are to HELP YOU THINK THROUGH problems. The solution is at the bottom of this page, but please don't look at it until you have tried (and failed) at least three or four times.
== Terminology ==  
== Terminology ==  


Line 9: Line 6:


== A debugging process ==
== A debugging process ==
 
[[File:Arrows.png|right|frame|This is an important process for you to understand <ref>http://www.flaticon.com/</ref>]]
7 Steps to fix a bug
6 Steps to fix an error


The correct approach to debug is to follow a very structured procedure based on repeating the same steps for every bug, the reason for this is that bugs usually are symptoms of a much bigger problem going on, so in order for us to uncover the real nature of the error we have to make sure we do an exhaustive and systematic revision of it.
The correct approach to debug is to follow a very structured procedure based on repeating the same steps for every bug, the reason for this is that bugs usually are symptoms of a much bigger problem going on, so in order for us to uncover the real nature of the error we have to make sure we do an exhaustive and systematic revision of it.
Line 35: Line 32:


# Logging. It can be to the console, file… It should help you to trace the error in the code.
# Logging. It can be to the console, file… It should help you to trace the error in the code.
# Debugging. Debugging in the most technical sense of the word, meaning turning on whatever the debugger you are using and stepping through the code.
# Removing code.   
# Removing code.   
    ''Take out half of the code from the action causing the machine to crash, and keep splitting the code until you find the error.''
<blockquote style="padding: 5px; background-color: #FAAFBA; border: solid thin gray;">
  [[File:Exclamation.png]] This is one of the most important strategies you can use to find errors:
 
  ''Take out half of the code from the action causing the program to produce an error and keep splitting the code until you find the error.''
</blockquote>


=== Step 3. Analyze the error ===
=== Step 3. Analyze the error ===
Line 43: Line 43:
This is a critical step, use a bottom-up approach from the place the error was found and analyze the code so you can see the big picture of the error, analyzing a bug has two main goals: to check that around that error there aren’t any other errors to be found (the iceberg metaphor), and to make sure what are the risks of entering any collateral damage in the fix.
This is a critical step, use a bottom-up approach from the place the error was found and analyze the code so you can see the big picture of the error, analyzing a bug has two main goals: to check that around that error there aren’t any other errors to be found (the iceberg metaphor), and to make sure what are the risks of entering any collateral damage in the fix.


=== Step 4. Prove your analysis ===
This is a straight forward step, after analyzing the original bug you may have come with a few more errors that may appear on the application.
=== Step 5. Cover lateral damage ===
At this stage you are almost ready to start coding the fix. If you are working on a complex application, please document your fix in an error reporting database.


=== Step 6. Fix the error. ===
=== Step 4. Fix the error. ===


That’s it, finally you can fix the error!
That’s it, finally you can fix the error!


=== Step 7. Validate the solution.====
=== Step 5. Validate the solution.===


Run the program again and reproduce the same steps that you discovered in step 1.  
Run the program again and reproduce the same steps that you discovered in step 1.  


<ref>http://www.makinggoodsoftware.com/2009/06/14/7-steps-to-fix-an-error/</ref>  
<ref>http://www.makinggoodsoftware.com/2009/06/14/7-steps-to-fix-an-error/</ref>
 
== What is this problem set trying to do ==


'''You are going to create errors when you code!''' There is a process to follow when you are debugging. I expect EVERY student to follow these steps when you are debugging. The purpose of this problem set is to encourage you to understand and apply your understanding of the debugging process to your code (and the code of a classmate).
== See Also ==  
 
[[Understanding error messages in Python]]
== The Problem ==
 
You should write a program that asks a user to enter an email address. Your program should check if the email:
 
# has an @ sign
# has a period .
# has a common top level domain (org, com)
 
== Some Code to Get You Started ==
 
<syntaxhighlight lang="python">
 
email = raw_input("Enter your email ")
 
 
</syntaxhighlight>
 
== Take This Further ==
 
# you can test for a @ and a . Could you also test for common misspellings?
# if you can test for common misspellings, could you suggest the correct spelling?
# we can check for common .com, .org, addresses but what about other top level domain names [http://www.iana.org/domains/root/db click here for a fairly scary list of them]
 
== How you will be assessed ==
 
Every problem set is a formative assignment.  [[Media:Problem-setrubric.pdf|Please click here to see how you will be graded]]


== References ==
== References ==
Line 96: Line 61:
<references />
<references />


== See also ==
[[Category:debugging]]
 
[http://www.openbookproject.net/thinkcs/python/english2e/app_a.html a short paper on the debugging process]
 
== A possible solution ==
 
 
<div class="toccolours mw-collapsible mw-collapsed">
Click the expand link to see one possible solution, but NOT before you have tried and failed at least three times
<div class="mw-collapsible-content">
 
<syntaxhighlight lang="python">
 
top_level_domains = ['com', 'org', 'pl', 'kz', 'edu']
 
 
while True:
    email = raw_input("Enter you email ")
    if '@' not in email:
        print("Error: you need an @ sign in your email.")
        break
    elif '.' not in email:
        print("Error: you need a . sign in your email. Please try again")   
        break
    # I am grateful to my student Sneha for this line below. It is a succinct way of capturing the characters AFTER the period.
    elif email[email.index('.')+1:] not in top_level_domains:
        print("Error: you need a valid domain name at the end")   
    else:
        print("Success: the email address you entered has passed our basic validation tests.")
        break 
 
</syntaxhighlight>
 
</div>
</div>
[[Category:problem set]]
[[Category:python]]
[[Category:strings]]

Latest revision as of 08:37, 8 December 2021

Terminology[edit]

In computers, debugging is the process of locating and fixing or bypassing bugs (errors) in computer program code or the engineering of a hardware device. To debug a program or hardware device is to start with a problem, isolate the source of the problem, and then fix it. A user of a program that does not know how to fix the problem may learn enough about the problem to be able to avoid it until it is permanently fixed. When someone says they've debugged a program or "worked the bugs out" of a program, they imply that they fixed it so that the bugs no longer exist.[1]

Debugging is the process of finding and resolving of defects that prevent correct operation of computer software or a system. Debugging tends to be harder when various subsystems are tightly coupled, as changes in one may cause bugs to emerge in another.[2]

A debugging process[edit]

This is an important process for you to understand [3]

6 Steps to fix an error

The correct approach to debug is to follow a very structured procedure based on repeating the same steps for every bug, the reason for this is that bugs usually are symptoms of a much bigger problem going on, so in order for us to uncover the real nature of the error we have to make sure we do an exhaustive and systematic revision of it.

The degree of formality when following the steps may vary depending on the bug, for critical errors it is better to document every single step in a document. For minor errors, or bugs found while coding it is just enough to follow them as a mental guideline.

Step 1. Identify the error.[edit]

This is an obvious step but a tricky one, sometimes a bad identification of an error can cause lots of wasted developing time.

A few tips to make sure you identify the bug correctly:

  1. See the error.
  2. Reproduce the error.

You never should say that an error has been fixed if you were not able to reproduce it.

  1. Understand what the expected behavior should be.
  2. Validate the identification.

Ask yourself: is this expected behavior or an actual error?


Step 2. Find the error.[edit]

Once we have an error correctly identified, it is time to go through the code to find the exact spot where the error is located, at this stage we are not interested in understanding the big picture for the error, we are just focused on finding it. A few techniques that may help to find an error are:

  1. Logging. It can be to the console, file… It should help you to trace the error in the code.
  2. Removing code.

Exclamation.png This is one of the most important strategies you can use to find errors:

Take out half of the code from the action causing the program to produce an error and keep splitting the code until you find the error.

Step 3. Analyze the error[edit]

This is a critical step, use a bottom-up approach from the place the error was found and analyze the code so you can see the big picture of the error, analyzing a bug has two main goals: to check that around that error there aren’t any other errors to be found (the iceberg metaphor), and to make sure what are the risks of entering any collateral damage in the fix.


Step 4. Fix the error.[edit]

That’s it, finally you can fix the error!

Step 5. Validate the solution.[edit]

Run the program again and reproduce the same steps that you discovered in step 1.

[4]

See Also[edit]

Understanding error messages in Python

References[edit]

  1. ↑ http://searchsoftwarequality.techtarget.com/definition/debugging
  2. ↑ https://en.wikipedia.org/wiki/Debugging#Typical_debugging_process
  3. ↑ http://www.flaticon.com/
  4. ↑ http://www.makinggoodsoftware.com/2009/06/14/7-steps-to-fix-an-error/

Provide an answer from a number of possibilities. Recognize and state briefly a distinguishing fact or feature.

Provide an answer from a number of possibilities. Recognize and state briefly a distinguishing fact or feature.

Follow and record the action of an algorithm.

Break down in order to bring out the essential elements or structure. To identify parts and relationships, and to interpret information to reach conclusions.

Break down in order to bring out the essential elements or structure. To identify parts and relationships, and to interpret information to reach conclusions.

Retrieved from "https://computersciencewiki.org/index.php?title=Debugging&oldid=11540"