testing-debugging/quickref.tex
author Amit Sethi
Fri, 12 Nov 2010 15:23:54 +0530
changeset 489 bc8d01c3c9b3
parent 401 abf092be95ef
permissions -rw-r--r--
Added quickref for testing-debugging
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
489
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     1
Skeleton of a test:\\
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     2
{\ex \lstinline| if __name__ == '__main__':|}
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     3
{\ex \lstinline|      result = gcd(48, 64) |}  
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     4
{\ex \lstinline|      if result != 16:     |}
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     5
{\ex \lstinline|           print ``Test Failed'' |}
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     6
{\ex \lstinline|      print ``Test Passed''      |}
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     7
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     8
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
     9
\textbf{Testing}
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    10
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    11
Get results from function or unit of code being tested.Compare it to original output. Test passed if they match else failed.
401
abf092be95ef Adding testing and debugging files
Amit Sethi
parents:
diff changeset
    12
489
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    13
\textbf{Code Style} 
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    14
Four Space Indentation
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    15
79 character limit on a line
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    16
Funtions should be seperated by 
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    17
blank line
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    18
Use Docstring
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    19
White space around operators 
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    20
   
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    21
Skeleton of try catch:\\
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    22
{\ex \lstinline|     try:                  |}
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    23
{\ex \lstinline|      	  num = int(a)     |}
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    24
{\ex \lstinline|     except:               |}
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    25
{\ex \lstinline|         print ``Wrong input...'' |}
401
abf092be95ef Adding testing and debugging files
Amit Sethi
parents:
diff changeset
    26
489
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    27
Starting debugger in ipython:\\
bc8d01c3c9b3 Added quickref for testing-debugging
Amit Sethi
parents: 401
diff changeset
    28
{\ex \lstinline|     %debug                  |}