~dkuhlman/python-training-materials/Materials

<li>coded in 100% pure Python, using the <a class="reference internal" href="tkinter.html#module-tkinter" title="tkinter: Interface to Tcl/Tk for graphical user interfaces"><code class="xref py py-mod docutils literal"><span class="pre">tkinter</span></code></a> GUI toolkit</li>

102

<li>cross-platform: works mostly the same on Windows, Unix, and Mac OS X</li>

103

<li>Python shell window (interactive interpreter) with colorizing

104

of code input, output, and error messages</li>

105

<li>multi-window text editor with multiple undo, Python colorizing,

106

smart indent, call tips, auto completion, and other features</li>

107

<li>search within any window, replace within editor windows, and search

108

through multiple files (grep)</li>

109

<li>debugger with persistent breakpoints, stepping, and viewing

110

of global and local namespaces</li>

111

<li>configuration, browsers, and other dialogs</li>

112

</ul>

113

114

<h2>25.5.1. Menus<a class="headerlink" href="#menus" title="Permalink to this headline">¶</a></h2>

115

<p>IDLE has two main window types, the Shell window and the Editor window. It is

116

possible to have multiple editor windows simultaneously. Output windows, such

117

as used for Edit / Find in Files, are a subtype of edit window. They currently

118

have the same top menu as Editor windows but a different default title and

119

context menu.</p>

120

<p>IDLE’s menus dynamically change based on which window is currently selected.

121

Each menu documented below indicates which window type it is associated with.</p>

122

123

<h3>25.5.1.1. File menu (Shell and Editor)<a class="headerlink" href="#file-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3>

124

125

126

<dd>Create a new file editing window.</dd>

127

128

<dd>Open an existing file with an Open dialog.</dd>

129

<dt>Recent Files</dt>

130

<dd>Open a list of recent files. Click one to open it.</dd>

131

<dt>Open Module...</dt>

132

<dd>Open an existing module (searches sys.path).</dd>

133

</dl>

134

135

<dt>Class Browser</dt>

136

<dd>Show functions, classes, and methods in the current Editor file in a

137

tree structure. In the shell, open a module first.</dd>

138

<dt>Path Browser</dt>

139

<dd>Show sys.path directories, modules, functions, classes and methods in a

140

tree structure.</dd>

141

142

<dd>Save the current window to the associated file, if there is one. Windows

143

that have been changed since being opened or last saved have a * before

144

and after the window title. If there is no associated file,

145

do Save As instead.</dd>

146

147

<dd>Save the current window with a Save As dialog. The file saved becomes the

148

new associated file for the window.</dd>

149

150

<dd>Save the current window to different file without changing the associated

151

file.</dd>

152

<dt>Print Window</dt>

153

<dd>Print the current window to the default printer.</dd>

154

<dt>Close</dt>

155

<dd>Close the current window (ask to save if unsaved).</dd>

156

157

<dd>Close all windows and quit IDLE (ask to save unsaved windows).</dd>

158

</dl>

159

</div>

160

161

<h3>25.5.1.2. Edit menu (Shell and Editor)<a class="headerlink" href="#edit-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3>

162

163

164

<dd>Undo the last change to the current window. A maximum of 1000 changes may

165

be undone.</dd>

166

167

<dd>Redo the last undone change to the current window.</dd>

168

169

<dd>Copy selection into the system-wide clipboard; then delete the selection.</dd>

170

171

<dd>Copy selection into the system-wide clipboard.</dd>

172

<dt>Paste</dt>

173

<dd>Insert contents of the system-wide clipboard into the current window.</dd>

174

</dl>

175

<p>The clipboard functions are also available in context menus.</p>

176

177

<dt>Select All</dt>

178

<dd>Select the entire contents of the current window.</dd>

179

180

<dd>Open a search dialog with many options</dd>

181

<dt>Find Again</dt>

182

<dd>Repeat the last search, if there is one.</dd>

183

<dt>Find Selection</dt>

184

<dd>Search for the currently selected string, if there is one.</dd>

185

<dt>Find in Files...</dt>

186

<dd>Open a file search dialog. Put results in a new output window.</dd>

187

<dt>Replace...</dt>

188

<dd>Open a search-and-replace dialog.</dd>

189

190

<dd>Move cursor to the line number requested and make that line visible.</dd>

191

<dt>Show Completions</dt>

192

<dd>Open a scrollable list allowing selection of keywords and attributes. See

193

Completions in the Tips sections below.</dd>

194

<dt>Expand Word</dt>

195

<dd>Expand a prefix you have typed to match a full word in the same window;

196

repeat to get a different expansion.</dd>

197

198

<dd>After an unclosed parenthesis for a function, open a small window with

199

function parameter hints.</dd>

200

<dt>Show surrounding parens</dt>

201

<dd>Highlight the surrounding parenthesis.</dd>

202

</dl>

203

</div>

204

205

<h3>25.5.1.3. Format menu (Editor window only)<a class="headerlink" href="#format-menu-editor-window-only" title="Permalink to this headline">¶</a></h3>

206

207

<dt>Indent Region</dt>

208

<dd>Shift selected lines right by the indent width (default 4 spaces).</dd>

209

<dt>Dedent Region</dt>

210

<dd>Shift selected lines left by the indent width (default 4 spaces).</dd>

211

<dt>Comment Out Region</dt>

212

<dd>Insert ## in front of selected lines.</dd>

213

<dt>Uncomment Region</dt>

214

<dd>Remove leading # or ## from selected lines.</dd>

215

<dt>Tabify Region</dt>

216

<dd>Turn <em>leading</em> stretches of spaces into tabs. (Note: We recommend using

217

4 space blocks to indent Python code.)</dd>

218

<dt>Untabify Region</dt>

219

<dd>Turn <em>all</em> tabs into the correct number of spaces.</dd>

220

<dt>Toggle Tabs</dt>

221

<dd>Open a dialog to switch between indenting with spaces and tabs.</dd>

222

<dt>New Indent Width</dt>

223

<dd>Open a dialog to change indent width. The accepted default by the Python

224

community is 4 spaces.</dd>

225

<dt>Format Paragraph</dt>

226

<dd>Reformat the current blank-line-delimited paragraph in comment block or

227

multiline string or selected line in a string. All lines in the

228

paragraph will be formatted to less than N columns, where N defaults to 72.</dd>

229

<dt>Strip trailing whitespace</dt>

230

<dd>Remove any space characters after the last non-space character of a line.</dd>

231

</dl>

232

</div>

233

234

<span id="index-2"></span><h3>25.5.1.4. Run menu (Editor window only)<a class="headerlink" href="#run-menu-editor-window-only" title="Permalink to this headline">¶</a></h3>

235

236

<dt>Python Shell</dt>

237

<dd>Open or wake up the Python Shell window.</dd>

238

<dt>Check Module</dt>

239

<dd>Check the syntax of the module currently open in the Editor window. If the

240

module has not been saved IDLE will either prompt the user to save or

241

autosave, as selected in the General tab of the Idle Settings dialog. If

242

there is a syntax error, the approximate location is indicated in the

243

Editor window.</dd>

244

<dt>Run Module</dt>

245

<dd>Do Check Module (above). If no error, restart the shell to clean the

246

environment, then execute the module. Output is displayed in the Shell

247

window. Note that output requires use of <code class="docutils literal"><span class="pre">print</span></code> or <code class="docutils literal"><span class="pre">write</span></code>.

248

When execution is complete, the Shell retains focus and displays a prompt.

249

At this point, one may interactively explore the result of execution.

250

This is similar to executing a file with <code class="docutils literal"><span class="pre">python</span> <span class="pre">-i</span> <span class="pre">file</span></code> at a command

251

line.</dd>

252

</dl>

253

</div>

254

255

<h3>25.5.1.5. Shell menu (Shell window only)<a class="headerlink" href="#shell-menu-shell-window-only" title="Permalink to this headline">¶</a></h3>

256

257

<dt>View Last Restart</dt>

258

<dd>Scroll the shell window to the last Shell restart.</dd>

259

<dt>Restart Shell</dt>

260

<dd>Restart the shell to clean the environment.</dd>

261

<dt>Interrupt Execution</dt>

262

<dd>Stop a running program.</dd>

263

</dl>

264

</div>

265

266

<h3>25.5.1.6. Debug menu (Shell window only)<a class="headerlink" href="#debug-menu-shell-window-only" title="Permalink to this headline">¶</a></h3>

267

268

269

<dd>Look on the current line. with the cursor, and the line above for a filename

270

and line number. If found, open the file if not already open, and show the

271

line. Use this to view source lines referenced in an exception traceback

272

and lines found by Find in Files. Also available in the context menu of

273

the Shell window and Output windows.</dd>

274

</dl>

275

276

<dt>Debugger (toggle)</dt>

277

<dd>When actived, code entered in the Shell or run from an Editor will run

278

under the debugger. In the Editor, breakpoints can be set with the context

279

menu. This feature is still incomplete and somewhat experimental.</dd>

280

<dt>Stack Viewer</dt>

281

<dd>Show the stack traceback of the last exception in a tree widget, with

282

access to locals and globals.</dd>

283

<dt>Auto-open Stack Viewer</dt>

284

<dd>Toggle automatically opening the stack viewer on an unhandled exception.</dd>

285

</dl>

286

</div>

287

288

<h3>25.5.1.7. Options menu (Shell and Editor)<a class="headerlink" href="#options-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3>

289

290

<dt>Configure IDLE</dt>

291

<dd><p class="first">Open a configuration dialog and change preferences for the following:

292

fonts, indentation, keybindings, text color themes, startup windows and

293

size, additional help sources, and extensions (see below). On OS X,

294

open the configuration dialog by selecting Preferences in the application

295

menu. To use a new built-in color theme (IDLE Dark) with older IDLEs,

296

save it as a new custom theme.</p>

297

<p class="last">Non-default user settings are saved in a .idlerc directory in the user’s

298

home directory. Problems caused by bad user configuration files are solved

299

by editing or deleting one or more of the files in .idlerc.</p>

300

</dd>

301

<dt>Code Context (toggle)(Editor Window only)</dt>

302

<dd>Open a pane at the top of the edit window which shows the block context

303

of the code which has scrolled above the top of the window.</dd>

304

</dl>

305

</div>

306

307

<h3>25.5.1.8. Window menu (Shell and Editor)<a class="headerlink" href="#window-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3>

308

309

<dt>Zoom Height</dt>

310

<dd>Toggles the window between normal size and maximum height. The initial size

311

defaults to 40 lines by 80 chars unless changed on the General tab of the

312

Configure IDLE dialog.</dd>

313

</dl>

314

<p>The rest of this menu lists the names of all open windows; select one to bring

315

it to the foreground (deiconifying it if necessary).</p>

316

</div>

317

318

<h3>25.5.1.9. Help menu (Shell and Editor)<a class="headerlink" href="#help-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3>

319

320

<dt>About IDLE</dt>

321

<dd>Display version, copyright, license, credits, and more.</dd>

322

323

<dd>Display a help file for IDLE detailing the menu options, basic editing and

324

navigation, and other tips.</dd>

325

<dt>Python Docs</dt>

326

<dd>Access local Python documentation, if installed, or start a web browser

327

and open docs.python.org showing the latest Python documentation.</dd>

328

<dt>Turtle Demo</dt>

329

<dd>Run the turtledemo module with example python code and turtle drawings.</dd>

330

</dl>

331

<p>Additional help sources may be added here with the Configure IDLE dialog under

332

the General tab.</p>

333

</div>

334

335

<span id="index-4"></span><h3>25.5.1.10. Context Menus<a class="headerlink" href="#context-menus" title="Permalink to this headline">¶</a></h3>

336

<p>Open a context menu by right-clicking in a window (Control-click on OS X).

337

Context menus have the standard clipboard functions also on the Edit menu.</p>

338

339

340

<dd>Copy selection into the system-wide clipboard; then delete the selection.</dd>

341

342

<dd>Copy selection into the system-wide clipboard.</dd>

343

<dt>Paste</dt>

344

<dd>Insert contents of the system-wide clipboard into the current window.</dd>

345

</dl>

346

<p>Editor windows also have breakpoint functions. Lines with a breakpoint set are

347

specially marked. Breakpoints only have an effect when running under the

348

debugger. Breakpoints for a file are saved in the user’s .idlerc directory.</p>

349

350

<dt>Set Breakpoint</dt>

351

<dd>Set a breakpoint on the current line.</dd>

352

<dt>Clear Breakpoint</dt>

353

<dd>Clear the breakpoint on that line.</dd>

354

</dl>

355

<p>Shell and Output windows have the following.</p>

356

357

358

<dd>Same as in Debug menu.</dd>

359

</dl>

360

</div>

361

</div>

362

363

<h2>25.5.2. Editing and navigation<a class="headerlink" href="#editing-and-navigation" title="Permalink to this headline">¶</a></h2>

364

<p>In this section, ‘C’ refers to the <code class="kbd docutils literal"><span class="pre">Control</span></code> key on Windows and Unix and

365

the <code class="kbd docutils literal"><span class="pre">Command</span></code> key on Mac OSX.</p>

366

<ul>

367

<li><p class="first"><code class="kbd docutils literal"><span class="pre">Backspace</span></code> deletes to the left; <code class="kbd docutils literal"><span class="pre">Del</span></code> deletes to the right</p>

368

</li>

369

<li><p class="first"><code class="kbd docutils literal"><span class="pre">C-Backspace</span></code> delete word left; <code class="kbd docutils literal"><span class="pre">C-Del</span></code> delete word to the right</p>

370

</li>

371

<li><p class="first">Arrow keys and <code class="kbd docutils literal"><span class="pre">Page</span> <span class="pre">Up</span></code>/<code class="kbd docutils literal"><span class="pre">Page</span> <span class="pre">Down</span></code> to move around</p>

372

</li>

373

<li><p class="first"><code class="kbd docutils literal"><span class="pre">C-LeftArrow</span></code> and <code class="kbd docutils literal"><span class="pre">C-RightArrow</span></code> moves by words</p>

374

</li>

375

<li><p class="first"><code class="kbd docutils literal"><span class="pre">Home</span></code>/<code class="kbd docutils literal"><span class="pre">End</span></code> go to begin/end of line</p>

376

</li>

377

<li><p class="first"><code class="kbd docutils literal"><span class="pre">C-Home</span></code>/<code class="kbd docutils literal"><span class="pre">C-End</span></code> go to begin/end of file</p>

378

</li>

379

<li><p class="first">Some useful Emacs bindings are inherited from Tcl/Tk:</p>

380

381

382

<li><code class="kbd docutils literal"><span class="pre">C-a</span></code> beginning of line</li>

383

384

<li><code class="kbd docutils literal"><span class="pre">C-k</span></code> kill line (but doesn’t put it in clipboard)</li>

385

<li><code class="kbd docutils literal"><span class="pre">C-l</span></code> center window around the insertion point</li>

386

<li><code class="kbd docutils literal"><span class="pre">C-b</span></code> go backwards one character without deleting (usually you can

387

also use the cursor key for this)</li>

388

<li><code class="kbd docutils literal"><span class="pre">C-f</span></code> go forward one character without deleting (usually you can

389

also use the cursor key for this)</li>

390

<li><code class="kbd docutils literal"><span class="pre">C-p</span></code> go up one line (usually you can also use the cursor key for

391

this)</li>

392

<li><code class="kbd docutils literal"><span class="pre">C-d</span></code> delete next character</li>

393

</ul>

394

</div></blockquote>

395

</li>

396

</ul>

397

<p>Standard keybindings (like <code class="kbd docutils literal"><span class="pre">C-c</span></code> to copy and <code class="kbd docutils literal"><span class="pre">C-v</span></code> to paste)

398

may work. Keybindings are selected in the Configure IDLE dialog.</p>

399

400

<h3>25.5.2.1. Automatic indentation<a class="headerlink" href="#automatic-indentation" title="Permalink to this headline">¶</a></h3>

401

<p>After a block-opening statement, the next line is indented by 4 spaces (in the

402

Python Shell window by one tab). After certain keywords (break, return etc.)

403

the next line is dedented. In leading indentation, <code class="kbd docutils literal"><span class="pre">Backspace</span></code> deletes up

404

to 4 spaces if they are there. <code class="kbd docutils literal"><span class="pre">Tab</span></code> inserts spaces (in the Python

405

Shell window one tab), number depends on Indent width. Currently tabs

406

are restricted to four spaces due to Tcl/Tk limitations.</p>

407

<p>See also the indent/dedent region commands in the edit menu.</p>

408

</div>

409

410

<h3>25.5.2.2. Completions<a class="headerlink" href="#completions" title="Permalink to this headline">¶</a></h3>

411

<p>Completions are supplied for functions, classes, and attributes of classes,

412

both built-in and user-defined. Completions are also provided for

413

filenames.</p>

414

<p>The AutoCompleteWindow (ACW) will open after a predefined delay (default is

415

two seconds) after a ‘.’ or (in a string) an os.sep is typed. If after one

416

of those characters (plus zero or more other characters) a tab is typed

417

the ACW will open immediately if a possible continuation is found.</p>

418

<p>If there is only one possible completion for the characters entered, a

419

<code class="kbd docutils literal"><span class="pre">Tab</span></code> will supply that completion without opening the ACW.</p>

420

<p>‘Show Completions’ will force open a completions window, by default the

421

<code class="kbd docutils literal"><span class="pre">C-space</span></code> will open a completions window. In an empty

422

string, this will contain the files in the current directory. On a

423

blank line, it will contain the built-in and user-defined functions and

424

classes in the current name spaces, plus any modules imported. If some

425

characters have been entered, the ACW will attempt to be more specific.</p>

426

<p>If a string of characters is typed, the ACW selection will jump to the

427

entry most closely matching those characters. Entering a <code class="kbd docutils literal"><span class="pre">tab</span></code> will

428

cause the longest non-ambiguous match to be entered in the Editor window or

429

Shell. Two <code class="kbd docutils literal"><span class="pre">tab</span></code> in a row will supply the current ACW selection, as

430

will return or a double click. Cursor keys, Page Up/Down, mouse selection,

431

and the scroll wheel all operate on the ACW.</p>

432

<p>“Hidden” attributes can be accessed by typing the beginning of hidden

433

name after a ‘.’, e.g. ‘_’. This allows access to modules with

434

<code class="docutils literal"><span class="pre">__all__</span></code> set, or to class-private attributes.</p>

435

<p>Completions and the ‘Expand Word’ facility can save a lot of typing!</p>

436

<p>Completions are currently limited to those in the namespaces. Names in

437

an Editor window which are not via <code class="docutils literal"><span class="pre">__main__</span></code> and <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal"><span class="pre">sys.modules</span></code></a> will

438

not be found. Run the module once with your imports to correct this situation.

439

Note that IDLE itself places quite a few modules in sys.modules, so

440

much can be found by default, e.g. the re module.</p>

441

<p>If you don’t like the ACW popping up unbidden, simply make the delay

442

longer or disable the extension.</p>

443

</div>

444

445

<h3>25.5.2.3. Calltips<a class="headerlink" href="#calltips" title="Permalink to this headline">¶</a></h3>

446

<p>A calltip is shown when one types <code class="kbd docutils literal"><span class="pre">(</span></code> after the name of an <em>acccessible</em>

447

function. A name expression may include dots and subscripts. A calltip

448

remains until it is clicked, the cursor is moved out of the argument area,

449

or <code class="kbd docutils literal"><span class="pre">)</span></code> is typed. When the cursor is in the argument part of a definition,

450

the menu or shortcut display a calltip.</p>

451

<p>A calltip consists of the function signature and the first line of the

452

docstring. For builtins without an accessible signature, the calltip

453

consists of all lines up the fifth line or the first blank line. These

454

details may change.</p>

455

<p>The set of <em>accessible</em> functions depends on what modules have been imported

456

into the user process, including those imported by Idle itself,

457

and what definitions have been run, all since the last restart.</p>

458

<p>For example, restart the Shell and enter <code class="docutils literal"><span class="pre">itertools.count(</span></code>. A calltip

459

appears because Idle imports itertools into the user process for its own use.

460

(This could change.) Enter <code class="docutils literal"><span class="pre">turtle.write(</span></code> and nothing appears. Idle does

461

not import turtle. The menu or shortcut do nothing either. Enter

462

<code class="docutils literal"><span class="pre">import</span> <span class="pre">turtle</span></code> and then <code class="docutils literal"><span class="pre">turtle.write(</span></code> will work.</p>

463

<p>In an editor, import statements have no effect until one runs the file. One

464

might want to run a file after writing the import statements at the top,

465

or immediately run an existing file before editing.</p>

466

</div>

467

468

<h3>25.5.2.4. Python Shell window<a class="headerlink" href="#python-shell-window" title="Permalink to this headline">¶</a></h3>

469

<ul>

470

<li><p class="first"><code class="kbd docutils literal"><span class="pre">C-c</span></code> interrupts executing command</p>

471

</li>

472

<li><p class="first"><code class="kbd docutils literal"><span class="pre">C-d</span></code> sends end-of-file; closes window if typed at a <code class="docutils literal"><span class="pre">>>></span></code> prompt</p>

473

</li>

474

<li><p class="first"><code class="kbd docutils literal"><span class="pre">Alt-/</span></code> (Expand word) is also useful to reduce typing</p>

475

<p>Command history</p>

476

477

<li><code class="kbd docutils literal"><span class="pre">Alt-p</span></code> retrieves previous command matching what you have typed. On

478

OS X use <code class="kbd docutils literal"><span class="pre">C-p</span></code>.</li>

479

<li><code class="kbd docutils literal"><span class="pre">Alt-n</span></code> retrieves next. On OS X use <code class="kbd docutils literal"><span class="pre">C-n</span></code>.</li>

480

<li><code class="kbd docutils literal"><span class="pre">Return</span></code> while on any previous command retrieves that command</li>

481

</ul>

482

</li>

483

</ul>

484

</div>

485

486

<h3>25.5.2.5. Text colors<a class="headerlink" href="#text-colors" title="Permalink to this headline">¶</a></h3>

487

<p>Idle defaults to black on white text, but colors text with special meanings.

488

For the shell, these are shell output, shell error, user output, and

489

user error. For Python code, at the shell prompt or in an editor, these are

490

keywords, builtin class and function names, names following <code class="docutils literal"><span class="pre">class</span></code> and

491

<code class="docutils literal"><span class="pre">def</span></code>, strings, and comments. For any text window, these are the cursor (when

492

present), found text (when possible), and selected text.</p>

493

<p>Text coloring is done in the background, so uncolorized text is occasionally

494

visible. To change the color scheme, use the Configure IDLE dialog

495

Highlighting tab. The marking of debugger breakpoint lines in the editor and

496

text in popups and dialogs is not user-configurable.</p>

497

</div>

498

</div>

499

500

<h2>25.5.3. Startup and code execution<a class="headerlink" href="#startup-and-code-execution" title="Permalink to this headline">¶</a></h2>

501

<p>Upon startup with the <code class="docutils literal"><span class="pre">-s</span></code> option, IDLE will execute the file referenced by

502

the environment variables <span class="target" id="index-5"></span><code class="xref std std-envvar docutils literal"><span class="pre">IDLESTARTUP</span></code> or <span class="target" id="index-6"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONSTARTUP"><code class="xref std std-envvar docutils literal"><span class="pre">PYTHONSTARTUP</span></code></a>.

503

IDLE first checks for <code class="docutils literal"><span class="pre">IDLESTARTUP</span></code>; if <code class="docutils literal"><span class="pre">IDLESTARTUP</span></code> is present the file

504

referenced is run. If <code class="docutils literal"><span class="pre">IDLESTARTUP</span></code> is not present, IDLE checks for

505

<code class="docutils literal"><span class="pre">PYTHONSTARTUP</span></code>. Files referenced by these environment variables are

506

convenient places to store functions that are used frequently from the IDLE

507

shell, or for executing import statements to import common modules.</p>

508

<p>In addition, <code class="docutils literal"><span class="pre">Tk</span></code> also loads a startup file if it is present. Note that the

509

Tk file is loaded unconditionally. This additional file is <code class="docutils literal"><span class="pre">.Idle.py</span></code> and is

510

looked for in the user’s home directory. Statements in this file will be

511

executed in the Tk namespace, so this file is not useful for importing

512

functions to be used from IDLE’s Python shell.</p>

513

514

<h3>25.5.3.1. Command line usage<a class="headerlink" href="#command-line-usage" title="Permalink to this headline">¶</a></h3>

515

<div class="highlight-none"><div class="highlight"><pre><span></span>idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...

516

517

-c command run command in the shell window

518

-d enable debugger and open shell window

519

-e open editor window

520

-h print help message with legal combinations and exit

521

-i open shell window

522

-r file run file in shell window

523

-s run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window

524

-t title set title of shell window

525

- run stdin in shell (- must be last option before args)

526

</pre></div>

527

</div>

528

<p>If there are arguments:</p>

529

530

<li>If <code class="docutils literal"><span class="pre">-</span></code>, <code class="docutils literal"><span class="pre">-c</span></code>, or <code class="docutils literal"><span class="pre">r</span></code> is used, all arguments are placed in

531

<code class="docutils literal"><span class="pre">sys.argv[1:...]</span></code> and <code class="docutils literal"><span class="pre">sys.argv[0]</span></code> is set to <code class="docutils literal"><span class="pre">''</span></code>, <code class="docutils literal"><span class="pre">'-c'</span></code>,

532

or <code class="docutils literal"><span class="pre">'-r'</span></code>. No editor window is opened, even if that is the default

533

set in the Options dialog.</li>

534

<li>Otherwise, arguments are files opened for editing and

535

<code class="docutils literal"><span class="pre">sys.argv</span></code> reflects the arguments passed to IDLE itself.</li>

536

</ul>

537

</div>

538

539

<h3>25.5.3.2. IDLE-console differences<a class="headerlink" href="#idle-console-differences" title="Permalink to this headline">¶</a></h3>

540

<p>As much as possible, the result of executing Python code with IDLE is the

541

same as executing the same code in a console window. However, the different

542

interface and operation occasionally affects visible results. For instance,

543

<code class="docutils literal"><span class="pre">sys.modules</span></code> starts with more entries.</p>

544

<p>IDLE also replaces <code class="docutils literal"><span class="pre">sys.stdin</span></code>, <code class="docutils literal"><span class="pre">sys.stdout</span></code>, and <code class="docutils literal"><span class="pre">sys.stderr</span></code> with

545

objects that get input from and send output to the Shell window.

546

When this window has the focus, it controls the keyboard and screen.

547

This is normally transparent, but functions that directly access the keyboard

548

and screen will not work. If <code class="docutils literal"><span class="pre">sys</span></code> is reset with <code class="docutils literal"><span class="pre">importlib.reload(sys)</span></code>,

549

IDLE’s changes are lost and things like <code class="docutils literal"><span class="pre">input</span></code>, <code class="docutils literal"><span class="pre">raw_input</span></code>, and

550

<code class="docutils literal"><span class="pre">print</span></code> will not work correctly.</p>

551

<p>With IDLE’s Shell, one enters, edits, and recalls complete statements.

552

Some consoles only work with a single physical line at a time. IDLE uses

553

<code class="docutils literal"><span class="pre">exec</span></code> to run each statement. As a result, <code class="docutils literal"><span class="pre">'__builtins__'</span></code> is always

554

defined for each statement.</p>

555

</div>

556

557

<h3>25.5.3.3. Running without a subprocess<a class="headerlink" href="#running-without-a-subprocess" title="Permalink to this headline">¶</a></h3>

558

<p>By default, IDLE executes user code in a separate subprocess via a socket,

559

which uses the internal loopback interface. This connection is not

560

externally visible and no data is sent to or received from the Internet.

561

If firewall software complains anyway, you can ignore it.</p>

562

<p>If the attempt to make the socket connection fails, Idle will notify you.

563

Such failures are sometimes transient, but if persistent, the problem

564

may be either a firewall blocking the connecton or misconfiguration of

565

a particular system. Until the problem is fixed, one can run Idle with

566

the -n command line switch.</p>

567

<p>If IDLE is started with the -n command line switch it will run in a

568

single process and will not create the subprocess which runs the RPC

569

Python execution server. This can be useful if Python cannot create

570

the subprocess or the RPC socket interface on your platform. However,

571

in this mode user code is not isolated from IDLE itself. Also, the

572

environment is not restarted when Run/Run Module (F5) is selected. If

573

your code has been modified, you must reload() the affected modules and

574

re-import any specific items (e.g. from foo import baz) if the changes

575

are to take effect. For these reasons, it is preferable to run IDLE

576

with the default subprocess if at all possible.</p>

577

578

<p><span class="versionmodified">Deprecated since version 3.4.</span></p>

579

</div>

580

</div>

581

</div>

582

583

<h2>25.5.4. Help and preferences<a class="headerlink" href="#help-and-preferences" title="Permalink to this headline">¶</a></h2>

584

585

<h3>25.5.4.1. Additional help sources<a class="headerlink" href="#additional-help-sources" title="Permalink to this headline">¶</a></h3>

586

<p>IDLE includes a help menu entry called “Python Docs” that will open the

587

extensive sources of help, including tutorials, available at docs.python.org.

588

Selected URLs can be added or removed from the help menu at any time using the

589

Configure IDLE dialog. See the IDLE help option in the help menu of IDLE for

590

more information.</p>

591

</div>

592

593

<h3>25.5.4.2. Setting preferences<a class="headerlink" href="#setting-preferences" title="Permalink to this headline">¶</a></h3>

594

<p>The font preferences, highlighting, keys, and general preferences can be

595

changed via Configure IDLE on the Option menu. Keys can be user defined;

596

IDLE ships with four built in key sets. In addition a user can create a

597

custom key set in the Configure IDLE dialog under the keys tab.</p>

598

</div>

599

600

<h3>25.5.4.3. Extensions<a class="headerlink" href="#extensions" title="Permalink to this headline">¶</a></h3>

601

<p>IDLE contains an extension facility. Peferences for extensions can be

602

changed with Configure Extensions. See the beginning of config-extensions.def

603

in the idlelib directory for further information. The default extensions

604

are currently:</p>

605

606

<li>FormatParagraph</li>

607

<li>AutoExpand</li>

608

<li>ZoomHeight</li>

609

<li>ScriptBinding</li>

610

<li>CallTips</li>

611

<li>ParenMatch</li>

612

<li>AutoComplete</li>

613

<li>CodeContext</li>

614

<li>RstripExtension</li>

615

</ul>

616

</div>

617

</div>

618

</div>

619

620

621

</div>

622

</div>

623

</div>

624

625

626

<h3><a href="../contents.html">Table Of Contents</a></h3>

627

<ul>

628

629

<li><a class="reference internal" href="#menus">25.5.1. Menus</a><ul>

630

<li><a class="reference internal" href="#file-menu-shell-and-editor">25.5.1.1. File menu (Shell and Editor)</a></li>

631

<li><a class="reference internal" href="#edit-menu-shell-and-editor">25.5.1.2. Edit menu (Shell and Editor)</a></li>

632

<li><a class="reference internal" href="#format-menu-editor-window-only">25.5.1.3. Format menu (Editor window only)</a></li>

633

<li><a class="reference internal" href="#run-menu-editor-window-only">25.5.1.4. Run menu (Editor window only)</a></li>

634

<li><a class="reference internal" href="#shell-menu-shell-window-only">25.5.1.5. Shell menu (Shell window only)</a></li>

635

<li><a class="reference internal" href="#debug-menu-shell-window-only">25.5.1.6. Debug menu (Shell window only)</a></li>

636

<li><a class="reference internal" href="#options-menu-shell-and-editor">25.5.1.7. Options menu (Shell and Editor)</a></li>

637

<li><a class="reference internal" href="#window-menu-shell-and-editor">25.5.1.8. Window menu (Shell and Editor)</a></li>

638

<li><a class="reference internal" href="#help-menu-shell-and-editor">25.5.1.9. Help menu (Shell and Editor)</a></li>

639

<li><a class="reference internal" href="#context-menus">25.5.1.10. Context Menus</a></li>

640

</ul>

641

</li>

642

<li><a class="reference internal" href="#editing-and-navigation">25.5.2. Editing and navigation</a><ul>

643

<li><a class="reference internal" href="#automatic-indentation">25.5.2.1. Automatic indentation</a></li>

644

<li><a class="reference internal" href="#completions">25.5.2.2. Completions</a></li>

645

<li><a class="reference internal" href="#calltips">25.5.2.3. Calltips</a></li>

646

<li><a class="reference internal" href="#python-shell-window">25.5.2.4. Python Shell window</a></li>

647

<li><a class="reference internal" href="#text-colors">25.5.2.5. Text colors</a></li>

648

</ul>

649

</li>

650

<li><a class="reference internal" href="#startup-and-code-execution">25.5.3. Startup and code execution</a><ul>

651

<li><a class="reference internal" href="#command-line-usage">25.5.3.1. Command line usage</a></li>

652

<li><a class="reference internal" href="#idle-console-differences">25.5.3.2. IDLE-console differences</a></li>

653

<li><a class="reference internal" href="#running-without-a-subprocess">25.5.3.3. Running without a subprocess</a></li>

654

</ul>

655

</li>

656

<li><a class="reference internal" href="#help-and-preferences">25.5.4. Help and preferences</a><ul>

657

<li><a class="reference internal" href="#additional-help-sources">25.5.4.1. Additional help sources</a></li>

658

<li><a class="reference internal" href="#setting-preferences">25.5.4.2. Setting preferences</a></li>

659

<li><a class="reference internal" href="#extensions">25.5.4.3. Extensions</a></li>

660

</ul>

661

</li>

662

</ul>

663

</li>

664

</ul>

665

666

<h4>Previous topic</h4>

667

<p class="topless"><a href="tkinter.scrolledtext.html"

668

title="previous chapter">25.4. <code class="docutils literal"><span class="pre">tkinter.scrolledtext</span></code> — Scrolled Text Widget</a></p>

669

<h4>Next topic</h4>

670

<p class="topless"><a href="othergui.html"

671

title="next chapter">25.6. Other Graphical User Interface Packages</a></p>

672

673

674

675

<li><a href="../bugs.html">Report a Bug</a></li>

676

<li><a href="../_sources/library/idle.txt"

677

rel="nofollow">Show Source</a></li>

678

</ul>

679

</div>

680

</div>

681

</div>

682

683

</div>

684

685

<h3>Navigation</h3>

686

<ul>

687

688

<a href="../genindex.html" title="General Index"

689

>index</a></li>

690

691

<a href="../py-modindex.html" title="Python Module Index"

692

>modules</a> |</li>

693

694

<a href="othergui.html" title="25.6. Other Graphical User Interface Packages"

695

>next</a> |</li>

696

697

<a href="tkinter.scrolledtext.html" title="25.4. tkinter.scrolledtext — Scrolled Text Widget"

698

>previous</a> |</li>

699

<li><img src="../_static/py.png" alt=""

700

style="vertical-align: middle; margin-top: -1px"/></li>

701

<li><a href="https://www.python.org/">Python</a> »</li>

702

<li>

703

704

<a href="../index.html">Documentation </a> »

705

</li>

706

707

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>

708

<li class="nav-item nav-item-2"><a href="tk.html" >25. Graphical User Interfaces with Tk</a> »</li>

709

710

711

712

713

714

715

716

717

718

</form>

719

</div>

720

721

722

</li>

723

724

</ul>

725

</div>

726

727

728

<br />

729

The Python Software Foundation is a non-profit corporation.

730

<a href="https://www.python.org/psf/donations/">Please donate.</a>

731

<br />

732

Last updated on Sep 23, 2016.

733

<a href="../bugs.html">Found a bug</a>?

734

<br />

735

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.

736

</div>

737

738

</body>

739

</html>

b'\\ No newline at end of file'

Older »