This is a bugfix release handling an exception while documenting pydantic
models using enums.
Internal
- Simplify model field's constraint extraction removing dependency on private
methods.
Bugfix
- Properly handle constraint extraction avoiding exceptions due to prior
reliance on unpredictable behavior of private attributes.
- Fix incorrect type annotation string results for non-builtin types in
``intercept_type_annotations_py_gt_39``.
Testing
Add pydantic 2.1 to test matrix.
Add tests for various kinds of constrained types.
Add "no exception" tests for specific pydantic models, such as containing
enums.
Contributors
Thanks to nagledb <https://github.com/nagledb>__ for reporting a bug
related to enums
[#169](https://github.com/mansenfranzen/autodoc_pydantic/issues/169) <https://github.com/mansenfranzen/autodoc_pydantic/issues/169>__.
Thanks to jerryjiahaha <https://github.com/jerryjiahaha>__ for providing
a pull request fixing the enums bug
[#170](https://github.com/mansenfranzen/autodoc_pydantic/issues/170) <https://github.com/mansenfranzen/autodoc_pydantic/pull/170>__.
v2.0.0 - 2023-07-24
This is a major release supporting pydantic v2. In June 2023, pydantic v2 was
released while introducing backwards incompatible API and behavioral changes in
comparison to pydantic v1. Supporting pydantic v2 required substantial
adjustments to the codebase leading to a new major release of autodoc_pydantic
(v1.9.0 -> v2.0.0), too.
In order to keep the codebase clean and concise, separate versions for v1 and
v2 were created. The v2 branch will eventually become the new main branch
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)
Updates the requirements on autodoc-pydantic to permit the latest version.
Changelog
Sourced from autodoc-pydantic's changelog.
... (truncated)
Commits
c81dc45
Fix syntax error in pyproject.toml57e7f2a
Merge pull request #172 from mansenfranzen/all-contributors/add-jerryjiahaha6e56479
docs: update .all-contributorsrc [skip ci]f269e4a
docs: update README.md [skip ci]03f201f
Merge pull request #171 from mansenfranzen/all-contributors/add-nagledbe5fde22
docs: update .all-contributorsrc [skip ci]6dca0da
docs: update README.md [skip ci]001504a
Merge pull request #170 from jerryjiahaha/mainafe28cb
Update changelog. Bump version - skip ci.94e979f
More compatibility fixes for various sphinx versions.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)