set zip_safe to avoid warning during installation

[dirk-thomas]

http://setuptools.readthedocs.io/en/latest/setuptools.html#setting-the-zip-safe-flag

[mikaelarguedas]

Thanks these warnings were one on the only thing polluting stderr during builds.
Did you happen to run CI with this change to confirm everything work as zip ? or did you focus on changing the packages that would obviously work, to then (as a follow-up) do a more thorough investigation for the other python packages?

[dirk-thomas]

When the flag is not specified the warning indicates what is being chosen based on the package content (e.g. usage of __file__). I only set the values based on the stderr output to what was already being determined by setuptools. Therefore I didn't run CI for the change since there shouldn't be any change - except the warnings going away for these packages.

[mikaelarguedas]

Looking at the nightlies, packages in other repositories (ros2cli or examples) produce similar console pollution, but they are not covered by this set of PRs. So the question of how the packages targeted by this set of PRs were chosen still stands.

I'm fine merging those without review as without a job confirming the disappearance of the warnings or a summary of the console outputs that motivated this change; it is hard to review as it forces the reviewer to go dig them out from previous jobs output and compare the flag with what is set in this set of PRs.

[dirk-thomas]

There is always more to fix. I addressed the ones I notices. I won't spend time right now looking for more of these. But whenever I stumble over additional warnings in the future (as with any other problem) I will create more PRs.

Please feel free to run CI if you think it help in the review process. I don't think it will have any effect on passing / failing the build or the test results.

[mikaelarguedas]

I opened the missing PRs as it made it easier to review the existing ones with a full job console output.
Job from master: https://ci.ros2.org/job/ci_turtlebot-demo_linux/115

• 33 occurences of "zip_safe flag not set; analyzing archive"
• 8 packages generating warnings (search for module references) saying that the flag should be set to False:
  • ament_flake8
  • ament_pep8
  • ament_copyright
  • ament_clang_format
  • ament_tools
  • ament_uncrustify
  • ros2cli
  • ros2pkg

Job after this set of PR: https://ci.ros2.org/job/ci_turtlebot-demo_linux/116

• 0 occurences of "zip_safe flag not set; analyzing archive" meaning that we addressed all python packages that were missing the flag

[dirk-thomas]

Awesome 👍