Typed objects qol #202

denis-simo · 2026-02-04T01:14:47Z

The first set of changes to Evo typed objects based on user interviews.

Easier access to data that is closer to numpy and pandas via to_dataframe (which effectively is an alias for get_dataframe)
Easier access to attributes pointset.attributes['Au ppm'] instead of pointset.attributes['locations.Au ppm'] or pointset.locations.attributes['Au ppm']
If the user has forgotten to add .json let them be and add it for them.
New accessors to create type objects that don't require the user to know what object type they want to create.
Instead of pointset = await PointSet.from_reference(manager, reference) you cand do poinset = await object_from_reference(manager, reference)
No expectation for the user to specify CRS, it defaults to something sensible if the user does not care about it.
Basic links to Evo stuff. Do we officially support all of them - no, however users don't care and this package can be updated when we next change frontends or decide to support long term links in Evo (and not just blocksync block models)

denis-simo · 2026-02-04T01:19:19Z

packages/evo-sdk-common/src/evo/common/styles/html.py

+        extra_content,
+        '</div>'
+    ]
+    return ''.join(html_parts)


denis-simo · 2026-02-04T01:19:58Z

packages/evo-sdk-common/src/evo/common/styles/html.py

+        border-radius: 3px;
+        padding: 16px;
+        margin: 8px 0;
+        font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;


Reviewing if this needs to align with evo branding or we use the fonts more common in the notebooks.

…typed objects from Evo. THe user does not need to know about the type.

…ng in objects too.

grantroch

I don't understand the Annotation/Schema changes but looked at everything else.

grantroch · 2026-02-04T20:29:13Z

packages/evo-objects/src/evo/objects/typed/_data.py

            raise DataLoaderError("Data was modified since the object was downloaded")
        return await self._obj.download_dataframe(self.as_dict(), fb=fb, column_names=self.data_columns)

+    async def to_dataframe(self, fb: IFeedback = NoFeedback) -> pd.DataFrame:


I think we need to consider this change. We shouldn't have both of these methods around. Decide on one and move on. It seems like Ben already had conversations around this naming and perhaps they already considered to vs get.

We should decide the naming of these methods and pick one convention. I changed from as to get, as the former was brought up as confusing in a code review. I'm not opposed to to.

grantroch · 2026-02-04T20:43:42Z

packages/evo-objects/src/evo/objects/typed/base.py

+        return await self.from_reference(self._context, self.metadata.url)
+
+    def search(self, expression: str) -> Any:
+        """Search the object metadata using a JMESPath expression.


Some more useful examples could be helpful here. I don't really want to lookup what a JMESPath expression. is.

grantroch · 2026-02-04T20:50:15Z

packages/evo-objects/src/evo/objects/typed/base.py

+        # Build unified table with all rows
+        table_rows = []
+        for label, value in rows:
+            if label in ("Bounding box:",) or label.endswith(":") and isinstance(value, str) and "<table" in value:


The "Bounding Box" check is redundant with the endswith check. Also, I don't know if those are necessary as we didn't use to have those first two checks, only the latter checks.

grantroch · 2026-02-04T20:58:24Z

packages/evo-objects/src/evo/objects/typed/regular_grid.py

+        :param fb: Optional feedback object to report download progress.
+        :return: A DataFrame with cell attribute columns.
+        """
+        if keys:


Do we really need this branch? We should support passing no keys as an option.

grantroch · 2026-02-04T20:59:23Z

packages/evo-objects/src/evo/objects/typed/regular_masked_grid.py

+        :param fb: Optional feedback object to report download progress.
+        :return: A DataFrame with cell attribute columns.
+        """
+        if keys:


Likewise, these shouldn't require this branch.

grantroch · 2026-02-04T21:00:18Z

packages/evo-objects/src/evo/objects/typed/tensor_grid.py

+        :param fb: Optional feedback object to report download progress.
+        :return: A DataFrame with cell attribute columns.
+        """
+        if keys:


grantroch · 2026-02-04T21:03:22Z

packages/evo-objects/src/evo/objects/typed/base.py


+
+    @property
+    def viewer_url(self) -> str:


Can these be replaced by the shared functions in evo/common/urls?

BenLewis-Seequent · 2026-02-08T20:00:07Z

packages/evo-objects/src/evo/objects/typed/_data.py

            raise DataLoaderError("Data was modified since the object was downloaded")
        return await self._obj.download_dataframe(self.as_dict(), fb=fb, column_names=self.data_columns)

+    async def to_dataframe(self, fb: IFeedback = NoFeedback) -> pd.DataFrame:


We should decide the naming of these methods and pick one convention. I changed from as to get, as the former was brought up as confusing in a code review. I'm not opposed to to.

BenLewis-Seequent · 2026-02-08T21:35:25Z

packages/evo-objects/src/evo/objects/typed/base.py

+    return await object_from_reference(context, reference)
+
+
+class _BaseObject:


Was there a reason this no longer inherits from SchemaModel? This seems to be duplicating some logic from there.

BenLewis-Seequent · 2026-02-08T21:44:11Z

packages/evo-objects/src/evo/objects/typed/base.py

+        return await object_type._replace(context, reference, data, create_if_missing=True)
+
+
+class ConstructableObject(BaseObject, Generic[_T]):


This doesn't appear to be used.

I initially used this class so that the data parameters to the create/replace/create_or_replace methods had the correct and strict type. i.e. for PointSet, the 'data' parameters would be type PointSetData, so passing a Regular3DGridData, could be picked up by a type checker. I subsequently decided to remove it, for simplification.

BenLewis-Seequent · 2026-02-08T21:47:16Z

packages/evo-objects/src/evo/objects/typed/regular_masked_grid.py

+if TYPE_CHECKING:
+    pass  # Attributes is imported directly above


BenLewis-Seequent · 2026-02-08T21:51:22Z

packages/evo-sdk-common/src/evo/common/urls.py

+    if isinstance(value, str):
+        return value
+
+    # Check for ObjectReference (it's a str subclass with extra attributes)


Wouldn't it already be returned above, as isinstance(value, str) would be true even for a sub-class.

denis-simo added 3 commits February 4, 2026 13:28

Adding basic extensions to typed objects based on user feedback.

64d5187

Added methods that got missed during the porting.

b33baa8

Fixed up the failing test.

d87144b

denis-simo requested review from a team as code owners February 4, 2026 01:14

Fixed up the notebook to remove the outputs.

f59291a

denis-simo commented Feb 4, 2026

View reviewed changes

packages/evo-sdk-common/src/evo/common/styles/html.py

extra_content,

'</div>'

]

return ''.join(html_parts)

Copy link

Author

denis-simo Feb 4, 2026 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

denis-simo commented Feb 4, 2026

View reviewed changes

denis-simo added 2 commits February 4, 2026 14:32

Fixed up the notebook to reflect the new prefered style for creating …

16d82cb

…typed objects from Evo. THe user does not need to know about the type.

Fixed up missing the alignment and added tests to cover pretty printi…

00bf5c1

…ng in objects too.

grantroch reviewed Feb 4, 2026

View reviewed changes

BenLewis-Seequent reviewed Feb 8, 2026

View reviewed changes

		return await object_from_reference(context, reference)


		class _BaseObject:

		return await object_type._replace(context, reference, data, create_if_missing=True)


		class ConstructableObject(BaseObject, Generic[_T]):

		if TYPE_CHECKING:
		pass # Attributes is imported directly above

Typed objects qol #202

Are you sure you want to change the base?

Typed objects qol #202

Uh oh!

Conversation

denis-simo commented Feb 4, 2026

Uh oh!

denis-simo Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

grantroch left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

denis-simo Feb 4, 2026 •

edited

Loading