annotate paint/package.py @ 33:5efb61fde8aa

improved docstring
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 30 Mar 2012 13:43:23 -0700
parents f2e31ac03bb3
children acb2f4896291
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
e230ac76aaa4 stub package model
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 """
e230ac76aaa4 stub package model
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2 package model for python PAckage INTrospection
e230ac76aaa4 stub package model
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3 """
e230ac76aaa4 stub package model
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
5 import os
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
6 import pip
29
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
7 import pypi
9
562230cc2e86 now the package class should at least extracts things. it doesnt actually do anything useful
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
8 import shutil
19
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
9 import subprocess
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
10 import sys
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
11 import tarfile
5
5b74792d46e4 stub package model;
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
12 import tempfile
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
13 import urllib2
21
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
14 import urlparse
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
15 import utils
5
5b74792d46e4 stub package model;
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
16
19
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
17 try:
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
18 from subprocess import check_call as call
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
19 except ImportError:
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
20 from subporcess import call
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
21
10
d63ae03cc300 * fix up __init__ imports
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
22 __all__ = ['Package']
d63ae03cc300 * fix up __init__ imports
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
23
4
e230ac76aaa4 stub package model
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
24 class Package(object):
33
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
25 """
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
26 class for python package introspection.
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
27 constructor takes the package 'src'
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
28 """
4
e230ac76aaa4 stub package model
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
29
e230ac76aaa4 stub package model
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
30 def __init__(self, src):
e230ac76aaa4 stub package model
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
31 self.src = src
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
32
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
33 # ephemeral data
5
5b74792d46e4 stub package model;
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
34 self._tmppath = None
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
35 self._egg_info_path = None
33
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
36 self._build_path = None
5
5b74792d46e4 stub package model;
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
37
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
38 # TODO: list of temporary files/directories to be deleted
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
39
5
5b74792d46e4 stub package model;
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
40 def path(self):
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
41 """filesystem path to package directory"""
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
42
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
43 # return cached copy if it exists
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
44 if self._tmppath:
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
45 return self._tmppath
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
46
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
47 # fetch from the web if a URL
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
48 tmpfile = None
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
49 src = self.src
5
5b74792d46e4 stub package model;
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
50 if utils.isURL(self.src):
8
c1181e9c9ca2 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
51 tmpfile = src = self.fetch()
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
52
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
53 # unpack if an archive
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
54 if self._is_archive(src):
8
c1181e9c9ca2 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
55 try:
c1181e9c9ca2 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
56 self.unpack(src)
c1181e9c9ca2 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
57 finally:
c1181e9c9ca2 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
58 if tmpfile:
c1181e9c9ca2 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
59 os.remove(tmpfile)
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
60 return self._tmppath
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
61
5
5b74792d46e4 stub package model;
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
62 return self.src
5b74792d46e4 stub package model;
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
63
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
64 def fetch(self, filename=None):
8
c1181e9c9ca2 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
65 """fetch from remote source to a temporary file"""
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
66 if filename is None:
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
67 fd, filename = tempfile.mkstemp()
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
68 os.close(fd)
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
69 fp = file(filename, 'w')
15
8c8b7482772f fix a few failures but still failing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
70 resource = urllib2.urlopen(self.src)
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
71 fp.write(resource.read())
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
72 fp.close()
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
73 return filename
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
74
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
75 def unpack(self, archive):
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
76 """unpack the archive to a temporary destination"""
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
77 # TODO: should handle zipfile additionally at least
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
78 # Ideally, this would be pluggable, etc
8
c1181e9c9ca2 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
79 assert tarfile.is_tarfile(archive), "%s is not an archive" % self.src
9
562230cc2e86 now the package class should at least extracts things. it doesnt actually do anything useful
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
80 tf = tarfile.TarFile.open(archive)
562230cc2e86 now the package class should at least extracts things. it doesnt actually do anything useful
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
81 self._tmppath = tempfile.mkdtemp()
19
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
82 members = tf.getmembers()
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
83
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
84 # cut off the top level directory
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
85 assert not [i for i in members if not os.path.sep in i.name]
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
86 tld = set()
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
87 for member in members:
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
88 directory, member.name = member.name.split(os.path.sep, 1)
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
89 tld.add(directory)
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
90 assert len(tld) == 1
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
91
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
92 # extract
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
93 for member in members:
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
94 tf.extract(member, path=self._tmppath)
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
95 tf.close()
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
96
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
97 def _is_archive(self, path):
7
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
98 """returns if the filesystem path is an archive"""
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
99 # TODO: should handle zipfile additionally at least
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
100 # Ideally, this would be pluggable, etc
a7bf894c96c7 yet more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
101 return tarfile.is_tarfile(path)
9
562230cc2e86 now the package class should at least extracts things. it doesnt actually do anything useful
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
102
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
103 def _cleanup(self):
9
562230cc2e86 now the package class should at least extracts things. it doesnt actually do anything useful
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
104 if self._tmppath:
562230cc2e86 now the package class should at least extracts things. it doesnt actually do anything useful
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
105 shutil.rmtree(self._tmppath)
562230cc2e86 now the package class should at least extracts things. it doesnt actually do anything useful
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
106 self._tmppath = None
562230cc2e86 now the package class should at least extracts things. it doesnt actually do anything useful
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
107
18
4c4d1e194bf7 leave in debugging code for now
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
108 # __del__ = cleanup
11
c41a946d34af stub out info method
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
109
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
110 ### python-package-specific functionality
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
111
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
112 def _egg_info(self):
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
113 """build the egg_info directory"""
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
114
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
115 if self._egg_info_path:
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
116 # return cached copy
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
117 return self._egg_info_path
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
118
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
119 directory = self.path()
16
e6cdc58fc4f5 more helpful debugging
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
120 setup_py = os.path.join(directory, 'setup.py')
e6cdc58fc4f5 more helpful debugging
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
121 if not os.path.exists(setup_py):
17
e74fc40e1f64 interpolate string
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
122 raise AssertionError("%s does not exist" % setup_py)
11
c41a946d34af stub out info method
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
123
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
124 # setup the egg info
19
c54db80d6e7f fix test
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
125 call([sys.executable, 'setup.py', 'egg_info'], cwd=directory, stdout=subprocess.PIPE)
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
126
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
127 # get the .egg-info directory
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
128 egg_info = [i for i in os.listdir(directory)
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
129 if i.endswith('.egg-info')]
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
130 assert len(egg_info) == 1, 'Expected one .egg-info directory in %s, got: %s' % (directory, egg_info)
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
131 egg_info = os.path.join(directory, egg_info[0])
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
132 assert os.path.isdir(egg_info), "%s is not a directory" % egg_info
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
133
14
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
134 # cache it
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
135 self._egg_info_path = egg_info
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
136 return self._egg_info_path
14
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
137
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
138 def info(self):
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
139 """return info dictionary for package"""
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
140 # could use pkginfo
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
141
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
142 egg_info = self._egg_info()
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
143
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
144 # read the package information
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
145 pkg_info = os.path.join(egg_info, 'PKG-INFO')
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
146 info_dict = {}
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
147 for line in file(pkg_info).readlines():
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
148 if not line or line[0].isspace():
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
149 continue # XXX neglects description
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
150 assert ':' in line
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
151 key, value = [i.strip() for i in line.split(':', 1)]
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
152 info_dict[key] = value
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
153
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
154 # return the information
20
11bc01a089e7 return only the dictionary
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
155 return info_dict
13
0dd1f8f83be2 moving towards some sort of organization
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
156
11
c41a946d34af stub out info method
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
157 def dependencies(self):
14
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
158 """return the dependencies"""
32
f2e31ac03bb3 flushing this out
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
159 # TODO: should probably have a more detailed dict:
f2e31ac03bb3 flushing this out
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
160 # {'mozinfo': {'version': '>= 0.2',
f2e31ac03bb3 flushing this out
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
161 # 'url': 'http://something.com/'}}
14
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
162
21
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
163 # get the egg_info directory
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
164 egg_info = self._egg_info()
14
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
165
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
166 # read the dependencies
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
167 requires = os.path.join(egg_info, 'requires.txt')
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
168 if os.path.exists(requires):
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
169 dependencies = [i.strip() for i in file(requires).readlines() if i.strip()]
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
170 else:
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
171 dependencies = []
21
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
172 dependencies = dict([(i, None) for i in dependencies])
14
6d27c2136163 a decent structure; need to reuse more
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
173
21
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
174 # read the dependency links
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
175 dependency_links = os.path.join(egg_info, 'dependency_links.txt')
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
176 if os.path.exists(dependency_links):
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
177 links = [i.strip() for i in file(dependency_links).readlines() if i.strip()]
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
178 for link in links:
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
179 # XXX pretty ghetto
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
180 assert '#egg=' in link
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
181 url, dep = link.split('#egg=', 1)
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
182 if dep in dependencies:
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
183 dependencies[dep] = link
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
184
4df3e715817d now have passing tests again
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
185 return dependencies
24
54c1e7e43a54 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
186
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
187 def extension(self):
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
188 """filename extension"""
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
189
33
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
190 def repackage(self, destination):
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
191 """
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
192 repackage the package to ensure its actually in the right form
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
193 """
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
194
33
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
195 if self._build_path:
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
196 return self._build_path
5efb61fde8aa improved docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
197
24
54c1e7e43a54 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
198 def download(self, directory):
54c1e7e43a54 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
199 """download a package and all its dependencies using pip"""
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
200 if not os.path.exists(directory):
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
201 os.makedirs(directory)
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
202 assert os.path.isdir(directory)
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
203 pip.main(['install', '--download', directory, self.src])
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
204
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
205 def pypi(self, directory):
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
206 """
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
207 download packages for a pypi directory structure
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
208 http://k0s.org/portfolio/pypi.html
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
209 """
29
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
210 if not os.path.exists(directory):
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
211 os.makedirs(directory)
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
212 assert os.path.isdir(directory)
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
213 tempdir = tempfile.mkdtemp()
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
214 try:
29
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
215 self.download(tempdir)
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
216 for package in os.listdir(tempdir):
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
217
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
218 # full path
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
219 src = os.path.join(tempdir, package)
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
220
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
221 package = Package(src)
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
222
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
223 # # get destination dirname, filename
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
224 # try:
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
225 # dirname, filename = pypi.pypi_path(src)
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
226 # except ValueError:
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
227 # # PKG-INFO not found
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
228 # pass # TODO
29
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
229
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
230 # # make the directory if it doesn't exist
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
231 # subdir = os.path.join(directory, dirname)
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
232 # if not os.path.exists(subdir):
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
233 # os.makedirs(subdir)
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
234 # assert os.path.isdir(subdir)
29
59524b6d25c0 implementing making pypi directory strcuture from a package
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
235
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
236 # # move the file
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
237 # shutil.move(src, os.path.join(subdir, filename))
28
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
238 finally:
c44fb4b6918b CLI sorta works
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
239 shutil.rmtree(tempdir)
31
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
240
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
241 def pypi_path(self, path):
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
242 """
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
243 returns subpath 2-tuple appropriate for pypi path structure:
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
244 http://k0s.org/portfolio/pypi.html
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
245 """
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
246 info = self.info()
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
247 # sdist = pkginfo.sdist.SDist(path)
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
248
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
249 # determine the extension (XXX hacky)
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
250 extensions = ('.tar.gz', '.zip', '.tar.bz2')
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
251 for ext in extensions:
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
252 import pdb; pdb.set_trace()
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
253 if sdist.filename.endswith(ext):
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
254 break
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
255 else:
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
256 raise Exception("Extension %s not found: %s" % (extensions, sdist.filename))
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
257
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
258 # get the filename destination
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
259 filename = '%s-%s%s' % (info['name'], ext)
5fb1844db0b2 back to the drawring broad
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
260 return sdist.name, filename