feature: Add png for jupyter nb and saving #382
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
giulioungaretti
commented
Nov 7, 2016
| buffer.open(self.rpg.QtCore.QIODevice.ReadWrite) | ||
| image.save(buffer, 'PNG') | ||
| buffer.close() | ||
| return bytes(byte_array._getValue()) |
There was a problem hiding this comment.
note to self: this is a gnarly hack IMHO, but then again no other way around.
Allow to programmatically do something after the loop is done. F.ex save the plot.
The default was 1 second, but I think aiming for 100hz, and using that as default is a bit closer to reality. Then in the examples we can just use the default which makes for less typing for the users!
giulioungaretti
force-pushed
the
feature/save_QT
branch
from
c4468d1 to
dff292b
Compare
|
@alan-geller can you look at 55eab24 and dff292b , since it touches your code :D It just adds the option to run a task at the end of the loop or active loop , which is really useful to automatically save plots and sets the default refresh rate to around 100hz (which is kind of a basic golden standard, IMHO) ! |
alan-geller
suggested changes
Nov 8, 2016
|
|
||
| def with_bg_task(self, task, min_delay=1): | ||
| def with_bg_task(self, task, end_task=None, min_delay=1): |
There was a problem hiding this comment.
@giulioungaretti I think this works fine, but I'm not sure the two features (background task and end task) should be joined at the hip like this. If we think of this end_task as specifically finishing whatever was done by the background task, which seems reasonable to me, then linking them is fine, but perhaps a more descriptive name for end_task would help make it clearer to the user. bg_final_task? bg_task_finish? end_bg_task?
There was a problem hiding this comment.
@alan-geller agree, and yes I think that's how one should think and then yes, bg_final_task is just perfect!
| @@ -263,7 +263,7 @@ def with_bg_task(self, task, end_task=None, min_delay=1): | |||
| end_task: A callable object with no parameters. This object will be | |||
| invoked at the end of the measurement loop. | |||
|
|
|||
| min_delay (default 1): The minimum number of seconds to wait | |||
| min_delay (default 0.01): The minimum number of seconds to wait | |||
There was a problem hiding this comment.
I had originally set this to 1 because anything shorter caused the loop to slow appreciably when using matplot. With qtplot it's not a problem. I'm fine with being more aggressive with the default, but I think in the doc string perhaps we should suggest that users lengthen the min_delay if the background task is doing a lot of processing, such as updating a matplot graph.
There was a problem hiding this comment.
That is indeed a problem with matplotlib, yes we should definitely add that to avoid nasty surprises!
| """ | ||
| Attaches a background task to this loop. | ||
|
|
||
| Args: | ||
| task: A callable object with no parameters. This object will be | ||
| invoked periodically during the measurement loop. | ||
|
|
||
| min_delay (default 1): The minimum number of seconds to wait | ||
| end_task: A callable object with no parameters. This object will be |
There was a problem hiding this comment.
I think the doc string here should clarify that end_task is intended to clean up after or otherwise finish the background task work, rather than being for general cleanup.
bors bot
added a commit
that referenced
this pull request
Sep 6, 2022
4559: Update towncrier requirement from ~=21.9.0 to ~=22.8.0 r=jenshnielsen a=dependabot[bot] Updates the requirements on [towncrier](https://github.com/hawkowl/towncrier) to permit the latest version. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/hawkowl/towncrier/releases">towncrier's releases</a>.</em></p> <blockquote> <h2>Towncrier 22.8.0</h2> <h1>towncrier 22.8.0 (2022-08-29)</h1> <p>No significant changes since the previous release candidate.</p> <h1>towncrier 22.8.0.rc1 (2022-08-28)</h1> <h2>Features</h2> <ul> <li> <p>Make the check subcommand succeed for branches that change the news file</p> <p>This should enable the <code>check</code> subcommand to be used as a CI lint step and not fail when a pull request only modifies the configured news file (i.e. when the news file is being assembled for the next release). (<code>[#337](twisted/towncrier#337) <https://github.com/hawkowl/towncrier/issues/337></code>_)</p> </li> <li> <p>Added support to tables in toml settings, which provides a more intuitive way to configure custom types. (<code>[#369](twisted/towncrier#369) <https://github.com/hawkowl/towncrier/issues/369></code>_)</p> </li> <li> <p>The <code>towncrier create</code> command line now has a new <code>-m TEXT</code> argument that is used to define the content of the newly created fragment. (<code>[#374](twisted/towncrier#374) <https://github.com/hawkowl/towncrier/issues/374></code>_)</p> </li> </ul> <h2>Bugfixes</h2> <ul> <li> <p>The extra newline between the title and rendered content when using <code>--draft</code> is no longer inserted. (<code>[#105](twisted/towncrier#105) <https://github.com/hawkowl/towncrier/issues/105></code>_)</p> </li> <li> <p>The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered.</p> <p>Support for having the release notes for each version in a separate file is working again. This is a regression introduced in VERSION 19.9.0rc1. (<code>[#391](twisted/towncrier#391) <https://github.com/hawkowl/towncrier/issues/391></code>_)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Improve <code>CONTRIBUTING.rst</code> and add PR template. (<code>[#342](twisted/towncrier#342) <https://github.com/hawkowl/towncrier/issues/342></code>_)</li> <li>Move docs too the main branch and document custom fragment types. (<code>[#367](twisted/towncrier#367) <https://github.com/hawkowl/towncrier/issues/367></code>_)</li> <li>The CLI help messages were updated to contain more information. (<code>[#384](twisted/towncrier#384) <https://github.com/hawkowl/towncrier/issues/384></code>_)</li> </ul> <h2>Deprecations and Removals</h2> <ul> <li>Support for all Python versions older than 3.7 has been dropped. (<code>[#378](twisted/towncrier#378) <https://github.com/hawkowl/towncrier/issues/378></code>_)</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/twisted/towncrier/blob/trunk/NEWS.rst">towncrier's changelog</a>.</em></p> <blockquote> <h1>towncrier 22.8.0 (2022-08-29)</h1> <p>No significant changes since the previous release candidate.</p> <h1>towncrier 22.8.0.rc1 (2022-08-28)</h1> <h2>Features</h2> <ul> <li> <p>Make the check subcommand succeed for branches that change the news file</p> <p>This should enable the <code>check</code> subcommand to be used as a CI lint step and not fail when a pull request only modifies the configured news file (i.e. when the news file is being assembled for the next release). (<code>[#337](twisted/towncrier#337) <https://github.com/hawkowl/towncrier/issues/337></code>_)</p> </li> <li> <p>Added support to tables in toml settings, which provides a more intuitive way to configure custom types. (<code>[#369](twisted/towncrier#369) <https://github.com/hawkowl/towncrier/issues/369></code>_)</p> </li> <li> <p>The <code>towncrier create</code> command line now has a new <code>-m TEXT</code> argument that is used to define the content of the newly created fragment. (<code>[#374](twisted/towncrier#374) <https://github.com/hawkowl/towncrier/issues/374></code>_)</p> </li> </ul> <h2>Bugfixes</h2> <ul> <li> <p>The extra newline between the title and rendered content when using <code>--draft</code> is no longer inserted. (<code>[#105](twisted/towncrier#105) <https://github.com/hawkowl/towncrier/issues/105></code>_)</p> </li> <li> <p>The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered.</p> <p>Support for having the release notes for each version in a separate file is working again. This is a regression introduced in VERSION 19.9.0rc1. (<code>[#391](twisted/towncrier#391) <https://github.com/hawkowl/towncrier/issues/391></code>_)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Improve <code>CONTRIBUTING.rst</code> and add PR template. (<code>[#342](twisted/towncrier#342) <https://github.com/hawkowl/towncrier/issues/342></code>_)</li> <li>Move docs too the main branch and document custom fragment types. (<code>[#367](twisted/towncrier#367) <https://github.com/hawkowl/towncrier/issues/367></code>_)</li> <li>The CLI help messages were updated to contain more information. (<code>[#384](twisted/towncrier#384) <https://github.com/hawkowl/towncrier/issues/384></code>_)</li> </ul> <h2>Deprecations and Removals</h2> <ul> <li>Support for all Python versions older than 3.7 has been dropped. (<code>[#378](twisted/towncrier#378) <https://github.com/hawkowl/towncrier/issues/378></code>_)</li> </ul> <h2>Misc</h2> <ul> <li><code>[#292](twisted/towncrier#292) <https://github.com/hawkowl/towncrier/issues/292></code><em>, <code>[#330](twisted/towncrier#330) <https://github.com/hawkowl/towncrier/issues/330></code></em>, <code>[#366](twisted/towncrier#366) <https://github.com/hawkowl/towncrier/issues/366></code><em>, <code>[#376](twisted/towncrier#376) <https://github.com/hawkowl/towncrier/issues/376></code></em>, <code>[#377](twisted/towncrier#377) <https://github.com/hawkowl/towncrier/issues/377></code><em>, <code>[#380](twisted/towncrier#380) <https://github.com/hawkowl/towncrier/issues/380></code></em>, <code>[#381](twisted/towncrier#381) <https://github.com/hawkowl/towncrier/issues/381></code><em>, <code>[#382](twisted/towncrier#382) <https://github.com/hawkowl/towncrier/issues/382></code></em>, <code>[#383](twisted/towncrier#383) <https://github.com/hawkowl/towncrier/issues/383></code><em>, <code>[#393](twisted/towncrier#393) <https://github.com/hawkowl/towncrier/issues/393></code></em>, <code>[#399](twisted/towncrier#399) <https://github.com/hawkowl/towncrier/issues/399></code><em>, <code>[#402](twisted/towncrier#402) <https://github.com/hawkowl/towncrier/issues/402></code></em></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/twisted/towncrier/commit/411f2676b18daf9ba1eb656f7dc6c726397c4a9e"><code>411f267</code></a> Update version for final release.</li> <li><a href="https://github.com/twisted/towncrier/commit/f031dfa94e52e07b6c71e88cd5cd50e3803ad96c"><code>f031dfa</code></a> towncrier build --yes</li> <li><a href="https://github.com/twisted/towncrier/commit/4c854f58a2074458cd66767aca9f3aaa34d842d8"><code>4c854f5</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/402">#402</a> from webknjaz/patch-2</li> <li><a href="https://github.com/twisted/towncrier/commit/f911402b69960bee358b0c2011d685721afa9454"><code>f911402</code></a> Pin external github actions,</li> <li><a href="https://github.com/twisted/towncrier/commit/a814202234214182855fe4a5ffb40c7f7aec2b04"><code>a814202</code></a> [pre-commit.ci] auto fixes from pre-commit.com hooks</li> <li><a href="https://github.com/twisted/towncrier/commit/675219a6deac7c65bb94b72da55059b7077e5ec4"><code>675219a</code></a> Add a dummy change note for PR <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/402">#402</a></li> <li><a href="https://github.com/twisted/towncrier/commit/b566bfb0dcdcd86fa9d349875eba15e647c06459"><code>b566bfb</code></a> Uninvent the wheel w/ <code>re-actors/alls-green</code> @ GHA</li> <li><a href="https://github.com/twisted/towncrier/commit/5bf0a4653bb2adf52162550d436f1dc39f6e0446"><code>5bf0a46</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/396">#396</a> from twisted/292-more-ci-checks</li> <li><a href="https://github.com/twisted/towncrier/commit/1bb62219a9e7b0d969292cae56104678b8bea151"><code>1bb6221</code></a> Merge branch 'trunk' into 292-more-ci-checks</li> <li><a href="https://github.com/twisted/towncrier/commit/07baa2ba4b1159462dcb212395be1de91674698d"><code>07baa2b</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/395">#395</a> from twisted/384-cli-help</li> <li>Additional commits viewable in <a href="https://github.com/hawkowl/towncrier/compare/21.9.0...22.8.0">compare view</a></li> </ul> </details> <br /> You can trigger a rebase of this PR by commenting ``@dependabot` rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - ``@dependabot` rebase` will rebase this PR - ``@dependabot` recreate` will recreate this PR, overwriting any edits that have been made to it - ``@dependabot` merge` will merge this PR after your CI passes on it - ``@dependabot` squash and merge` will squash and merge this PR after your CI passes on it - ``@dependabot` cancel merge` will cancel a previously requested merge and block automerging - ``@dependabot` reopen` will reopen this PR if it is closed - ``@dependabot` close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - ``@dependabot` ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - ``@dependabot` ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - ``@dependabot` ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Changes needed for this * Invert logic for single file. 22.8.0 fixed the logic such that single_file=False is correct when you have more than one file * Pin versions of towncrier and sphinx towncrier to reflect this (so we get the right config) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jens H. Nielsen <Jens.Nielsen@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #360 and hints at an easy solution for #376 .
Changes proposed in this pull request:
with_bg_taskRefactoring QT in an idoimatic way will take a bit more time, this at least lessens the pain for say @nataliejpg and some other experimentalist.