Add Box type annotations to render routines. #1674

rocky · 2026-02-03T14:55:53Z

Add Box type annotations to render routines
Remove "_" from non-private classes. Go over render docstrings.
Fix type errors found by mypy:
- Initialize BoxExpression.boxes.
- Initialize GraphicsBox.boxwidth.
- Initialize GraphicsBox.boxheight

Also: remove "_" from non-private classes. Go over render docstrings.

rocky · 2026-02-03T15:04:43Z

@mmatera: you asked for changes in #1671 to be split out.

Here, we just go over type annotations. This aspect was, in fact, a larger problem than just MathML. But it should come first because, in order have a more informed discussion of MathML, we need a better foundation.

The changes here seem larger than what's really going on: renaming "self" to "box" and adding specific type definitions. (And in doing so, already I am seeing a type failure.)

mmatera · 2026-02-03T15:36:32Z

I am seing now some type errors in master too, with the latest version of mypy (1.19.1). Some of the errors here should be fixed by adding an assertion / condition to narrow the type of the argument. But I guess that in all the render routines, the type of the argument box should be BoxElementMixin, and then narrow them inside each function.

mmatera · 2026-02-03T15:36:48Z

BTW, thanks for the work of splitting this in parts.

mmatera · 2026-02-03T15:38:03Z

mathics/builtin/box/graphics.py



-class _GraphicsElementBox(BoxExpression, ABC):
+class GraphicsElementBox(BoxExpression, ABC):


I think the underscore was to avoid considering this class as a Builtin to be shown in the documentation.

(In WMA this builtin does not exist)

I think the underscore was to avoid considering this class as a Builtin to be shown in the documentation.

The entire module is marked no-doc. So this should no longer be a reason for having an underscore. In Python, an underscore typically indicates a private class, and this is not private. If it had an underscore previously, that was the wrong way to solve the problem. But at any rate this problem does not exist.

(In WMA this builtin does not exist)

I don't understand what this is getting at. We have many classes in Mathics3 and some built-in function classes that do not exist in WMA.

I think the underscore was to avoid considering this class as a Builtin to be shown in the documentation.

The entire module is marked no-doc. So this should no longer be a reason for having an underscore. In Python, an underscore typically indicates a private class, and this is not private. If it had an underscore previously, that was the wrong way to solve the problem. But at any rate this problem does not exist.

It should not be loaded as a Built-in symbol. Check what happens in the CLI when you entry

?BoxGraphicsElement

The underscore prevents that this class contribute with a definition. But this is a symptom that this module does not belongs to mathics.builtin.box module.

This is what I get in this branch:

In[1]:= ? GraphicsElementBox Out[1]= box representation for a graphics element Attributes[GraphicsElementBox] = {Protected, ReadProtected}

It should not be loaded as a Built-in symbol. Check what happens in the CLI when you entry

?BoxGraphicsElement

I think you mean ?GraphicsElementBox, right?

The underscore prevents that this class contribute with a definition. But this is a symptom that this module does not belongs here.

If it gets renamed with the word Box first, I don't think that will get added as a definition, right? I think that's how BoxExpression works, right?

It should not be loaded as a Built-in symbol. Check what happens in the CLI when you entry
?BoxGraphicsElement

I think you mean ?GraphicsElementBox, right?

yep

The underscore prevents that this class contribute with a definition. But this is a symptom that this module does not belongs here.

If it gets renamed with the word Box first, I don't think that will get added as a definition, right? I think that's how BoxExpression works, right?

We was very clever if we did that...

As it is, it is loaded. But OK, it is not terrible. We can adjust it later.

I just looked at the code. What is done to define list DOES_NOT_ADD_BUILTIN_DEFINITION = [...] in the module.

See https://github.com/Mathics3/mathics-core/blob/master/mathics/builtin/forms/base.py#L51

And that is far better than overloading the meaning of underscore at the beginning of a list. I'll add this in there now.

Initialize: * BoxExpression.boxes * GraphicsBox.boxwidth * GraphicsBox.boxheight * GrapnicsBox.boxes Make sure to convert sympy.Float to Python float

rocky · 2026-02-03T15:55:08Z

I am seing now some type errors in master too, with the latest version of mypy (1.19.1). Some of the errors here should be fixed by adding an assertion / condition to narrow the type of the argument.

Ok.

But I guess that in all the render routines, the type of the argument box should be BoxElementMixin, and then narrow them inside each function.

I don't think "all", but just the top-level generic ones.

mmatera · 2026-02-03T16:30:41Z

I don't think "all", but just the top-level generic ones.

I mean, all the functions which are registered.

rocky · 2026-02-03T16:39:31Z

I don't think "all", but just the top-level generic ones.

I mean, all the functions which are registered.

This is not the situation for RowBox, and several other boxes like that. def rowbox(box: RowBox..) should always get passed a RowBox.

mmatera

LGTM. Merge when you feel it is ready.

so ??GraphicsElementBox is not predefined inside a Mathics3 session.

rocky · 2026-02-03T17:23:13Z

LGTM. Merge when you feel it is ready.

Great! Tomorrow, I'll look over the separation of box attributes, which belong to the box object, from boxing options, which are passed via the **options parameter.

After that, we can then start a discussion on the code that needs to compute box information and where and how that should work.

Add Box type annotations to render routines.

6c529bd

Also: remove "_" from non-private classes. Go over render docstrings.

mmatera reviewed Feb 3, 2026

View reviewed changes

Fix type errors found by mypy

3c53f98

Initialize: * BoxExpression.boxes * GraphicsBox.boxwidth * GraphicsBox.boxheight * GrapnicsBox.boxes Make sure to convert sympy.Float to Python float

rocky force-pushed the add-box-type-annotations branch from 0fcab42 to 7325a25 Compare February 3, 2026 16:06

More mypy/type work.

942752a

rocky force-pushed the add-box-type-annotations branch from 7325a25 to 942752a Compare February 3, 2026 16:40

mmatera approved these changes Feb 3, 2026

View reviewed changes

Exclude GraphicsElementBox from definition...

6710a35

so ??GraphicsElementBox is not predefined inside a Mathics3 session.

rocky merged commit 3a11b75 into master Feb 3, 2026
21 checks passed

rocky deleted the add-box-type-annotations branch February 3, 2026 17:19



		class _GraphicsElementBox(BoxExpression, ABC):
		class GraphicsElementBox(BoxExpression, ABC):

Uh oh!

Add Box type annotations to render routines. #1674

Add Box type annotations to render routines. #1674

Uh oh!

Conversation

rocky commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rocky commented Feb 3, 2026

Uh oh!

mmatera commented Feb 3, 2026

Uh oh!

mmatera commented Feb 3, 2026

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!

mmatera Feb 3, 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!

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!

rocky commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmatera commented Feb 3, 2026

Uh oh!

rocky commented Feb 3, 2026

Uh oh!

mmatera left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rocky commented Feb 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rocky commented Feb 3, 2026 •

edited

Loading

mmatera Feb 3, 2026 •

edited

Loading

rocky commented Feb 3, 2026 •

edited

Loading