add NOTE about fields_not_requested != unset_fields

materialsproject · Dec 17, 2024 · 87c072e · 87c072e
1 parent c176278
commit 87c072e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/mp_api/client/core/client.py b/mp_api/client/core/client.py
@@ -1075,6 +1075,8 @@ def _generate_returned_model(self, doc):
         data_model = create_model(  # type: ignore
             "MPDataDoc",
             **include_fields,
+            # TODO fields_not_requested is not the same as unset_fields
+            # i.e. field could be requested but not available in the raw doc
             fields_not_requested=(list[str], unset_fields),
             __base__=self.document_model,
         )