pythonreader/debugging/index.html at main · codeinplace2020/pythonreader

History

270 lines (205 loc) · 10.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

<!doctype html>

<head>

MathJax.Hub.Config({tex2jax: {inlineMath: [['$','$'], ['\$','\$']]}});

</script>

</head>

<body>

</button>

Lectures

</a>

class="dropdown-item"

href="../../lectures/1-Welcome/index.html"

1. Welcome

</a>

2. Control Flow

</a>

3. Decomposition

</a>

4. Variables

</a>

5. Arithmetic Expressions

</a>

</div>

</li>

Assignments

</a>

class="dropdown-item"

href="https://docs.google.com/forms/d/e/1FAIpQLSfeKsiN9eJ-zWBqKUNuTLsm3sGJ6zfsG6v9DNvZPPUnAfnRAg/viewform?usp=sf_link"

target="_blank"

0 - Who are you?

</a>

<a class="dropdown-item"

href="../../assn/karel.html"

1 - Karel

</a>

</div>

</li>

<a class="nav-link dropdown-toggle" href="#" role="button" data-toggle="dropdown" aria-haspopup="true"

aria-expanded="false">

Section

</a>

<a class="dropdown-item"

href="http://cs198.stanford.edu/cs198/auth/default.aspx"

target="_blank">

Section Management

</a>

<hr />

<a class="dropdown-item"

href="../../section/section1/section1.html"

target="_blank">

Section 1

</a>

Section 1 Project

</a>

Section 1 Online IDE

</a>

</div>

</li>

Handouts

</a>

<a class="dropdown-item" href="../../handouts/01-general-information.pdf">General Information</a>

<a class="dropdown-item" href="../../handouts/02-course-placement.pdf"> Course Placement</a>

<a class="dropdown-item" href=../../handouts/03-honor-code.pdf>Honor Code</a>

<a class="dropdown-item" href=../../handouts/installingpycharm.html>Installing PyCharm</a>

<a class="dropdown-item" href=../../assn/04-using-karel-with-pycharm.pdf>Using Karel in PyCharm</a>

<a class="dropdown-item" href=../../handouts/06-submitting-assignments.pdf>Submitting Assignments</a>

</div>

</li>

</ul>

<i class="fas fa-th-large"></i> Schedule </a>

</li>

</ul>

</div>

</nav> <div class="container">

<p>Today: loose ends: looking at error messages, more string functions, what is computer hardware?

<h1>Debugging</h1>

<p>Many times you run your code and see an error message. Here are some example debug error messages and how to decode them.

<p>These examples use our old <a href=movie.zip>movie.zip</a> example, editing movie-solution.py to put in some bugs and see what they do.

<h2>Bug and Symptom</h2>

<p>A "bug" is a flaw in the code - the code as written does not do what we wanted. Python doe s not notice the bug right away typically. Python does not know what we wanted, it just does what the lines say until it hits an error case, like a bad index or non-existent function name.

<p>When Python hits an error and halts - we'll think of that as the "symptom" you observe. Your job is to work backwards from the symptom to figure out the underlying bug. Very often the symptom is right on the line with the bug, and so it's pretty straightforward. But sometimes it can be more complicated.

<h2>scroll_left Grid code</h2>

<p>Here is the correct code for our scroll_left() example. Try putting in various bugs to see the error messages. Run the Doctests to see what we get.

<pre>

def scroll_left(grid):

"""

Implement scroll_left as in lecture notes.

>>> grid = Grid.build([['a', 'b', 'c'], ['d', None, None]])

>>> scroll_left(grid)

[['b', 'c', None], [None, None, None]]

"""

for y in range(grid.height):

for x in range(grid.width):

# Copying towards the left

# x, y is source, copy to x-1, y

val = grid.get(x, y)

if x > 0 and val != None:

grid.set(x - 1, y, val)

grid.set(x, y, None)

return grid

</pre>

<h2>1. Bad Function Name: <code>grid.geet()</code></h2>

<p>Put a bug in scroll_left() function: <code>grid.geet(x, y)</code>

<pre>

for y in range(grid.height):

for x in range(grid.width):

# Copying towards the left

# x, y is source, copy to x-1, y

val = <font color=red>grid.geet(x, y)</font> # line 59

</pre>

<p>Run the Doctests, the run gets an error. Look at the bottom of the error listing first, work your way upwards. The error identifies the line with the problem, it's a line in your own code. and the error message is reasonable. This is a common, easy case - Python notices the problem right on the line with the wrong code.

<pre>

....

File "<doctest scroll_left[1]>", line 1, in <module>

scroll_left(grid)

File "...movie/movie-solution.py", line 59, in scroll_left

val = grid.geet(x, y)

AttributeError: 'Grid' object has no attribute 'geet'

</pre>

<h2>2. Error In Downstream Function</h2>

<p>Suppose a() passes bad data to b(), then b() uses the data and crashes. The error message will be in b(), but the real bug is "upstream" in a().

<p>Bug: change x value to be wrong before grid.get() is called...

<pre>

for y in range(grid.height):

for x in range(grid.width):

# Copying towards the left

# x, y is source, copy to x-1, y

val = grid.get(<font color=red>x + 1000</font>, y) # line 59

</pre>

<p>Here is the error message - look at the bottom of the listing and work your way upwards, looking for your function (movie-solution.py) vs. some function you called (grid.py).

<pre>

....

File ".../movie/movie-solution.py", line 59, in scroll_left

val = grid.get(x + 1000, y)

File ".../movie/grid.py", line 76, in get

return self.array[y][x]

IndexError: list index out of range

</pre>

<p>Look at the bottom of the error listing and work up. Index-out-of-range error is not our code, it's in grid.py which we did not write. Look up one function, and we see "movie-solution.py line 59", <code>grid.get(x + 1000, y)</code>. This is line that called get() with bad data, leading it to crash.

<p>Or more likely, the logic just above line 59 was missing a < test, or had wrong arithmetic so it <b>set</b> x incorrectly, and that led to the index out of bounds error down in grid.py.

</div>

</body>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls