Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

feat: 433 Creates a Dict from a given json List #437

Merged
merged 11 commits into from
Apr 21, 2022

Conversation

jofaul
Copy link
Contributor

@jofaul jofaul commented Apr 8, 2022

Closes #433.

Summary of Changes

New class and package to generate the annotations dict for a given file (path), given that the file is a json file that contains a list of unused sklearn functions or classes. This dict is to be used in #436.

Testing instructions

Test classes were written, just run them. Further Testing can be done with help of the json file from #436 and the API-editor Client itself (import the json and test if it added annotations are correct).

@jofaul jofaul changed the title Creates a Dict from a given json List feat: Creates a Dict from a given json List Apr 8, 2022
@github-actions
Copy link

github-actions bot commented Apr 8, 2022

MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ CREDENTIALS secretlint yes no 3.86s
✅ GIT git_diff yes no 0.01s
✅ JSON eslint-plugin-jsonc 1 0 0 1.08s
✅ JSON jsonlint 1 0 0.27s
✅ JSON prettier 1 0 0 0.53s
✅ JSON v8r 1 0 1.33s
✅ PYTHON black 4 0 0 0.37s
✅ PYTHON isort 4 0 0 0.17s
✅ PYTHON mypy 4 0 20.64s

See errors details in artifact MegaLinter reports on CI Job page
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

@jofaul
Copy link
Contributor Author

jofaul commented Apr 8, 2022

@lars-reimann der eine Test schlägt fehl, weil wir da eine Datei lesen wollen die nicht gefunden wird - gibt es eine Möglichkeit den Test erfolgreich laufen zu lassen? @Aclrian wenn du noch eine Idee hast probiers gerne :D

@jofaul jofaul added the enhancement 💡 New feature or request label Apr 8, 2022
@GideonKoenig GideonKoenig changed the title feat: Creates a Dict from a given json List feat: 433 Creates a Dict from a given json List Apr 17, 2022
@GideonKoenig GideonKoenig self-assigned this Apr 17, 2022
@lars-reimann
Copy link
Member

Only suggestion I have would be more user-focused PR titles. "433 Creates a Dict from a given json List" is very technical and does not describe what this PR actually accomplishes.

@GideonKoenig GideonKoenig merged commit f6fc3fa into main Apr 21, 2022
@GideonKoenig GideonKoenig deleted the 433-automatisch-unused-annotation-generieren branch April 21, 2022 12:17
lars-reimann pushed a commit that referenced this pull request Nov 2, 2022
)

Bumps [numpydoc](https://github.com/numpy/numpydoc) from 1.4.0 to 1.5.0.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/numpy/numpydoc/blob/main/doc/release_notes.rst">numpydoc's
changelog</a>.</em></p>
<blockquote>
<h2>1.5.0</h2>
<p>Release date: 8 October 2022</p>
<p>Requires Python 3.7+ and Sphinx 4.2+.</p>
<p><code>Full Changelog
&lt;https://github.com/numpy/numpydoc/compare/v1.4.0...v1.5.0&gt;</code>__</p>
<p>Fixed bugs</p>
<pre><code>
- Parsing ``returns`` section with several types and no name
`[#428](numpy/numpydoc#428)
&lt;https://github.com/numpy/numpydoc/issues/428&gt;`__
- BUG: Fix returns parsing no name
`[#429](numpy/numpydoc#429)
&lt;https://github.com/numpy/numpydoc/pull/429&gt;`__ (`rossbar
&lt;https://github.com/rossbar&gt;`__)
<p>Closed issues
</code></pre></p>
<ul>
<li>readthedocs build failing
<code>[#439](numpy/numpydoc#439)
&lt;https://github.com/numpy/numpydoc/issues/439&gt;</code>__</li>
<li>Exclude class properties from being listed under METHODS section
<code>[#339](numpy/numpydoc#339)
&lt;https://github.com/numpy/numpydoc/issues/339&gt;</code>__</li>
<li>BUG: Numpydoc doesn’t render attributes decorated with
<code>cached\_property</code> in the Attributes section
<code>[#432](numpy/numpydoc#432)
&lt;https://github.com/numpy/numpydoc/issues/432&gt;</code>__</li>
<li>Is numpydoc_use_blockquotes deprecated or not yet?
<code>[#420](numpy/numpydoc#420)
&lt;https://github.com/numpy/numpydoc/issues/420&gt;</code>__</li>
<li>No light theme available in docs
<code>[#413](numpy/numpydoc#413)
&lt;https://github.com/numpy/numpydoc/issues/413&gt;</code>__</li>
<li>1.4.0 release plan
<code>[#408](numpy/numpydoc#408)
&lt;https://github.com/numpy/numpydoc/issues/408&gt;</code>__</li>
</ul>
<p>Merged pull requests</p>
<pre><code>
- Update doc requirements
`[#441](numpy/numpydoc#441)
&lt;https://github.com/numpy/numpydoc/pull/441&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Update pydata-sphinx-theme
`[#440](numpy/numpydoc#440)
&lt;https://github.com/numpy/numpydoc/pull/440&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Support Python 3.11
`[#438](numpy/numpydoc#438)
&lt;https://github.com/numpy/numpydoc/pull/438&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Update precommit hooks
`[#437](numpy/numpydoc#437)
&lt;https://github.com/numpy/numpydoc/pull/437&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Use Python 3.10 to build docs
`[#436](numpy/numpydoc#436)
&lt;https://github.com/numpy/numpydoc/pull/436&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Use `requirements/*.txt` files for CI
`[#435](numpy/numpydoc#435)
&lt;https://github.com/numpy/numpydoc/pull/435&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Fix front page `[#434](numpy/numpydoc#434)
&lt;https://github.com/numpy/numpydoc/pull/434&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Add cached property support
`[#433](numpy/numpydoc#433)
&lt;https://github.com/numpy/numpydoc/pull/433&gt;`__ (`rossbar
&lt;https://github.com/rossbar&gt;`__)
- ENH: Update validate.py to allow parameters with trailing underscores.
`[#425](numpy/numpydoc#425)
&lt;https://github.com/numpy/numpydoc/pull/425&gt;`__ (`stefmolin
&lt;https://github.com/stefmolin&gt;`__)
- DOC: Use ``:ref:`` when referring to section headers
`[#424](numpy/numpydoc#424)
&lt;https://github.com/numpy/numpydoc/pull/424&gt;`__ (`namurphy
&lt;https://github.com/namurphy&gt;`__)
- Remove numpydoc_use_blockquotes
`[#422](numpy/numpydoc#422)
&lt;https://github.com/numpy/numpydoc/pull/422&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Require sphinx&gt;=4.2 (cleanup)
`[#421](numpy/numpydoc#421)
&lt;https://github.com/numpy/numpydoc/pull/421&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- docs: fix validation include line numbers
`[#418](numpy/numpydoc#418)
&lt;https://github.com/numpy/numpydoc/pull/418&gt;`__ (`thatlittleboy
&lt;https://github.com/thatlittleboy&gt;`__)
- Update precommit linters
`[#417](numpy/numpydoc#417)
&lt;https://github.com/numpy/numpydoc/pull/417&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- Update GH actions
`[#416](numpy/numpydoc#416)
&lt;https://github.com/numpy/numpydoc/pull/416&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
- ENH: Add support for dict show_inherited_class_members
`[#415](numpy/numpydoc#415)
&lt;https://github.com/numpy/numpydoc/pull/415&gt;`__ (`larsoner
&lt;https://github.com/larsoner&gt;`__)
- DOC: Add theme switcher and default to lightmode.
`[#414](numpy/numpydoc#414)
&lt;https://github.com/numpy/numpydoc/pull/414&gt;`__ (`rossbar
&lt;https://github.com/rossbar&gt;`__)
- Require sphinx&gt;=4.2
`[#411](numpy/numpydoc#411)
&lt;https://github.com/numpy/numpydoc/pull/411&gt;`__ (`jarrodmillman
&lt;https://github.com/jarrodmillman&gt;`__)
<p>* <em>This Changelog was automatically generated by</em>\
<code>github_changelog_generator
&amp;lt;https://github.com/github-changelog-generator/github-changelog-generator&amp;gt;</code>__
</code></pre></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/numpy/numpydoc/commit/3a8a96cda5e04ef77caa076be1fcd115e3987b62"><code>3a8a96c</code></a>
Designate 1.5.0 release</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/c6338c7607355f38c382017e5f492f50e1b44da9"><code>c6338c7</code></a>
Update doc requirements (<a
href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/441">#441</a>)</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/72e9cd4dae1d451ca24f06e0fa7a82285b381139"><code>72e9cd4</code></a>
Update pydata-sphinx-theme (<a
href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/440">#440</a>)</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/8b983feb66ffcbebebe58aa5d10fea6c2a66207f"><code>8b983fe</code></a>
Bump version</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/26cfa5847df5cdd6c0fa49c9be410fdfac2c7afe"><code>26cfa58</code></a>
Designate 1.5.0rc1 release</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/664e7144ece8f0779b18f6282ed7a42e35f130ab"><code>664e714</code></a>
Suport Python 3.11 (<a
href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/438">#438</a>)</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/4c74647afc82a1b352701a52f0f1a33891dbd3ff"><code>4c74647</code></a>
Fix front page (<a
href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/434">#434</a>)</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/ddcf0fea7a68d9f826ed863588ecc494b11d83a4"><code>ddcf0fe</code></a>
Add cached property support (<a
href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/433">#433</a>)</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/94b7a844a8ed956a2fc2f17cf0630ae54af323ea"><code>94b7a84</code></a>
Update precommit hooks (<a
href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/437">#437</a>)</li>
<li><a
href="https://github.com/numpy/numpydoc/commit/db404754f0cd7bb0927280e769bc8c9d95a2e42d"><code>db40475</code></a>
Use Python 3.10 to build docs (<a
href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/436">#436</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/numpy/numpydoc/compare/v1.4.0...v1.5.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=numpydoc&package-manager=pip&previous-version=1.4.0&new-version=1.5.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 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] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement 💡 New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatisch unused Annotation generieren
4 participants