[docs] Add typing info to quick start #1082

nhairs · 2024-10-26T03:48:17Z

docs/source/quickstart.rst

BoboTiG · 2024-11-01T12:16:18Z

Thank you @nhairs :)

Bumps [watchdog](https://github.com/gorakhargosh/watchdog) from 5.0.3 to 6.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/gorakhargosh/watchdog/releases">watchdog's releases</a>.</em></p> <blockquote> <h2>6.0.0</h2> <h2>Breaking Changes</h2> <ul> <li>[inotify] Use of <code>select.poll()</code> instead of deprecated <code>select.select()</code>, if available. (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1078">#1078</a>)</li> <li>[utils] Removed the unused <code>echo_class()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>echo_instancemethod()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>echo_module()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>is_class_private_name()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>is_classmethod()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>ic_method(met()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>method_name()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>name()</code> function from the <code>echo</code> module.</li> <li>[watchmedo] Removed the <code>--trace</code> CLI argument from the <code>watchmedo log</code> command, useless since events are logged by default at the <code>LoggerTrick</code> class level.</li> </ul> <h2>Other CHanges</h2> <ul> <li>Pin test dependecies.</li> <li>[docs] Add typing info to quick start. (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1082">#1082</a>)</li> <li>[inotify] Fix reading inotify file descriptor after closing it. (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1081">#1081</a>)</li> <li>[utils] The <code>stop_signal</code> keyword-argument type of the <code>AutoRestartTrick</code> class can now be either a <code>signal.Signals</code> or an <code>int</code>.</li> <li>[utils] Added the <code>__repr__()</code> method to the <code>Trick</code> class.</li> <li>[watchmedo] Fixed Mypy issues.</li> <li>[watchmedo] Added the <code>__repr__()</code> method to the <code>HelpFormatter</code> class.</li> <li>[windows] Fixed Mypy issues.</li> </ul> <p>💟 Thanks to our beloved contributors: <a href="https://github.com/g-pichler"><code>@g-pichler</code></a>, <a href="https://github.com/ethan-vanderheijden"><code>@ethan-vanderheijden</code></a>, <a href="https://github.com/nhairs"><code>@nhairs</code></a>, <a href="https://github.com/BoboTiG"><code>@BoboTiG</code></a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/gorakhargosh/watchdog/blob/master/changelog.rst">watchdog's changelog</a>.</em></p> <blockquote> <p>6.0.0</p> <pre><code> 2024-11-01 • `full history <https://github.com/gorakhargosh/watchdog/compare/v5.0.3...v6.0.0>`__ <ul> <li>Pin test dependecies.</li> <li>[docs] Add typing info to quick start. (<code>[#1082](gorakhargosh/watchdog#1082) &lt;https://github.com/gorakhargosh/watchdog/pull/1082&gt;</code>__)</li> <li>[inotify] Use of <code>select.poll()</code> instead of deprecated <code>select.select()</code>, if available. (<code>[#1078](gorakhargosh/watchdog#1078) &lt;https://github.com/gorakhargosh/watchdog/pull/1078&gt;</code>__)</li> <li>[inotify] Fix reading inotify file descriptor after closing it. (<code>[#1081](gorakhargosh/watchdog#1081) &lt;https://github.com/gorakhargosh/watchdog/pull/1081&gt;</code>__)</li> <li>[utils] The <code>stop_signal</code> keyword-argument type of the <code>AutoRestartTrick</code> class can now be either a <code>signal.Signals</code> or an <code>int</code>.</li> <li>[utils] Added the <code>__repr__()</code> method to the <code>Trick</code> class.</li> <li>[utils] Removed the unused <code>echo_class()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>echo_instancemethod()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>echo_module()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>is_class_private_name()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>is_classmethod()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>ic_method(met()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>method_name()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>name()</code> function from the <code>echo</code> module.</li> <li>[watchmedo] Fixed Mypy issues.</li> <li>[watchmedo] Added the <code>__repr__()</code> method to the <code>HelpFormatter</code> class.</li> <li>[watchmedo] Removed the <code>--trace</code> CLI argument from the <code>watchmedo log</code> command, useless since events are logged by default at the <code>LoggerTrick</code> class level.</li> <li>[windows] Fixed Mypy issues.</li> <li>Thanks to our beloved contributors: <a href="https://github.com/BoboTiG"><code>@BoboTiG</code></a>, <a href="https://github.com/g-pichler"><code>@g-pichler</code></a>, <a href="https://github.com/ethan-vanderheijden"><code>@ethan-vanderheijden</code></a>, <a href="https://github.com/nhairs"><code>@nhairs</code></a> </code></pre></li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/gorakhargosh/watchdog/commit/76c091dc8841de1d1a1cd6511bb509fe4f058de6"><code>76c091d</code></a> Version 6.0.0</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/58386d88747259b8b3da5082e30f1c6e0aa3b31a"><code>58386d8</code></a> Fixes, and clean-up (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1084">#1084</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/db698a52bbb1eb8cc34e889a8afdac6f17a99e57"><code>db698a5</code></a> fix: reading inotify file descriptor after closing it. (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1081">#1081</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/73d561265b109f30cf76a280cdcc74aa9e6df391"><code>73d5612</code></a> [docs] Add typing info to quick start (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1082">#1082</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/d774fec477a8f57d24b588164ebdd39b2d507bcd"><code>d774fec</code></a> docs: Update README Badges (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1083">#1083</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/6b74737501c85df9b9c2585faef4797a5250171b"><code>6b74737</code></a> docs: funding</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/3d1b888bccdd27a28f9f12a4e89288afe1ee493a"><code>3d1b888</code></a> [inotify] Use of <code>select.poll()</code> instead of deprecated <code>select.select()</code> (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1078">#1078</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/6a4f1cf846e03c8701fcc53b9e910077b5824e59"><code>6a4f1cf</code></a> Bump the version</li> <li>See full diff in <a href="https://github.com/gorakhargosh/watchdog/compare/v5.0.3...v6.0.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=watchdog&package-manager=pip&previous-version=5.0.3&new-version=6.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually 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 show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@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> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [watchdog](https://github.com/gorakhargosh/watchdog) from 5.0.3 to 6.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/gorakhargosh/watchdog/releases">watchdog's releases</a>.</em></p> <blockquote> <h2>6.0.0</h2> <h2>Breaking Changes</h2> <ul> <li>[inotify] Use of <code>select.poll()</code> instead of deprecated <code>select.select()</code>, if available. (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1078">#1078</a>)</li> <li>[utils] Removed the unused <code>echo_class()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>echo_instancemethod()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>echo_module()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>is_class_private_name()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>is_classmethod()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>ic_method(met()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>method_name()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>name()</code> function from the <code>echo</code> module.</li> <li>[watchmedo] Removed the <code>--trace</code> CLI argument from the <code>watchmedo log</code> command, useless since events are logged by default at the <code>LoggerTrick</code> class level.</li> </ul> <h2>Other Changes</h2> <ul> <li>Pin test dependecies.</li> <li>[docs] Add typing info to quick start. (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1082">#1082</a>)</li> <li>[inotify] Fix reading inotify file descriptor after closing it. (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1081">#1081</a>)</li> <li>[utils] The <code>stop_signal</code> keyword-argument type of the <code>AutoRestartTrick</code> class can now be either a <code>signal.Signals</code> or an <code>int</code>.</li> <li>[utils] Added the <code>__repr__()</code> method to the <code>Trick</code> class.</li> <li>[watchmedo] Fixed Mypy issues.</li> <li>[watchmedo] Added the <code>__repr__()</code> method to the <code>HelpFormatter</code> class.</li> <li>[windows] Fixed Mypy issues.</li> </ul> <p>💟 Thanks to our beloved contributors: <a href="https://github.com/g-pichler"><code>@g-pichler</code></a>, <a href="https://github.com/ethan-vanderheijden"><code>@ethan-vanderheijden</code></a>, <a href="https://github.com/nhairs"><code>@nhairs</code></a>, <a href="https://github.com/BoboTiG"><code>@BoboTiG</code></a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/gorakhargosh/watchdog/blob/master/changelog.rst">watchdog's changelog</a>.</em></p> <blockquote> <p>6.0.0</p> <pre><code> 2024-11-01 • `full history <https://github.com/gorakhargosh/watchdog/compare/v5.0.3...v6.0.0>`__ <ul> <li>Pin test dependecies.</li> <li>[docs] Add typing info to quick start. (<code>[#1082](gorakhargosh/watchdog#1082) &lt;https://github.com/gorakhargosh/watchdog/pull/1082&gt;</code>__)</li> <li>[inotify] Use of <code>select.poll()</code> instead of deprecated <code>select.select()</code>, if available. (<code>[#1078](gorakhargosh/watchdog#1078) &lt;https://github.com/gorakhargosh/watchdog/pull/1078&gt;</code>__)</li> <li>[inotify] Fix reading inotify file descriptor after closing it. (<code>[#1081](gorakhargosh/watchdog#1081) &lt;https://github.com/gorakhargosh/watchdog/pull/1081&gt;</code>__)</li> <li>[utils] The <code>stop_signal</code> keyword-argument type of the <code>AutoRestartTrick</code> class can now be either a <code>signal.Signals</code> or an <code>int</code>.</li> <li>[utils] Added the <code>__repr__()</code> method to the <code>Trick</code> class.</li> <li>[utils] Removed the unused <code>echo_class()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>echo_instancemethod()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>echo_module()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>is_class_private_name()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>is_classmethod()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>ic_method(met()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>method_name()</code> function from the <code>echo</code> module.</li> <li>[utils] Removed the unused <code>name()</code> function from the <code>echo</code> module.</li> <li>[watchmedo] Fixed Mypy issues.</li> <li>[watchmedo] Added the <code>__repr__()</code> method to the <code>HelpFormatter</code> class.</li> <li>[watchmedo] Removed the <code>--trace</code> CLI argument from the <code>watchmedo log</code> command, useless since events are logged by default at the <code>LoggerTrick</code> class level.</li> <li>[windows] Fixed Mypy issues.</li> <li>Thanks to our beloved contributors: <a href="https://github.com/BoboTiG"><code>@BoboTiG</code></a>, <a href="https://github.com/g-pichler"><code>@g-pichler</code></a>, <a href="https://github.com/ethan-vanderheijden"><code>@ethan-vanderheijden</code></a>, <a href="https://github.com/nhairs"><code>@nhairs</code></a> </code></pre></li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/gorakhargosh/watchdog/commit/76c091dc8841de1d1a1cd6511bb509fe4f058de6"><code>76c091d</code></a> Version 6.0.0</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/58386d88747259b8b3da5082e30f1c6e0aa3b31a"><code>58386d8</code></a> Fixes, and clean-up (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1084">#1084</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/db698a52bbb1eb8cc34e889a8afdac6f17a99e57"><code>db698a5</code></a> fix: reading inotify file descriptor after closing it. (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1081">#1081</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/73d561265b109f30cf76a280cdcc74aa9e6df391"><code>73d5612</code></a> [docs] Add typing info to quick start (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1082">#1082</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/d774fec477a8f57d24b588164ebdd39b2d507bcd"><code>d774fec</code></a> docs: Update README Badges (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1083">#1083</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/6b74737501c85df9b9c2585faef4797a5250171b"><code>6b74737</code></a> docs: funding</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/3d1b888bccdd27a28f9f12a4e89288afe1ee493a"><code>3d1b888</code></a> [inotify] Use of <code>select.poll()</code> instead of deprecated <code>select.select()</code> (<a href="https://redirect.github.com/gorakhargosh/watchdog/issues/1078">#1078</a>)</li> <li><a href="https://github.com/gorakhargosh/watchdog/commit/6a4f1cf846e03c8701fcc53b9e910077b5824e59"><code>6a4f1cf</code></a> Bump the version</li> <li>See full diff in <a href="https://github.com/gorakhargosh/watchdog/compare/v5.0.3...v6.0.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=watchdog&package-manager=pip&previous-version=5.0.3&new-version=6.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually 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 show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@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> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

nhairs added 3 commits October 26, 2024 14:44

[docs] Add typing info to quick start

02cc862

ref: gorakhargosh#982

Add to authors (including fixing ordering)

69e40d9

Fix base module --> api

9e7afc5

BoboTiG reviewed Oct 26, 2024

View reviewed changes

docs/source/quickstart.rst Show resolved Hide resolved

BoboTiG reviewed Nov 1, 2024

View reviewed changes

docs/source/quickstart.rst Outdated Show resolved Hide resolved

Update docs/source/quickstart.rst

c321be7

BoboTiG merged commit 73d5612 into gorakhargosh:master Nov 1, 2024
6 of 7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Add typing info to quick start #1082

[docs] Add typing info to quick start #1082

[docs] Add typing info to quick start #1082

[docs] Add typing info to quick start #1082

Conversation

nhairs commented Oct 26, 2024

BoboTiG commented Nov 1, 2024