Skip to content

Commit 93cd8df

Browse files
authored
Bump the required group with 9 updates (#89)
Bumps the required group with 9 updates: | Package | From | To | | --- | --- | --- | | [pydoclint](https://github.com/jsh9/pydoclint) | `0.5.6` | `0.5.9` | | [mkdocs-macros-plugin](https://github.com/fralau/mkdocs_macros_plugin) | `1.0.5` | `1.2.0` | | [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.34` | `9.5.39` | | [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) | `0.25.2` | `0.26.1` | | [mkdocstrings-python](https://github.com/mkdocstrings/python) | `1.10.9` | `1.11.1` | | [types-protobuf](https://github.com/python/typeshed) | `5.27.0.20240626` | `5.28.0.20240924` | | [pylint](https://github.com/pylint-dev/pylint) | `3.2.7` | `3.3.1` | | [pytest](https://github.com/pytest-dev/pytest) | `8.3.2` | `8.3.3` | | [hypothesis](https://github.com/HypothesisWorks/hypothesis) | `6.111.2` | `6.112.2` | Updates `pydoclint` from 0.5.6 to 0.5.9 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/jsh9/pydoclint/releases">pydoclint's releases</a>.</em></p> <blockquote> <h2>0.5.9</h2> <h2>What's Changed</h2> <ul> <li>doc(usage): Including a null-ls use with neovim. by <a href="https://github.com/aemonge"><code>@​aemonge</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/167">jsh9/pydoclint#167</a></li> <li>Improve handling of long type annotations by <a href="https://github.com/jsh9"><code>@​jsh9</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/173">jsh9/pydoclint#173</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/aemonge"><code>@​aemonge</code></a> made their first contribution in <a href="https://redirect.github.com/jsh9/pydoclint/pull/167">jsh9/pydoclint#167</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jsh9/pydoclint/compare/0.5.8...0.5.9">https://github.com/jsh9/pydoclint/compare/0.5.8...0.5.9</a></p> <h2>0.5.8</h2> <h2>What's Changed</h2> <ul> <li>fix: DOC503 catch namespaced exceptions by <a href="https://github.com/Amar1729"><code>@​Amar1729</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/168">jsh9/pydoclint#168</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jsh9/pydoclint/compare/0.5.7...0.5.8">https://github.com/jsh9/pydoclint/compare/0.5.7...0.5.8</a></p> <h2>0.5.7</h2> <h2>What's Changed</h2> <ul> <li>docs: add &quot;sphinx&quot; as an allowed style by <a href="https://github.com/Amar1729"><code>@​Amar1729</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/159">jsh9/pydoclint#159</a></li> <li>tox: use <code>deps = .</code> instead of <code>pip install</code> by <a href="https://github.com/Amar1729"><code>@​Amar1729</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/160">jsh9/pydoclint#160</a></li> <li>Switch from tab to 4 spaces in baseline by <a href="https://github.com/cidrblock"><code>@​cidrblock</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/152">jsh9/pydoclint#152</a></li> <li>feat: introduce DOC503 for checking specific raised exceptions by <a href="https://github.com/Amar1729"><code>@​Amar1729</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/161">jsh9/pydoclint#161</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/Amar1729"><code>@​Amar1729</code></a> made their first contribution in <a href="https://redirect.github.com/jsh9/pydoclint/pull/159">jsh9/pydoclint#159</a></li> <li><a href="https://github.com/cidrblock"><code>@​cidrblock</code></a> made their first contribution in <a href="https://redirect.github.com/jsh9/pydoclint/pull/152">jsh9/pydoclint#152</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jsh9/pydoclint/compare/0.5.6...0.5.7">https://github.com/jsh9/pydoclint/compare/0.5.6...0.5.7</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/jsh9/pydoclint/blob/main/CHANGELOG.md">pydoclint's changelog</a>.</em></p> <blockquote> <h2>[0.5.9] - 2024-09-29</h2> <ul> <li> <p>Fixed</p> <ul> <li>Fixed an edge case where type annotations are very long</li> </ul> </li> <li> <p>Full diff</p> <ul> <li><a href="https://github.com/jsh9/pydoclint/compare/0.5.8...0.5.9">https://github.com/jsh9/pydoclint/compare/0.5.8...0.5.9</a></li> </ul> </li> </ul> <h2>[0.5.8] - 2024-09-23</h2> <ul> <li> <p>Fixed</p> <ul> <li>Fixed the logic of handling exceptions namespaces (<code>a.b.c.MyException</code>)</li> </ul> </li> <li> <p>Full diff</p> <ul> <li><a href="https://github.com/jsh9/pydoclint/compare/0.5.7...0.5.8">https://github.com/jsh9/pydoclint/compare/0.5.7...0.5.8</a></li> </ul> </li> </ul> <h2>[0.5.7] - 2024-09-02</h2> <ul> <li> <p>Added</p> <ul> <li>A new violation code, <code>DOC503</code>, which checks that exceptions in the function body match those in the &quot;Raises&quot; section of the docstring</li> </ul> </li> <li> <p>Changed</p> <ul> <li>Switched from tab to 4 spaces in baseline</li> </ul> </li> <li> <p>Full diff</p> <ul> <li><a href="https://github.com/jsh9/pydoclint/compare/0.5.6...0.5.7">https://github.com/jsh9/pydoclint/compare/0.5.6...0.5.7</a></li> </ul> </li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/jsh9/pydoclint/commit/81704368e3368c4f7b6d6ea6b16b163608579d65"><code>8170436</code></a> Improve handling of long type annotations (<a href="https://redirect.github.com/jsh9/pydoclint/issues/173">#173</a>)</li> <li><a href="https://github.com/jsh9/pydoclint/commit/27ff76915d548ebc19bcd1e9f802bb7c0386b4a6"><code>27ff769</code></a> doc(usage): Including a null-ls use with neovim. (<a href="https://redirect.github.com/jsh9/pydoclint/issues/167">#167</a>)</li> <li><a href="https://github.com/jsh9/pydoclint/commit/5e941f54c4ff11580f33652b39fa00c4a158955d"><code>5e941f5</code></a> fix: DOC503 catch namespaced exceptions (<a href="https://redirect.github.com/jsh9/pydoclint/issues/168">#168</a>)</li> <li><a href="https://github.com/jsh9/pydoclint/commit/f75860489c4d4769767beabcad9b099cc2b2a88d"><code>f758604</code></a> feat: introduce DOC503 for checking specific raised exceptions (<a href="https://redirect.github.com/jsh9/pydoclint/issues/161">#161</a>)</li> <li><a href="https://github.com/jsh9/pydoclint/commit/ae285899e56001581c34e89e15ac9ea359aa4ca7"><code>ae28589</code></a> Switch from tab to 4 spaces in baseline (<a href="https://redirect.github.com/jsh9/pydoclint/issues/152">#152</a>)</li> <li><a href="https://github.com/jsh9/pydoclint/commit/1e80fd3e44d7ffaf0235a9f96912c4a95e9fb6b1"><code>1e80fd3</code></a> tox: use <code>deps = .</code> instead of <code>pip install</code> (<a href="https://redirect.github.com/jsh9/pydoclint/issues/160">#160</a>)</li> <li><a href="https://github.com/jsh9/pydoclint/commit/23b89f6a530e6986d4d54eede4defc371483b50d"><code>23b89f6</code></a> docs: add &quot;sphinx&quot; as an allowed style (<a href="https://redirect.github.com/jsh9/pydoclint/issues/159">#159</a>)</li> <li>See full diff in <a href="https://github.com/jsh9/pydoclint/compare/0.5.6...0.5.9">compare view</a></li> </ul> </details> <br /> Updates `mkdocs-macros-plugin` from 1.0.5 to 1.2.0 <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/fralau/mkdocs-macros-plugin/blob/master/CHANGELOG.md">mkdocs-macros-plugin's changelog</a>.</em></p> <blockquote> <h2>1.2.0, 2024-09-15</h2> <ul> <li>Added: three hooks <code>register_variables/macros/filters</code> to facilitate cooperation with other MkDocs plugins.</li> <li>Fixed: `define_env() was always required in module (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/191">#191</a>)</li> <li>Added: trace the case when no module is found (INFO)</li> <li>Improved documentation, particularly about HTML pages</li> <li>Added: parameters <code>j2_comment_start_string</code> and <code>j2_comment_end_string</code> to plugin's parameters, to specify alternate markers for comments.</li> <li>Added the multiline parameter <code>force_render_paths</code> in the config file, to specify directories or file patterns to be rendered for the case when <code>render_by_default = false</code> (the <code>render_macros</code> parameter in the YAML header of the page has the last word).</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/e8b3f45628ebaf8be2cb9d58a7263dd8dc3df24f"><code>e8b3f45</code></a> Document hooks for <a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/237">#237</a> (register macros/variables/filters)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/c1029d54dcb938a8ba736f87009eff5bf29ed953"><code>c1029d5</code></a> Document how to correct issue with macros / admonitions (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/240">#240</a>)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/67ccb159e7f135305b3f3a20bd56c58a623228e8"><code>67ccb15</code></a> Merge pull request <a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/238">#238</a> from timvink/master</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/03f5e89acfa246439cc877cc83c386cdebb1b21f"><code>03f5e89</code></a> Fix registration system</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/ddace9739ffa43b26285e82ea70c8ff0d0e719af"><code>ddace97</code></a> remove property on register methods</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/363d9046eeb6cb45f33e56c1cc4507cb6487bc39"><code>363d904</code></a> Add three hooks <code>register_variables/macros/filters</code> (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/237">#237</a>)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/2fb833e4009f6875d0df01f00e7c2d4640c1e00a"><code>2fb833e</code></a> Improved implementation for relative url (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/236">#236</a>)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/69e7cada20e500177756ce6fe89a7b0c4b1aa640"><code>69e7cad</code></a> Merge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/5bec964e81d9342ce92b838ad235247dec670f51"><code>5bec964</code></a> Add standard filter <code>normalize_url</code> (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/236">#236</a>)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/9a08f11742c130b06ff3345d64855669dbbcc4aa"><code>9a08f11</code></a> Merge pull request <a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/228">#228</a> from caomingpei/master</li> <li>Additional commits viewable in <a href="https://github.com/fralau/mkdocs_macros_plugin/compare/v1.0.5...v1.2.0">compare view</a></li> </ul> </details> <br /> Updates `mkdocs-material` from 9.5.34 to 9.5.39 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/squidfunk/mkdocs-material/releases">mkdocs-material's releases</a>.</em></p> <blockquote> <h2>mkdocs-material-9.5.39</h2> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7226">#7226</a>: not staying on page when using mike's canonical versioning</li> </ul> <p>Thanks go to <a href="https://github.com/ilyagr"><code>@​ilyagr</code></a> for their contributions</p> <h2>mkdocs-material-9.5.38</h2> <ul> <li>Added Albanian translations</li> </ul> <p>Thanks go to <a href="https://github.com/gerardkraja"><code>@​gerardkraja</code></a> for their contributions</p> <h2>mkdocs-material-9.5.37</h2> <ul> <li>Added 4th and 5th level ordered list styles</li> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7548">#7548</a>: Tags have no spacing in search</li> </ul> <h2>mkdocs-material-9.5.36</h2> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7544">#7544</a>: Social cards incorrectly rendering HTML entities</li> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7542">#7542</a>: Improved support for setting custom list styles</li> </ul> <h2>mkdocs-material-9.5.35</h2> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7498">#7498</a>: Search not showing for Vietnamese language</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG">mkdocs-material's changelog</a>.</em></p> <blockquote> <p>mkdocs-material-9.5.39+insiders-4.53.14 (2024-09-29)</p> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7567">#7567</a>: Empty headlines when using typeset plugin with anchorlinks</li> </ul> <p>mkdocs-material-9.5.39 (2024-09-29)</p> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7226">#7226</a>: not staying on page when using mike's canonical versioning</li> </ul> <p>mkdocs-material-9.5.38 (2024-09-26)</p> <ul> <li>Added Albanian translations</li> </ul> <p>mkdocs-material-9.5.37 (2024-09-25)</p> <ul> <li>Added 4th and 5th level ordered list styles</li> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7548">#7548</a>: Tags have no spacing in search</li> </ul> <p>mkdocs-material-9.5.36 (2024-09-21)</p> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7544">#7544</a>: Social cards incorrectly rendering HTML entities</li> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7542">#7542</a>: Improved support for setting custom list styles</li> </ul> <p>mkdocs-material-9.5.35 (2024-09-18)</p> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7498">#7498</a>: Search not showing for Vietnamese language</li> </ul> <p>mkdocs-material-9.5.34+insiders-4.53.13 (2024-09-14)</p> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7520">#7520</a>: Social plugin errors for generated files (MkDocs 1.6+)</li> </ul> <p>mkdocs-material-9.5.34 (2024-08-31)</p> <ul> <li>Updated Mermaid.js to version 11 (latest)</li> </ul> <p>mkdocs-material-9.5.33 (2024-08-23)</p> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7453">#7453</a>: Incorrect position of tooltip when sorting table</li> </ul> <p>mkdocs-material-9.5.32 (2024-08-19)</p> <ul> <li>Fixed RXSS vulnerability via deep link in search results</li> <li>Added support for fetching latest release from GitLab</li> </ul> <p>mkdocs-material-9.5.31+insiders-4.53.12 (2024-08-02)</p> <ul> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7410">#7410</a>: Instant previews jump on content tabs with anchor links</li> <li>Fixed <a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7408">#7408</a>: Instant previews jump on content tabs</li> </ul> <p>mkdocs-material-9.5.31 (2024-08-02)</p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/70db88f41449f6e801178457944ceb26279dd464"><code>70db88f</code></a> Prepare 9.5.39 release</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/187705e3b855ee86e3cea7e8499b1ce4222cd4aa"><code>187705e</code></a> Updated dependencies</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/56fdb282d027efc083237beec842733ad24ff51d"><code>56fdb28</code></a> Adjusted code copy button documentation</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/aeb9492c08fa12ada87e832d2c03c3984ce59fe0"><code>aeb9492</code></a> Fixed stay no page functionality when using mike's canonical versioning (<a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7559">#7559</a>)</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/50a15becc8b14698d145dce3efdfcbb25edda755"><code>50a15be</code></a> Updated link to step-by-step guide on YouTube</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/117250a46288841f2f359e5c85070a2d85d69b03"><code>117250a</code></a> Prepare 9.5.38 release</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/74ca2341ac7ab59b931926f74111d98fb73c67f3"><code>74ca234</code></a> Added Albanian translations</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/84ddbba7ef2b0d8965129f51f4c6475cb3612f8a"><code>84ddbba</code></a> Prepare 9.5.37 release</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/fd984136badbc6ca708c1a3528fcfb15364ee7f0"><code>fd98413</code></a> Documentation (<a href="https://redirect.github.com/squidfunk/mkdocs-material/issues/7557">#7557</a>)</li> <li><a href="https://github.com/squidfunk/mkdocs-material/commit/573d23d147e899e7980a5d79a1756beb3911071d"><code>573d23d</code></a> Updated dependencies</li> <li>Additional commits viewable in <a href="https://github.com/squidfunk/mkdocs-material/compare/9.5.34...9.5.39">compare view</a></li> </ul> </details> <br /> Updates `mkdocstrings[python]` from 0.25.2 to 0.26.1 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mkdocstrings/mkdocstrings/releases">mkdocstrings[python]'s releases</a>.</em></p> <blockquote> <h2>0.26.1</h2> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.26.1">0.26.1</a> - 2024-09-06</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.26.0...0.26.1">Compare with 0.26.0</a><!-- raw HTML omitted --></p> <h3>Bug Fixes</h3> <ul> <li>Instantiate config of the autorefs plugin when it is not enabled by the user (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/db2ab3403a95034987d574a517ddc426a4b4e1bd">db2ab34</a> by Timothée Mazzucotelli). <a href="https://redirect.github.com/mkdocstrings/autorefs/issues/57">Issue-autorefs#57</a></li> </ul> <h2>0.26.0</h2> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.26.0">0.26.0</a> - 2024-09-02</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.25.2...0.26.0">Compare with 0.25.2</a><!-- raw HTML omitted --></p> <h3>Build</h3> <ul> <li>Upgrade Python-Markdown lower bound to 3.6 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/28565f97f21bf81b2bc554679c641fba3f639882">28565f9</a> by Timothée Mazzucotelli).</li> </ul> <h3>Dependencies</h3> <ul> <li>Depend on mkdocs-autorefs v1 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/33aa573efb17b13e7b9da77e29aeccb3fbddd8e8">33aa573</a> by Timothée Mazzucotelli).</li> </ul> <h3>Features</h3> <ul> <li>Allow hooking into autorefs when converting Markdown docstrings (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/b63e72691a8f92dd59b56304125de4a19e0d028c">b63e726</a> by Timothée Mazzucotelli). <a href="https://redirect.github.com/mkdocstrings/autorefs/pull/46">Based-on-PR-autorefs#46</a></li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md">mkdocstrings[python]'s changelog</a>.</em></p> <blockquote> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.26.1">0.26.1</a> - 2024-09-06</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.26.0...0.26.1">Compare with 0.26.0</a><!-- raw HTML omitted --></p> <h3>Bug Fixes</h3> <ul> <li>Instantiate config of the autorefs plugin when it is not enabled by the user (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/db2ab3403a95034987d574a517ddc426a4b4e1bd">db2ab34</a> by Timothée Mazzucotelli). <a href="https://redirect.github.com/mkdocstrings/autorefs/issues/57">Issue-autorefs#57</a></li> </ul> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.26.0">0.26.0</a> - 2024-09-02</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.25.2...0.26.0">Compare with 0.25.2</a><!-- raw HTML omitted --></p> <h3>Build</h3> <ul> <li>Upgrade Python-Markdown lower bound to 3.6 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/28565f97f21bf81b2bc554679c641fba3f639882">28565f9</a> by Timothée Mazzucotelli).</li> </ul> <h3>Dependencies</h3> <ul> <li>Depend on mkdocs-autorefs v1 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/33aa573efb17b13e7b9da77e29aeccb3fbddd8e8">33aa573</a> by Timothée Mazzucotelli).</li> </ul> <h3>Features</h3> <ul> <li>Allow hooking into autorefs when converting Markdown docstrings (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/b63e72691a8f92dd59b56304125de4a19e0d028c">b63e726</a> by Timothée Mazzucotelli). <a href="https://redirect.github.com/mkdocstrings/autorefs/pull/46">Based-on-PR-autorefs#46</a></li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/651d17642c54db49f4b6ba68b3ea216a6996907d"><code>651d176</code></a> chore: Prepare release 0.26.1</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/db2ab3403a95034987d574a517ddc426a4b4e1bd"><code>db2ab34</code></a> fix: Instantiate config of the autorefs plugin when it is not enabled by the ...</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/a65035a51312b57a8556e6ae02033e05463b96fb"><code>a65035a</code></a> docs: Clarify that Installation section</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/b1aa042f26c346dbdbf10efb20612c0dc5f8834f"><code>b1aa042</code></a> chore: Prepare release 0.26.0</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/b63e72691a8f92dd59b56304125de4a19e0d028c"><code>b63e726</code></a> feat: Allow hooking into autorefs when converting Markdown docstrings</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/3c878b7f53f2b13a61f2facb5a91a949955e688e"><code>3c878b7</code></a> chore: Upgrade mkdocs-redirects lower bound to avoid deprecation warning</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/28565f97f21bf81b2bc554679c641fba3f639882"><code>28565f9</code></a> build: Upgrade Python-Markdown lower bound to 3.6</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/52fad1163127e94d130bbbd479b51e8e38405f8c"><code>52fad11</code></a> style: Format</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/c6ca5228339926da8f140dbed4602043add51416"><code>c6ca522</code></a> docs: Fix dead link</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/8041ef35c4b3379d74d2afec75c967315b2b5f36"><code>8041ef3</code></a> docs: Update code highlight lines</li> <li>Additional commits viewable in <a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.25.2...0.26.1">compare view</a></li> </ul> </details> <br /> Updates `mkdocstrings-python` from 1.10.9 to 1.11.1 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mkdocstrings/python/releases">mkdocstrings-python's releases</a>.</em></p> <blockquote> <h2>1.11.1</h2> <h2><a href="https://github.com/mkdocstrings/python/releases/tag/1.11.1">1.11.1</a> - 2024-09-03</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/python/compare/1.11.0...1.11.1">Compare with 1.11.0</a><!-- raw HTML omitted --></p> <h3>Code Refactoring</h3> <ul> <li>Prepare <code>relative_crossrefs</code> and <code>scoped_crossrefs</code> insiders features (<a href="https://github.com/mkdocstrings/python/commit/dd8b014a8ab3decc31d4b08bc22fe68577e1a02c">dd8b014</a> by Timothée Mazzucotelli).</li> </ul> <h2>1.11.0</h2> <h2><a href="https://github.com/mkdocstrings/python/releases/tag/1.11.0">1.11.0</a> - 2024-09-03</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/python/compare/1.10.9...1.11.0">Compare with 1.10.9</a><!-- raw HTML omitted --></p> <h3>Features</h3> <ul> <li>Hook into autorefs to provide context around cross-ref errors (<a href="https://github.com/mkdocstrings/python/commit/bb4be5be1b85be50f46c7889231a2d4a3bd05165">bb4be5b</a> by Timothée Mazzucotelli).</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md">mkdocstrings-python's changelog</a>.</em></p> <blockquote> <h2><a href="https://github.com/mkdocstrings/python/releases/tag/1.11.1">1.11.1</a> - 2024-09-03</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/python/compare/1.11.0...1.11.1">Compare with 1.11.0</a><!-- raw HTML omitted --></p> <h3>Code Refactoring</h3> <ul> <li>Prepare <code>relative_crossrefs</code> and <code>scoped_crossrefs</code> insiders features (<a href="https://github.com/mkdocstrings/python/commit/dd8b014a8ab3decc31d4b08bc22fe68577e1a02c">dd8b014</a> by Timothée Mazzucotelli).</li> </ul> <h2><a href="https://github.com/mkdocstrings/python/releases/tag/1.11.0">1.11.0</a> - 2024-09-03</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/python/compare/1.10.9...1.11.0">Compare with 1.10.9</a><!-- raw HTML omitted --></p> <h3>Features</h3> <ul> <li>Hook into autorefs to provide context around cross-ref errors (<a href="https://github.com/mkdocstrings/python/commit/bb4be5be1b85be50f46c7889231a2d4a3bd05165">bb4be5b</a> by Timothée Mazzucotelli).</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mkdocstrings/python/commit/6dafa9ac307fb476ea4b2a17190718ca059c9811"><code>6dafa9a</code></a> chore: Prepare release 1.11.1</li> <li><a href="https://github.com/mkdocstrings/python/commit/dd8b014a8ab3decc31d4b08bc22fe68577e1a02c"><code>dd8b014</code></a> refactor: Prepare <code>relative_crossrefs</code> and <code>scoped_crossrefs</code> insiders features</li> <li><a href="https://github.com/mkdocstrings/python/commit/7b11ba86a6ca6a1e8ec5d720e0d167062b44a4a4"><code>7b11ba8</code></a> docs: Update docs from insiders</li> <li><a href="https://github.com/mkdocstrings/python/commit/446d72515e96ae734056fb5b351a2faf99621bf1"><code>446d725</code></a> chore: Prepare release 1.11.0</li> <li><a href="https://github.com/mkdocstrings/python/commit/bb4be5be1b85be50f46c7889231a2d4a3bd05165"><code>bb4be5b</code></a> feat: Hook into autorefs to provide context around cross-ref errors</li> <li>See full diff in <a href="https://github.com/mkdocstrings/python/compare/1.10.9...1.11.1">compare view</a></li> </ul> </details> <br /> Updates `types-protobuf` from 5.27.0.20240626 to 5.28.0.20240924 <details> <summary>Commits</summary> <ul> <li>See full diff in <a href="https://github.com/python/typeshed/commits">compare view</a></li> </ul> </details> <br /> Updates `pylint` from 3.2.7 to 3.3.1 <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/pylint-dev/pylint/commit/76bce72bc57cc8089e439cc9d22fed5806341ed4"><code>76bce72</code></a> Bump pylint to 3.3.1, update changelog (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9954">#9954</a>)</li> <li><a href="https://github.com/pylint-dev/pylint/commit/55ee81651aa98d644e046a0f02f20576ecb3a6dc"><code>55ee816</code></a> Bump astroid to 3.3.4 (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9951">#9951</a>) (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9952">#9952</a>)</li> <li><a href="https://github.com/pylint-dev/pylint/commit/6350dfa900b11de442bc562564884037ca8bc4f6"><code>6350dfa</code></a> Bump pylint to 3.3.0, update changelog</li> <li><a href="https://github.com/pylint-dev/pylint/commit/78f3dfa0c40bdb1e0f145e75c309f28f4e8cc31e"><code>78f3dfa</code></a> Bump astroid to 3.3.3 (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9939">#9939</a>)</li> <li><a href="https://github.com/pylint-dev/pylint/commit/b28c1f69334191ade62357d01c248742afac24b3"><code>b28c1f6</code></a> Add check for <code>unnecessary-default-type-args</code> (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9938">#9938</a>)</li> <li><a href="https://github.com/pylint-dev/pylint/commit/bd97b93db80298570bce6a0197c62d78a4d5134f"><code>bd97b93</code></a> [doc framework] Assert that the good and bad example exists in the doc (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9936">#9936</a>)</li> <li><a href="https://github.com/pylint-dev/pylint/commit/7aa44364a6c202dce8384eafad7f4d5fb6492dad"><code>7aa4436</code></a> Fix duplicate workflow step ids (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9934">#9934</a>)</li> <li><a href="https://github.com/pylint-dev/pylint/commit/09509163baaba140fca2633930a6632f05830246"><code>0950916</code></a> [pre-commit] Add codespell, and fix some existing typos (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9912">#9912</a>)</li> <li><a href="https://github.com/pylint-dev/pylint/commit/3b4a7f9ba6ed01298324d73e2e625324ee4a39e7"><code>3b4a7f9</code></a> Add details.rst for c-extension-no-member (<a href="https://redirect.github.com/pylint-dev/pylint/issues/9933">#9933</a>)</li> <li><a href="https://github.com/pylint-dev/pylint/commit/7d60c27efc799dabd2aa217744636c81036c78c6"><code>7d60c27</code></a> Explicitly save cache in primer jobs</li> <li>Additional commits viewable in <a href="https://github.com/pylint-dev/pylint/compare/v3.2.7...v3.3.1">compare view</a></li> </ul> </details> <br /> Updates `pytest` from 8.3.2 to 8.3.3 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/pytest-dev/pytest/releases">pytest's releases</a>.</em></p> <blockquote> <h2>8.3.3</h2> <h1>pytest 8.3.3 (2024-09-09)</h1> <h2>Bug fixes</h2> <ul> <li> <p><a href="https://redirect.github.com/pytest-dev/pytest/issues/12446">#12446</a>: Avoid calling <code>@Property</code> (and other instance descriptors) during fixture discovery -- by <code>asottile</code>{.interpreted-text role=&quot;user&quot;}</p> </li> <li> <p><a href="https://redirect.github.com/pytest-dev/pytest/issues/12659">#12659</a>: Fixed the issue of not displaying assertion failure differences when using the parameter <code>--import-mode=importlib</code> in pytest&gt;=8.1.</p> </li> <li> <p><a href="https://redirect.github.com/pytest-dev/pytest/issues/12667">#12667</a>: Fixed a regression where type change in [ExceptionInfo.errisinstance]{.title-ref} caused [mypy]{.title-ref} to fail.</p> </li> <li> <p><a href="https://redirect.github.com/pytest-dev/pytest/issues/12744">#12744</a>: Fixed typing compatibility with Python 3.9 or less -- replaced [typing.Self]{.title-ref} with [typing_extensions.Self]{.title-ref} -- by <code>Avasam</code>{.interpreted-text role=&quot;user&quot;}</p> </li> <li> <p><a href="https://redirect.github.com/pytest-dev/pytest/issues/12745">#12745</a>: Fixed an issue with backslashes being incorrectly converted in nodeid paths on Windows, ensuring consistent path handling across environments.</p> </li> <li> <p><a href="https://redirect.github.com/pytest-dev/pytest/issues/6682">#6682</a>: Fixed bug where the verbosity levels where not being respected when printing the &quot;msg&quot; part of failed assertion (as in <code>assert condition, msg</code>).</p> </li> <li> <p><a href="https://redirect.github.com/pytest-dev/pytest/issues/9422">#9422</a>: Fix bug where disabling the terminal plugin via <code>-p no:terminal</code> would cause crashes related to missing the <code>verbose</code> option.</p> <p>-- by <code>GTowers1</code>{.interpreted-text role=&quot;user&quot;}</p> </li> </ul> <h2>Improved documentation</h2> <ul> <li><a href="https://redirect.github.com/pytest-dev/pytest/issues/12663">#12663</a>: Clarify that the [pytest_deselected]{.title-ref} hook should be called from [pytest_collection_modifyitems]{.title-ref} hook implementations when items are deselected.</li> <li><a href="https://redirect.github.com/pytest-dev/pytest/issues/12678">#12678</a>: Remove erroneous quotes from [tmp_path_retention_policy]{.title-ref} example in docs.</li> </ul> <h2>Miscellaneous internal changes</h2> <ul> <li><a href="https://redirect.github.com/pytest-dev/pytest/issues/12769">#12769</a>: Fix typos discovered by codespell and add codespell to pre-commit hooks.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/pytest-dev/pytest/commit/d0f136fe64f9374f18a04562305b178fb380d1ec"><code>d0f136f</code></a> build(deps): Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.1 (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12790">#12790</a>)</li> <li><a href="https://github.com/pytest-dev/pytest/commit/972f307c7861ae498e705d3d12e003fa4b035ac0"><code>972f307</code></a> Prepare release version 8.3.3</li> <li><a href="https://github.com/pytest-dev/pytest/commit/0dabdcfe4de99147a07bd577804b60818ea25bc4"><code>0dabdcf</code></a> Include co-authors in release announcement (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12795">#12795</a>) (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12797">#12797</a>)</li> <li><a href="https://github.com/pytest-dev/pytest/commit/a9910a413a691e1b216e2235a9cbec0921117702"><code>a9910a4</code></a> Do not discover properties when iterating fixtures (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12781">#12781</a>) (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12788">#12788</a>)</li> <li><a href="https://github.com/pytest-dev/pytest/commit/0f10b6b0d8138d3539de75cb7b2e33167b6fc882"><code>0f10b6b</code></a> Fix issue with slashes being turned into backslashes on Windows (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12760">#12760</a>) (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12">#12</a>...</li> <li><a href="https://github.com/pytest-dev/pytest/commit/300d13d2231db85186729c2091ea33480cb39c1a"><code>300d13d</code></a> Merge pull request <a href="https://redirect.github.com/pytest-dev/pytest/issues/12785">#12785</a> from pytest-dev/patchback/backports/8.3.x/57cccf7f4...</li> <li><a href="https://github.com/pytest-dev/pytest/commit/e5d32c73abcf4fa1362b15aaf660074de8f710d4"><code>e5d32c7</code></a> Merge pull request <a href="https://redirect.github.com/pytest-dev/pytest/issues/12784">#12784</a> from svenevs/fix/docs-example-parametrize-minor-typo</li> <li><a href="https://github.com/pytest-dev/pytest/commit/bc913d194ec009699194b016ca619d5ae7f22c91"><code>bc913d1</code></a> Streamline checks for verbose option (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12706">#12706</a>) (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12778">#12778</a>)</li> <li><a href="https://github.com/pytest-dev/pytest/commit/01cfcc9f2dda817b25511772593012fd93e092d0"><code>01cfcc9</code></a> Fix typos and introduce codespell pre-commit hook (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12769">#12769</a>) (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12774">#12774</a>)</li> <li><a href="https://github.com/pytest-dev/pytest/commit/4873394d53635ef62d1915d23972ed4281a784eb"><code>4873394</code></a> doc: Remove past training (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12772">#12772</a>) (<a href="https://redirect.github.com/pytest-dev/pytest/issues/12773">#12773</a>)</li> <li>Additional commits viewable in <a href="https://github.com/pytest-dev/pytest/compare/8.3.2...8.3.3">compare view</a></li> </ul> </details> <br /> Updates `hypothesis` from 6.111.2 to 6.112.2 <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/83c22d92684b256400a4871a13ad4ffcad447a36"><code>83c22d9</code></a> Bump hypothesis-python version to 6.112.2 and update changelog</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/3c1350dcdcc16009d3e374bd28654592f0222c0c"><code>3c1350d</code></a> Merge pull request <a href="https://redirect.github.com/HypothesisWorks/hypothesis/issues/4119">#4119</a> from HypothesisWorks/create-pull-request/patch</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/2958a45987a87f5647498a43f061a31b31ad705f"><code>2958a45</code></a> Fix for cyclic exception context</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/75650b90a197bbce695e2ebdaff759fed1d21109"><code>75650b9</code></a> Merge pull request <a href="https://redirect.github.com/HypothesisWorks/hypothesis/issues/4061">#4061</a> from abeakkas/fix-assume-example</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/7fdad0b4fac45c1aa2c700c9fbd80fd860a6ca8e"><code>7fdad0b</code></a> Update pinned dependencies</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/879225d8836c657fe970ceb1a95df072e06352d4"><code>879225d</code></a> Merge pull request <a href="https://redirect.github.com/HypothesisWorks/hypothesis/issues/4112">#4112</a> from HypothesisWorks/create-pull-request/patch</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/bd8e963288c5e5e8b509eabad8a5d2f36830f9f4"><code>bd8e963</code></a> Update pinned dependencies</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/4d079f7a62a6fdabfb2f2a2b276cb0f721ea62de"><code>4d079f7</code></a> Merge pull request <a href="https://redirect.github.com/HypothesisWorks/hypothesis/issues/4104">#4104</a> from Zac-HD/update-deps</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/1caa0f226ca157cfbdc61df7066155906cb7e993"><code>1caa0f2</code></a> drop win py39 CI</li> <li><a href="https://github.com/HypothesisWorks/hypothesis/commit/f81af9c6c072eb633e61ffa472417207fe9207d1"><code>f81af9c</code></a> Update pinned deps</li> <li>Additional commits viewable in <a href="https://github.com/HypothesisWorks/hypothesis/compare/hypothesis-python-6.111.2...hypothesis-python-6.112.2">compare view</a></li> </ul> </details> <br /> 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 <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </details>
2 parents dfdfaf3 + 09e8b16 commit 93cd8df

File tree

5 files changed

+25
-17
lines changed

5 files changed

+25
-17
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
- `GrpcStreamBroadcaster` now takes a `AsyncIterable` instead of a `AsyncIterator` as the `stream_method`. This is to match the type of streaming methods generated by `grpc`, so no conversion to an `AsyncIterator` is needed.
1010
- gRPC URLs don't have a default port anymore, unless a default is set via `ChannelOptions`. If you want to set a default port for URLs, please pass custom `ChannelOptions` as `defaults` to `parse_grpc_uri` or as `channel_defaults` to `BaseApiClient`.
11+
* The `ExponentialBackoff` and `LinearBackoff` classes now require keyword arguments for their constructor. This change was made to make the classes easier to use and to avoid confusion with the order of the arguments.
1112

1213
## New Features
1314

pyproject.toml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ dev-flake8 = [
4242
"flake8 == 7.1.1",
4343
"flake8-docstrings == 1.7.0",
4444
"flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
45-
"pydoclint == 0.5.6",
45+
"pydoclint == 0.5.9",
4646
"pydocstyle == 6.3.0",
4747
"frequenz-client-base",
4848
]
@@ -53,34 +53,34 @@ dev-mkdocs = [
5353
"mike == 2.1.3",
5454
"mkdocs-gen-files == 0.5.0",
5555
"mkdocs-literate-nav == 0.6.1",
56-
"mkdocs-macros-plugin == 1.0.5",
57-
"mkdocs-material == 9.5.34",
58-
"mkdocstrings[python] == 0.25.2",
59-
"mkdocstrings-python == 1.10.9",
56+
"mkdocs-macros-plugin == 1.2.0",
57+
"mkdocs-material == 9.5.39",
58+
"mkdocstrings[python] == 0.26.1",
59+
"mkdocstrings-python == 1.11.1",
6060
"frequenz-repo-config[lib] == 0.10.0",
6161
"frequenz-client-base",
6262
]
6363
dev-mypy = [
6464
"mypy == 1.11.2",
6565
"types-Markdown == 3.7.0.20240822",
66-
"types-protobuf == 5.27.0.20240626",
66+
"types-protobuf == 5.28.0.20240924",
6767
"grpc-stubs == 1.53.0.5", # This dependency introduces breaking changes in patch releases
6868
# For checking the noxfile, docs/ script, and tests
6969
"frequenz-client-base[dev-mkdocs,dev-noxfile,dev-pytest]",
7070
]
7171
dev-noxfile = ["nox == 2024.4.15", "frequenz-repo-config[lib] == 0.10.0"]
7272
dev-pylint = [
73-
"pylint == 3.2.7",
73+
"pylint == 3.3.1",
7474
# For checking the noxfile, docs/ script, and tests
7575
"frequenz-client-base[dev-mkdocs,dev-noxfile,dev-pytest]",
7676
]
7777
dev-pytest = [
78-
"pytest == 8.3.2",
78+
"pytest == 8.3.3",
7979
"frequenz-repo-config[extra-lint-examples] == 0.10.0",
8080
"pytest-mock == 3.14.0",
8181
"pytest-asyncio == 0.24.0",
8282
"async-solipsism == 0.7",
83-
"hypothesis == 6.111.2",
83+
"hypothesis == 6.112.2",
8484
"frequenz-client-base",
8585
]
8686
dev = [

src/frequenz/client/base/client.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,9 @@ async def call_stub_method(
258258
) -> StubOutT: ...
259259

260260

261-
async def call_stub_method(
261+
# We need the `noqa: DOC503` because `pydoclint` can't figure out that
262+
# `ApiClientError.from_grpc_error()` returns a `GrpcError` instance.
263+
async def call_stub_method( # noqa: DOC503
262264
client: BaseApiClient[StubT],
263265
stub_method: Callable[[], Awaitable[StubOutT]],
264266
*,

src/frequenz/client/base/retry.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ class LinearBackoff(Strategy):
7979

8080
def __init__(
8181
self,
82+
*,
8283
interval: float = DEFAULT_RETRY_INTERVAL,
8384
jitter: float = DEFAULT_RETRY_JITTER,
8485
limit: int | None = None,
@@ -124,9 +125,9 @@ class ExponentialBackoff(Strategy):
124125
DEFAULT_MULTIPLIER = 2.0
125126
"""Default multiplier for exponential increment."""
126127

127-
# pylint: disable=too-many-arguments
128-
def __init__(
128+
def __init__( # pylint: disable=too-many-arguments
129129
self,
130+
*,
130131
initial_interval: float = DEFAULT_INTERVAL,
131132
max_interval: float = DEFAULT_MAX_INTERVAL,
132133
multiplier: float = DEFAULT_MULTIPLIER,

tests/retry_strategy/test_retry_strategy.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ def test_no_limit(self) -> None:
2323

2424
def test_iter(self) -> None:
2525
"""Test iterator."""
26-
assert list(retry.LinearBackoff(1, 0, 3)) == [1, 1, 1]
26+
assert list(retry.LinearBackoff(interval=1, jitter=0, limit=3)) == [1, 1, 1]
2727

2828
def test_with_limit(self) -> None:
2929
"""Test limit works."""
@@ -89,7 +89,7 @@ def test_with_jitter_with_limit(self) -> None:
8989

9090
def test_deep_copy(self) -> None:
9191
"""Test if deep copies are really deep copies."""
92-
strategy = retry.LinearBackoff(1.0, 0.0, 2)
92+
strategy = retry.LinearBackoff(interval=1.0, jitter=0.0, limit=2)
9393

9494
copy1 = strategy.copy()
9595
assert copy1.next_interval() == 1.0
@@ -108,7 +108,9 @@ class TestExponentialBackoff:
108108

109109
def test_no_limit(self) -> None:
110110
"""Test base case."""
111-
strategy = retry.ExponentialBackoff(3, 30, 2, 0.0)
111+
strategy = retry.ExponentialBackoff(
112+
initial_interval=3, max_interval=30, multiplier=2, jitter=0.0
113+
)
112114

113115
assert strategy.next_interval() == 3.0
114116
assert strategy.next_interval() == 6.0
@@ -119,7 +121,7 @@ def test_no_limit(self) -> None:
119121

120122
def test_with_limit(self) -> None:
121123
"""Test limit works."""
122-
strategy = retry.ExponentialBackoff(3, jitter=0.0, limit=3)
124+
strategy = retry.ExponentialBackoff(initial_interval=3, jitter=0.0, limit=3)
123125

124126
assert strategy.next_interval() == 3.0
125127
assert strategy.next_interval() == 6.0
@@ -128,7 +130,9 @@ def test_with_limit(self) -> None:
128130

129131
def test_deep_copy(self) -> None:
130132
"""Test if deep copies are really deep copies."""
131-
strategy = retry.ExponentialBackoff(3.0, 30.0, 2, 0.0, 2)
133+
strategy = retry.ExponentialBackoff(
134+
initial_interval=3.0, max_interval=30.0, multiplier=2, jitter=0.0, limit=2
135+
)
132136

133137
copy1 = strategy.copy()
134138
assert copy1.next_interval() == 3.0

0 commit comments

Comments
 (0)