Make the message __repr__ for python look nicer. #60
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dirk-thomas
reviewed
May 30, 2019
| @@ -334,7 +334,18 @@ if isinstance(type_, AbstractNestedType): | |||
| typename = self.__class__.__module__.split('.') | |||
| typename.pop() | |||
| typename.append(self.__class__.__name__) | |||
| @[if 'import array' in imports]@ | |||
There was a problem hiding this comment.
Instead of using this runtime condition (which magically changes the logic for all fields as soon as an array field is added) use the types stored for each slot in SLOT_TYPES.
There was a problem hiding this comment.
I see, good point. I've done this in 33e0ff6
| for s in self.__slots__: | ||
| field = getattr(self, s, None) | ||
| if type(field) == array.array: | ||
| t = repr(field.tolist()) |
There was a problem hiding this comment.
Since this operation is fairly expensive (in terms of memory usage) I would suggest to keep using repr(field) and then process the string to remove the array(typecode, ) part.
There was a problem hiding this comment.
I did this in 079d988.
clalancette
force-pushed
the
fix-python-array-repr
branch
from
98fbce1
to
ce9a5ea
Compare
Before this patch, publishing a message with "ros2 topic pub" would print something like: publishing #5: my_msgs.msg.my_msg(axes=array('f', [0.0])) While that is OK, it is kind of ugly. This patch hides the typecode and the "array" so that the output looks like: publishing #5: my_msgs.msg.my_msg(axes=[0.0]) Which is also how it looked in Crystal. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>
Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>
clalancette
force-pushed
the
fix-python-array-repr
branch
from
ce9a5ea
to
079d988
Compare
Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>
|
Since this touches all of the generated Python code, I'm going to do a full CI run on Linux: |
Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>
Signed-off-by: Dirk Thomas <dirk-thomas@users.noreply.github.com>
dirk-thomas
reviewed
May 30, 2019
dirk-thomas
approved these changes
May 30, 2019
jacobperron
approved these changes
May 31, 2019
There was a problem hiding this comment.
The change looks okay to me. But when I publish certain messages with the master branch, I don't see the "array(" prefix, for example:
$ ros2 topic pub chatter action_msgs/msg/GoalStatusArray
publisher: beginning loop
publishing #1: action_msgs.msg.GoalStatusArray(status_list=[])
Why is it that only some messages are affected?
|
I guess we may only see the array prefix with arrays of basic types. |
|
mjcarroll
approved these changes
May 31, 2019
clalancette
added a commit
that referenced
this pull request
Jun 12, 2019
* Make the message __repr__ for python look nicer. Before this patch, publishing a message with "ros2 topic pub" would print something like: publishing #5: my_msgs.msg.my_msg(axes=array('f', [0.0])) While that is OK, it is kind of ugly. This patch hides the typecode and the "array" so that the output looks like: publishing #5: my_msgs.msg.my_msg(axes=[0.0]) Which is also how it looked in Crystal. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> * Use string processing for arrays. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> * Use the SLOT_TYPES for printing. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> * Flake8 fix. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> * some update Signed-off-by: Dirk Thomas <dirk-thomas@users.noreply.github.com>
clalancette
added a commit
that referenced
this pull request
Jun 12, 2019
* Make the message __repr__ for python look nicer. Before this patch, publishing a message with "ros2 topic pub" would print something like: publishing #5: my_msgs.msg.my_msg(axes=array('f', [0.0])) While that is OK, it is kind of ugly. This patch hides the typecode and the "array" so that the output looks like: publishing #5: my_msgs.msg.my_msg(axes=[0.0]) Which is also how it looked in Crystal. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> * Use string processing for arrays. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> * Use the SLOT_TYPES for printing. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> * Flake8 fix. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> * some update Signed-off-by: Dirk Thomas <dirk-thomas@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this patch, publishing a message with "ros2 topic pub"
would print something like:
publishing #5: my_msgs.msg.my_msg(axes=array('f', [0.0]))
While that is OK, it is kind of ugly. This patch hides the
typecode and the "array" so that the output looks like:
publishing #5: my_msgs.msg.my_msg(axes=[0.0])
Which is also how it looked in Crystal.
Signed-off-by: Chris Lalancette clalancette@openrobotics.org
Note that this is currently targeting the
fix-array-publishbranch; we'll need to retarget once that one is merged. Also note that this is kind of an RFC; while it is quite ugly, it is a cosmetic issue, and touching the generated python code may be too risky for Dashing at this point. I'll run CI presently, but opinions welcome.