Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Implement bbox_inches="tight" as a post-processing step. #19923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Implement bbox_inches="tight" as a post-processing step. #19923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 13 additions & 26 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
import matplotlib as mpl
from matplotlib import (
_api, backend_tools as tools, cbook, colors, docstring, textpath,
tight_bbox, transforms, widgets, get_backend, is_interactive, rcParams)
transforms, widgets, get_backend, is_interactive, rcParams)
from matplotlib._pylab_helpers import Gcf
from matplotlib.backend_managers import ToolManager
from matplotlib.cbook import _setattr_cm
Expand Down Expand Up @@ -2273,11 +2273,7 @@ def print_figure(
if not cbook._str_equal(color, "auto"):
stack.enter_context(self.figure._cm_set(**{prop: color}))

if bbox_inches is None:
bbox_inches = rcParams['savefig.bbox']

if (self.figure.get_constrained_layout() or
bbox_inches == "tight"):
if self.figure.get_constrained_layout():
# we need to trigger a draw before printing to make sure
# CL works. "tight" also needs a draw to get the right
# locations:
Expand All @@ -2289,22 +2285,6 @@ def print_figure(
with getattr(renderer, "_draw_disabled", nullcontext)():
self.figure.draw(renderer)

if bbox_inches:
if bbox_inches == "tight":
bbox_inches = self.figure.get_tightbbox(
renderer, bbox_extra_artists=bbox_extra_artists)
if pad_inches is None:
pad_inches = rcParams['savefig.pad_inches']
bbox_inches = bbox_inches.padded(pad_inches)

# call adjust_bbox to save only the given area
restore_bbox = tight_bbox.adjust_bbox(self.figure, bbox_inches,
canvas.fixed_dpi)

_bbox_inches_restore = (bbox_inches, restore_bbox)
else:
_bbox_inches_restore = None

# we have already done CL above, so turn it off:
stack.enter_context(self.figure._cm_set(constrained_layout=False))
try:
Expand All @@ -2316,12 +2296,19 @@ def print_figure(
facecolor=facecolor,
edgecolor=edgecolor,
orientation=orientation,
bbox_inches_restore=_bbox_inches_restore,
**kwargs)
if bbox_inches is None:
bbox_inches = rcParams["savefig.bbox"]
if bbox_inches == "tight":
bbox_inches = self.figure.get_tightbbox(
self.figure._cachedRenderer,
bbox_extra_artists=bbox_extra_artists)
if pad_inches is None:
pad_inches = rcParams["savefig.pad_inches"]
bbox_inches = bbox_inches.padded(pad_inches)
if bbox_inches:
canvas.adjust_bbox(filename, bbox_inches)
finally:
if bbox_inches and restore_bbox:
restore_bbox()

self.figure.set_canvas(self)
return result

Expand Down
7 changes: 7 additions & 0 deletions lib/matplotlib/backends/backend_agg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,13 @@ def print_tif(self, filename_or_obj, *, pil_kwargs=None):

print_tiff = print_tif

def adjust_bbox(self, filename, bbox_inches):
bbox = self.figure.dpi_scale_trans.transform_bbox(bbox_inches)
h = self.figure.bbox.height
img = Image.open(filename)
img = img.crop((bbox.x0, h - bbox.y1, bbox.x1, h - bbox.y0))
img.save(filename, format=img.format) # TODO: also copy metadata


@_Backend.export
class _BackendAgg(_Backend):
Expand Down
26 changes: 26 additions & 0 deletions lib/matplotlib/backends/backend_pdf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2719,6 +2719,32 @@ def draw(self):
self.figure.draw_no_output()
return super().draw()

def adjust_bbox(self, filename, bbox_inches):
bbox = self.figure.dpi_scale_trans.transform_bbox(bbox_inches)
# What about PdfPages?
with open(filename, "a+b") as file:
file.seek(0)
buf = file.read()
page_pos = file.tell()
pageid = self.figure._cachedRenderer.file.pageList[-1].id
page_match = re.search(
rb"(?s)%d 0 obj\n.*?/MediaBox.*?\nendobj\n" % pageid, buf)
file.write(re.sub(br"/MediaBox \[[^]]*\]", b"/MediaBox %s"
% pdfRepr(bbox.extents.tolist()), page_match[0]))
startxref_pos = file.tell()
file.write(b"xref\n")
file.write(b"0 1\n0000000000 65535 f \n")
file.write(b"%d 1\n%010d 00000 n \n" % (pageid, page_pos))
file.write(b"trailer\n")
trailer_match = re.search(
rb"(?s)trailer\n<< (.*) >>\nstartxref\n(\d+)\n%%EOF",
buf[buf.rfind(b"trailer\n"):])
file.write(
b"<< %s /Prev %s >>\n" % (trailer_match[1], trailer_match[2]))
file.write(b"startxref\n")
file.write(b"%d\n" % startxref_pos)
file.write(b"%%EOF\n")


FigureManagerPdf = FigureManagerBase

Expand Down
12 changes: 12 additions & 0 deletions lib/matplotlib/backends/backend_svg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import itertools
import logging
import os
import pathlib
import re
import uuid

Expand Down Expand Up @@ -1345,6 +1346,17 @@ def draw(self):
self.figure.draw_no_output()
return super().draw()

def adjust_bbox(self, filename, bbox_inches):
bbox = self.figure.dpi_scale_trans.transform_bbox(bbox_inches)
buf = pathlib.Path(filename).read_text()
w, h, x, y = map(short_float_fmt, [
bbox.width, bbox.height,
bbox.x0, self.figure.bbox.height - bbox.y1])
buf = re.sub('width="[^"]*"', f'width="{w}pt"', buf, 1)
buf = re.sub('height="[^"]*"', f'height="{h}pt"', buf, 1)
buf = re.sub('viewBox="[^"]*"', f'viewBox="{x} {y} {w} {h}"', buf, 1)
pathlib.Path(filename).write_text(buf)


FigureManagerSVG = FigureManagerBase

Expand Down