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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
|
#!/usr/bin/env python3
# Note: Do not embed any non-ASCII characters in this file until pip has been
# fixed. See https://github.com/xonsh/xonsh/issues/487.
import os
import subprocess
import sys
from setuptools import setup
from setuptools.command.build_py import build_py
from setuptools.command.develop import develop
from setuptools.command.install import install
from setuptools.command.install_scripts import install_scripts
from setuptools.command.sdist import sdist
from wheel.bdist_wheel import bdist_wheel
TABLES = [
"xonsh/lexer_table.py",
"xonsh/parser_table.py",
"xonsh/completion_parser_table.py",
]
def python_tag():
ver = sys.version_info
return f"py{ver.major}{ver.minor}"
def clean_tables():
"""Remove the lexer/parser modules that are dynamically created."""
for f in TABLES:
if os.path.isfile(f):
os.remove(f)
print("Removed " + f)
os.environ["XONSH_DEBUG"] = "1"
def build_tables():
"""Build the lexer/parser modules."""
print("Building lexer and parser tables.", file=sys.stderr)
root_dir = os.path.abspath(os.path.dirname(__file__))
sys.path.insert(0, root_dir)
from xonsh.parser import Parser
from xonsh.parsers.completion_context import CompletionContextParser
Parser(
yacc_table="parser_table",
outputdir=os.path.join(root_dir, "xonsh"),
yacc_debug=True,
)
CompletionContextParser(
yacc_table="completion_parser_table",
outputdir=os.path.join(root_dir, "xonsh"),
debug=True,
)
sys.path.pop(0)
def dirty_version():
"""
If install/sdist is run from a git directory (not a conda install), add
a devN suffix to reported version number and write a gitignored file
that holds the git hash of the current state of the repo to be queried
by ``xonfig``
"""
try:
_version = subprocess.check_output(["git", "describe", "--tags"])
except Exception:
print("failed to find git tags", file=sys.stderr)
return False
_version = _version.decode("ascii")
try:
_, N, sha = _version.strip().split("-")
except ValueError: # tag name may contain "-"
print("failed to parse git version", file=sys.stderr)
return False
sha = sha.strip("g")
replace_version(N)
_cmd = ["git", "show", "-s", "--format=%cd", "--date=local", sha]
try:
_date = subprocess.check_output(_cmd)
_date = _date.decode("ascii")
# remove weekday name for a shorter string
_date = " ".join(_date.split()[1:])
except:
_date = ""
print("failed to get commit date", file=sys.stderr)
with open("xonsh/dev.githash", "w") as f:
f.write(f"{sha}|{_date}")
print("wrote git version: " + sha, file=sys.stderr)
return True
ORIGINAL_VERSION_LINE = None
def replace_version(N):
"""Replace version in `__init__.py` with devN suffix"""
global ORIGINAL_VERSION_LINE
with open("xonsh/__init__.py") as f:
raw = f.read()
lines = raw.splitlines()
msg_assert = "__version__ must be the first line of the __init__.py"
assert "__version__" in lines[0], msg_assert
ORIGINAL_VERSION_LINE = lines[0]
lines[0] = lines[0].rstrip(' "') + f'.dev{N}"'
upd = "\n".join(lines) + "\n"
with open("xonsh/__init__.py", "w") as f:
f.write(upd)
def restore_version():
"""If we touch the version in __init__.py discard changes after install."""
if ORIGINAL_VERSION_LINE is None:
return
with open("xonsh/__init__.py") as f:
raw = f.read()
lines = raw.splitlines()
lines[0] = ORIGINAL_VERSION_LINE
upd = "\n".join(lines) + "\n"
with open("xonsh/__init__.py", "w") as f:
f.write(upd)
class xbuild_py(build_py):
"""Xonsh specialization of setuptools build_py class."""
def run(self):
clean_tables()
build_tables()
# add dirty version number
dirty = dirty_version()
super().run()
if dirty:
restore_version()
class xbdist(bdist_wheel):
def initialize_options(self):
super().initialize_options()
# because XonshParser will be build for each minor python version, we need separate builds
self.python_tag = python_tag()
class xinstall(install):
"""Xonsh specialization of setuptools install class.
For production, let setuptools generate the
startup script, e.g: `pip installl .' rather than
relying on 'python setup.py install'."""
def run(self):
clean_tables()
build_tables()
# add dirty version number
dirty = dirty_version()
super().run()
if dirty:
restore_version()
class xsdist(sdist):
"""Xonsh specialization of setuptools sdist class."""
def make_release_tree(self, basedir, files):
clean_tables()
build_tables()
dirty = dirty_version()
files.extend(TABLES)
super().make_release_tree(basedir, files)
if dirty:
restore_version()
# Hack to overcome pip/setuptools problem on Win 10. See:
# https://github.com/tomduck/pandoc-eqnos/issues/6
# https://github.com/pypa/pip/issues/2783
# Custom install_scripts command class for setup()
class install_scripts_quoted_shebang(install_scripts):
"""Ensure there are quotes around shebang paths with spaces."""
def write_script(self, script_name, contents, mode="t", *ignored):
shebang = str(contents.splitlines()[0])
if (
shebang.startswith("#!")
and " " in shebang[2:].strip()
and '"' not in shebang
):
quoted_shebang = '#!"%s"' % shebang[2:].strip()
contents = contents.replace(shebang, quoted_shebang)
super().write_script(script_name, contents, mode, *ignored)
class install_scripts_rewrite(install_scripts):
"""Change default python3 to the concrete python binary used to install/develop inside xon.sh script"""
def run(self):
super().run()
if not self.dry_run:
for file in self.get_outputs():
if file.endswith("xon.sh"):
# this is the value distutils use on its shebang translation
bs_cmd = self.get_finalized_command("build_scripts")
exec_param = getattr(bs_cmd, "executable", None)
with open(file) as f:
content = f.read()
processed = content.replace(" python3 ", f' "{exec_param}" ')
with open(file, "w") as f:
f.write(processed)
class xdevelop(develop):
"""Xonsh specialization of setuptools develop class."""
def run(self):
clean_tables()
build_tables()
dirty = dirty_version()
develop.run(self)
if dirty:
restore_version()
def install_script(self, dist, script_name, script_text, dev_path=None):
if script_name == "xon.sh":
# change default python3 to the concrete python binary used to install/develop inside xon.sh script
script_text = script_text.replace(" python3 ", f' "{sys.executable}" ')
super().install_script(dist, script_name, script_text, dev_path)
# The custom install needs to be used on Windows machines
cmdclass = {
"install": xinstall,
"sdist": xsdist,
"build_py": xbuild_py,
"develop": xdevelop,
"bdist_wheel": xbdist,
}
if os.name == "nt":
cmdclass["install_scripts"] = install_scripts_quoted_shebang
else:
cmdclass["install_scripts"] = install_scripts_rewrite
def main():
"""The main entry point."""
try:
if "--name" not in sys.argv:
logo_fname = os.path.join(os.path.dirname(__file__), "logo.txt")
with open(logo_fname, "rb") as f:
logo = f.read().decode("utf-8")
print(logo)
except UnicodeEncodeError:
pass
setup(
cmdclass=cmdclass,
)
if __name__ == "__main__":
main()
|