Skip to content

Add figsize and rc_context parameters to tee decorator #11

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

Merged
mmore500 merged 4 commits into from
Apr 21, 2026
+229 −98
Merged

Add figsize and rc_context parameters to tee decorator #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
13ddc41
Add teeplot_figsize kwarg to resize saved figures
claude Apr 21, 2026
1f85f2f
Add teeplot_rc_context kwarg and document teeplot_figsize
claude Apr 21, 2026
5ad1ff5
Use MappingProxyType for teeplot_rc_context default
claude Apr 21, 2026
eed6ea3
Use MappingProxyType for teeplot_outattrs default
claude Apr 21, 2026
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
4 changes: 4 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,8 @@ Executes a plotting function and saves the resulting plot to specified formats u
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``teeplot_dpi`` | Resolution for rasterized components of saved plots, default is publication-quality 300 dpi. |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``teeplot_figsize`` | Optional ``(width, height)`` tuple in inches; resizes the current figure via ``set_size_inches`` after the plotter runs. |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``teeplot_oncollision`` | Strategy for handling filename collisions: "error", "fix", "ignore", or "warn", default "warn"; inferred from environment if not specified. |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``teeplot_outattrs`` | Dict with additional key-value attributes to include in the output filename. |
Expand All @@ -270,6 +272,8 @@ Executes a plotting function and saves the resulting plot to specified formats u
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``teeplot_postprocess`` | Actions to perform after plotting but before saving. Can be a string of code to ``exec`` or a callable function. If a string, it's executed with access to ``plt`` and ``sns`` (if installed), and the plotter return value as ``teed``. |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``teeplot_rc_context`` | Mapping of matplotlib rcParams applied via ``matplotlib.rc_context`` around the plotter, postprocess, and save steps. |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``teeplot_save`` | File formats to save the plots in. Defaults to global settings if ``True``, all output suppressed if ``False``. Default global setting is ``{" .png", ".pdf"}``. Supported: ".eps", ".png", ".pdf", ".pgf", ".ps", ".svg". |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``teeplot_show`` | Dictates whether ``plt.show()`` should be called after plot is saved. If True, the plot is displayed using ``plt.show()``. Default behavior is to display if an interactive environment is detected (e.g., a notebook). |
Expand Down
211 changes: 113 additions & 98 deletions teeplot/teeplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import functools
import os
import pathlib
import types
import typing
import warnings
import sys
Expand Down Expand Up @@ -62,13 +63,15 @@ def tee(
*args: typing.Any,
teeplot_callback: bool = False,
teeplot_dpi: int = 300,
teeplot_figsize: typing.Optional[typing.Tuple[float, float]] = None,
teeplot_oncollision: typing.Optional[
typext.Literal["error", "fix", "ignore", "warn"]] = None,
teeplot_outattrs: typing.Dict[str, str] = {},
teeplot_outattrs: typing.Mapping[str, str] = types.MappingProxyType({}),
teeplot_outdir: str = "teeplots",
teeplot_outinclude: typing.Iterable[str] = tuple(),
teeplot_outexclude: typing.Iterable[str] = tuple(),
teeplot_postprocess: typing.Union[str, typing.Callable] = "",
teeplot_rc_context: typing.Mapping[str, typing.Any] = types.MappingProxyType({}),
teeplot_save: typing.Union[typing.Iterable[str], bool] = True,
teeplot_show: typing.Optional[bool] = None,
teeplot_subdir: str = '',
Expand All @@ -93,11 +96,15 @@ def tee(
Resolution for rasterized components of the saved plot in dots per inch.

Default is publication-quality 300 dpi.
teeplot_figsize : Tuple[float, float], optional
Size of the saved plot in inches as (width, height).

If provided, the current figure is resized after the plotter runs.
teeplot_oncollision : Literal["error", "fix", "ignore", "warn"], optional
Strategy for handling collisions between generated filenames.

Default "ignore" if executing in interactive mode, else default "warn".
teeplot_outattrs : Dict[str, str], optional
teeplot_outattrs : Mapping[str, str], optional
Additional attributes to include in the output filename.
teeplot_outdir : str, default "teeplots"
Base directory for saving plots.
Expand All @@ -122,6 +129,9 @@ def tee(
return value as the `teed` kwarg, second with the plotter return value
as the `ax` kwarg, third with no args, and last with the plotter
return value as a positional arg.
teeplot_rc_context : Mapping[str, Any], optional
Mapping of matplotlib rcParams to apply via `matplotlib.rc_context`
around the plotter, postprocess, and save steps.
teeplot_save : Union[str, Iterable[str], bool], default True
File formats to save the plots in.

Expand Down Expand Up @@ -224,46 +234,50 @@ def tee(
# ----- end argument parsing
# ----- begin plotting

teed = plotter(*args, **{k: v for k, v in kwargs.items()})
with matplotlib.rc_context(teeplot_rc_context):
teed = plotter(*args, **{k: v for k, v in kwargs.items()})

if isinstance(teeplot_postprocess, abc.Callable):
while "make breakable":
try:
teeplot_postprocess(teed=teed) # first attempt
break
except TypeError:
pass
try:
teeplot_postprocess(ax=teed) # second attempt
break
except TypeError:
pass
try:
teeplot_postprocess() # third attempt
break
except TypeError:
pass
if teeplot_figsize is not None:
plt.gcf().set_size_inches(*teeplot_figsize)

if isinstance(teeplot_postprocess, abc.Callable):
while "make breakable":
try:
teeplot_postprocess(teed=teed) # first attempt
break
except TypeError:
pass
try:
teeplot_postprocess(ax=teed) # second attempt
break
except TypeError:
pass
try:
teeplot_postprocess() # third attempt
break
except TypeError:
pass
try:
teeplot_postprocess(teed) # fourth attempt
break
except TypeError:
pass
raise TypeError( # give up
f"teeplot_postprocess={teeplot_postprocess} threw TypeError "
"or call signature incompatible with attempted invocations",
)
elif teeplot_postprocess:
if not isinstance(teeplot_postprocess, str):
raise TypeError(
"teeplot_postprocess must be str or Callable, "
f"not {type(teeplot_postprocess)} {teeplot_postprocess}"
)
try:
teeplot_postprocess(teed) # fourth attempt
break
except TypeError:
import seaborn as sns
import seaborn
except ModuleNotFoundError:
pass
raise TypeError( # give up
f"teeplot_postprocess={teeplot_postprocess} threw TypeError "
"or call signature incompatible with attempted invocations",
)
elif teeplot_postprocess:
if not isinstance(teeplot_postprocess, str):
raise TypeError(
"teeplot_postprocess must be str or Callable, "
f"not {type(teeplot_postprocess)} {teeplot_postprocess}"
)
try:
import seaborn as sns
import seaborn
except ModuleNotFoundError:
pass
exec(teeplot_postprocess)
exec(teeplot_postprocess)

incl = [*teeplot_outinclude]
attr_maker = lambda ext: {
Expand Down Expand Up @@ -296,65 +310,66 @@ def tee(
out_folder.mkdir(parents=True, exist_ok=True)

def save_callback():
for ext in save:

if ext not in teeplot_save:
if teeplot_verbose > 1:
print(f"skipping {out_path}")
continue

out_path = pathlib.Path(
kn.chop(
str(out_folder / out_filenamer(ext)),
mkdir=True,
),
)

if out_path in _history:
if teeplot_oncollision == "error":
raise RuntimeError(f"teeplot already created file {out_path}")
elif teeplot_oncollision == "fix":
count = _history[out_path]
suffix = f"ext={ext}"
assert str(out_path).endswith(suffix)
out_path = str(out_path)[:-len(suffix)] + f"#={count}+" + suffix
elif teeplot_oncollision == "ignore":
pass
elif teeplot_oncollision == "warn":
warnings.warn(
f"teeplot already created file {out_path}, overwriting it",
)
else:
raise ValueError(
"teeplot_oncollision must be one of 'error', 'fix', "
f"'ignore', or 'warn', not {teeplot_oncollision}",
)
_history[out_path] += 1

if teeplot_verbose:
print(out_path)
plt.savefig(
str(out_path),
bbox_inches='tight',
transparent=teeplot_transparent,
dpi=teeplot_dpi,
# see https://matplotlib.org/2.1.1/users/whats_new.html#reproducible-ps-pdf-and-svg-output
**dict(
metadata={
key: None
for key in {
".png": [],
".pdf": ["CreationDate"],
".svg": ["Date"],
}.get(ext, [])
},
) if ext != ".pgf" else {},
)

if teeplot_show or (teeplot_show is None and hasattr(sys, 'ps1')):
plt.show()

return teed
with matplotlib.rc_context(teeplot_rc_context):
for ext in save:

if ext not in teeplot_save:
if teeplot_verbose > 1:
print(f"skipping {out_path}")
continue

out_path = pathlib.Path(
kn.chop(
str(out_folder / out_filenamer(ext)),
mkdir=True,
),
)

if out_path in _history:
if teeplot_oncollision == "error":
raise RuntimeError(f"teeplot already created file {out_path}")
elif teeplot_oncollision == "fix":
count = _history[out_path]
suffix = f"ext={ext}"
assert str(out_path).endswith(suffix)
out_path = str(out_path)[:-len(suffix)] + f"#={count}+" + suffix
elif teeplot_oncollision == "ignore":
pass
elif teeplot_oncollision == "warn":
warnings.warn(
f"teeplot already created file {out_path}, overwriting it",
)
else:
raise ValueError(
"teeplot_oncollision must be one of 'error', 'fix', "
f"'ignore', or 'warn', not {teeplot_oncollision}",
)
_history[out_path] += 1

if teeplot_verbose:
print(out_path)
plt.savefig(
str(out_path),
bbox_inches='tight',
transparent=teeplot_transparent,
dpi=teeplot_dpi,
# see https://matplotlib.org/2.1.1/users/whats_new.html#reproducible-ps-pdf-and-svg-output
**dict(
metadata={
key: None
for key in {
".png": [],
".pdf": ["CreationDate"],
".svg": ["Date"],
}.get(ext, [])
},
) if ext != ".pgf" else {},
)

if teeplot_show or (teeplot_show is None and hasattr(sys, 'ps1')):
plt.show()

return teed

if teeplot_callback:
return save_callback, teed
Expand Down
Loading
Loading