Skip to content

Static typing for Message, Services, and Actions #206

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

Jump to bottom
Open
wants to merge 70 commits into
base: rolling
Choose a base branch
from
Open

Static typing for Message, Services, and Actions #206

wants to merge 70 commits into from

Conversation

InvincibleRMC
Copy link
Contributor

@InvincibleRMC InvincibleRMC commented Mar 15, 2024 •
edited
Loading

Adds static typing to generated messages. Closes #157.

@InvincibleRMC
explicit export and py.typed
f81e023 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Fix line lengths
2f99351 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Fix hanging indent
05761d8 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Improve typing
9807b07 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Fix subscription error
288ba5d 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC InvincibleRMC marked this pull request as draft March 15, 2024 07:12
@InvincibleRMC
Copy link
Contributor Author

Still need to fix a circular import issue.

@InvincibleRMC
Tests complete
9aad27a 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Fewer flake8
2822852 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC InvincibleRMC marked this pull request as ready for review March 15, 2024 16:35
InvincibleRMC and others added 18 commits March 15, 2024 13:36
@InvincibleRMC
Fix typing import error
118b9ef 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Update _msg.py.em
af91451 
Signed-off-by: Michael Carlstrom <36806982+InvincibleRMC@users.noreply.github.com>
@InvincibleRMC
Constructor typing refactor
153a6d7 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Update _msg.py.em
6a147a7 
Signed-off-by: Michael Carlstrom <36806982+InvincibleRMC@users.noreply.github.com>
@InvincibleRMC
remove structure_needs_at_least_one_member
946381a 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Add actual numpy type annotations
956fe0a 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Add None
ae98901 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Add types to __prepare__ args
8d06b8c 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Default type annotations
ad14966 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Constant type annotations
48def6b 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Type constants
8458b38 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
SLOT_TYPES type
9f80bcc 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
small refactor
4b2f72c 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Add Protocol
a412da2 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Blank lines for flake8
86d8a97 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Remove Literal for better 3.6 support
5d839f4 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Better return types
1aef88a 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Move TYPE_CHECKING import
468c8f5 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
match getter and setter
375cc73 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
fix numpy types
576fe24 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
resolve all()
381d1e1 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
fix mypy error
41cc561 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
type ignore around mypy#3004
6e357c3 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
revert specifc getter type
dd5c3e9 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Use Any to avoid mypy#3004
b6bc52c 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Copy link
Contributor Author

One thing I have learn which is relevant to #216 is that currently according to pep 484 is that a type annotation of float allows int. There is currently no defined way to define a realFloat type that disallows int. There are many discussions about this.

@InvincibleRMC
Copy link
Contributor Author

@sloretz @fujitatomoya could you review this pull request if you get the chance? It would improve the pub/sub, service/clients in rclpy since currently the generics are being ignored.

sloretz
sloretz requested changes Mar 13, 2025
View reviewed changes
Copy link
Contributor

@sloretz sloretz left a comment

Choose a reason for hiding this comment

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

Thank you for the PR! It's no small feat to make changes to the empy templates 🙇

I'm still looking through the changes in _msg.py.em, but I have some feedback in the meantime.

InvincibleRMC and others added 5 commits March 13, 2025 19:54
@InvincibleRMC @sloretz
Update rosidl_generator_py/resource/_msg.py.em
1582363 
Co-authored-by: Shane Loretz <shane.loretz@gmail.com>
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC @sloretz
Update rosidl_generator_py/resource/_msg.py.em
f8df11f 
Co-authored-by: Shane Loretz <shane.loretz@gmail.com>
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
feedback changes
79f101c 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
remove extra if
6554f57 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Add missing py.typed
1edbf9a 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
sloretz
sloretz reviewed Mar 14, 2025
View reviewed changes
Copy link
Contributor

@sloretz sloretz left a comment

Choose a reason for hiding this comment

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

Few more places to use if @(member.name) is not None else instead of or

@sloretz
if @(member.name) is not None else
494bab6 
Signed-off-by: Shane Loretz <shane.loretz@gmail.com>
sloretz
sloretz reviewed Mar 14, 2025
View reviewed changes
@InvincibleRMC
remove duplicated imports
6ba0242 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Add proper NoReturn type for Srv/Action
d272ce4 
Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>
@InvincibleRMC
Copy link
Contributor Author

@sloretz Following up I was able to remove the duplicate imports. Let me know if there are any other questions/suggestions. Thanks again for reviewing this pr.

@InvincibleRMC
Copy link
Contributor Author

Now that kilted is starting to wrap up friendly ping @sloretz to re-review when you get a chance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sloretz sloretz sloretz requested changes

@quarkytale quarkytale Awaiting requested review from quarkytale

Assignees

@sloretz sloretz

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Python type annotation
3 participants
@InvincibleRMC @haudren-woven @sloretz