Merge repeated requirements

README.md

@@ -48,6 +48,9 @@ It's possible to bundle all of a catkin package's python requirements, as well a
 into a virtualenv. This process will also override the standard `catkin_install_python` macro to wrap a virtualenv
 loader around the specified python scripts.
 
+This operation does not do any dependency resolution - similar to how `pip` operates, the topmost dependency declaration
+'wins' (https://github.com/pypa/pip/issues/988).
+
 Add an build dependency to `package.xml`:
 
 ```

catkin_virtualenv/cmake/combine_requirements.py

@@ -23,9 +23,9 @@
 import re
 import sys
 
-from catkin_virtualenv import requirements
+from packaging.requirements import Requirement
 
-comment_regex = re.compile('\s*#.*')
+comment_regex = re.compile(r'\s*#.*')
 
 
 def combine_requirements(requirements_list, output_file):
@@ -36,14 +36,9 @@ def combine_requirements(requirements_list, output_file):
         contents = comment_regex.sub('', contents)
         for requirement_string in contents.splitlines():
             if requirement_string and not requirement_string.isspace():
-                requirement = requirements.Requirement(requirement_string)
-                try:
-                    combined_requirements[requirement.name] = combined_requirements[requirement.name] + requirement
-                except KeyError:
+                requirement = Requirement(requirement_string)
+                if requirement.name not in combined_requirements:
                     combined_requirements[requirement.name] = requirement
-                except requirements.ReqMergeException as e:
-                    print("In files {}: {}".format(requirements_list, e), file=sys.stderr)
-                    raise
 
     for requirement in combined_requirements.values():
         output_file.write("{}\n".format(requirement))

catkin_virtualenv/package.xml

@@ -32,6 +32,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
   <buildtool_depend>catkin</buildtool_depend>
 
   <build_export_depend>python-enum34</build_export_depend>
+  <build_export_depend>python-packaging</build_export_depend>
   <build_export_depend>python-virtualenv</build_export_depend>
   <build_export_depend>python3-dev</build_export_depend>
 

test_catkin_virtualenv/requirements.txt

@@ -1 +1 @@
-wrapt>=1.10.11
+requests==2.20.1

test_catkin_virtualenv/test/test_virtualenv_library.py

@@ -23,4 +23,5 @@
 class TestVirtualenv(unittest.TestCase):
 
     def test_import_wrapt(self):
-        importlib.import_module("wrapt")
+        requests = importlib.import_module("requests")
+        self.assertEquals(requests.__version__, "2.20.1")

test_catkin_virtualenv/test/test_virtualenv_script

@@ -26,7 +26,8 @@ import unittest
 class TestVirtualenv(unittest.TestCase):
 
     def test_import_wrapt(self):
-        importlib.import_module("wrapt")
+        requests = importlib.import_module("requests")
+        self.assertEquals(requests.__version__, "2.20.1")
 
 
 if __name__ == '__main__':

test_catkin_virtualenv_inherited/CMakeLists.txt

@@ -0,0 +1,29 @@
+cmake_minimum_required(VERSION 2.8.3)
+project(test_catkin_virtualenv_inherited)
+
+find_package(catkin REQUIRED COMPONENTS catkin_virtualenv)
+
+catkin_package()
+
+catkin_generate_virtualenv()
+
+install(FILES requirements.txt
+  DESTINATION ${CATKIN_PACKAGE_SHARE_DESTINATION})
+
+if(CATKIN_ENABLE_TESTING)
+  find_package(rostest REQUIRED)
+
+  catkin_install_python(
+    PROGRAMS
+      test/test_virtualenv_script
+    DESTINATION ${CATKIN_PACKAGE_BIN_DESTINATION})
+
+  catkin_add_nosetests(test
+    DEPENDENCIES ${PROJECT_NAME}_generate_virtualenv
+  )
+
+  add_rostest(test/virtualenv_script.test
+    DEPENDENCIES ${PROJECT_NAME}_generate_virtualenv
+  )
+
+endif()

test_catkin_virtualenv_inherited/package.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0"?>
+<?xml-model href="http://download.ros.org/schema/package_format2.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
+<!--
+Software License Agreement (GPL)
+
+\file      package.xml
+\authors   Paul Bovbel <pbovbel@locusrobotics.com>
+\copyright Copyright (c) (2017,), Locus Robotics, All rights reserved.
+
+This program is free software: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 2 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+-->
+<package format="2">
+  <name>test_catkin_virtualenv_inherited</name>
+  <version>0.2.1</version>
+  <description>Package to test inherited requirements.</description>
+
+  <maintainer email="pbovbel@locusrobotics.com">Paul Bovbel</maintainer>
+  <license>GPL</license>
+  <author email="pbovbel@locusrobotics.com">Paul Bovbel</author>
+
+  <buildtool_depend>catkin</buildtool_depend>
+
+  <build_depend>catkin_virtualenv</build_depend>
+
+  <depend>test_catkin_virtualenv</depend>
+
+  <test_depend>rostest</test_depend>
+
+  <export>
+    <pip_requirements>requirements.txt</pip_requirements>
+  </export>
+
+</package>

test_catkin_virtualenv_inherited/requirements.txt

@@ -0,0 +1 @@
+requests==2.19.1

test_catkin_virtualenv_inherited/test/test_virtualenv_library.py

@@ -0,0 +1,27 @@
+# Software License Agreement (GPL)
+#
+# \file      test_virtualenv_library.py
+# \authors   Paul Bovbel <pbovbel@locusrobotics.com>
+# \copyright Copyright (c) (2017,), Locus Robotics, All rights reserved.
+#
+# This program is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation, either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+import importlib
+import unittest
+
+
+class TestVirtualenv(unittest.TestCase):
+
+    def test_import_wrapt(self):
+        requests = importlib.import_module("requests")
+        self.assertEquals(requests.__version__, "2.19.1")

test_catkin_virtualenv_inherited/test/test_virtualenv_script

@@ -0,0 +1,34 @@
+#!/usr/bin/env python
+# Software License Agreement (GPL)
+#
+# \file      test_virtualenv_script
+# \authors   Paul Bovbel <pbovbel@locusrobotics.com>
+# \copyright Copyright (c) (2017,), Locus Robotics, All rights reserved.
+#
+# This program is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation, either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+import importlib
+import rostest
+import sys
+import unittest
+
+
+class TestVirtualenv(unittest.TestCase):
+
+    def test_import_wrapt(self):
+        requests = importlib.import_module("requests")
+        self.assertEquals(requests.__version__, "2.19.1")
+
+
+if __name__ == '__main__':
+    rostest.rosrun('test_catkin_virtualenv_inherited', 'test_virtualenv_script', TestVirtualenv, sys.argv)

test_catkin_virtualenv_inherited/test/virtualenv_script.test

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<!--
+Software License Agreement (GPL)
+
+\file      virtualenv_script.test
+\authors   Paul Bovbel <pbovbel@locusrobotics.com>
+\copyright Copyright (c) (2017,), Locus Robotics, All rights reserved.
+
+This program is free software: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 2 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+-->
+<launch>
+  <test test-name="virtualenv_script" pkg="test_catkin_virtualenv_inherited" type="test_virtualenv_script" />
+</launch>

test_catkin_virtualenv_py3/requirements.txt

@@ -1 +1 @@
-wrapt>=1.10.11
+requests==2.20.1

test_catkin_virtualenv_py3/test/test_virtualenv_library.py

@@ -23,4 +23,5 @@
 class TestVirtualenv(unittest.TestCase):
 
     def test_import_wrapt(self):
-        importlib.import_module("wrapt")
+        requests = importlib.import_module("requests")
+        self.assertEquals(requests.__version__, "2.20.1")

test_catkin_virtualenv_py3/test/test_virtualenv_script

@@ -26,8 +26,9 @@ import unittest
 class TestVirtualenv(unittest.TestCase):
 
     def test_import_wrapt(self):
-        importlib.import_module("wrapt")
+        requests = importlib.import_module("requests")
+        self.assertEquals(requests.__version__, "2.20.1")
 
 
 if __name__ == '__main__':
-    rostest.rosrun('test_catkin_virtualenv', 'test_virtualenv_script', TestVirtualenv, sys.argv)
+    rostest.rosrun('test_catkin_virtualenv_py3', 'test_virtualenv_script', TestVirtualenv, sys.argv)

test_catkin_virtualenv_py3/test/virtualenv_script.test

@@ -20,5 +20,5 @@ You should have received a copy of the GNU General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>.
 -->
 <launch>
-  <test test-name="test_virtualenv_script_py3" pkg="test_catkin_virtualenv_py3" type="test_virtualenv_script" />
+  <test test-name="virtualenv_script" pkg="test_catkin_virtualenv_py3" type="test_virtualenv_script" />
 </launch>