Skip to content

Handle non-entity fields that are present in includes #626 #627

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
patrick-austin wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Handle non-entity fields that are present in includes #626 #627

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 16 additions & 14 deletions datagateway_api/datagateway_api/icat/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,8 @@ def entity_to_dict(self, entity, includes):
# Verifying that `includes` only has fields which are related to the entity
include_set = (entity.InstRel | entity.InstMRel) & set(includes)
for key in entity.InstAttr | entity.MetaAttr | include_set:
entity_data = getattr(entity, key)
if key in includes:

target = getattr(entity, key)
# Copy and remove don't return values so must be done separately
includes_copy = includes.copy()
try:
Expand All @@ -173,23 +172,26 @@ def entity_to_dict(self, entity, includes):
"Key couldn't be found to remove from include list, this could"
" cause an issue further on in the request",
)
if isinstance(target, Entity):
d[key] = self.entity_to_dict(target, includes_copy)
if isinstance(entity_data, Entity):
d[key] = self.entity_to_dict(entity_data, includes_copy)
continue
# Related fields with one-many relationships are stored as EntityLists
elif isinstance(target, EntityList):
elif isinstance(entity_data, EntityList):
d[key] = []
for e in target:
for e in entity_data:
d[key].append(self.entity_to_dict(e, includes_copy))
continue
# May not actually be an Entity(ies), e.g. type may be in the includes but is also sometimes a str field
# Fall through to usual behaviour below

# Add actual piece of data to the dictionary
else:
entity_data = getattr(entity, key)
# Convert datetime objects to strings ready to be outputted as JSON
if isinstance(entity_data, datetime):
# Remove timezone data which isn't utilised in ICAT
entity_data = DateHandler.datetime_object_to_str(entity_data)

d[key] = entity_data
# Convert datetime objects to strings ready to be outputted as JSON
if isinstance(entity_data, datetime):
# Remove timezone data which isn't utilised in ICAT
entity_data = DateHandler.datetime_object_to_str(entity_data)

d[key] = entity_data

return d

def flatten_query_included_fields(self, includes):
Expand Down