Title: Recommendation for using pyplot vs OOP API · Issue #15355 · matplotlib/matplotlib · GitHub
Open Graph Title: Recommendation for using pyplot vs OOP API · Issue #15355 · matplotlib/matplotlib
X Title: Recommendation for using pyplot vs OOP API · Issue #15355 · matplotlib/matplotlib
Description: I would like to know if it is recommended to always use the OOP API if matplotlib plots need to be created in a library. The reason why I'm asking is the following: We have lots of libraries that create matplotlib plots non-interactively...
Open Graph Description: I would like to know if it is recommended to always use the OOP API if matplotlib plots need to be created in a library. The reason why I'm asking is the following: We have lots of libraries that c...
X Description: I would like to know if it is recommended to always use the OOP API if matplotlib plots need to be created in a library. The reason why I'm asking is the following: We have lots of libraries th...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/15355
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Recommendation for using pyplot vs OOP API","articleBody":"\r\nI would like to know if it is recommended to always use the OOP API if\r\nmatplotlib plots need to be created in a library. \r\n\r\nThe reason why I'm asking is the following: We have lots of libraries that\r\ncreate matplotlib plots non-interactively if the code is run as part of a\r\n(multi-threaded) service on a head-less system or interactively if a\r\nconsole-script is started manually. For these libraries we run unit tests on\r\na CI server. Since we don't explicilty specify a backend (via\r\nmatplotlib.use), we either have to mock the pylot API a bit or run a fake\r\nxserver (Xvfb) in the background to fix issues due to missing DISPLAY env\r\nvar. (On our headless systems we neither use a custom matplotlibrc nor do we\r\nset the MATPLOTLIB_BACKEND env var. pyqt/pyside is installed on these\r\nsystems because the console scripts depend on qt libs)\r\n\r\nThe matplotlib documentation of the mpl API\r\n(https://matplotlib.org/3.1.1/api/index.html) contains the following two\r\nsentences:\r\n\r\n\u003e At its core, Matplotlib is object-oriented. We recommend directly working\r\nwith the objects, if you need more control and customization of your plots.\r\n\r\n\u003e pyplot is mainly intended for interactive plots and simple cases of\r\nprogrammatic plot generation.\r\n\r\n**Do you recommend to use pyplot in our case or rather recommend us to use the OOP API\r\ndirectly**? Independent of the recommendation I think it makes sense to extend the docs a bit and mention\r\nthis use-case, since our use-case is probably very common.\r\n\r\nBTW There are unfortunately very few (currently only 1:\r\nhttps://matplotlib.org/gallery/api/agg_oo_sgskip.html) examples that show\r\nhow the OOP API is supposed to be used. What is missing IMO is an example\r\nthat shows how to use plotting functions both interactively and\r\nnon-interactively.","author":{"url":"https://github.com/twmr","@type":"Person","name":"twmr"},"datePublished":"2019-10-01T14:06:14.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":6},"url":"https://github.com/15355/matplotlib/issues/15355"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:f177b6ce-3d0f-62fe-e758-4e293b4d4525 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 971C:1F0D01:B2F64F:B645D0:6A512620 |
| html-safe-nonce | e02d557daa5c7b84ba18809d67e4296b77841862ceef0f1b875bd7df4c1618f0 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NzFDOjFGMEQwMTpCMkY2NEY6QjY0NUQwOjZBNTEyNjIwIiwidmlzaXRvcl9pZCI6IjM1MTAzNDg1MDMwNTMzMTM1NjgiLCJyZWdpb25fZWRnZSI6InNlYSIsInJlZ2lvbl9yZW5kZXIiOiJzZWEifQ== |
| visitor-hmac | 8200ac5f3c1782c2c62ce08ec0b05fcbf23362254168ba829305eb9b38034bdb |
| hovercard-subject-tag | issue:500921047 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/matplotlib/matplotlib/15355/issue_layout |
| twitter:image | https://opengraph.githubassets.com/083052280b16a6338f50749e88107f271fd6fecebfee62595f45fcdb09fa145d/matplotlib/matplotlib/issues/15355 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/083052280b16a6338f50749e88107f271fd6fecebfee62595f45fcdb09fa145d/matplotlib/matplotlib/issues/15355 |
| og:image:alt | I would like to know if it is recommended to always use the OOP API if matplotlib plots need to be created in a library. The reason why I'm asking is the following: We have lots of libraries that c... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | twmr |
| hostname | github.com |
| expected-hostname | github.com |
| None | 689b683944b0d7f015d0e776452c970832fa81b82dc15284469b556ecced715b |
| turbo-cache-control | no-preview |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 942b51ed3bd5feee3d5e2719f890a5fe286edbbb |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width