Skip to main content

Save all open Matplotlib figures

Project description

savefigs

CI workflow status Version on PyPI

Easily save all open Matplotlib figures, with useful filenames.

Usage

Assume we have a script some_script.py that creates multiple Matplotlib figures.

Import the savefigs function:

from savefigs import savefigs

The below examples assume the figures do not have labels (fig.get_label()). If a figure does have a label, it will be used in place of fig{num}.

Default save settings (./{script filename stem}{figure label or fig{num}}.png):

savefigs()
# ./some_script_fig1.png, ./some_script_fig2.png, ...

👆 The filenames tell us which script generated the figures as well as their relative places in the figure generation order (or labels if they are labeled).

Specify directory:

savefigs(save_dir="figs")  # must exist
# ./figs/some_script_fig1.png, ./figs/some_script_fig2.png, ...

Specify a different prefix to the base stem format:

savefigs(stem_prefix="run1")
# ./run1_fig1.png, ./run1_fig2.png, ...

Save in multiple file formats:

savefigs(formats=["png", "pdf"])
# ./some_script_fig1.png, ./some_script_fig1.pdf, ...

Avoid overwriting files:

savefigs(clobber=False, noclobber_method="add_num")
# ./some_script_fig3.png (assuming ./some_script_fig{1,2}.png already exist)

👆 By default (without changing noclobber_method), setting clobber=False will instead error.

Background

When writing a script that creates multiple figures, I usually label them (usually using the num argument to plt.figure()/plt.subplots()), which makes it easier to find the correct figure window. Then, at the end of the script I write a loop like:

for num in plt.get_fignums():
    fig = plt.figure(num)
    fig.savefig(f"{fig.get_label()}.pdf", ...)
    # Maybe another format...

savefigs() essentially does this, but is more robust and provides additional features through keyword arguments. And it saves having to write those lines in the script, instead allowing the simple one-liner:

from savefigs import savefigs; savefigs()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

savefigs-0.2.1.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

savefigs-0.2.1-py2.py3-none-any.whl (6.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file savefigs-0.2.1.tar.gz.

File metadata

  • Download URL: savefigs-0.2.1.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for savefigs-0.2.1.tar.gz
Algorithm Hash digest
SHA256 7b8935ef0895e9f2f49f1e8f3527d017222cf22373c7d025feb18c0a33ac1a89
MD5 eb959cae63b2683fdf70294bbee6497b
BLAKE2b-256 ca7581504e769b53e151fe4422f45ab328c21f2777f5fadb1eddd3846771cfb0

See more details on using hashes here.

File details

Details for the file savefigs-0.2.1-py2.py3-none-any.whl.

File metadata

  • Download URL: savefigs-0.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for savefigs-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2ead50439a2d0e3089be0494f8f886ffa9b2cc9de86a6e4c65feda4b5796ca68
MD5 7c17b86f39c4325c40a7e4ad8fb110b3
BLAKE2b-256 f6713c80ae0324a0295cb6861b53ddf5eec37386b9baba6aee6a47921250abb2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page