Skip to content

Feat: tolerant load entity #104

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

Merged
merged 3 commits into from
Feb 20, 2025
Merged

Feat: tolerant load entity #104

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1d996e
Feat: tolerant load_entity via model_to_use param implemented
LukasGold Feb 20, 2025
b5ad52f
Fix: Wring type for query_instance arg "category"
LukasGold Feb 20, 2025
3c2e706
Fix: Printing wrong variable
LukasGold Feb 20, 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
40 changes: 26 additions & 14 deletions src/osw/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,6 +712,9 @@ class LoadEntityParam(BaseModel):
autofetch_schema: Optional[bool] = True
"""If true, load the corresponding schemas /
categories ad-hoc if not already present"""
model_to_use: Optional[Type[OswBaseModel]] = None
"""If provided this model will be used to create an entity (instance of the
model), instead of instantiating the autofetched schema."""
remove_empty: Optional[bool] = True
"""If true, remove key with an empty string, list, dict or set as value
from the jsondata."""
Expand Down Expand Up @@ -770,6 +773,9 @@ def load_entity(
else:
param = entity_title

if param.model_to_use:
print(f"Using schema {param.model_to_use.__name__} to create entity")

# store original cache state
cache_state = self.site.get_cache_enabled()
if param.disable_cache:
Expand Down Expand Up @@ -797,23 +803,29 @@ def load_entity(
schemas.append(schema)
# generate model if not already exists
cls_name: str = schema["title"]
if not hasattr(model, cls_name):
if param.autofetch_schema:
self.fetch_schema(
OSW.FetchSchemaParam(
schema_title=category, mode="append"
# If a schema_to_use is provided, we do not need to check if the
# model exists
if not param.model_to_use:
if not hasattr(model, cls_name):
if param.autofetch_schema:
self.fetch_schema(
OSW.FetchSchemaParam(
schema_title=category, mode="append"
)
)
if not hasattr(model, cls_name):
schemas_fetched = False
print(
f"Error: Model {cls_name} not found. Schema {category} "
f"needs to be fetched first."
)
if not hasattr(model, cls_name):
schemas_fetched = False
print(
f"Error: Model {cls_name} not found. Schema {category} "
f"needs to be fetched first."
)
if not schemas_fetched:
continue

if len(schemas) == 0:
if param.model_to_use:
entity: model.OswBaseModel = param.model_to_use(**jsondata)

elif len(schemas) == 0:
print("Error: no schema defined")

elif len(schemas) == 1:
Expand Down Expand Up @@ -1055,7 +1067,7 @@ def set_content(content_to_set: dict) -> None:
if param.remove_empty:
remove_empty(local_content["jsondata"])
if param.debug:
print(f"'local_content': {str(remote_content)}")
print(f"'local_content': {str(local_content)}")
# Apply the overwrite logic
# a) If there is a key in the remote content that is not in the local
# content, we have to keep it
Expand Down Expand Up @@ -1513,7 +1525,7 @@ def __init__(self, **data):
self._titles = [parts["title"] for parts in self._category_string_parts]

def query_instances(
self, category: Union[str, OswBaseModel, OSW.QueryInstancesParam]
self, category: Union[str, Type[OswBaseModel], OSW.QueryInstancesParam]
) -> List[str]:
if not isinstance(category, OSW.QueryInstancesParam):
category = OSW.QueryInstancesParam(categories=category)
Expand Down
Loading