Skip to content

Allow for model excluded fields in MPDataDoc construction #989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Allow for model excluded fields in MPDataDoc construction #989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ac8738
ensure that MPDataDoc picks up on model-excluded fields
esoteric-ephemera Jun 24, 2025
df5e52e
add user_entries to pourbaix
esoteric-ephemera Jun 27, 2025
2ecdb75
add feature to add user computed entries to pourbaix
esoteric-ephemera Jun 27, 2025
b622cbd
undo unrelated changes
esoteric-ephemera Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions mp_api/client/core/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,7 @@ def api_sanitize(

for model in models:
model_fields_to_leave = {f[1] for f in fields_tuples if model.__name__ == f[0]}
for name in model.model_fields:
field = model.model_fields[name]
field_json_extra = field.json_schema_extra
for name, field in model.model_fields.items():
field_type = field.annotation

if field_type is not None and allow_dict_msonable:
Expand All @@ -88,7 +86,14 @@ def api_sanitize(
new_field = FieldInfo.from_annotated_attribute(
Optional[field_type], None
)
new_field.json_schema_extra = field_json_extra or {}

for attr in (
"json_schema_extra",
"exclude",
):
if (val := getattr(field, attr)) is not None:
setattr(new_field, attr, val)

model.model_fields[name] = new_field

model.model_rebuild(force=True)
Expand Down
4 changes: 2 additions & 2 deletions mp_api/client/routes/materials/phonon.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
from __future__ import annotations

import json
import numpy as np
from collections import defaultdict

import numpy as np
from emmet.core.phonon import PhononBS, PhononBSDOSDoc, PhononDOS
from monty.json import MontyDecoder
from emmet.core.phonon import PhononBSDOSDoc, PhononBS, PhononDOS

from mp_api.client.core import BaseRester, MPRestError
from mp_api.client.core.utils import validate_ids
Expand Down
Loading