Merge lp:~bjornt/snapcraft/setuptools into lp:~snappy-dev/snapcraft/core

[Björn Tillenius]

Add support for setuptools based python projects.

Add support for setuptools based Python project.

I initially did it for Python3 only, but then I saw lp:~sergiusens/snapcraft/setuptools for Python 2. I merged in that branch and made the implementations consistent.

[lp:~bjornt/snapcraft/setuptools]

138. By Björn Tillenius on 2015-09-11

Merge trunk, resolve conflicts.

139. By Björn Tillenius on 2015-09-11

Lint.

[Sergio Schvezov (sergiusens)]

this looks good.

I would prefer os.path.join instead of self.installdir + '/... though

[lp:~bjornt/snapcraft/setuptools]

140. By Björn Tillenius on 2015-09-11

Use os.path.join()

Use single quotes instead of double quotes.

[Björn Tillenius (bjornt)]

On Fri, Sep 11, 2015 at 06:05:35PM -0000, Sergio Schvezov wrote:
> this looks good.
>
> I would prefer os.path.join instead of self.installdir + '/... though

Sure. I've changed it to use os.path.join()

I also changed all the strings to use single quotes, since you seem to
prefer that.

--
Björn Tillenius | https://launchpad.net/~bjornt

[Ted Gould (ted)]

So, what I don't love about this branch is that it pulls in setuptools everytime, even if you're not using it to build the package. All Python users are getting setup tools installed into their snap. Now, this isn't your fault. There isn't currently a way to fix this. Sergio is brainstorming a solution, but my thought is that if there's nothing easy we can take this as is with a TODO to fix that eventually.

[Ted Gould (ted)]

Talking on IRC about this, we don't have a solution for the packages yet, but we don't think this branch should block because of that.

review: Approve

[Sergio Schvezov (sergiusens)]

review: Approve

=== modified file 'snapcraft/plugins/python2.py'
--- snapcraft/plugins/python2.py	2015-09-07 19:25:14 +0000
+++ snapcraft/plugins/python2.py	2015-09-11 19:54:09 +0000
@@ -21,6 +21,7 @@
 
     _PLUGIN_STAGE_PACKAGES = [
         'python-dev',
+        'python-setuptools',
     ]
 
     # note that we don't need to set PYTHONHOME here,

=== modified file 'snapcraft/plugins/python2_project.py'
--- snapcraft/plugins/python2_project.py	2015-08-03 18:21:58 +0000
+++ snapcraft/plugins/python2_project.py	2015-09-11 19:54:09 +0000
@@ -14,6 +14,8 @@
 # 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 os
+
 import snapcraft
 
 
@@ -26,6 +28,20 @@
         return self.handle_source_options()
 
     def build(self):
+        # If setuptools is used, it tries to create files in the
+        # dist-packages dir and import from there, so it needs to exist
+        # and be in the PYTHONPATH. It's harmless if setuptools isn't
+        # used.
+        os.makedirs(self.dist_packages_dir, exist_ok=True)
+        env = os.environ.copy()
+        env['PYTHONPATH'] = self.dist_packages_dir
+
         return self.run(
-            ["python2", "setup.py", "install", "--install-layout=deb",
-             "--prefix={}/usr".format(self.installdir)])
+            ['python2', 'setup.py', 'install', '--install-layout=deb',
+             '--prefix={}/usr'.format(self.installdir)],
+            env=env)
+
+    @property
+    def dist_packages_dir(self):
+        return os.path.join(
+            self.installdir, 'usr', 'lib', 'python2.7', 'dist-packages')

=== modified file 'snapcraft/plugins/python3.py'
--- snapcraft/plugins/python3.py	2015-09-07 19:25:14 +0000
+++ snapcraft/plugins/python3.py	2015-09-11 19:54:09 +0000
@@ -21,6 +21,7 @@
 
     _PLUGIN_STAGE_PACKAGES = [
         'python3-dev',
+        'python3-setuptools',
     ]
 
     # note that we don't need to set PYTHONHOME here,

=== modified file 'snapcraft/plugins/python3_project.py'
--- snapcraft/plugins/python3_project.py	2015-07-22 18:23:16 +0000
+++ snapcraft/plugins/python3_project.py	2015-09-11 19:54:09 +0000
@@ -14,6 +14,8 @@
 # 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 os
+
 import snapcraft
 
 
@@ -26,6 +28,19 @@
         return self.handle_source_options()
 
     def build(self):
+        # If setuptools is used, it tries to create files in the
+        # dist-packages dir and import from there, so it needs to exist
+        # and be in the PYTHONPATH. It's harmless if setuptools isn't
+        # used.
+        os.makedirs(self.dist_packages_dir, exist_ok=True)
+        env = os.environ.copy()
+        env['PYTHONPATH'] = self.dist_packages_dir
         return self.run(
-            ["python3", "setup.py", "install", "--install-layout=deb",
-             "--prefix=%s/usr" % self.installdir])
+            ['python3', 'setup.py', 'install', '--install-layout=deb',
+             '--prefix=%s/usr' % self.installdir],
+            env=env)
+
+    @property
+    def dist_packages_dir(self):
+        return os.path.join(
+            self.installdir, 'usr', 'lib', 'python3', 'dist-packages')