Codestin Search App

History

2084 lines (1961 loc) · 193 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

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>10. API參照 — Python 3.7.0 說明文件</title>

title="在 Python 3.7.0 說明文件中搜尋"

href="../_static/opensearch.xml"/>

</head><body>

<ul>

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

accesskey="I">索引</a></li>

<a href="../py-modindex.html" title="Python 模組索引"

>模組</a> |</li>

<a href="../install/index.html" title="安裝 Python 模組（舊版）"

accesskey="N">下一頁</a> |</li>

<a href="commandref.html" title="9. 指令參照"

accesskey="P">上一頁</a> |</li>

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

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

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

<li>

zh_TW

3.7.0

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

</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">發布 Python 模組（舊版）</a> »</li>

</form>

</div>

</li>

</ul>

</div>

<h1>10. API參照<a class="headerlink" href="#api-reference" title="本標題的永久連結">¶</a></h1>

<h2>10.1. <a class="reference internal" href="#module-distutils.core" title="distutils.core: The core Distutils functionality"><code class="xref py py-mod docutils literal notranslate">distutils.core</code></a> — Core Distutils functionality<a class="headerlink" href="#module-distutils.core" title="本標題的永久連結">¶</a></h2>

The <a class="reference internal" href="#module-distutils.core" title="distutils.core: The core Distutils functionality"><code class="xref py py-mod docutils literal notranslate">distutils.core</code></a> module is the only module that needs to be installed

to use the Distutils. It provides the <a class="reference internal" href="#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate">setup()</code></a> (which is called from the

setup script). Indirectly provides the <code class="xref py py-class docutils literal notranslate">distutils.dist.Distribution</code> and

<a class="reference internal" href="#distutils.cmd.Command" title="distutils.cmd.Command"><code class="xref py py-class docutils literal notranslate">distutils.cmd.Command</code></a> class.

<code class="descclassname">distutils.core.</code><code class="descname">setup</code>(arguments)<a class="headerlink" href="#distutils.core.setup" title="本定義的永久連結">¶</a></dt>

<dd>The basic do-everything function that does most everything you could ever ask

for from a Distutils method.

The setup function takes a large number of arguments. These are laid out in the

following table.

</colgroup>

<tr class="row-odd"><th class="head">argument name</th>

<th class="head">value</th>

</tr>

</thead>

<td>The name of the package</td>

<td>a string</td>

</tr>

<tr class="row-odd"><td>version</td>

<td>The version number of the

package; see

<a class="reference internal" href="#module-distutils.version" title="distutils.version: implements classes that represent module version numbers."><code class="xref py py-mod docutils literal notranslate">distutils.version</code></a></td>

<td>a string</td>

</tr>

<tr class="row-even"><td>description</td>

<td>A single line describing the

package</td>

<td>a string</td>

</tr>

<tr class="row-odd"><td>long_description</td>

<td>Longer description of the

package</td>

<td>a string</td>

</tr>

<tr class="row-even"><td>author</td>

<td>The name of the package author</td>

<td>a string</td>

</tr>

<tr class="row-odd"><td>author_email</td>

<td>The email address of the

package author</td>

<td>a string</td>

</tr>

<tr class="row-even"><td>maintainer</td>

<td>The name of the current

maintainer, if different from

the author. Note that if

the maintainer is provided,

distutils will use it as the

author in <code class="file docutils literal notranslate">PKG-INFO</code></td>

<td>a string</td>

</tr>

<tr class="row-odd"><td>maintainer_email</td>

<td>The email address of the

current maintainer, if

different from the author</td>

<td>a string</td>

</tr>

<td>A URL for the package

(homepage)</td>

<td>a string</td>

</tr>

<tr class="row-odd"><td>download_url</td>

<td>A URL to download the package</td>

<td>a string</td>

</tr>

<tr class="row-even"><td>packages</td>

<td>A list of Python packages that

distutils will manipulate</td>

<td>a list of strings</td>

</tr>

<tr class="row-odd"><td>py_modules</td>

<td>A list of Python modules that

distutils will manipulate</td>

<td>a list of strings</td>

</tr>

<tr class="row-even"><td>scripts</td>

<td>A list of standalone script

files to be built and

installed</td>

<td>a list of strings</td>

</tr>

<tr class="row-odd"><td>ext_modules</td>

<td>A list of Python extensions to

be built</td>

<td>a list of instances of

<a class="reference internal" href="#distutils.core.Extension" title="distutils.core.Extension"><code class="xref py py-class docutils literal notranslate">distutils.core.Extension</code></a></td>

</tr>

<tr class="row-even"><td>classifiers</td>

<td>A list of categories for the

package</td>

<td>a list of strings; valid classifiers are listed on <a class="reference external" href="https://pypi.org/classifiers">PyPI</a>.</td>

</tr>

<tr class="row-odd"><td>distclass</td>

<td>the <a class="reference internal" href="#distutils.core.Distribution" title="distutils.core.Distribution"><code class="xref py py-class docutils literal notranslate">Distribution</code></a>

class to use</td>

<td>a subclass of

<a class="reference internal" href="#distutils.core.Distribution" title="distutils.core.Distribution"><code class="xref py py-class docutils literal notranslate">distutils.core.Distribution</code></a></td>

</tr>

<tr class="row-even"><td>script_name</td>

<td>The name of the setup.py

script - defaults to

<td>a string</td>

</tr>

<tr class="row-odd"><td>script_args</td>

<td>Arguments to supply to the

setup script</td>

<td>a list of strings</td>

</tr>

<tr class="row-even"><td>options</td>

<td>default options for the setup

script</td>

<td>a dictionary</td>

</tr>

<tr class="row-odd"><td>license</td>

<td>The license for the package</td>

<td>a string</td>

</tr>

<tr class="row-even"><td>keywords</td>

<td>Descriptive meta-data, see

<td>a list of strings or a comma-separated string</td>

</tr>

<tr class="row-odd"><td>platforms</td>

<td>a list of strings or a comma-separated string</td>

</tr>

<tr class="row-even"><td>cmdclass</td>

<td>A mapping of command names to

<a class="reference internal" href="#distutils.core.Command" title="distutils.core.Command"><code class="xref py py-class docutils literal notranslate">Command</code></a> subclasses</td>

<td>a dictionary</td>

</tr>

<tr class="row-odd"><td>data_files</td>

<td>A list of data files to

install</td>

</tr>

<tr class="row-even"><td>package_dir</td>

<td>A mapping of package to

directory names</td>

<td>a dictionary</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">distutils.core.</code><code class="descname">run_setup</code>(script_name[, script_args=None, stop_after='run'])<a class="headerlink" href="#distutils.core.run_setup" title="本定義的永久連結">¶</a></dt>

<dd>Run a setup script in a somewhat controlled environment, and return the

<code class="xref py py-class docutils literal notranslate">distutils.dist.Distribution</code> instance that drives things. This is

useful if you need to find out the distribution meta-data (passed as keyword

args from script to <a class="reference internal" href="#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate">setup()</code></a>), or the contents of the config files or

command-line.

script_name is a file that will be read and run with <a class="reference internal" href="../library/functions.html#exec" title="exec"><code class="xref py py-func docutils literal notranslate">exec()</code></a>. <code class="docutils literal notranslate">sys.argv[0]</code>

will be replaced with script for the duration of the call. script_args is a

list of strings; if supplied, <code class="docutils literal notranslate">sys.argv[1:]</code> will be replaced by script_args

for the duration of the call.

stop_after tells <a class="reference internal" href="#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate">setup()</code></a> when to stop processing; possible values:

</colgroup>

<tr class="row-odd"><th class="head">value</th>

<th class="head">description</th>

</tr>

</thead>

<td>Stop after the <a class="reference internal" href="#distutils.core.Distribution" title="distutils.core.Distribution"><code class="xref py py-class docutils literal notranslate">Distribution</code></a>

instance has been created and populated

with the keyword arguments to <a class="reference internal" href="#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate">setup()</code></a></td>

</tr>

<tr class="row-odd"><td>config</td>

<td>Stop after config files have been parsed

(and their data stored in the

</tr>

<tr class="row-even"><td>commandline</td>

<td>Stop after the command-line

(<code class="docutils literal notranslate">sys.argv[1:]</code> or script_args) have

been parsed (and the data stored in the

</tr>

<td>Stop after all commands have been run (the

same as if <a class="reference internal" href="#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate">setup()</code></a> had been called

in the usual way). This is the default

value.</td>

</tr>

</tbody>

</table>

</dd></dl>

In addition, the <a class="reference internal" href="#module-distutils.core" title="distutils.core: The core Distutils functionality"><code class="xref py py-mod docutils literal notranslate">distutils.core</code></a> module exposed a number of classes that

live elsewhere.

<li><code class="xref py py-class docutils literal notranslate">Extension</code> from <a class="reference internal" href="#module-distutils.extension" title="distutils.extension: Provides the Extension class, used to describe C/C++ extension modules in setup scripts"><code class="xref py py-mod docutils literal notranslate">distutils.extension</code></a></li>

<li><a class="reference internal" href="#distutils.cmd.Command" title="distutils.cmd.Command"><code class="xref py py-class docutils literal notranslate">Command</code></a> from <a class="reference internal" href="#module-distutils.cmd" title="distutils.cmd: This module provides the abstract base class Command. This class is subclassed by the modules in the distutils.command subpackage."><code class="xref py py-mod docutils literal notranslate">distutils.cmd</code></a></li>

<li><code class="xref py py-class docutils literal notranslate">Distribution</code> from <a class="reference internal" href="#module-distutils.dist" title="distutils.dist: Provides the Distribution class, which represents the module distribution being built/installed/distributed"><code class="xref py py-mod docutils literal notranslate">distutils.dist</code></a></li>

</ul>

A short description of each of these follows, but see the relevant module for

the full reference.

class <code class="descclassname">distutils.core.</code><code class="descname">Extension</code><a class="headerlink" href="#distutils.core.Extension" title="本定義的永久連結">¶</a></dt>

<dd>The Extension class describes a single C or C++ extension module in a setup

script. It accepts the following keyword arguments in its constructor:

</colgroup>

<tr class="row-odd"><th class="head">argument name</th>

<th class="head">value</th>

</tr>

</thead>

<td>the full name of the

extension, including any

packages — ie. not a

filename or pathname, but

Python dotted name</td>

<td>a string</td>

</tr>

<tr class="row-odd"><td>sources</td>

<td>list of source filenames,

relative to the distribution

root (where the setup script

lives), in Unix form (slash-

separated) for portability.

Source files may be C, C++,

SWIG (.i), platform-specific

resource files, or whatever

else is recognized by the

build_ext command

as source for a Python

extension.</td>

<td>a list of strings</td>

</tr>

<tr class="row-even"><td>include_dirs</td>

<td>list of directories to search

for C/C++ header files (in

Unix form for portability)</td>

<td>a list of strings</td>

</tr>

<tr class="row-odd"><td>define_macros</td>

<td>list of macros to define; each

macro is defined using a

2-tuple <code class="docutils literal notranslate">(name, value)</code>,

where value is

either the string to define it

to or <code class="docutils literal notranslate">None</code> to define it

without a particular value

(equivalent of <code class="docutils literal notranslate">#define FOO</code>

in source or <code class="xref std std-option docutils literal notranslate">-DFOO</code>

on Unix C compiler command

line)</td>

<td>a list of tuples</td>

</tr>

<tr class="row-even"><td>undef_macros</td>

<td>list of macros to undefine

explicitly</td>

<td>a list of strings</td>

</tr>

<tr class="row-odd"><td>library_dirs</td>

<td>list of directories to search

for C/C++ libraries at link

time</td>

<td>a list of strings</td>

</tr>

<tr class="row-even"><td>libraries</td>

<td>list of library names (not

filenames or paths) to link

against</td>

<td>a list of strings</td>

</tr>

<tr class="row-odd"><td>runtime_library_dirs</td>

<td>list of directories to search

for C/C++ libraries at run

time (for shared extensions,

this is when the extension is

loaded)</td>

<td>a list of strings</td>

</tr>

<tr class="row-even"><td>extra_objects</td>

<td>list of extra files to link

with (eg. object files not

implied by 『sources』, static

library that must be

explicitly specified, binary

resource files, etc.)</td>

<td>a list of strings</td>

</tr>

<tr class="row-odd"><td>extra_compile_args</td>

<td>any extra platform- and

compiler-specific information

to use when compiling the

source files in 『sources』. For

platforms and compilers where

a command line makes sense,

this is typically a list of

command-line arguments, but

for other platforms it could

be anything.</td>

<td>a list of strings</td>

</tr>

<tr class="row-even"><td>extra_link_args</td>

<td>any extra platform- and

compiler-specific information

to use when linking object

files together to create the

extension (or to create a new

static Python interpreter).

Similar interpretation as for

『extra_compile_args』.</td>

<td>a list of strings</td>

</tr>

<tr class="row-odd"><td>export_symbols</td>

<td>list of symbols to be exported

from a shared extension. Not

used on all platforms, and not

generally necessary for Python

extensions, which typically

export exactly one symbol:

<code class="docutils literal notranslate">init</code> + extension_name.</td>

<td>a list of strings</td>

</tr>

<tr class="row-even"><td>depends</td>

<td>list of files that the

extension depends on</td>

<td>a list of strings</td>

</tr>

<tr class="row-odd"><td>language</td>

<td>extension language (i.e.

<code class="docutils literal notranslate">'c'</code>, <code class="docutils literal notranslate">'c++'</code>,

<code class="docutils literal notranslate">'objc'</code>). Will be detected

from the source extensions if

not provided.</td>

<td>a string</td>

</tr>

<tr class="row-even"><td>optional</td>

<td>specifies that a build failure

in the extension should not

abort the build process, but

simply skip the extension.</td>

<td>a boolean</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">distutils.core.</code><code class="descname">Distribution</code><a class="headerlink" href="#distutils.core.Distribution" title="本定義的永久連結">¶</a></dt>

<dd>A <a class="reference internal" href="#distutils.core.Distribution" title="distutils.core.Distribution"><code class="xref py py-class docutils literal notranslate">Distribution</code></a> describes how to build, install and package up a Python

software package.

See the <a class="reference internal" href="#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate">setup()</code></a> function for a list of keyword arguments accepted by the

Distribution constructor. <a class="reference internal" href="#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate">setup()</code></a> creates a Distribution instance.

3.7 版更變: <a class="reference internal" href="#distutils.core.Distribution" title="distutils.core.Distribution"><code class="xref py py-class docutils literal notranslate">Distribution</code></a> now warns if <code class="docutils literal notranslate">classifiers</code>,

<code class="docutils literal notranslate">keywords</code> and <code class="docutils literal notranslate">platforms</code> fields are not specified as a list or

a string.

</div>

</dd></dl>

class <code class="descclassname">distutils.core.</code><code class="descname">Command</code><a class="headerlink" href="#distutils.core.Command" title="本定義的永久連結">¶</a></dt>

<dd>A <a class="reference internal" href="#distutils.core.Command" title="distutils.core.Command"><code class="xref py py-class docutils literal notranslate">Command</code></a> class (or rather, an instance of one of its subclasses)

implement a single distutils command.

</dd></dl>

</div>

<h2>10.2. <a class="reference internal" href="#module-distutils.ccompiler" title="distutils.ccompiler: Abstract CCompiler class"><code class="xref py py-mod docutils literal notranslate">distutils.ccompiler</code></a> — CCompiler base class<a class="headerlink" href="#module-distutils.ccompiler" title="本標題的永久連結">¶</a></h2>

This module provides the abstract base class for the <a class="reference internal" href="#distutils.ccompiler.CCompiler" title="distutils.ccompiler.CCompiler"><code class="xref py py-class docutils literal notranslate">CCompiler</code></a>

classes. A <a class="reference internal" href="#distutils.ccompiler.CCompiler" title="distutils.ccompiler.CCompiler"><code class="xref py py-class docutils literal notranslate">CCompiler</code></a> instance can be used for all the compile and

link steps needed to build a single project. Methods are provided to set

options for the compiler — macro definitions, include directories, link path,

libraries and the like.

This module provides the following functions.

<code class="descclassname">distutils.ccompiler.</code><code class="descname">gen_lib_options</code>(compiler, library_dirs, runtime_library_dirs, libraries)<a class="headerlink" href="#distutils.ccompiler.gen_lib_options" title="本定義的永久連結">¶</a></dt>

<dd>Generate linker options for searching library directories and linking with

specific libraries. libraries and library_dirs are, respectively, lists of

library names (not filenames!) and search directories. Returns a list of

command-line options suitable for use with some compiler (depending on the two

format strings passed in).

</dd></dl>

<code class="descclassname">distutils.ccompiler.</code><code class="descname">gen_preprocess_options</code>(macros, include_dirs)<a class="headerlink" href="#distutils.ccompiler.gen_preprocess_options" title="本定義的永久連結">¶</a></dt>

<dd>Generate C pre-processor options (<code class="xref std std-option docutils literal notranslate">-D</code>, <code class="xref std std-option docutils literal notranslate">-U</code>, <code class="xref std std-option docutils literal notranslate">-I</code>) as

used by at least two types of compilers: the typical Unix compiler and Visual

C++. macros is the usual thing, a list of 1- or 2-tuples, where <code class="docutils literal notranslate">(name,)</code>

means undefine (<code class="xref std std-option docutils literal notranslate">-U</code>) macro name, and <code class="docutils literal notranslate">(name, value)</code> means define

(<code class="xref std std-option docutils literal notranslate">-D</code>) macro name to value. include_dirs is just a list of

directory names to be added to the header file search path (<code class="xref std std-option docutils literal notranslate">-I</code>).

Returns a list of command-line options suitable for either Unix compilers or

Visual C++.

</dd></dl>

<code class="descclassname">distutils.ccompiler.</code><code class="descname">get_default_compiler</code>(osname, platform)<a class="headerlink" href="#distutils.ccompiler.get_default_compiler" title="本定義的永久連結">¶</a></dt>

<dd>Determine the default compiler to use for the given platform.

osname should be one of the standard Python OS names (i.e. the ones returned

by <code class="docutils literal notranslate">os.name</code>) and platform the common value returned by <code class="docutils literal notranslate">sys.platform</code> for

the platform in question.

The default values are <code class="docutils literal notranslate">os.name</code> and <code class="docutils literal notranslate">sys.platform</code> in case the parameters

are not given.

</dd></dl>

<code class="descclassname">distutils.ccompiler.</code><code class="descname">new_compiler</code>(plat=None, compiler=None, verbose=0, dry_run=0, force=0)<a class="headerlink" href="#distutils.ccompiler.new_compiler" title="本定義的永久連結">¶</a></dt>

<dd>Factory function to generate an instance of some CCompiler subclass for the

supplied platform/compiler combination. plat defaults to <code class="docutils literal notranslate">os.name</code> (eg.

<code class="docutils literal notranslate">'posix'</code>, <code class="docutils literal notranslate">'nt'</code>), and compiler defaults to the default compiler for

that platform. Currently only <code class="docutils literal notranslate">'posix'</code> and <code class="docutils literal notranslate">'nt'</code> are supported, and the

default compilers are 「traditional Unix interface」 (<code class="xref py py-class docutils literal notranslate">UnixCCompiler</code>

class) and Visual C++ (<code class="xref py py-class docutils literal notranslate">MSVCCompiler</code> class). Note that it’s perfectly

possible to ask for a Unix compiler object under Windows, and a Microsoft

compiler object under Unix—if you supply a value for compiler, plat is

ignored.

</dd></dl>

<code class="descclassname">distutils.ccompiler.</code><code class="descname">show_compilers</code>()<a class="headerlink" href="#distutils.ccompiler.show_compilers" title="本定義的永久連結">¶</a></dt>

<dd>Print list of available compilers (used by the <code class="xref std std-option docutils literal notranslate">--help-compiler</code> options

to build, build_ext, build_clib).

</dd></dl>

class <code class="descclassname">distutils.ccompiler.</code><code class="descname">CCompiler</code>([verbose=0, dry_run=0, force=0])<a class="headerlink" href="#distutils.ccompiler.CCompiler" title="本定義的永久連結">¶</a></dt>

<dd>The abstract base class <a class="reference internal" href="#distutils.ccompiler.CCompiler" title="distutils.ccompiler.CCompiler"><code class="xref py py-class docutils literal notranslate">CCompiler</code></a> defines the interface that must be

implemented by real compiler classes. The class also has some utility methods

used by several compiler classes.

The basic idea behind a compiler abstraction class is that each instance can be

used for all the compile/link steps in building a single project. Thus,

attributes common to all of those compile and link steps — include

directories, macros to define, libraries to link against, etc. — are

attributes of the compiler instance. To allow for variability in how individual

files are treated, most of those attributes may be varied on a per-compilation

or per-link basis.

The constructor for each subclass creates an instance of the Compiler object.

Flags are verbose (show verbose output), dry_run (don’t actually execute the

steps) and force (rebuild everything, regardless of dependencies). All of

these flags default to <code class="docutils literal notranslate">0</code> (off). Note that you probably don’t want to

instantiate <a class="reference internal" href="#distutils.ccompiler.CCompiler" title="distutils.ccompiler.CCompiler"><code class="xref py py-class docutils literal notranslate">CCompiler</code></a> or one of its subclasses directly - use the

<code class="xref py py-func docutils literal notranslate">distutils.CCompiler.new_compiler()</code> factory function instead.

The following methods allow you to manually alter compiler options for the

instance of the Compiler class.

<code class="descname">add_include_dir</code>(dir)<a class="headerlink" href="#distutils.ccompiler.CCompiler.add_include_dir" title="本定義的永久連結">¶</a></dt>

<dd>Add dir to the list of directories that will be searched for header files.

The compiler is instructed to search directories in the order in which they are

supplied by successive calls to <a class="reference internal" href="#distutils.ccompiler.CCompiler.add_include_dir" title="distutils.ccompiler.CCompiler.add_include_dir"><code class="xref py py-meth docutils literal notranslate">add_include_dir()</code></a>.

</dd></dl>

<code class="descname">set_include_dirs</code>(dirs)<a class="headerlink" href="#distutils.ccompiler.CCompiler.set_include_dirs" title="本定義的永久連結">¶</a></dt>

<dd>Set the list of directories that will be searched to dirs (a list of strings).

Overrides any preceding calls to <a class="reference internal" href="#distutils.ccompiler.CCompiler.add_include_dir" title="distutils.ccompiler.CCompiler.add_include_dir"><code class="xref py py-meth docutils literal notranslate">add_include_dir()</code></a>; subsequent calls to

<a class="reference internal" href="#distutils.ccompiler.CCompiler.add_include_dir" title="distutils.ccompiler.CCompiler.add_include_dir"><code class="xref py py-meth docutils literal notranslate">add_include_dir()</code></a> add to the list passed to <a class="reference internal" href="#distutils.ccompiler.CCompiler.set_include_dirs" title="distutils.ccompiler.CCompiler.set_include_dirs"><code class="xref py py-meth docutils literal notranslate">set_include_dirs()</code></a>.

This does not affect any list of standard include directories that the compiler

may search by default.

</dd></dl>

<code class="descname">add_library</code>(libname)<a class="headerlink" href="#distutils.ccompiler.CCompiler.add_library" title="本定義的永久連結">¶</a></dt>

<dd>Add libname to the list of libraries that will be included in all links driven

by this compiler object. Note that libname should *not* be the name of a

file containing a library, but the name of the library itself: the actual

filename will be inferred by the linker, the compiler, or the compiler class

(depending on the platform).

The linker will be instructed to link against libraries in the order they were

supplied to <a class="reference internal" href="#distutils.ccompiler.CCompiler.add_library" title="distutils.ccompiler.CCompiler.add_library"><code class="xref py py-meth docutils literal notranslate">add_library()</code></a> and/or <a class="reference internal" href="#distutils.ccompiler.CCompiler.set_libraries" title="distutils.ccompiler.CCompiler.set_libraries"><code class="xref py py-meth docutils literal notranslate">set_libraries()</code></a>. It is perfectly

valid to duplicate library names; the linker will be instructed to link against

libraries as many times as they are mentioned.

</dd></dl>

<code class="descname">set_libraries</code>(libnames)<a class="headerlink" href="#distutils.ccompiler.CCompiler.set_libraries" title="本定義的永久連結">¶</a></dt>

<dd>Set the list of libraries to be included in all links driven by this compiler

object to libnames (a list of strings). This does not affect any standard

system libraries that the linker may include by default.

</dd></dl>

<code class="descname">add_library_dir</code>(dir)<a class="headerlink" href="#distutils.ccompiler.CCompiler.add_library_dir" title="本定義的永久連結">¶</a></dt>

<dd>Add dir to the list of directories that will be searched for libraries

specified to <a class="reference internal" href="#distutils.ccompiler.CCompiler.add_library" title="distutils.ccompiler.CCompiler.add_library"><code class="xref py py-meth docutils literal notranslate">add_library()</code></a> and <a class="reference internal" href="#distutils.ccompiler.CCompiler.set_libraries" title="distutils.ccompiler.CCompiler.set_libraries"><code class="xref py py-meth docutils literal notranslate">set_libraries()</code></a>. The linker will be

instructed to search for libraries in the order they are supplied to

<a class="reference internal" href="#distutils.ccompiler.CCompiler.add_library_dir" title="distutils.ccompiler.CCompiler.add_library_dir"><code class="xref py py-meth docutils literal notranslate">add_library_dir()</code></a> and/or <a class="reference internal" href="#distutils.ccompiler.CCompiler.set_library_dirs" title="distutils.ccompiler.CCompiler.set_library_dirs"><code class="xref py py-meth docutils literal notranslate">set_library_dirs()</code></a>.

</dd></dl>

<code class="descname">set_library_dirs</code>(dirs)<a class="headerlink" href="#distutils.ccompiler.CCompiler.set_library_dirs" title="本定義的永久連結">¶</a></dt>

<dd>Set the list of library search directories to dirs (a list of strings). This

does not affect any standard library search path that the linker may search by

default.

</dd></dl>

<code class="descname">add_runtime_library_dir</code>(dir)<a class="headerlink" href="#distutils.ccompiler.CCompiler.add_runtime_library_dir" title="本定義的永久連結">¶</a></dt>

<dd>Add dir to the list of directories that will be searched for shared libraries

at runtime.

</dd></dl>

<code class="descname">set_runtime_library_dirs</code>(dirs)<a class="headerlink" href="#distutils.ccompiler.CCompiler.set_runtime_library_dirs" title="本定義的永久連結">¶</a></dt>

<dd>Set the list of directories to search for shared libraries at runtime to dirs

(a list of strings). This does not affect any standard search path that the

runtime linker may search by default.

</dd></dl>

<code class="descname">define_macro</code>(name[, value=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.define_macro" title="本定義的永久連結">¶</a></dt>

<dd>Define a preprocessor macro for all compilations driven by this compiler object.

The optional parameter value should be a string; if it is not supplied, then

the macro will be defined without an explicit value and the exact outcome

depends on the compiler used.

</dd></dl>

<code class="descname">undefine_macro</code>(name)<a class="headerlink" href="#distutils.ccompiler.CCompiler.undefine_macro" title="本定義的永久連結">¶</a></dt>

<dd>Undefine a preprocessor macro for all compilations driven by this compiler

object. If the same macro is defined by <a class="reference internal" href="#distutils.ccompiler.CCompiler.define_macro" title="distutils.ccompiler.CCompiler.define_macro"><code class="xref py py-meth docutils literal notranslate">define_macro()</code></a> and

undefined by <a class="reference internal" href="#distutils.ccompiler.CCompiler.undefine_macro" title="distutils.ccompiler.CCompiler.undefine_macro"><code class="xref py py-meth docutils literal notranslate">undefine_macro()</code></a> the last call takes precedence

(including multiple redefinitions or undefinitions). If the macro is

redefined/undefined on a per-compilation basis (ie. in the call to

<a class="reference internal" href="../library/functions.html#compile" title="compile"><code class="xref py py-meth docutils literal notranslate">compile()</code></a>), then that takes precedence.

</dd></dl>

<code class="descname">add_link_object</code>(object)<a class="headerlink" href="#distutils.ccompiler.CCompiler.add_link_object" title="本定義的永久連結">¶</a></dt>

<dd>Add object to the list of object files (or analogues, such as explicitly named

library files or the output of 「resource compilers」) to be included in every

link driven by this compiler object.

</dd></dl>

<code class="descname">set_link_objects</code>(objects)<a class="headerlink" href="#distutils.ccompiler.CCompiler.set_link_objects" title="本定義的永久連結">¶</a></dt>

<dd>Set the list of object files (or analogues) to be included in every link to

objects. This does not affect any standard object files that the linker may

include by default (such as system libraries).

</dd></dl>

The following methods implement methods for autodetection of compiler options,

providing some functionality similar to GNU autoconf.

<code class="descname">detect_language</code>(sources)<a class="headerlink" href="#distutils.ccompiler.CCompiler.detect_language" title="本定義的永久連結">¶</a></dt>

<dd>Detect the language of a given file, or list of files. Uses the instance

attributes <code class="xref py py-attr docutils literal notranslate">language_map</code> (a dictionary), and <code class="xref py py-attr docutils literal notranslate">language_order</code> (a

list) to do the job.

</dd></dl>

<code class="descname">find_library_file</code>(dirs, lib[, debug=0])<a class="headerlink" href="#distutils.ccompiler.CCompiler.find_library_file" title="本定義的永久連結">¶</a></dt>

<dd>Search the specified list of directories for a static or shared library file

lib and return the full path to that file. If debug is true, look for a

debugging version (if that makes sense on the current platform). Return

<code class="docutils literal notranslate">None</code> if lib wasn’t found in any of the specified directories.

</dd></dl>

<code class="descname">has_function</code>(funcname[, includes=None, include_dirs=None, libraries=None, library_dirs=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.has_function" title="本定義的永久連結">¶</a></dt>

<dd>Return a boolean indicating whether funcname is supported on the current

platform. The optional arguments can be used to augment the compilation

environment by providing additional include files and paths and libraries and

paths.

</dd></dl>

<code class="descname">library_dir_option</code>(dir)<a class="headerlink" href="#distutils.ccompiler.CCompiler.library_dir_option" title="本定義的永久連結">¶</a></dt>

<dd>Return the compiler option to add dir to the list of directories searched for

libraries.

</dd></dl>

<code class="descname">library_option</code>(lib)<a class="headerlink" href="#distutils.ccompiler.CCompiler.library_option" title="本定義的永久連結">¶</a></dt>

<dd>Return the compiler option to add lib to the list of libraries linked into the

shared library or executable.

</dd></dl>

<code class="descname">runtime_library_dir_option</code>(dir)<a class="headerlink" href="#distutils.ccompiler.CCompiler.runtime_library_dir_option" title="本定義的永久連結">¶</a></dt>

<dd>Return the compiler option to add dir to the list of directories searched for

runtime libraries.

</dd></dl>

<code class="descname">set_executables</code>(**args)<a class="headerlink" href="#distutils.ccompiler.CCompiler.set_executables" title="本定義的永久連結">¶</a></dt>

<dd>Define the executables (and options for them) that will be run to perform the

various stages of compilation. The exact set of executables that may be

specified here depends on the compiler class (via the 『executables』 class

attribute), but most will have:

</colgroup>

<tr class="row-odd"><th class="head">attribute</th>

<th class="head">description</th>

</tr>

</thead>

<tr class="row-even"><td>compiler</td>

<td>the C/C++ compiler</td>

</tr>

<tr class="row-odd"><td>linker_so</td>

<td>linker used to create shared objects and

libraries</td>

</tr>

<tr class="row-even"><td>linker_exe</td>

<td>linker used to create binary executables</td>

</tr>

<tr class="row-odd"><td>archiver</td>

<td>static library creator</td>

</tr>

</tbody>

</table>

On platforms with a command-line (Unix, DOS/Windows), each of these is a string

that will be split into executable name and (optional) list of arguments.

(Splitting the string is done similarly to how Unix shells operate: words are

delimited by spaces, but quotes and backslashes can override this. See

<a class="reference internal" href="#distutils.util.split_quoted" title="distutils.util.split_quoted"><code class="xref py py-func docutils literal notranslate">distutils.util.split_quoted()</code></a>.)

</dd></dl>

The following methods invoke stages in the build process.

<code class="descname">compile</code>(sources[, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, depends=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.compile" title="本定義的永久連結">¶</a></dt>

<dd>Compile one or more source files. Generates object files (e.g. transforms a

<code class="file docutils literal notranslate">.c</code> file to a <code class="file docutils literal notranslate">.o</code> file.)

sources must be a list of filenames, most likely C/C++ files, but in reality

anything that can be handled by a particular compiler and compiler class (eg.

<code class="xref py py-class docutils literal notranslate">MSVCCompiler</code> can handle resource files in sources). Return a list of

object filenames, one per source filename in sources. Depending on the

implementation, not all source files will necessarily be compiled, but all

corresponding object filenames will be returned.

If output_dir is given, object files will be put under it, while retaining

their original path component. That is, <code class="file docutils literal notranslate">foo/bar.c</code> normally compiles to

<code class="file docutils literal notranslate">foo/bar.o</code> (for a Unix implementation); if output_dir is build, then

it would compile to <code class="file docutils literal notranslate">build/foo/bar.o</code>.

macros, if given, must be a list of macro definitions. A macro definition is

either a <code class="docutils literal notranslate">(name, value)</code> 2-tuple or a <code class="docutils literal notranslate">(name,)</code> 1-tuple. The former defines

a macro; if the value is <code class="docutils literal notranslate">None</code>, the macro is defined without an explicit

value. The 1-tuple case undefines a macro. Later

definitions/redefinitions/undefinitions take precedence.

include_dirs, if given, must be a list of strings, the directories to add to

the default include file search path for this compilation only.

debug is a boolean; if true, the compiler will be instructed to output debug

symbols in (or alongside) the object file(s).

extra_preargs and extra_postargs are implementation-dependent. On platforms

that have the notion of a command-line (e.g. Unix, DOS/Windows), they are most

likely lists of strings: extra command-line arguments to prepend/append to the

compiler command line. On other platforms, consult the implementation class

documentation. In any event, they are intended as an escape hatch for those

occasions when the abstract compiler framework doesn’t cut the mustard.

depends, if given, is a list of filenames that all targets depend on. If a

source file is older than any file in depends, then the source file will be

recompiled. This supports dependency tracking, but only at a coarse

granularity.

Raises <code class="xref py py-exc docutils literal notranslate">CompileError</code> on failure.

</dd></dl>

<code class="descname">create_static_lib</code>(objects, output_libname[, output_dir=None, debug=0, target_lang=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.create_static_lib" title="本定義的永久連結">¶</a></dt>

<dd>Link a bunch of stuff together to create a static library file. The 「bunch of

stuff」 consists of the list of object files supplied as objects, the extra

object files supplied to <a class="reference internal" href="#distutils.ccompiler.CCompiler.add_link_object" title="distutils.ccompiler.CCompiler.add_link_object"><code class="xref py py-meth docutils literal notranslate">add_link_object()</code></a> and/or

<a class="reference internal" href="#distutils.ccompiler.CCompiler.set_link_objects" title="distutils.ccompiler.CCompiler.set_link_objects"><code class="xref py py-meth docutils literal notranslate">set_link_objects()</code></a>, the libraries supplied to <a class="reference internal" href="#distutils.ccompiler.CCompiler.add_library" title="distutils.ccompiler.CCompiler.add_library"><code class="xref py py-meth docutils literal notranslate">add_library()</code></a> and/or

<a class="reference internal" href="#distutils.ccompiler.CCompiler.set_libraries" title="distutils.ccompiler.CCompiler.set_libraries"><code class="xref py py-meth docutils literal notranslate">set_libraries()</code></a>, and the libraries supplied as libraries (if any).

output_libname should be a library name, not a filename; the filename will be

inferred from the library name. output_dir is the directory where the library

file will be put.

debug is a boolean; if true, debugging information will be included in the

library (note that on most platforms, it is the compile step where this matters:

the debug flag is included here just for consistency).

target_lang is the target language for which the given objects are being

compiled. This allows specific linkage time treatment of certain languages.

Raises <code class="xref py py-exc docutils literal notranslate">LibError</code> on failure.

</dd></dl>

<code class="descname">link</code>(target_desc, objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.link" title="本定義的永久連結">¶</a></dt>

<dd>Link a bunch of stuff together to create an executable or shared library file.

The 「bunch of stuff」 consists of the list of object files supplied as objects.

output_filename should be a filename. If output_dir is supplied,

output_filename is relative to it (i.e. output_filename can provide

directory components if needed).

libraries is a list of libraries to link against. These are library names,

not filenames, since they’re translated into filenames in a platform-specific

way (eg. foo becomes <code class="file docutils literal notranslate">libfoo.a</code> on Unix and <code class="file docutils literal notranslate">foo.lib</code> on

DOS/Windows). However, they can include a directory component, which means the

linker will look in that specific directory rather than searching all the normal

locations.

library_dirs, if supplied, should be a list of directories to search for

libraries that were specified as bare library names (ie. no directory

component). These are on top of the system default and those supplied to

is a list of directories that will be embedded into the shared library and used

to search for other shared libraries that *it* depends on at run-time. (This

may only be relevant on Unix.)

export_symbols is a list of symbols that the shared library will export.

(This appears to be relevant only on Windows.)

debug is as for <a class="reference internal" href="../library/functions.html#compile" title="compile"><code class="xref py py-meth docutils literal notranslate">compile()</code></a> and <a class="reference internal" href="#distutils.ccompiler.CCompiler.create_static_lib" title="distutils.ccompiler.CCompiler.create_static_lib"><code class="xref py py-meth docutils literal notranslate">create_static_lib()</code></a>, with the

slight distinction that it actually matters on most platforms (as opposed to

<a class="reference internal" href="#distutils.ccompiler.CCompiler.create_static_lib" title="distutils.ccompiler.CCompiler.create_static_lib"><code class="xref py py-meth docutils literal notranslate">create_static_lib()</code></a>, which includes a debug flag mostly for form’s

sake).

extra_preargs and extra_postargs are as for <a class="reference internal" href="../library/functions.html#compile" title="compile"><code class="xref py py-meth docutils literal notranslate">compile()</code></a> (except of

course that they supply command-line arguments for the particular linker being

used).

target_lang is the target language for which the given objects are being

compiled. This allows specific linkage time treatment of certain languages.

Raises <code class="xref py py-exc docutils literal notranslate">LinkError</code> on failure.

</dd></dl>

<code class="descname">link_executable</code>(objects, output_progname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, target_lang=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.link_executable" title="本定義的永久連結">¶</a></dt>

<dd>Link an executable. output_progname is the name of the file executable, while

objects are a list of object filenames to link in. Other arguments are as for

the <a class="reference internal" href="#distutils.ccompiler.CCompiler.link" title="distutils.ccompiler.CCompiler.link"><code class="xref py py-meth docutils literal notranslate">link()</code></a> method.

</dd></dl>

<code class="descname">link_shared_lib</code>(objects, output_libname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.link_shared_lib" title="本定義的永久連結">¶</a></dt>

<dd>Link a shared library. output_libname is the name of the output library,

while objects is a list of object filenames to link in. Other arguments are

as for the <a class="reference internal" href="#distutils.ccompiler.CCompiler.link" title="distutils.ccompiler.CCompiler.link"><code class="xref py py-meth docutils literal notranslate">link()</code></a> method.

</dd></dl>

<code class="descname">link_shared_object</code>(objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.link_shared_object" title="本定義的永久連結">¶</a></dt>

<dd>Link a shared object. output_filename is the name of the shared object that

will be created, while objects is a list of object filenames to link in.

Other arguments are as for the <a class="reference internal" href="#distutils.ccompiler.CCompiler.link" title="distutils.ccompiler.CCompiler.link"><code class="xref py py-meth docutils literal notranslate">link()</code></a> method.

</dd></dl>

<code class="descname">preprocess</code>(source[, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None])<a class="headerlink" href="#distutils.ccompiler.CCompiler.preprocess" title="本定義的永久連結">¶</a></dt>

<dd>Preprocess a single C/C++ source file, named in source. Output will be written

to file named output_file, or stdout if output_file not supplied.

macros is a list of macro definitions as for <a class="reference internal" href="../library/functions.html#compile" title="compile"><code class="xref py py-meth docutils literal notranslate">compile()</code></a>, which will

augment the macros set with <a class="reference internal" href="#distutils.ccompiler.CCompiler.define_macro" title="distutils.ccompiler.CCompiler.define_macro"><code class="xref py py-meth docutils literal notranslate">define_macro()</code></a> and <a class="reference internal" href="#distutils.ccompiler.CCompiler.undefine_macro" title="distutils.ccompiler.CCompiler.undefine_macro"><code class="xref py py-meth docutils literal notranslate">undefine_macro()</code></a>.

include_dirs is a list of directory names that will be added to the default

list, in the same way as <a class="reference internal" href="#distutils.ccompiler.CCompiler.add_include_dir" title="distutils.ccompiler.CCompiler.add_include_dir"><code class="xref py py-meth docutils literal notranslate">add_include_dir()</code></a>.

Raises <code class="xref py py-exc docutils literal notranslate">PreprocessError</code> on failure.

</dd></dl>

The following utility methods are defined by the <a class="reference internal" href="#distutils.ccompiler.CCompiler" title="distutils.ccompiler.CCompiler"><code class="xref py py-class docutils literal notranslate">CCompiler</code></a> class, for

use by the various concrete subclasses.

<code class="descname">executable_filename</code>(basename[, strip_dir=0, output_dir=''])<a class="headerlink" href="#distutils.ccompiler.CCompiler.executable_filename" title="本定義的永久連結">¶</a></dt>

<dd>Returns the filename of the executable for the given basename. Typically for

non-Windows platforms this is the same as the basename, while Windows will get

a <code class="file docutils literal notranslate">.exe</code> added.

</dd></dl>

<code class="descname">library_filename</code>(libname[, lib_type='static', strip_dir=0, output_dir=''])<a class="headerlink" href="#distutils.ccompiler.CCompiler.library_filename" title="本定義的永久連結">¶</a></dt>

<dd>Returns the filename for the given library name on the current platform. On Unix

a library with lib_type of <code class="docutils literal notranslate">'static'</code> will typically be of the form

<code class="file docutils literal notranslate">liblibname.a</code>, while a lib_type of <code class="docutils literal notranslate">'dynamic'</code> will be of the form

<code class="file docutils literal notranslate">liblibname.so</code>.

</dd></dl>

<code class="descname">object_filenames</code>(source_filenames[, strip_dir=0, output_dir=''])<a class="headerlink" href="#distutils.ccompiler.CCompiler.object_filenames" title="本定義的永久連結">¶</a></dt>

<dd>Returns the name of the object files for the given source files.

source_filenames should be a list of filenames.

</dd></dl>

<code class="descname">shared_object_filename</code>(basename[, strip_dir=0, output_dir=''])<a class="headerlink" href="#distutils.ccompiler.CCompiler.shared_object_filename" title="本定義的永久連結">¶</a></dt>

<dd>Returns the name of a shared object file for the given file name basename.

</dd></dl>

<code class="descname">execute</code>(func, args[, msg=None, level=1])<a class="headerlink" href="#distutils.ccompiler.CCompiler.execute" title="本定義的永久連結">¶</a></dt>

<dd>Invokes <a class="reference internal" href="#distutils.util.execute" title="distutils.util.execute"><code class="xref py py-func docutils literal notranslate">distutils.util.execute()</code></a>. This method invokes a Python function

func with the given arguments args, after logging and taking into account

the dry_run flag.

</dd></dl>

<code class="descname">spawn</code>(cmd)<a class="headerlink" href="#distutils.ccompiler.CCompiler.spawn" title="本定義的永久連結">¶</a></dt>

<dd>Invokes <code class="xref py py-func docutils literal notranslate">distutils.util.spawn()</code>. This invokes an external process to run

the given command.

</dd></dl>

<code class="descname">mkpath</code>(name[, mode=511])<a class="headerlink" href="#distutils.ccompiler.CCompiler.mkpath" title="本定義的永久連結">¶</a></dt>

<dd>Invokes <a class="reference internal" href="#distutils.dir_util.mkpath" title="distutils.dir_util.mkpath"><code class="xref py py-func docutils literal notranslate">distutils.dir_util.mkpath()</code></a>. This creates a directory and any

missing ancestor directories.

</dd></dl>

<dd>Invokes <a class="reference internal" href="#distutils.file_util.move_file" title="distutils.file_util.move_file"><code class="xref py py-meth docutils literal notranslate">distutils.file_util.move_file()</code></a>. Renames src to dst.

</dd></dl>

<code class="descname">announce</code>(msg[, level=1])<a class="headerlink" href="#distutils.ccompiler.CCompiler.announce" title="本定義的永久連結">¶</a></dt>

<dd>Write a message using <code class="xref py py-func docutils literal notranslate">distutils.log.debug()</code>.

</dd></dl>

<dd>Write a warning message msg to standard error.

</dd></dl>

<code class="descname">debug_print</code>(msg)<a class="headerlink" href="#distutils.ccompiler.CCompiler.debug_print" title="本定義的永久連結">¶</a></dt>

<dd>If the debug flag is set on this <a class="reference internal" href="#distutils.ccompiler.CCompiler" title="distutils.ccompiler.CCompiler"><code class="xref py py-class docutils literal notranslate">CCompiler</code></a> instance, print msg to

standard output, otherwise do nothing.

</dd></dl>

</div>

<h2>10.3. <a class="reference internal" href="#module-distutils.unixccompiler" title="distutils.unixccompiler: UNIX C Compiler"><code class="xref py py-mod docutils literal notranslate">distutils.unixccompiler</code></a> — Unix C Compiler<a class="headerlink" href="#module-distutils.unixccompiler" title="本標題的永久連結">¶</a></h2>

This module provides the <code class="xref py py-class docutils literal notranslate">UnixCCompiler</code> class, a subclass of

<code class="xref py py-class docutils literal notranslate">CCompiler</code> that handles the typical Unix-style command-line C compiler:

<li>macros defined with <code class="xref std std-option docutils literal notranslate">-Dname[=value]</code></li>

<li>macros undefined with <code class="xref std std-option docutils literal notranslate">-Uname</code></li>

<li>include search directories specified with <code class="xref std std-option docutils literal notranslate">-Idir</code></li>

<li>libraries specified with <code class="xref std std-option docutils literal notranslate">-llib</code></li>

<li>library search directories specified with <code class="xref std std-option docutils literal notranslate">-Ldir</code></li>

<li>compile handled by cc (or similar) executable with <code class="xref std std-option docutils literal notranslate">-c</code>

option: compiles <code class="file docutils literal notranslate">.c</code> to <code class="file docutils literal notranslate">.o</code></li>

<li>link static library handled by ar command (possibly with

ranlib)</li>

<li>link shared library handled by cc <code class="xref std std-option docutils literal notranslate">-shared</code></li>

</ul>

</div>

<h2>10.4. <a class="reference internal" href="#module-distutils.msvccompiler" title="distutils.msvccompiler: Microsoft Compiler"><code class="xref py py-mod docutils literal notranslate">distutils.msvccompiler</code></a> — Microsoft Compiler<a class="headerlink" href="#module-distutils.msvccompiler" title="本標題的永久連結">¶</a></h2>

This module provides <code class="xref py py-class docutils literal notranslate">MSVCCompiler</code>, an implementation of the abstract

<code class="xref py py-class docutils literal notranslate">CCompiler</code> class for Microsoft Visual Studio. Typically, extension

modules need to be compiled with the same compiler that was used to compile

Python. For Python 2.3 and earlier, the compiler was Visual Studio 6. For Python

2.4 and 2.5, the compiler is Visual Studio .NET 2003.

<code class="xref py py-class docutils literal notranslate">MSVCCompiler</code> will normally choose the right compiler, linker etc. on

its own. To override this choice, the environment variables DISTUTILS_USE_SDK

and MSSdk must be both set. MSSdk indicates that the current environment has

been setup by the SDK’s <code class="docutils literal notranslate">SetEnv.Cmd</code> script, or that the environment variables

had been registered when the SDK was installed; DISTUTILS_USE_SDK indicates

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

apiref.html

Latest commit

History

apiref.html

File metadata and controls