Clean Pydantic BaseModel objects out of API docs - #1115
Open
TimMonko wants to merge 4 commits into
Open
Conversation
brisvag
reviewed
Aug 20, 2026
brisvag
left a comment
Contributor
There was a problem hiding this comment.
Is there a way to add at least a collapsed section with this, or at least a link to the pydantic docs?
Member
Author
Contributor
|
I like this! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

References and relevant issues
Closes #964
Description
Pydantic v2 causes every
EventedModel-based API page (Viewer, Camera, Colormap, ...) cluttered with inheritedBaseModelmembers. Here we useconf.pyto hide them from the tables and the autodoc Details sections.napari's own overrides (
model_dump,json,model_json_schema) are kept. IMO this is desirable because the API docs aren't just for "everything" but should be a bit more opinionated, especially for most users that don't need these.Dropped from the tables:
copy,dict,construct,parse_*,schema*,validate,from_orm,update_forward_refs), 8 v2 (model_construct,model_copy,model_dump_json,model_parametrized_name,model_rebuild,model_validate*), andmodel_post_initmodel_computed_fields,model_config,model_extra,model_fields,model_fields_set