Show More
@@ -1,213 +1,212 | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | """ |
|
2 | """ | |
3 | This module defines the things that are used in setup.py for building IPython |
|
3 | This module defines the things that are used in setup.py for building IPython | |
4 |
|
4 | |||
5 | This includes: |
|
5 | This includes: | |
6 |
|
6 | |||
7 | * The basic arguments to setup |
|
7 | * The basic arguments to setup | |
8 | * Functions for finding things like packages, package data, etc. |
|
8 | * Functions for finding things like packages, package data, etc. | |
9 | * A function for checking dependencies. |
|
9 | * A function for checking dependencies. | |
10 | """ |
|
10 | """ | |
11 |
|
11 | |||
12 | # Copyright (c) IPython Development Team. |
|
12 | # Copyright (c) IPython Development Team. | |
13 | # Distributed under the terms of the Modified BSD License. |
|
13 | # Distributed under the terms of the Modified BSD License. | |
14 |
|
14 | |||
15 | import os |
|
15 | import os | |
16 | from pathlib import Path |
|
16 | from pathlib import Path | |
17 | import re |
|
17 | import re | |
18 | import sys |
|
18 | import sys | |
19 | from glob import glob |
|
19 | from glob import glob | |
20 | from logging import log |
|
20 | from logging import log | |
21 |
|
21 | |||
22 | from setuptools import Command |
|
22 | from setuptools import Command | |
23 | from setuptools.command.build_py import build_py |
|
23 | from setuptools.command.build_py import build_py | |
24 |
|
24 | |||
25 | from setuptools.command.install import install |
|
25 | from setuptools.command.install import install | |
26 | from setuptools.command.install_scripts import install_scripts |
|
26 | from setuptools.command.install_scripts import install_scripts | |
27 |
|
27 | |||
28 |
|
28 | |||
29 | #------------------------------------------------------------------------------- |
|
29 | #------------------------------------------------------------------------------- | |
30 | # Useful globals and utility functions |
|
30 | # Useful globals and utility functions | |
31 | #------------------------------------------------------------------------------- |
|
31 | #------------------------------------------------------------------------------- | |
32 |
|
32 | |||
33 | # A few handy globals |
|
33 | # A few handy globals | |
34 | repo_root = Path(__file__).resolve().parent |
|
34 | repo_root = Path(__file__).resolve().parent | |
35 |
|
35 | |||
36 |
def execfile( |
|
36 | def execfile(path, globs, locs=None): | |
37 | locs = locs or globs |
|
37 | locs = locs or globs | |
38 |
with open( |
|
38 | with path.open(encoding="utf-8") as f: | |
39 |
exec(compile(f.read(), |
|
39 | exec(compile(f.read(), str(path), "exec"), globs, locs) | |
40 |
|
40 | |||
41 | #--------------------------------------------------------------------------- |
|
41 | #--------------------------------------------------------------------------- | |
42 | # Basic project information |
|
42 | # Basic project information | |
43 | #--------------------------------------------------------------------------- |
|
43 | #--------------------------------------------------------------------------- | |
44 |
|
44 | |||
45 | # release.py contains version, authors, license, url, keywords, etc. |
|
45 | # release.py contains version, authors, license, url, keywords, etc. | |
46 |
|
|
46 | execfile(Path(repo_root, "IPython", "core", "release.py"), globals()) | |
47 | exec(f.read(), globals()) |
|
|||
48 |
|
47 | |||
49 | # Create a dict with the basic information |
|
48 | # Create a dict with the basic information | |
50 | # This dict is eventually passed to setup after additional keys are added. |
|
49 | # This dict is eventually passed to setup after additional keys are added. | |
51 | setup_args = dict( |
|
50 | setup_args = dict( | |
52 | author = author, |
|
51 | author = author, | |
53 | author_email = author_email, |
|
52 | author_email = author_email, | |
54 | license = license, |
|
53 | license = license, | |
55 | ) |
|
54 | ) | |
56 |
|
55 | |||
57 | #--------------------------------------------------------------------------- |
|
56 | #--------------------------------------------------------------------------- | |
58 | # Check package data |
|
57 | # Check package data | |
59 | #--------------------------------------------------------------------------- |
|
58 | #--------------------------------------------------------------------------- | |
60 |
|
59 | |||
61 | def check_package_data(package_data): |
|
60 | def check_package_data(package_data): | |
62 | """verify that package_data globs make sense""" |
|
61 | """verify that package_data globs make sense""" | |
63 | print("checking package data") |
|
62 | print("checking package data") | |
64 | for pkg, data in package_data.items(): |
|
63 | for pkg, data in package_data.items(): | |
65 | pkg_root = Path(*pkg.split(".")) |
|
64 | pkg_root = Path(*pkg.split(".")) | |
66 | for d in data: |
|
65 | for d in data: | |
67 | path = pkg_root / d |
|
66 | path = pkg_root / d | |
68 |
if |
|
67 | if "*" in str(path): | |
69 | assert len(glob(path)) > 0, "No files match pattern %s" % path |
|
68 | assert len(glob(path)) > 0, "No files match pattern %s" % path | |
70 | else: |
|
69 | else: | |
71 | assert path.exists(), f"Missing package data: {path}" |
|
70 | assert path.exists(), f"Missing package data: {path}" | |
72 |
|
71 | |||
73 |
|
72 | |||
74 | def check_package_data_first(command): |
|
73 | def check_package_data_first(command): | |
75 | """decorator for checking package_data before running a given command |
|
74 | """decorator for checking package_data before running a given command | |
76 |
|
75 | |||
77 | Probably only needs to wrap build_py |
|
76 | Probably only needs to wrap build_py | |
78 | """ |
|
77 | """ | |
79 | class DecoratedCommand(command): |
|
78 | class DecoratedCommand(command): | |
80 | def run(self): |
|
79 | def run(self): | |
81 | check_package_data(self.package_data) |
|
80 | check_package_data(self.package_data) | |
82 | command.run(self) |
|
81 | command.run(self) | |
83 | return DecoratedCommand |
|
82 | return DecoratedCommand | |
84 |
|
83 | |||
85 |
|
84 | |||
86 | #--------------------------------------------------------------------------- |
|
85 | #--------------------------------------------------------------------------- | |
87 | # Find data files |
|
86 | # Find data files | |
88 | #--------------------------------------------------------------------------- |
|
87 | #--------------------------------------------------------------------------- | |
89 |
|
88 | |||
90 | def find_data_files(): |
|
89 | def find_data_files(): | |
91 | """ |
|
90 | """ | |
92 | Find IPython's data_files. |
|
91 | Find IPython's data_files. | |
93 |
|
92 | |||
94 | Just man pages at this point. |
|
93 | Just man pages at this point. | |
95 | """ |
|
94 | """ | |
96 |
|
95 | |||
97 | if "freebsd" in sys.platform: |
|
96 | if "freebsd" in sys.platform: | |
98 | manpagebase = Path("man") / "man1" |
|
97 | manpagebase = Path("man") / "man1" | |
99 | else: |
|
98 | else: | |
100 | manpagebase = Path("share") / "man" / "man1" |
|
99 | manpagebase = Path("share") / "man" / "man1" | |
101 |
|
100 | |||
102 | # Simple file lists can be made by hand |
|
101 | # Simple file lists can be made by hand | |
103 | manpages = [f for f in Path("docs/man").glob("*.1.gz") if f.is_file()] |
|
102 | manpages = [f for f in Path("docs/man").glob("*.1.gz") if f.is_file()] | |
104 | if not manpages: |
|
103 | if not manpages: | |
105 | # When running from a source tree, the manpages aren't gzipped |
|
104 | # When running from a source tree, the manpages aren't gzipped | |
106 | manpages = [f for f in Path("docs/man").glob("*.1") if f.is_file()] |
|
105 | manpages = [f for f in Path("docs/man").glob("*.1") if f.is_file()] | |
107 |
|
106 | |||
108 | # And assemble the entire output list |
|
107 | # And assemble the entire output list | |
109 | data_files = [(str(manpagebase), [str(f) for f in manpages])] |
|
108 | data_files = [(str(manpagebase), [str(f) for f in manpages])] | |
110 |
|
109 | |||
111 | return data_files |
|
110 | return data_files | |
112 |
|
111 | |||
113 |
|
112 | |||
114 | # The two functions below are copied from IPython.utils.path, so we don't need |
|
113 | # The two functions below are copied from IPython.utils.path, so we don't need | |
115 | # to import IPython during setup, which fails on Python 3. |
|
114 | # to import IPython during setup, which fails on Python 3. | |
116 |
|
115 | |||
117 | def target_outdated(target, deps): |
|
116 | def target_outdated(target, deps): | |
118 | """Determine whether a target is out of date. |
|
117 | """Determine whether a target is out of date. | |
119 |
|
118 | |||
120 | target_outdated(target,deps) -> 1/0 |
|
119 | target_outdated(target,deps) -> 1/0 | |
121 |
|
120 | |||
122 | deps: list of filenames which MUST exist. |
|
121 | deps: list of filenames which MUST exist. | |
123 | target: single filename which may or may not exist. |
|
122 | target: single filename which may or may not exist. | |
124 |
|
123 | |||
125 | If target doesn't exist or is older than any file listed in deps, return |
|
124 | If target doesn't exist or is older than any file listed in deps, return | |
126 | true, otherwise return false. |
|
125 | true, otherwise return false. | |
127 | """ |
|
126 | """ | |
128 | try: |
|
127 | try: | |
129 | target_time = Path(target).stat().st_mtime |
|
128 | target_time = Path(target).stat().st_mtime | |
130 | except FileNotFoundError: |
|
129 | except FileNotFoundError: | |
131 | return 1 |
|
130 | return 1 | |
132 | for dep in deps: |
|
131 | for dep in deps: | |
133 | dep_time = Path(dep).stat().st_mtime |
|
132 | dep_time = Path(dep).stat().st_mtime | |
134 | if dep_time > target_time: |
|
133 | if dep_time > target_time: | |
135 | # print("For target",target,"Dep failed:",dep) # dbg |
|
134 | # print("For target",target,"Dep failed:",dep) # dbg | |
136 | # print("times (dep,tar):",dep_time,target_time) # dbg |
|
135 | # print("times (dep,tar):",dep_time,target_time) # dbg | |
137 | return 1 |
|
136 | return 1 | |
138 | return 0 |
|
137 | return 0 | |
139 |
|
138 | |||
140 |
|
139 | |||
141 | def target_update(target, deps, cmd): |
|
140 | def target_update(target, deps, cmd): | |
142 | """Update a target with a given command given a list of dependencies. |
|
141 | """Update a target with a given command given a list of dependencies. | |
143 |
|
142 | |||
144 | target_update(target,deps,cmd) -> runs cmd if target is outdated. |
|
143 | target_update(target,deps,cmd) -> runs cmd if target is outdated. | |
145 |
|
144 | |||
146 | This is just a wrapper around target_outdated() which calls the given |
|
145 | This is just a wrapper around target_outdated() which calls the given | |
147 | command if target is outdated.""" |
|
146 | command if target is outdated.""" | |
148 |
|
147 | |||
149 | if target_outdated(target, deps): |
|
148 | if target_outdated(target, deps): | |
150 | os.system(cmd) |
|
149 | os.system(cmd) | |
151 |
|
150 | |||
152 | #--------------------------------------------------------------------------- |
|
151 | #--------------------------------------------------------------------------- | |
153 | # VCS related |
|
152 | # VCS related | |
154 | #--------------------------------------------------------------------------- |
|
153 | #--------------------------------------------------------------------------- | |
155 |
|
154 | |||
156 | def git_prebuild(pkg_dir, build_cmd=build_py): |
|
155 | def git_prebuild(pkg_dir, build_cmd=build_py): | |
157 | """Return extended build or sdist command class for recording commit |
|
156 | """Return extended build or sdist command class for recording commit | |
158 |
|
157 | |||
159 | records git commit in IPython.utils._sysinfo.commit |
|
158 | records git commit in IPython.utils._sysinfo.commit | |
160 |
|
159 | |||
161 | for use in IPython.utils.sysinfo.sys_info() calls after installation. |
|
160 | for use in IPython.utils.sysinfo.sys_info() calls after installation. | |
162 | """ |
|
161 | """ | |
163 |
|
162 | |||
164 | class MyBuildPy(build_cmd): |
|
163 | class MyBuildPy(build_cmd): | |
165 | ''' Subclass to write commit data into installation tree ''' |
|
164 | ''' Subclass to write commit data into installation tree ''' | |
166 | def run(self): |
|
165 | def run(self): | |
167 | # loose as `.dev` is suppose to be invalid |
|
166 | # loose as `.dev` is suppose to be invalid | |
168 | print("check version number") |
|
167 | print("check version number") | |
169 | loose_pep440re = re.compile(r'^(\d+)\.(\d+)\.(\d+((a|b|rc)\d+)?)(\.post\d+)?(\.dev\d*)?$') |
|
168 | loose_pep440re = re.compile(r'^(\d+)\.(\d+)\.(\d+((a|b|rc)\d+)?)(\.post\d+)?(\.dev\d*)?$') | |
170 | if not loose_pep440re.match(version): |
|
169 | if not loose_pep440re.match(version): | |
171 | raise ValueError("Version number '%s' is not valid (should match [N!]N(.N)*[{a|b|rc}N][.postN][.devN])" % version) |
|
170 | raise ValueError("Version number '%s' is not valid (should match [N!]N(.N)*[{a|b|rc}N][.postN][.devN])" % version) | |
172 |
|
171 | |||
173 |
|
172 | |||
174 | build_cmd.run(self) |
|
173 | build_cmd.run(self) | |
175 | # this one will only fire for build commands |
|
174 | # this one will only fire for build commands | |
176 | if hasattr(self, 'build_lib'): |
|
175 | if hasattr(self, 'build_lib'): | |
177 | self._record_commit(self.build_lib) |
|
176 | self._record_commit(self.build_lib) | |
178 |
|
177 | |||
179 | def make_release_tree(self, base_dir, files): |
|
178 | def make_release_tree(self, base_dir, files): | |
180 | # this one will fire for sdist |
|
179 | # this one will fire for sdist | |
181 | build_cmd.make_release_tree(self, base_dir, files) |
|
180 | build_cmd.make_release_tree(self, base_dir, files) | |
182 | self._record_commit(base_dir) |
|
181 | self._record_commit(base_dir) | |
183 |
|
182 | |||
184 | def _record_commit(self, base_dir): |
|
183 | def _record_commit(self, base_dir): | |
185 | import subprocess |
|
184 | import subprocess | |
186 | proc = subprocess.Popen('git rev-parse --short HEAD', |
|
185 | proc = subprocess.Popen('git rev-parse --short HEAD', | |
187 | stdout=subprocess.PIPE, |
|
186 | stdout=subprocess.PIPE, | |
188 | stderr=subprocess.PIPE, |
|
187 | stderr=subprocess.PIPE, | |
189 | shell=True) |
|
188 | shell=True) | |
190 | repo_commit, _ = proc.communicate() |
|
189 | repo_commit, _ = proc.communicate() | |
191 | repo_commit = repo_commit.strip().decode("ascii") |
|
190 | repo_commit = repo_commit.strip().decode("ascii") | |
192 |
|
191 | |||
193 | out_pth = Path(base_dir) / pkg_dir / "utils" / "_sysinfo.py" |
|
192 | out_pth = Path(base_dir) / pkg_dir / "utils" / "_sysinfo.py" | |
194 | if out_pth.is_file() and not repo_commit: |
|
193 | if out_pth.is_file() and not repo_commit: | |
195 | # nothing to write, don't clobber |
|
194 | # nothing to write, don't clobber | |
196 | return |
|
195 | return | |
197 |
|
196 | |||
198 | print(f"writing git commit '{repo_commit}' to {out_pth}") |
|
197 | print(f"writing git commit '{repo_commit}' to {out_pth}") | |
199 |
|
198 | |||
200 | # remove to avoid overwriting original via hard link |
|
199 | # remove to avoid overwriting original via hard link | |
201 | try: |
|
200 | try: | |
202 | out_pth.unlink() |
|
201 | out_pth.unlink() | |
203 | except FileNotFoundError: |
|
202 | except FileNotFoundError: | |
204 | pass |
|
203 | pass | |
205 | with out_pth.open("w", encoding="utf-8") as out_file: |
|
204 | with out_pth.open("w", encoding="utf-8") as out_file: | |
206 | out_file.writelines( |
|
205 | out_file.writelines( | |
207 | [ |
|
206 | [ | |
208 | "# GENERATED BY setup.py\n", |
|
207 | "# GENERATED BY setup.py\n", | |
209 | f'commit = "{repo_commit}"\n', |
|
208 | f'commit = "{repo_commit}"\n', | |
210 | ] |
|
209 | ] | |
211 | ) |
|
210 | ) | |
212 |
|
211 | |||
213 | return MyBuildPy |
|
212 | return MyBuildPy |
General Comments 0
You need to be logged in to leave comments.
Login now