Reorganize BaseModel annotations

[kc0506]

Change Summary

As per microsoft/pylance-release#6253, attribute docstrings are recommended to be placed in the top level of the class. I added several changes to #10104 to make tests pass.

The only tests that need to be modified are in test_type_hints, because typing.get_type_hints does not have access to types imported inside if TYPE_CHECKING blocks. Otherwise, we will have to import pydantic_core and pydantic.fields in pydantic.main only for type hint, which seems not ideal.

Related issue number

#10104

Checklist

• The pull request title is a good summary of the changes - it will be used in the changelog
• Unit tests for the changes exist
• Tests pass on CI
• Documentation reflects the changes where applicable
• My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

[codspeed-hq]

CodSpeed Performance Report

Merging #10110 will not alter performance

_{Comparing kc0506:reorganize-basemodel-attributes (c988e2e) with main (58abc3d)}

Summary

✅ 17 untouched benchmarks

[kc0506]

Coudn't figure out why tests for python 3.8 failed 👀
Followed every steps from ci.yml in my python 3.8 virtualenv but no error occurs

(pydantic-3.8) (base) kc0506@kc0506:~/pydantic$ make test
PDM, version 2.17.3
pdm run coverage run -m pytest --durations=10
======================================================= test session starts =======================================================
platform linux -- Python 3.8.18, pytest-8.3.2, pluggy-1.5.0
codspeed: 2.2.1 (callgraph: not supported)
benchmark: 4.0.0 (defaults: timer=time.perf_counter disable_gc=False min_rounds=5 min_time=0.000005 max_time=1.0 calibration_precision=10 warmup=True warmup_iterations=100000)
rootdir: /home/kc0506/pydantic
configfile: pyproject.toml
testpaths: tests
plugins: benchmark-4.0.0, Faker-26.1.0, examples-0.0.12, mock-3.14.0, pretty-1.2.0, codspeed-2.2.1
collected 5814 items / 1 skipped        

[sydney-runkle]

Looks similar to https://github.com/pydantic/pydantic/pull/10104/files, which @Viicos closed. Let's get his feedback here given that he was recently working on this 👍

[Viicos]

Thanks for giving a shot at this. I decided to close the previous PR as I saw it would require too much changes for a small added value.

However, I think I like the approach taken here.

Note that this is not a full review, I'll go a bit more in depth tomorrow morning.

---

Regarding the failing test, this is because Python 3.10 changed the way __annotations__ works. Prior to 3.10, __annotations__ would inherit the defined annotations from the base(s) class(es).

I'll take a look at a hopefully easy way to handle this.

[kc0506]

I forgot we could just clear BaseModel.__annotations__ at runtime 😅
Seems much cleaner than manually excluding BaseModel when evaluating type notations.

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
pydantic
main.py
pydantic/_internal
_fields.py
_model_construction.py
_typing_extra.py
Project Total

This report was generated by python-coverage-comment-action

[Viicos]

Thanks this is looking great. A few more comments. Would be awesome if you could update the description in the Attributes: section as well.

Ideally we should avoid the duplication but we seem to be limited by how mkdocstrings-python handle things :/

[kc0506]

@Viicos Thanks for the detailed suggestions!

[sydney-runkle]

Great work! Thanks @Viicos for giving some detailed line by line feedback.

[Viicos]

Awesome @kc0506