Any way to hide Pydantic 2.0 class internals?

[aaronsteers]

Problem Description

My class declaration has no members declared explicitly. However, the pdoc text generated includes some garbage internals from the Pydantic class, while not actually documenting any of the superclass's members. I would like to just globally suppress these:

• model_config
• model_post_init
• model_fields
• model_computed_fields

My class documentation index looks like this since migrating to Pydantic 2.0:

Since I'm not declaring these directly in my own code, I don't have a way to suppress them with a @private annotation or similar.

Steps to reproduce the behavior:

Create a class from Pydantic 2.0 BaseModel.

System Information

Paste the output of "pdoc --version" here.

pdoc: 14.5.1
Python: 3.10.12
Platform: macOS-14.5-arm64-arm-64bit

[elliot-100]

This seems to work (with a caveat re #714 ) if you add it to the superclass:

def model_fields(self):
    """@private"""
    pass

[mhils]

My suggestion here would be to use a custom template that overrides is_public:

pdoc/examples/custom-template/module.html.jinja2

Lines 21 to 32 in 8939754

	{#
	We can also adjust which members are documented by overriding the is_public macro.
	In this example, the private function `Dog.__lt__` is exposed publicly.
	However, doing this is not recommended, see https://pdoc.dev/docs/pdoc.html#control-what-is-documented.
	#}
	{% macro is_public(doc) %}
	{% if doc.qualname == "Dog.__lt__" %}
	true
	{% else %}
	{{ default_is_public(doc) }}
	{% endif %}
	{% endmacro %}

[JPHutchins]

My suggestion here would be to use a custom template that overrides is_public:

pdoc/examples/custom-template/module.html.jinja2

Lines 21 to 32 in 8939754

	{#
	We can also adjust which members are documented by overriding the is_public macro.
	In this example, the private function `Dog.__lt__` is exposed publicly.
	However, doing this is not recommended, see https://pdoc.dev/docs/pdoc.html#control-what-is-documented.
	#}
	{% macro is_public(doc) %}
	{% if doc.qualname == "Dog.__lt__" %}
	true
	{% else %}
	{{ default_is_public(doc) }}
	{% endif %}
	{% endmacro %}

I've found that this example syntax is not quite right. The inline comments of default_is_public state that false is given by an empty string rather than a literal boolean.

{#
We can also adjust which members are documented by overriding the is_public macro.
#}
{% macro is_public(doc) %}
    {% if doc.name.startswith("model_") %}
        {# False #}
    {% else %}
        {{ default_is_public(doc) }}
    {% endif %}
{% endmacro %}

I'm not sure what's right, but this is what finally worked for me.

[JPHutchins]

I'll be looking into filtering at the BaseModel inheritance as well since it is irrelevant to users.

[JPHutchins]

Thinking about it more, what I'm really looking for is filtering out inheritance that's not in the repo. That is, it can't be linked to. For example, it's not helpful to tell my users about all the builtin methods on a bytes object 🤣