Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump autodoc-pydantic from 1.7.2 to 1.8.0 in /docs #219

Merged
merged 1 commit into from
Nov 2, 2022

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 1, 2022

Bumps autodoc-pydantic from 1.7.2 to 1.8.0.

Changelog

Sourced from autodoc-pydantic's changelog.

v1.8.0 - 2022-10-13

This is a feature and bugfix release with major internal refactorings and added support for pydantic 1.10 and sphinx 5.1 and 5.2.

Feature


- Introduce ``hide-reused-validator`` configuration option for pydantic models
  and settings to hide class methods that are created while declaring functions
  as reusable validators
  `[#122](https://github.com/mansenfranzen/autodoc_pydantic/issues/122) <https://github.com/mansenfranzen/autodoc_pydantic/issues/122>`__.

Bugfix


- Fix incorrect reference of reused validators
  `[#122](https://github.com/mansenfranzen/autodoc_pydantic/issues/122) &lt;https://github.com/mansenfranzen/autodoc_pydantic/issues/122&gt;`__.
- Provide deterministic sort order for model's validator summary and field's
  validator list.
- Hide pydantic user warnings in sphinx output when testing for pydantic field
  serializability.

Internal
</code></pre>
<ul>
<li>Add <code>ValidatorAdapter</code> that provides a standardized interface to pydantic's
validator objects with additional metadata (e.g. root validator) for internal
usage in autodoc_pydantic.</li>
<li>Introduce <code>field_validator_mappings</code> to <code>inspection.ModelInspector</code> which
holds all mappings between fields and validators. It makes many helper
functions of <code>ValidatorInspector</code> and <code>FieldInspector</code> obsolete. Overall,
this greatly simplifies the inspection codebase.</li>
<li>Add <code>PydanticAutoDoc.resolve_inherited_validator_reference</code> to allow
proper reference resolution for inherited validators.</li>
</ul>
<p>Documentation</p>
<pre><code>

  • Add description for autodoc_pydantic_model_hide_reused_validator and
    autodoc_pydantic_settings_hide_reused_validator.
  • Add example section for reused validators with detailed explanation.
  • Refactor sphinx extension helper for building autodoc_pydantic docs
    for better readability and maintainability.
  • Add example_path to sphinx extension helper config_description.
  • Add FAQ question regarding interoperability with autoapi.

Testing

</tr></table>

... (truncated)

Commits
  • 7d0dbfd Merge pull request #142 from mansenfranzen/support_pydantic_110
  • 7490c1d Update changelog - skip ci.
  • 205c7f0 Provide compatibility for changed behavior of module doc string in sphinx 5.2.
  • 6a8badf Remove sphinx version pin.
  • e9bd574 Allow python 3.6.
  • d3a7b8d Fix bug in requires_forward_ref.
  • 71d0f82 Add pydantic import again to check self reference tests.
  • b925a2a Add missing comma in env spec list.
  • e674783 Adjust tests for pydantic 1.10. Properly compare pydantic version.
  • ae4fead Add tests for Sphinx 5.1, 5.2 and pydantic 1.10.
  • Additional commits viewable in compare view

Dependabot compatibility score

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 commands and options

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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Nov 1, 2022
Bumps [autodoc-pydantic](https://github.com/mansenfranzen/autodoc_pydantic) from 1.7.2 to 1.8.0.
- [Release notes](https://github.com/mansenfranzen/autodoc_pydantic/releases)
- [Changelog](https://github.com/mansenfranzen/autodoc_pydantic/blob/main/changelog.rst)
- [Commits](mansenfranzen/autodoc_pydantic@v1.7.2...v1.8.0)

---
updated-dependencies:
- dependency-name: autodoc-pydantic
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/docs/autodoc-pydantic-1.8.0 branch from 764b99c to 4b2f666 Compare November 2, 2022 13:40
@yfukai yfukai merged commit 6dd9c6f into main Nov 2, 2022
@dependabot dependabot bot deleted the dependabot/pip/docs/autodoc-pydantic-1.8.0 branch November 2, 2022 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant