Skip to content

Use context-stripped names in str(Expression) #1315

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Use context-stripped names in str(Expression) #1315

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions mathics/core/expression.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ def __repr__(self) -> str:

def __str__(self) -> str:
return "%s[%s]" % (
str(self.head),
self.get_head_name(short=True),
Copy link
Contributor

@mmatera mmatera Jan 24, 2025

Choose a reason for hiding this comment

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

This could be a problem if there are symbols with the same name in different contexts, which is something that you would want to detect in debugging.
Copy link
Member Author

@rocky rocky Jan 24, 2025

Choose a reason for hiding this comment

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

repr still shows the long names.

Personally in my debugging, I don't recall needing this yet. And in WMA I am seeing short names used in errors and tracing.

We could add a user-defined setting, but this is more complicated.
Copy link
Contributor

@mmatera mmatera Jan 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This is because WMA uses FullForm to show expressions "without formatting". For example,

In[1]:= F[s`p,t]//FullForm Out[1]//FullForm= F[s`p, t]
Copy link
Member Author

@rocky rocky Jan 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This is useful and related, but different.

This is a useful Mathics3 user function. But in addition, there is always the need for lower-level displays of elements. These functions get called and appear in error messages as well as in that TraceEvaluation.

What I've been noticing is that WMA does not fill out context paths when reporting error messages and we do. I can't find a good example of this but I am sure you've seen experienced these.
Copy link
Contributor

@mmatera mmatera Jan 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yep, because WMA uses "FullForm". We use just str() or repr()
Copy link
Member Author

@rocky rocky Jan 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Ok - then this can wait until after we have boxing under control and get superseded.
", ".join([str(element) for element in self.elements]),
)

Expand Down Expand Up @@ -765,8 +765,12 @@ def get_elements(self) -> Sequence[BaseElement]:
def get_head(self):
return self._head

def get_head_name(self):
return self._head.name if isinstance(self._head, Symbol) else ""
def get_head_name(self, short=False) -> str:
Copy link
Contributor

@mmatera mmatera Jan 24, 2025

Choose a reason for hiding this comment

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

This is OK
"""Returns an Expression's Head[] as a string. If
`short` is True, we remove leading context paths.
"""
head_name = self._head.name if isinstance(self._head, Symbol) else ""
return head_name.split("`")[-1] if short else head_name

def get_lookup_name(self) -> str:
"""
Expand Down
Loading