Mercurial > hg > PaInt

annotate paint/info.py @ 63:ad174d9f396d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docstring
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 25 Jan 2013 11:10:07 -0800
parents 1234bfb1f1f0
children 8f39ba642531
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 """
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2 interfaces to get information from a package
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3 """
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4
57
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
5 import imp
54
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6 import os
58
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
7 import subprocess
54
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8 import sys
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9
57
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
10 from subprocess import check_call as call
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
11
61
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
12 # TODO:
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
13 # Reconcile the difference between the keys (and values) between the different
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
14 # implementations. Pick a canon and stick with it.
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
15
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
16 # SetupOverridePackageInfo:
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
17 # {'entry_points': '\n', 'description': 'a dummy package', 'license': '', 'author': 'Jeff Hammel', 'install_requires': [], 'include_package_data': True, 'classifiers': [], 'url': 'http://example.com/', 'author_email': 'jhammel@mozilla.com', 'version': '0.1', 'zip_safe': False, 'packages': ['dummy'], 'long_description': 'dummy\n===========\n\na dummy package\n\n----\n\nJeff Hammel\n\nhttp://example.com/\n\n', 'name': 'dummy'}
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
18
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
19 # EggInfo:
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
20 # {'Name': 'dummy', 'License': 'UNKNOWN', 'Author': 'Jeff Hammel', 'Metadata-Version': '1.0', 'Home-page': 'http://example.com/', 'Summary': 'a dummy package', 'Platform': 'UNKNOWN', 'Version': '0.1', 'Author-email': 'jhammel@mozilla.com', 'Description': 'dummy'}
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
21
1234bfb1f1f0 we really need to pick a canon
Jeff Hammel <jhammel@mozilla.com>
parents: 60
diff changeset
22
54
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
23 class PackageInfo(object):
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
24 """abstract base class of package info"""
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
25 def __init__(self, path):
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
26 """
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
27 - path : path to setup.py or its directory
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
28 """
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
29 if os.path.isdir(path):
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
30 path = os.path.join(path, 'setup.py')
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
31 assert os.path.exists(path), "'%s' not found" % path
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
32 self.setup_py = os.path.abspath(path)
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
33
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
34 def __call__(self):
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
35 """returns dictionary of package info"""
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
36 raise NotImplementedError("abstract base class")
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
37
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
38 class SetupOverridePackageInfo(PackageInfo):
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
39 """
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
40 gather setup.py information by overriding the function
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
41 """
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
42
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
43 def __call__(self):
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
44 setuptools = sys.modules.get('setuptools')
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
45 sys.modules['setuptools'] = sys.modules[__name__]
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
46 globals()['setup'] = self._setup
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
47 try:
57
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
48 module = imp.load_source('setup', self.setup_py)
56
042a1b2a3e8a start flushing out tests
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
49 finally:
042a1b2a3e8a start flushing out tests
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
50 sys.modules.pop('setuptools')
042a1b2a3e8a start flushing out tests
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
51 if setuptools:
042a1b2a3e8a start flushing out tests
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
52 sys.modules['setuptools'] = setuptools
042a1b2a3e8a start flushing out tests
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
53 globals().pop('setup')
54
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
54 return self.__dict__.pop('_info')
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
55
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
56 def _setup(self, **kwargs):
a8236b97abd3 separate methods for gathering package information
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
57 self._info = kwargs
57
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
58
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
59 class EggInfo(PackageInfo):
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
60 """
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
61 use `python setup.py egg_info` to gather package information
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
62 """
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
63
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
64 def __call__(self):
58
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
65
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
66 info = self.read_pkg_info(self._pkg_info())
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
67 # TODO: install_requires
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
68 return info
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
69
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
70 @classmethod
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
71 def read_pkg_info(cls, path):
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
72 """reads PKG-INFO and returns a dict"""
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
73
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
74 # read the package information
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
75 info_dict = {}
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
76 for line in file(path).readlines():
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
77 if not line or line[0].isspace():
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
78 continue # XXX neglects description
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
79 assert ':' in line
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
80 key, value = [i.strip() for i in line.split(':', 1)]
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
81 info_dict[key] = value
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
82
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
83 # return the information
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
84 return info_dict
57
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
85
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
86 def _egg_info(self):
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
87 """build the egg_info directory"""
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
88
60
aa3c90255db6 fix minor errors
Jeff Hammel <jhammel@mozilla.com>
parents: 59
diff changeset
89 # cached result
aa3c90255db6 fix minor errors
Jeff Hammel <jhammel@mozilla.com>
parents: 59
diff changeset
90 if getattr(self, '_egg_info_path', None):
57
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
91 return self._egg_info_path
d5e5c7496784 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
92
58
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
93 directory = os.path.dirname(self.setup_py)
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
94
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
95 # setup the egg info
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
96 try:
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
97 call([sys.executable, 'setup.py', 'egg_info'], cwd=directory, stdout=subprocess.PIPE)
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
98 except Exception:
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
99 print "Failure to generate egg_info: %s" % self.setup_py
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
100 raise
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
101
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
102 # get the .egg-info directory
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
103 egg_info = [i for i in os.listdir(directory)
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
104 if i.endswith('.egg-info')]
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
105 assert len(egg_info) == 1, 'Expected one .egg-info directory in %s, got: %s' % (directory, egg_info)
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
106 egg_info = os.path.join(directory, egg_info[0])
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
107 assert os.path.isdir(egg_info), "%s is not a directory" % egg_info
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
108
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
109 # cache it
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
110 self._egg_info_path = egg_info
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
111 return self._egg_info_path
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
112
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
113 def _pkg_info(self):
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
114 """returns path to PKG-INFO file"""
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
115
59
acee5e882768 the egg-info tests fail. yay!
Jeff Hammel <jhammel@mozilla.com>
parents: 58
diff changeset
116 if getattr(self, '_pkg_info_path', None):
58
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
117 # return cached value
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
118 return self._pkg_info_path
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
119
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
120 try:
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
121 egg_info = self._egg_info()
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
122 except Exception, exception:
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
123 # try to get the package info from a file
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
124 path = os.path.dirname(self.setup_py)
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
125 pkg_info = os.path.join(path, 'PKG-INFO')
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
126 if os.path.exists(pkg_info):
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
127 self._pkg_info_path = pkg_info
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
128 return self._pkg_info_path
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
129 raise Exception("Cannot find or generate PKG-INFO")
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
130
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
131 pkg_info = os.path.join(egg_info, 'PKG-INFO')
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
132 assert os.path.exists(pkg_info)
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
133 self._pkg_info_path = pkg_info
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
134 return self._pkg_info_path
13767ee2ddf4 start adding an egg_info based information thingy
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
135