Skip to content
This repository has been archived by the owner on Jan 2, 2025. It is now read-only.

Commit

Permalink
Add __repr__ for Registry.__repr__(cls) (#400)
Browse files Browse the repository at this point in the history 
* __repr__ draft

Signed-off-by: zethson <[email protected]>

* Add __repr__ for Registry.__repr__(cls)

Signed-off-by: zethson <[email protected]>

* Refactoring

Signed-off-by: zethson <[email protected]>

* pre-commit

Signed-off-by: zethson <[email protected]>

* Add proper schema types

Signed-off-by: zethson <[email protected]>

* Add primitive types

Signed-off-by: zethson <[email protected]>

* Differentiate between bionty fields and other fields

Signed-off-by: zethson <[email protected]>

* 🎨 Restore original order

Signed-off-by: zethson <[email protected]>

* ✨ Generalize to more schemas

Signed-off-by: zethson <[email protected]>

* 🎨 Include FKs and simplify

Signed-off-by: zethson <[email protected]>

* 🎨 Reorder by base class

Signed-off-by: zethson <[email protected]>

* 🎨 Rename to Basic fields

Signed-off-by: zethson <[email protected]>

* 🎨 Refactor

Signed-off-by: zethson <[email protected]>

* 🎨 Refactor

Signed-off-by: zethson <[email protected]>

* 🎨 Refactoring

Signed-off-by: zethson <[email protected]>

---------

Signed-off-by: zethson <[email protected]>
  • Loading branch information
@Zethson
Zethson authored Jul 19, 2024
1 parent 3b61f8f commit e81faa6
Showing 1 changed file with 176 additions and 3 deletions.
179 changes: 176 additions & 3 deletions lnschema_core/models.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,16 @@
)

from django.db import models
from django.db.models import CASCADE, PROTECT
from django.db.models import CASCADE, PROTECT, Field
from django.db.models.base import ModelBase
from lamin_utils import logger
from lamindb_setup import _check_instance_setup, settings
from django.db.models.fields.related import (
ForeignKey,
ManyToManyField,
ManyToManyRel,
ManyToOneRel,
)
from lamin_utils import colors, logger
from lamindb_setup import _check_instance_setup

from lnschema_core.types import (
CharField,
Expand Down Expand Up @@ -520,6 +526,173 @@ def include_attribute(attr_name, attr_value):
result.append(attr)
return result

def __repr__(cls) -> str:
"""Designed to show schema version when Records are called directly.
Divided into several parts:
1. Header
2. Basic fields where we first show class specific fields and then base class fields
3. Relational fields where we show class specific relational fields and then base class fields
4. External schema fields where we show loaded schemas such as Bionty, wetlab and others
"""

def _get_type_for_field(field_name: str) -> str:
field = cls._meta.get_field(field_name)
related_model_name = (
field.related_model.__name__
if hasattr(field, "related_model") and field.related_model
else None
)
return (
related_model_name if related_model_name else field.get_internal_type()
)

def _get_base_class_fields(cls: models.Model) -> list[str]:
return [
field.name
for base in cls.__bases__
if hasattr(base, "_meta")
for field in base._meta.get_fields()
]

def _reorder_fields_by_class(fields_to_order: list[Field]) -> list[Field]:
"""Reorders the fields so that base class fields come last."""
non_base_class_fields = [
field
for field in fields_to_order
if field.name not in _get_base_class_fields(cls)
]
found_base_class_fields = [
field
for field in fields_to_order
if field.name in _get_base_class_fields(cls)
]
return non_base_class_fields + found_base_class_fields

# ---Header---
repr_str = f"{colors.green(cls.__name__)}\n"

# ---Basic fields---
basic_fields = [
field
for field in cls._meta.get_fields()
if not (
isinstance(field, ManyToOneRel)
or isinstance(field, ManyToManyRel)
or isinstance(field, ManyToManyField)
or isinstance(field, ForeignKey)
)
]
basic_fields = _reorder_fields_by_class(basic_fields)

repr_str += f" {colors.italic('Basic fields')}\n"
if basic_fields:
repr_str += "".join(
[
f" .{field_name.name}: {_get_type_for_field(field_name.name)}\n"
for field_name in basic_fields
]
)

# ---Relational fields---
relational_fields = (ManyToOneRel, ManyToManyRel, ManyToManyField, ForeignKey)

class_specific_relational_fields = [
field
for field in cls._meta.fields + cls._meta.many_to_many
if isinstance(field, relational_fields)
and not field.name.endswith("_links")
]

non_class_specific_relational_fields = [
field
for field in cls._meta.get_fields()
if isinstance(field, relational_fields)
and not field.name.endswith("_links")
]
non_class_specific_relational_fields = _reorder_fields_by_class(
non_class_specific_relational_fields
)

# Ensure that class specific fields (e.g. Artifact) come before non-class specific fields (e.g. collection)
filtered_non_class_specific = [
field
for field in non_class_specific_relational_fields
if field not in class_specific_relational_fields
]
ordered_relational_fields = (
class_specific_relational_fields + filtered_non_class_specific
)

non_external_schema_fields = []
external_schema_fields = []
for field in ordered_relational_fields:
field_name = repr(field).split(": ")[1][:-1]
if field_name.count(".") == 1 and "lnschema_core" not in field_name:
external_schema_fields.append(field)
else:
non_external_schema_fields.append(field)

def _get_related_field_type(field) -> str:
field_type = (
field.related_model.__get_name_with_schema__()
.replace(
"Artifact", ""
) # some fields have an unnecessary 'Artifact' in their name
.replace(
"Collection", ""
) # some fields have an unnecessary 'Collection' in their name
)
return (
_get_type_for_field(field.name)
if not field_type.strip()
else field_type
)

non_external_schema_fields_formatted = [
f" .{field.name.replace('_links', '')}: {_get_related_field_type(field)}\n"
for field in non_external_schema_fields
]
external_schema_fields_formatted = [
f" .{field.name.replace('_links', '')}: {_get_related_field_type(field)}\n"
for field in external_schema_fields
]

# Non-external relational fields
if non_external_schema_fields:
repr_str += f" {colors.italic('Relational fields')}\n"
repr_str += "".join(non_external_schema_fields_formatted)

# External relational fields
external_schemas = set()
for field in external_schema_fields_formatted:
field_type = field.split(":")[1].split()[0]
external_schemas.add(field_type.split(".")[0])

if external_schemas:
# We want Bionty to show up before other schemas
external_schemas = (
["bionty"] + sorted(external_schemas - {"bionty"}) # type: ignore
if "bionty" in external_schemas
else sorted(external_schemas)
)
for ext_schema in external_schemas:
ext_schema_fields = [
field
for field in external_schema_fields_formatted
if ext_schema in field
]

if ext_schema_fields:
repr_str += (
f" {colors.italic(f'{ext_schema.capitalize()} fields')}\n"
)
repr_str += "".join(ext_schema_fields)

repr_str = repr_str.rstrip("\n")

return repr_str

def from_values(
cls,
values: ListLike,
Expand Down

0 comments on commit e81faa6

Please sign in to comment.