🩹 Fix schema generation by making private attributes private

[s-weigand]

With pydantic 2 we had crashes when calling .model_json_schema() e.g.

from glotaran.project import Scheme

Scheme.model_json_schema()

The main reason for this was pydatic failure to serialize data_model_type to json since the value is a class.

This can all be prevented by making internal only fields "private" (leading _) so they get excluded from the schema since we don't want users to put values for them anyway.

As @joernweissenborn noted properly typing the fields with ClassVar those variables will also not be considered for the schema.

[github-actions]

👈 Launch a binder notebook on branch s-weigand/pyglotaran/fix-schema-generation

[s-weigand]

This PR is a draft since it depends on #1381

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Files	Coverage Δ
glotaran/builtin/elements/baseline/element.py	90.0% <100.0%> (+0.5%)	⬆️
glotaran/builtin/elements/clp_guide/element.py	100.0% <100.0%> (ø)
...aran/builtin/elements/coherent_artifact/element.py	77.5% <100.0%> (+0.2%)	⬆️
...ran/builtin/elements/damped_oscillation/element.py	94.3% <100.0%> (+<0.1%)	⬆️
glotaran/builtin/elements/kinetic/element.py	89.8% <100.0%> (+0.1%)	⬆️
glotaran/builtin/elements/spectral/element.py	85.0% <100.0%> (+0.3%)	⬆️
glotaran/model/data_model.py	87.5% <ø> (ø)
glotaran/model/element.py	96.6% <ø> (ø)

📢 Thoughts on this report? Let us know!.

[jsnel]

This PR is a draft since it depends on #1381

That PR has been merged, so promoting this PR.

[jsnel]

LGTM. Examples ran successfully.

[joernweissenborn]

Lgtm, but in the long run we should put these things into a ElementConfig class.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication