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