matplotlib.github.com/3.5.2/devel/contributing.html at main · matplotlib/matplotlib.github.com

History

1106 lines (1034 loc) · 68.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

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>Contributing — Matplotlib 3.5.2 documentation</title>

href="../_static/vendor/fontawesome/5.13.0/css/all.min.css">

href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">

href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">

title="Search within Matplotlib 3.5.2 documentation"

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

</head>

</a>

</div>

</button>

<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>

</li>

<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>

</li>

<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>

</li>

<a class="reference internal nav-link" href="../api/index.html">Reference</a>

</li>

<a class="reference internal nav-link" href="../users/index.html">User guide</a>

</li>

<a class="reference internal nav-link" href="index.html">Develop</a>

</li>

<a class="reference internal nav-link" href="../users/release_notes.html">Release notes</a>

</li>

</ul>

</div>

<label class="sr-only">gitter</label>

</a>

</li>

<label class="sr-only">discourse</label>

</a>

</li>

<label class="sr-only">GitHub</label>

</a>

</li>

<label class="sr-only">twitter</label>

</a>

</li>

</ul>

</div>

</nav>

</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">

Contributing

</a>

</li>

Bug triaging and issue curation

</a>

</li>

Setting up Matplotlib for development

</a>

</li>

Testing

</a>

</li>

Writing documentation

</a>

</li>

Documentation style guide

</a>

</li>

Working with

Matplotlib

source code

</a>

</label>

<ul>

Introduction

</a>

</li>

Install git

</a>

</li>

Following the latest source

</a>

</li>

Making a patch

</a>

</li>

Git for development

</a>

</label>

<ul>

Making your own copy (fork) of Matplotlib

</a>

</li>

Set up your fork

</a>

</li>

Configure git

</a>

</li>

Development workflow

</a>

</li>

Maintainer workflow

</a>

</li>

</ul>

</li>

git resources

</a>

</li>

Two and three dots in difference specs

</a>

</li>

</ul>

</li>

Pull request guidelines

</a>

</li>

Release guide

</a>

</li>

Dependencies

</a>

</li>

Minimum version of dependencies policy

</a>

</li>

Matplotlib Enhancement Proposals

</a>

</label>

<ul>

MEP Template

</a>

</li>

MEP8: PEP8

</a>

</li>

MEP9: Global interaction manager

</a>

</li>

MEP10: Docstring consistency

</a>

</li>

MEP11: Third-party dependencies

</a>

</li>

MEP12: Improve Gallery and Examples

</a>

</li>

MEP13: Use properties for Artists

</a>

</li>

MEP14: Text handling

</a>

</li>

MEP15: Fix axis autoscaling when limits are specified for one axis only

</a>

</li>

MEP19: Continuous Integration

</a>

</li>

MEP21: color and cm refactor

</a>

</li>

MEP22: Toolbar rewrite

</a>

</li>

MEP23: Multiple Figures per GUI window

</a>

</li>

MEP24: Negative radius in polar plots

</a>

</li>

MEP25: Serialization

</a>

</li>

MEP26: Artist styling

</a>

</li>

MEP27: Decouple pyplot from backends

</a>

</li>

MEP28: Remove Complexity from Axes.boxplot

</a>

</li>

MEP29: Text light markup

</a>

</li>

</ul>

</li>

</ul>

Licenses

</a>

</li>

Default color changes

</a>

</li>

</ul>

</div>

</nav>

</div>

</div>

On this page

</div>

Contributor incubator

</a>

Issues for new contributors

</a>

</li>

</ul>

</li>

Submitting a bug report

</a>

</li>

Requesting a new feature

</a>

</li>

Contributing code

</a>

How to contribute

</a>

</li>

Contributing pull requests

</a>

</li>

</ul>

</li>

Contributing documentation

</a>

</li>

Other ways to contribute

</a>

</li>

Coding guidelines

</a>

API changes

</a>

Rules

</a>

</li>

Introducing

</a>

</li>

Expiring

</a>

</li>

</ul>

</li>

Adding new API

</a>

</li>

New modules and files: installation

</a>

</li>

C/C++ extensions

</a>

</li>

Keyword argument processing

</a>

</li>

Using logging for debug messages

</a>

Which logging level to use?

</a>

</li>

</ul>

</li>

Writing examples

</a>

</li>

</ul>

</li>

</ul>

</nav>

</div>

</div>

<div>

<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">#</a></h1>

This project is a community effort, and everyone is welcome to

contribute. Everyone within the community

is expected to abide by our

<a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.

The project is hosted on

<a class="reference external" href="https://github.com/matplotlib/matplotlib">https://github.com/matplotlib/matplotlib</a>

<h2>Contributor incubator<a class="headerlink" href="#contributor-incubator" title="Permalink to this headline">#</a></h2>

If you are interested in becoming a regular contributor to Matplotlib, but

don't know where to start or feel insecure about it, you can join our non-public

communication channel for new contributors. To do so, please go to <a class="reference external" href="https://gitter.im/matplotlib/matplotlib">gitter</a> and ask to be added to '#incubator'.

This is a private gitter room moderated by core Matplotlib developers where you can

get guidance and support for your first few PRs. This is a place you can ask questions

about anything: how to use git, github, how our PR review process works, technical questions

about the code, what makes for good documentation or a blog post, how to get involved involved

in community work, or get "pre-review" on your PR.

<h3>Issues for new contributors<a class="headerlink" href="#issues-for-new-contributors" title="Permalink to this headline">#</a></h3>

While any contributions are welcome, we have marked some issues as

particularly suited for new contributors by the label

<a class="reference external" href="https://github.com/matplotlib/matplotlib/labels/good%20first%20issue">good first issue</a>

These are well documented issues, that do not require a deep understanding of

the internals of Matplotlib. The issues may additionally be tagged with a

difficulty. <code class="docutils literal notranslate">Difficulty: Easy</code> is suited for people with little Python experience.

<code class="docutils literal notranslate">Difficulty: Medium</code> and <code class="docutils literal notranslate">Difficulty: Hard</code> are not trivial to solve and

require more thought and programming experience.

</section>

<h2>Submitting a bug report<a class="headerlink" href="#submitting-a-bug-report" title="Permalink to this headline">#</a></h2>

If you find a bug in the code or documentation, do not hesitate to submit a

ticket to the

<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues">Issue Tracker</a>. You are

also welcome to post feature requests or pull requests.

If you are reporting a bug, please do your best to include the following:

<li>A short, top-level summary of the bug. In most cases, this should be 1-2

sentences.</li>

<li>A short, self-contained code snippet to reproduce the bug, ideally allowing

a simple copy and paste to reproduce. Please do your best to reduce the code

snippet to the minimum required.</li>

<li>The actual outcome of the code snippet.</li>

<li>The expected outcome of the code snippet.</li>

<li>The Matplotlib version, Python version and platform that you are using. You

can grab the version with the following commands:

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> import matplotlib

>>> matplotlib.__version__

'3.4.1'

>>> import platform

>>> platform.python_version()

'3.9.2'

</pre></div>

</div>

</li>

</ol>

We have preloaded the issue creation page with a Markdown template that you can

use to organize this information.

Thank you for your help in keeping bug reports complete, targeted and descriptive.

</section>

<h2>Requesting a new feature<a class="headerlink" href="#requesting-a-new-feature" title="Permalink to this headline">#</a></h2>

Please post feature requests to the

<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues">Issue Tracker</a>.

The Matplotlib developers will give feedback on the feature proposal. Since

Matplotlib is an open source project with limited resources, we encourage

users to then also

<a class="reference internal" href="#contributing-code">participate in the implementation</a>.

</section>

<h2>Contributing code<a class="headerlink" href="#contributing-code" title="Permalink to this headline">#</a></h2>

<h3>How to contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this headline">#</a></h3>

The preferred way to contribute to Matplotlib is to fork the <a class="reference external" href="https://github.com/matplotlib/matplotlib/">main

repository</a> on GitHub,

then submit a "pull request" (PR).

A brief overview is:

<li><a class="reference external" href="https://github.com/join">Create an account</a> on GitHub if you do not

already have one.</li>

<li>Fork the <a class="reference external" href="https://github.com/matplotlib/matplotlib">project repository</a>:

click on the 'Fork' button near the top of the page. This creates a copy of

the code under your account on the GitHub server.</li>

<li>Clone this copy to your local disk:

<div class="highlight-default notranslate"><div class="highlight"><pre>git clone https://github.com/<YOUR GITHUB USERNAME>/matplotlib.git

</pre></div>

</div>

</li>

<li>Enter the directory and install the local version of Matplotlib.

See <a class="reference internal" href="development_setup.html#installing-for-devs">Setting up Matplotlib for development</a> for instructions</li>

<li>Create a branch to hold your changes:

<div class="highlight-default notranslate"><div class="highlight"><pre>git checkout -b my-feature origin/master

</pre></div>

</div>

and start making changes. Never work in the <code class="docutils literal notranslate">master</code> branch!

</li>

<li>Work on this copy, on your computer, using Git to do the version control.

When you're done editing e.g., <code class="docutils literal notranslate">lib/matplotlib/collections.py</code>, do:

<div class="highlight-default notranslate"><div class="highlight"><pre>git add lib/matplotlib/collections.py

git commit

</pre></div>

</div>

to record your changes in Git, then push them to GitHub with:

<div class="highlight-default notranslate"><div class="highlight"><pre>git push -u origin my-feature

</pre></div>

</div>

</li>

</ol>

Finally, go to the web page of your fork of the Matplotlib repo, and click

'Pull request' to send your changes to the maintainers for review.

See also

<li><a class="reference external" href="https://git-scm.com/doc">Git documentation</a></li>

<li><a class="reference external" href="https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project">Git-Contributing to a Project</a></li>

<li><a class="reference external" href="https://lab.github.com/githubtraining/introduction-to-github">Introduction to GitHub</a></li>

<li><a class="reference internal" href="gitwash/development_workflow.html#development-workflow">Development workflow</a> for best practices for Matplotlib</li>

<li><a class="reference internal" href="gitwash/index.html#using-git">Working with Matplotlib source code</a></li>

</ul>

</div>

</section>

<h3>Contributing pull requests<a class="headerlink" href="#contributing-pull-requests" title="Permalink to this headline">#</a></h3>

It is recommended to check that your contribution complies with the following

rules before submitting a pull request:

<ul>

<li>If your pull request addresses an issue, please use the title to describe the

issue and mention the issue number in the pull request description to ensure

that a link is created to the original issue.</li>

<li>All public methods should have informative docstrings with sample usage when

appropriate. Use the <a class="reference external" href="https://numpydoc.readthedocs.io/en/latest/format.html">numpy docstring standard</a>.</li>

<li>Formatting should follow the recommendations of <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP8</a>, as enforced by

<a class="reference external" href="https://flake8.pycqa.org/">flake8</a>. You can check flake8 compliance from the command line with

<div class="highlight-default notranslate"><div class="highlight"><pre>python -m pip install flake8

flake8 /path/to/module.py

</pre></div>

</div>

or your editor may provide integration with it. Note that Matplotlib

intentionally does not use the <a class="reference external" href="https://black.readthedocs.io/">black</a> auto-formatter (<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/18796">1</a>), in particular due

to its unability to understand the semantics of mathematical expressions

(<a class="reference external" href="https://github.com/psf/black/issues/148">2</a>, <a class="reference external" href="https://github.com/psf/black/issues/1984">3</a>).

</li>

<li>Each high-level plotting function should have a simple example in the

<code class="docutils literal notranslate">Example</code> section of the docstring. This should be as simple as possible

to demonstrate the method. More complex examples should go in the

<code class="docutils literal notranslate">examples</code> tree.</li>

<li>Changes (both new features and bugfixes) should have good test coverage. See

<a class="reference internal" href="testing.html#testing">Testing</a> for more details.</li>

<li>Import the following modules using the standard scipy conventions:

<div class="highlight-default notranslate"><div class="highlight"><pre>import numpy as np

import numpy.ma as ma

import matplotlib as mpl

import matplotlib.pyplot as plt

import matplotlib.cbook as cbook

import matplotlib.patches as mpatches

</pre></div>

</div>

In general, Matplotlib modules should not import <a class="reference internal" href="../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate">rcParams</code></a> using <code class="docutils literal notranslate">from

matplotlib import rcParams</code>, but rather access it as <code class="docutils literal notranslate">mpl.rcParams</code>. This

is because some modules are imported very early, before the <a class="reference internal" href="../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate">rcParams</code></a>

singleton is constructed.

</li>

<li>If your change is a major new feature, add an entry to the <code class="docutils literal notranslate">What's new</code>

section by adding a new file in <code class="docutils literal notranslate">doc/users/next_whats_new</code> (see

<code class="file docutils literal notranslate">doc/users/next_whats_new/README.rst</code> for more information).</li>

<li>If you change the API in a backward-incompatible way, please document it in

<code class="file docutils literal notranslate">doc/api/next_api_changes/behavior</code>, by adding a new file with the

naming convention <code class="docutils literal notranslate">99999-ABC.rst</code> where the pull request number is followed

by the contributor's initials. (see <code class="file docutils literal notranslate">doc/api/api_changes.rst</code> for more

information)</li>

<li>See below for additional points about <a class="reference internal" href="#keyword-argument-processing">Keyword argument processing</a>, if

applicable for your pull request.</li>

</ul>

Note

The current state of the Matplotlib code base is not compliant with all

of those guidelines, but we expect that enforcing those constraints on all

new contributions will move the overall code base quality in the right

direction.

</div>

See also

<li><a class="reference internal" href="#coding-guidelines">Coding guidelines</a></li>

<li><a class="reference internal" href="testing.html#testing">Testing</a></li>

<li><a class="reference internal" href="documenting_mpl.html#documenting-matplotlib">Writing documentation</a></li>

</ul>

</div>

</section>

<h2>Contributing documentation<a class="headerlink" href="#contributing-documentation" title="Permalink to this headline">#</a></h2>

You as an end-user of Matplotlib can make a valuable contribution because you

more clearly see the potential for improvement than a core developer. For example, you can:

<li>Clarify a docstring</li>

<li>Write or update an <a class="reference internal" href="../gallery/index.html#gallery">example plot</a></li>

<li>Write or update a comprehensive <a class="reference internal" href="../tutorials/index.html#tutorials">tutorial</a></li>

</ul>

The documentation source files live in the same GitHub repository as the code.

Contributions are proposed and accepted through the pull request process.

For details see <a class="reference internal" href="#how-to-contribute">How to contribute</a>.

If you have trouble getting started, you may instead open an <a class="reference external" href="https://github.com/matplotlib/matplotlib/issues">issue</a>

describing the intended improvement.

See also

<li><a class="reference internal" href="documenting_mpl.html#documenting-matplotlib">Writing documentation</a></li>

</ul>

</div>

</section>

<h2>Other ways to contribute<a class="headerlink" href="#other-ways-to-contribute" title="Permalink to this headline">#</a></h2>

It also helps us if you spread the word: reference the project from your blog

and articles or link to it from your website! If Matplotlib contributes to a

project that leads to a scientific publication, please follow the

<a class="reference internal" href="../users/project/citing.html">Citing Matplotlib</a> guidelines.

</section>

<h2>Coding guidelines<a class="headerlink" href="#coding-guidelines" title="Permalink to this headline">#</a></h2>

<h3>API changes<a class="headerlink" href="#api-changes" title="Permalink to this headline">#</a></h3>

API consistency and stability are of great value. Therefore, API changes

(e.g. signature changes, behavior changes, removals) will only be conducted

if the added benefit is worth the user effort for adapting.

API changes in Matplotlib have to be performed following the deprecation process

below, except in very rare circumstances as deemed necessary by the development team.

This ensures that users are notified before the change will take effect and thus

prevents unexpected breaking of code.

<h4>Rules<a class="headerlink" href="#rules" title="Permalink to this headline">#</a></h4>

<li>Deprecations are targeted at the next point.release (e.g. 3.x)</li>

<li>Deprecated API is generally removed two two point-releases after introduction

of the deprecation. Longer deprecations can be imposed by core developers on

a case-by-case basis to give more time for the transition</li>

<li>The old API must remain fully functional during the deprecation period</li>

<li>If alternatives to the deprecated API exist, they should be available

during the deprecation period</li>

<li>If in doubt, decisions about API changes are finally made by the

API consistency lead developer</li>

</ul>

</section>

<h4>Introducing<a class="headerlink" href="#introducing" title="Permalink to this headline">#</a></h4>

<li>Announce the deprecation in a new file

<code class="file docutils literal notranslate">doc/api/next_api_changes/deprecations/99999-ABC.rst</code> where <code class="docutils literal notranslate">99999</code>

is the pull request number and <code class="docutils literal notranslate">ABC</code> are the contributor's initials.</li>

<li>If possible, issue a <a class="reference internal" href="../api/_api_api.html#matplotlib._api.deprecation.MatplotlibDeprecationWarning" title="matplotlib._api.deprecation.MatplotlibDeprecationWarning"><code class="xref py py-obj docutils literal notranslate">MatplotlibDeprecationWarning</code></a> when the deprecated

API is used. There are a number of helper tools for this:

<li>Use <code class="docutils literal notranslate">_api.warn_deprecated()</code> for general deprecation warnings</li>

<li>Use the decorator <code class="docutils literal notranslate">@_api.deprecated</code> to deprecate classes, functions,

methods, or properties</li>

<li>To warn on changes of the function signature, use the decorators

<code class="docutils literal notranslate">@_api.delete_parameter</code>, <code class="docutils literal notranslate">@_api.rename_parameter</code>, and

<code class="docutils literal notranslate">@_api.make_keyword_only</code></li>

</ul>

All these helpers take a first parameter since, which should be set to

the next point release, e.g. "3.x".

You can use standard rst cross references in alternative.

</li>

</ol>

</section>

<h4>Expiring<a class="headerlink" href="#expiring" title="Permalink to this headline">#</a></h4>

<li>Announce the API changes in a new file

<code class="file docutils literal notranslate">doc/api/next_api_changes/[kind]/99999-ABC.rst</code> where <code class="docutils literal notranslate">99999</code>

is the pull request number and <code class="docutils literal notranslate">ABC</code> are the contributor's initials, and

<code class="docutils literal notranslate">[kind]</code> is one of the folders <code class="file docutils literal notranslate">behavior</code>, <code class="file docutils literal notranslate">development</code>,

<code class="file docutils literal notranslate">removals</code>. See <code class="file docutils literal notranslate">doc/api/next_api_changes/README.rst</code> for more

information. For the content, you can usually copy the deprecation notice

and adapt it slightly.</li>

<li>Change the code functionality and remove any related deprecation warnings.</li>

</ol>

</section>

<h3>Adding new API<a class="headerlink" href="#adding-new-api" title="Permalink to this headline">#</a></h3>

Every new function, parameter and attribute that is not explicitly marked as

private (i.e., starts with an underscore) becomes part of Matplotlib's public

API. As discussed above, changing the existing API is cumbersome. Therefore,

take particular care when adding new API:

<li>Mark helper functions and internal attributes as private by prefixing them

with an underscore.</li>

<li>Carefully think about good names for your functions and variables.</li>

<li>Try to adopt patterns and naming conventions from existing parts of the

Matplotlib API.</li>

<li>Consider making as many arguments keyword-only as possible. See also

<a class="reference external" href="https://emptysqua.re/blog/api-evolution-the-right-way/#adding-parameters">API Evolution the Right Way -- Add Parameters Compatibly</a>.

</li>

</ul>

</section>

<h3>New modules and files: installation<a class="headerlink" href="#new-modules-and-files-installation" title="Permalink to this headline">#</a></h3>

<li>If you have added new files or directories, or reorganized existing

ones, make sure the new files are included in the match patterns in

in package_data in <code class="file docutils literal notranslate">setupext.py</code>.</li>

</ul>

</section>

<h3>C/C++ extensions<a class="headerlink" href="#c-c-extensions" title="Permalink to this headline">#</a></h3>

<li>Extensions may be written in C or C++.</li>

<li>Code style should conform to PEP7 (understanding that PEP7 doesn't

address C++, but most of its admonitions still apply).</li>

<li>Python/C interface code should be kept separate from the core C/C++

code. The interface code should be named <code class="file docutils literal notranslate">FOO_wrap.cpp</code> or

<code class="file docutils literal notranslate">FOO_wrapper.cpp</code>.</li>

<li>Header file documentation (aka docstrings) should be in Numpydoc

format. We don't plan on using automated tools for these

docstrings, and the Numpydoc format is well understood in the

scientific Python community.</li>

<li>C/C++ code in the <code class="file docutils literal notranslate">extern/</code> directory is vendored, and should be kept

close to upstream whenever possible. It can be modified to fix bugs or

implement new features only if the required changes cannot be made elsewhere

in the codebase. In particular, avoid making style fixes to it.</li>

</ul>

</section>

<h3>Keyword argument processing<a class="headerlink" href="#keyword-argument-processing" title="Permalink to this headline">#</a></h3>

Matplotlib makes extensive use of <code class="docutils literal notranslate">**kwargs</code> for pass-through customizations

from one function to another. A typical example is

<a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.text.html#matplotlib.axes.Axes.text" title="matplotlib.axes.Axes.text"><code class="xref py py-obj docutils literal notranslate">text</code></a>. The definition of <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.text.html#matplotlib.pyplot.text" title="matplotlib.pyplot.text"><code class="xref py py-obj docutils literal notranslate">matplotlib.pyplot.text</code></a> is a

simple pass-through to <a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.text.html#matplotlib.axes.Axes.text" title="matplotlib.axes.Axes.text"><code class="xref py py-obj docutils literal notranslate">matplotlib.axes.Axes.text</code></a>:

<div class="highlight-default notranslate"><div class="highlight"><pre># in pyplot.py

def text(x, y, s, fontdict=None, **kwargs):

return gca().text(x, y, s, fontdict=fontdict, **kwargs)

</pre></div>

</div>

<a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.text.html#matplotlib.axes.Axes.text" title="matplotlib.axes.Axes.text"><code class="xref py py-obj docutils literal notranslate">matplotlib.axes.Axes.text</code></a> (simplified for illustration) just

passes all <code class="docutils literal notranslate">args</code> and <code class="docutils literal notranslate">kwargs</code> on to <code class="docutils literal notranslate">matplotlib.text.Text.__init__</code>:

<div class="highlight-default notranslate"><div class="highlight"><pre># in axes/_axes.py

def text(self, x, y, s, fontdict=None, **kwargs):

t = Text(x=x, y=y, text=s, **kwargs)

</pre></div>

</div>

and <code class="docutils literal notranslate">matplotlib.text.Text.__init__</code> (again, simplified)

just passes them on to the <a class="reference internal" href="../api/_as_gen/matplotlib.artist.Artist.update.html#matplotlib.artist.Artist.update" title="matplotlib.artist.Artist.update"><code class="xref py py-obj docutils literal notranslate">matplotlib.artist.Artist.update</code></a> method:

<div class="highlight-default notranslate"><div class="highlight"><pre># in text.py

def __init__(self, x=0, y=0, text='', **kwargs):

super().__init__()

self.update(kwargs)

</pre></div>

</div>

<code class="docutils literal notranslate">update</code> does the work looking for methods named like

<code class="docutils literal notranslate">set_property</code> if <code class="docutils literal notranslate">property</code> is a keyword argument. i.e., no one

looks at the keywords, they just get passed through the API to the

artist constructor which looks for suitably named methods and calls

them with the value.

As a general rule, the use of <code class="docutils literal notranslate">**kwargs</code> should be reserved for

pass-through keyword arguments, as in the example above. If all the

keyword args are to be used in the function, and not passed

on, use the key/value keyword args in the function definition rather

than the <code class="docutils literal notranslate">**kwargs</code> idiom.

In some cases, you may want to consume some keys in the local

function, and let others pass through. Instead of popping arguments to

use off <code class="docutils literal notranslate">**kwargs</code>, specify them as keyword-only arguments to the local

function. This makes it obvious at a glance which arguments will be

consumed in the function. For example, in

<a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-meth docutils literal notranslate">plot()</code></a>, <code class="docutils literal notranslate">scalex</code> and <code class="docutils literal notranslate">scaley</code> are

local arguments and the rest are passed on as

<a class="reference internal" href="../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-meth docutils literal notranslate">Line2D()</code></a> keyword arguments:

<div class="highlight-default notranslate"><div class="highlight"><pre># in axes/_axes.py

def plot(self, *args, scalex=True, scaley=True, **kwargs):

lines = []

for line in self._get_lines(*args, **kwargs):

self.add_line(line)

lines.append(line)

</pre></div>

</div>

</section>

<h3>Using logging for debug messages<a class="headerlink" href="#using-logging-for-debug-messages" title="Permalink to this headline">#</a></h3>

Matplotlib uses the standard Python <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate">logging</code></a> library to write verbose

warnings, information, and debug messages. Please use it! In all those places

you write <a class="reference external" href="https://docs.python.org/3/library/functions.html#print" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate">print</code></a> calls to do your debugging, try using <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.debug" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate">logging.debug</code></a>

instead!

To include <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate">logging</code></a> in your module, at the top of the module, you need to

<code class="docutils literal notranslate">import logging</code>. Then calls in your code like:

<div class="highlight-default notranslate"><div class="highlight"><pre>_log = logging.getLogger(__name__) # right after the imports

# code

# more code

_log.info('Here is some information')

_log.debug('Here is some more detailed information')

</pre></div>

</div>

will log to a logger named <code class="docutils literal notranslate">matplotlib.yourmodulename</code>.

If an end-user of Matplotlib sets up <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate">logging</code></a> to display at levels more

verbose than <code class="docutils literal notranslate">logging.WARNING</code> in their code with the Matplotlib-provided

helper:

<div class="highlight-default notranslate"><div class="highlight"><pre>plt.set_loglevel("debug")

</pre></div>

</div>

or manually with

<div class="highlight-default notranslate"><div class="highlight"><pre>import logging

logging.basicConfig(level=logging.DEBUG)

import matplotlib.pyplot as plt

</pre></div>

</div>

Then they will receive messages like

<div class="highlight-none notranslate"><div class="highlight"><pre>DEBUG:matplotlib.backends:backend MacOSX version unknown

DEBUG:matplotlib.yourmodulename:Here is some information

DEBUG:matplotlib.yourmodulename:Here is some more detailed information

</pre></div>

</div>

<h4>Which logging level to use?<a class="headerlink" href="#which-logging-level-to-use" title="Permalink to this headline">#</a></h4>

There are five levels at which you can emit messages.

<li><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.critical" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate">logging.critical</code></a> and <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.error" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate">logging.error</code></a> are really only there for errors that

will end the use of the library but not kill the interpreter.</li>

<li><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.warning" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate">logging.warning</code></a> and <a class="reference internal" href="../api/_api_api.html#matplotlib._api.warn_external" title="matplotlib._api.warn_external"><code class="xref py py-obj docutils literal notranslate">_api.warn_external</code></a> are used to warn the user,

see below.</li>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

contributing.html

Latest commit

History

contributing.html

File metadata and controls