cpython/Misc/python.man at 9249f8034dfc47345cdbeeca3de8bc7afa2c4027 · python/cpython · GitHub

Repository navigation

History

386 lines (382 loc) · 11.6 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

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

.TH PYTHON "1" "$Date$"

./" To view this file while editing, run it through groff:

./" groff -Tascii -man python.man | less

.SH NAME

python \- an interpreted, interactive, object-oriented programming language

.SH SYNOPSIS

.B python

[

.B \-d

]

[

.B \-E

]

[

.B \-h

]

[

.B \-i

]

[

.B \-m

.I module-name

]

[

.B \-O

]

.br

[

.B -Q

.I argument

]

[

.B \-S

]

[

.B \-u

]

.br

[

.B \-v

]

[

.B \-V

]

[

.B \-W

.I argument

]

[

.B \-x

]

.br

[

.B \-c

.I command

.I script

]

[

.I arguments

]

.SH DESCRIPTION

Python is an interpreted, interactive, object-oriented programming

language that combines remarkable power with very clear syntax.

For an introduction to programming in Python you are referred to the

Python Tutorial.

The Python Library Reference documents built-in and standard types,

constants, functions and modules.

Finally, the Python Reference Manual describes the syntax and

semantics of the core language in (perhaps too) much detail.

(These documents may be located via the

.B "INTERNET RESOURCES"

below; they may be installed on your system as well.)

.PP

Python's basic power can be extended with your own modules written in

C or C++.

On most systems such modules may be dynamically loaded.

Python is also adaptable as an extension language for existing

applications.

See the internal documentation for hints.

.PP

Documentation for installed Python modules and packages can be

viewed by running the

.B pydoc

program.

.SH COMMAND LINE OPTIONS

.TP

.BI "\-c " command

Specify the command to execute (see next section).

This terminates the option list (following options are passed as

arguments to the command).

.TP

.B \-d

Turn on parser debugging output (for wizards only, depending on

compilation options).

.TP

.B \-E

Ignore environment variables like PYTHONPATH and PYTHONHOME that modify

the behavior of the interpreter.

.TP

.B \-h

Prints the usage for the interpreter executable and exits.

.TP

.B \-i

When a script is passed as first argument or the \fB\-c\fP option is

used, enter interactive mode after executing the script or the

command. It does not read the $PYTHONSTARTUP file. This can be

useful to inspect global variables or a stack trace when a script

raises an exception.

.TP

.BI "\-m " module-name

Searches

.I sys.path

for the named module and runs the corresponding

.I .py

file as a script.

.TP

.B \-O

Turn on basic optimizations. This changes the filename extension for

compiled (bytecode) files from

.I .pyc

to \fI.pyo\fP. Given twice, causes docstrings to be discarded.

.TP

.BI "\-Q " argument

Division control; see PEP 238. The argument must be one of "old" (the

default, int/int and long/long return an int or long), "new" (new

division semantics, i.e. int/int and long/long returns a float),

"warn" (old division semantics with a warning for int/int and

long/long), or "warnall" (old division semantics with a warning for

all use of the division operator). For a use of "warnall", see the

Tools/scripts/fixdiv.py script.

.TP

.B \-S

Disable the import of the module

.I site

and the site-dependent manipulations of

.I sys.path

that it entails.

.TP

.B \-u

Force stdin, stdout and stderr to be totally unbuffered. On systems

where it matters, also put stdin, stdout and stderr in binary mode.

Note that there is internal buffering in readlines() and

file-object iterators ("for line in sys.stdin") which is not

influenced by this option. To work around this, you will want to use

"sys.stdin.readline()" inside a "while 1:" loop.

.TP

.B \-v

Print a message each time a module is initialized, showing the place

(filename or built-in module) from which it is loaded. When given

twice, print a message for each file that is checked for when

searching for a module. Also provides information on module cleanup

at exit.

.TP

.B \-V

Prints the Python version number of the executable and exits.

.TP

.BI "\-W " argument

Warning control. Python sometimes prints warning message to

.IR sys.stderr .

A typical warning message has the following form:

.IB file ":" line ": " category ": " message.

By default, each warning is printed once for each source line where it

occurs. This option controls how often warnings are printed.

Multiple

.B \-W

options may be given; when a warning matches more than one

option, the action for the last matching option is performed.

Invalid

.B \-W

options are ignored (a warning message is printed about invalid

options when the first warning is issued). Warnings can also be

controlled from within a Python program using the

.I warnings

module.

The simplest form of

.I argument

is one of the following

.I action

strings (or a unique abbreviation):

.B ignore

to ignore all warnings;

.B default

to explicitly request the default behavior (printing each warning once

per source line);

.B all

to print a warning each time it occurs (this may generate many

messages if a warning is triggered repeatedly for the same source

line, such as inside a loop);

.B module

to print each warning only only the first time it occurs in each

module;

.B once

to print each warning only the first time it occurs in the program; or

.B error

to raise an exception instead of printing a warning message.

The full form of

.I argument

.IB action : message : category : module : line.

Here,

.I action

is as explained above but only applies to messages that match the

remaining fields. Empty fields match all values; trailing empty

fields may be omitted. The

.I message

field matches the start of the warning message printed; this match is

case-insensitive. The

.I category

field matches the warning category. This must be a class name; the

match test whether the actual warning category of the message is a

subclass of the specified warning category. The full class name must

be given. The

.I module

field matches the (fully-qualified) module name; this match is

case-sensitive. The

.I line

field matches the line number, where zero matches all line numbers and

is thus equivalent to an omitted line number.

.TP

.B \-x

Skip the first line of the source. This is intended for a DOS

specific hack only. Warning: the line numbers in error messages will

be off by one!

.SH INTERPRETER INTERFACE

The interpreter interface resembles that of the UNIX shell: when

called with standard input connected to a tty device, it prompts for

commands and executes them until an EOF is read; when called with a

file name argument or with a file as standard input, it reads and

executes a

.I script

from that file;

when called with

.B \-c

.I command,

it executes the Python statement(s) given as

.I command.

Here

.I command

may contain multiple statements separated by newlines.

Leading whitespace is significant in Python statements!

In non-interactive mode, the entire input is parsed before it is

executed.

.PP

If available, the script name and additional arguments thereafter are

passed to the script in the Python variable

.I sys.argv ,

which is a list of strings (you must first

.I import sys

to be able to access it).

If no script name is given,

.I sys.argv[0]

is an empty string; if

.B \-c

is used,

.I sys.argv[0]

contains the string

.I '-c'.

Note that options interpreted by the Python interpreter itself

are not placed in

.I sys.argv.

.PP

In interactive mode, the primary prompt is `>>>'; the second prompt

(which appears when a command is not complete) is `...'.

The prompts can be changed by assignment to

.I sys.ps1

.I sys.ps2.

The interpreter quits when it reads an EOF at a prompt.

When an unhandled exception occurs, a stack trace is printed and

control returns to the primary prompt; in non-interactive mode, the

interpreter exits after printing the stack trace.

The interrupt signal raises the

.I Keyboard\%Interrupt

exception; other UNIX signals are not caught (except that SIGPIPE is

sometimes ignored, in favor of the

.I IOError

exception). Error messages are written to stderr.

.SH FILES AND DIRECTORIES

These are subject to difference depending on local installation

conventions; ${prefix} and ${exec_prefix} are installation-dependent

and should be interpreted as for GNU software; they may be the same.

The default for both is \fI/usr/local\fP.

.IP \fI${exec_prefix}/bin/python\fP

Recommended location of the interpreter.

.PP

.I ${prefix}/lib/python<version>

.br

.I ${exec_prefix}/lib/python<version>

.RS

Recommended locations of the directories containing the standard

modules.

.RE

.PP

.I ${prefix}/include/python<version>

.br

.I ${exec_prefix}/include/python<version>

.RS

Recommended locations of the directories containing the include files

needed for developing Python extensions and embedding the

interpreter.

.RE

.SH ENVIRONMENT VARIABLES

.IP PYTHONHOME

Change the location of the standard Python libraries. By default, the

libraries are searched in ${prefix}/lib/python<version> and

${exec_prefix}/lib/python<version>, where ${prefix} and ${exec_prefix}

are installation-dependent directories, both defaulting to

\fI/usr/local\fP. When $PYTHONHOME is set to a single directory, its value

replaces both ${prefix} and ${exec_prefix}. To specify different values

for these, set $PYTHONHOME to ${prefix}:${exec_prefix}.

.IP PYTHONPATH

Augments the default search path for module files.

The format is the same as the shell's $PATH: one or more directory

pathnames separated by colons.

Non-existent directories are silently ignored.

The default search path is installation dependent, but generally

begins with ${prefix}/lib/python<version> (see PYTHONHOME above).

The default search path is always appended to $PYTHONPATH.

If a script argument is given, the directory containing the script is

inserted in the path in front of $PYTHONPATH.

The search path can be manipulated from within a Python program as the

variable

.I sys.path .

.IP PYTHONSTARTUP

If this is the name of a readable file, the Python commands in that

file are executed before the first prompt is displayed in interactive

mode.

The file is executed in the same name space where interactive commands

are executed so that objects defined or imported in it can be used

without qualification in the interactive session.

You can also change the prompts

.I sys.ps1

and

.I sys.ps2

in this file.

.IP PYTHONY2K

Set this to a non-empty string to cause the \fItime\fP module to

require dates specified as strings to include 4-digit years, otherwise

2-digit years are converted based on rules described in the \fItime\fP

module documentation.

.IP PYTHONOPTIMIZE