Commit522fbe7

committed

Better documentation for print_figure refactoring.

1 parent8159c81 commit522fbe7Copy full SHA for 522fbe7

File tree

+15

-3

lines changed

+15

-3

lines changed

Lines changed: 6 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -2018,7 +2018,11 @@ def get_supported_filetypes_grouped(cls):`
`2018`	`2018`	`groupings[name].sort()`
`2019`	`2019`	`returngroupings`
`2020`	`2020`
`2021`		`-def_get_print_canvas(self,format):`
	`2021`	`+def_get_output_canvas(self,format):`
	`2022`	`+"""Return a canvas that is suitable for saving figures to a specified`
	`2023`	`+ file format. If necessary, this function will switch to a registered`
	`2024`	`+ backend that supports the format.`
	`2025`	`+ """`
`2022`	`2026`	`method_name='print_%s'%format`
`2023`	`2027`
`2024`	`2028`	`# check if this canvas supports the requested format`
`@@ -2092,7 +2096,7 @@ def print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w',`
`2092`	`2096`	`format=format.lower()`
`2093`	`2097`
`2094`	`2098`	`# get canvas object and print method for format`
`2095`		`-canvas=self._get_print_canvas(format)`
	`2099`	`+canvas=self._get_output_canvas(format)`
`2096`	`2100`	`print_method=getattr(canvas,'print_%s'%format)`
`2097`	`2101`
`2098`	`2102`	`ifdpiisNone:`

Lines changed: 9 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -31,11 +31,19 @@`
`31`	`31`	`import matplotlib`
`32`	`32`	`matplotlib.use('module://my_backend')`
`33`	`33`
`34`		`-where my_backend.py is your module name.Thus syntax is also`
	`34`	`+where my_backend.py is your module name.This syntax is also`
`35`	`35`	`recognized in the rc file and in the -d argument in pylab, eg::`
`36`	`36`
`37`	`37`	`python simple_plot.py -dmodule://my_backend`
`38`	`38`
	`39`	`+If your backend implements support for saving figures (i.e. has a print_xyz()`
	`40`	`+method) you can register it as the default handler for a given file type`
	`41`	`+`
	`42`	`+ from matplotlib.backend_bases import register_backend`
	`43`	`+ register_backend('xyz', 'my_backend', 'XYZ File Format')`
	`44`	`+ ...`
	`45`	`+ plt.savefig("figure.xyz")`
	`46`	`+`
`39`	`47`	`The files that are most relevant to backend_writers are`
`40`	`48`
`41`	`49`	`matplotlib/backends/backend_your_backend.py`

Comments

(0)