Skip to content
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.

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

Add feature to print result parts to console #56

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

paul019
Copy link
Collaborator

@paul019 paul019 commented Aug 7, 2024

Resolve #28

@paul019 paul019 requested a review from Splines August 7, 2024 21:49
src/api/printable_result.py Show resolved Hide resolved
Comment on lines 21 to 23
def get_str_value(self) -> str:
stringifier = ConsoleStringifier(c.configuration.to_stringifier_config())
return stringifier.create_str_value(self._result)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would it be beneficial to also have access to the value and the uncertainties as numeric values, not only as strings? For example,

res = wiz.res(3.14, ...)
# Some further calculation
print(res.value + 1.0)

In this case, we should make very clear in the docs that the object returned by wiz.res() is non-modifiable, e.g. you cannot set res.value = 42 afterwards and expect the underlying value to change. It is read-only.

But maybe that is overkill and we should leave it at strings. One could also argue that the user already knows the numerical value upfront, so they could instead just assign it the a local variable before passing it to wiz.res() and would be good to go... This would also avoid confusion about the modifiability ob the object returned by wiz.res() since when you only get back strings, you probably don't expect that this would modify the underlying valueres.value = "42.0". In that case, maybe we can even drop the "str" part of the method names? Since the datatype is clear by the method signature -> str.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

But maybe that is overkill and we should leave it at strings.

I agree :-)

src/api/printable_result.py Outdated Show resolved Hide resolved
@paul019 paul019 requested a review from Splines September 9, 2024 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide methods to access value, unit etc. in Python code
2 participants