Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

setup.py cleanup: add -stripped build option to not include docs or tests #1878

Merged
merged 5 commits into from Jun 27, 2020
Merged

setup.py cleanup: add -stripped build option to not include docs or tests #1878

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
07dfa82
simplify, add -stripped option
May 19, 2020
c0b7da6
Merge remote-tracking branch 'origin/master' into refactor-setup
May 30, 2020
61cef86
Allow Python 2.7 on PyPy as long as PyPy is recent
Jun 23, 2020
aa4ab66
delete TODO comment (moved to issue tracker)
Jun 23, 2020
92f4410
test commit, this shouldn't work
Jun 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
167 changes: 81 additions & 86 deletions setup.py 100755 → 100644
View file
Open in desktop
Expand Up @@ -28,6 +28,12 @@
import sys
import os

# just import these always and fail early if not present
import distutils
from setuptools import setup

IS_PYPY = '__pypy__' in sys.builtin_module_names
illume marked this conversation as resolved.
Show resolved Hide resolved

def compilation_help():
""" On failure point people to a web page for help.
"""
Expand All @@ -52,8 +58,7 @@ def compilation_help():
default = 'https://www.pygame.org/wiki/Compilation'
url = help_urls.get(the_system, default)

is_pypy = '__pypy__' in sys.builtin_module_names
if is_pypy:
if IS_PYPY:
url += '\n https://www.pygame.org/wiki/CompilePyPy'

print ('\n---')
Expand All @@ -68,6 +73,17 @@ def compilation_help():
if not hasattr(sys, 'version_info') or sys.version_info < (2,7):
compilation_help()
raise SystemExit("Pygame requires Python version 2.7 or above.")
if sys.version_info >= (3, 0) and sys.version_info < (3, 4):
compilation_help()
raise SystemExit("Pygame requires Python3 version 3.5 or above.")
if IS_PYPY and sys.pypy_version_info < (7,):
raise SystemExit("Pygame requires PyPy version 7.0.0 above, compatible with CPython 2.7 or CPython 3.5+")

def consume_arg(name):
illume marked this conversation as resolved.
Show resolved Hide resolved
if name in sys.argv:
sys.argv.remove(name)
return True
return False

#get us to the correct directory
path = os.path.split(os.path.abspath(sys.argv[0]))[0]
Expand All @@ -76,7 +92,7 @@ def compilation_help():
# "-Wcast-align -Wconversion -Wstrict-prototypes " + \
# "-Wmissing-prototypes -Wmissing-declarations " + \
# "-Wnested-externs -Wshadow -Wredundant-decls"
if "-warnings" in sys.argv:
if consume_arg("-warnings"):
os.environ["CFLAGS"] = "-W -Wimplicit-int " + \
"-Wimplicit-function-declaration " + \
"-Wimplicit -Wmain -Wreturn-type -Wunused -Wswitch " + \
Expand All @@ -86,9 +102,8 @@ def compilation_help():
"-Wconversion -Wstrict-prototypes " + \
"-Wmissing-prototypes -Wmissing-declarations " + \
"-Wnested-externs -Wshadow -Wredundant-decls"
sys.argv.remove ("-warnings")

if '-pygame-ci' in sys.argv:
if consume_arg('-pygame-ci'):
cflags = os.environ.get('CFLAGS', '')
if cflags:
cflags += ' '
Expand All @@ -100,19 +115,28 @@ def compilation_help():
'-Werror=cast-align -Werror=int-conversion ' + \
'-Werror=incompatible-pointer-types'
os.environ['CFLAGS'] = cflags
sys.argv.remove ('-pygame-ci')

STRIPPED=False

# STRIPPED builds don't have developer resources like docs or tests

if "PYGAME_ANDROID" in os.environ:
# test cases and docs are useless inside an APK
illume marked this conversation as resolved.
Show resolved Hide resolved
STRIPPED=True

if consume_arg('-stripped'):
STRIPPED=True

enable_arm_neon = False
if '-enable-arm-neon' in sys.argv:
if consume_arg('-enable-arm-neon'):
enable_arm_neon = True
cflags = os.environ.get('CFLAGS', '')
if cflags:
cflags += ' '
cflags += '-mfpu=neon'
os.environ['CFLAGS'] = cflags
sys.argv.remove('-enable-arm-neon')

if 'cython' in sys.argv:
if consume_arg('cython'):
# compile .pyx files
# So you can `setup.py cython` or `setup.py cython install`
try:
Expand Down Expand Up @@ -183,13 +207,10 @@ def compilation_help():
kwargs['progress'] = '[{}/{}] '.format(i + 1, count)
cythonize_one(**kwargs)

sys.argv.remove('cython')

AUTO_CONFIG = False
if '-auto' in sys.argv:
if consume_arg('-auto'):
AUTO_CONFIG = True
sys.argv.remove('-auto')


import os.path, glob, stat, shutil
import distutils.sysconfig
Expand All @@ -201,21 +222,6 @@ def compilation_help():

revision = ''

# Python 3.0 patch
illume marked this conversation as resolved.
Show resolved Hide resolved
if sys.version_info[0:2] == (3, 0):
import distutils.version
def _cmp(x, y):
try:
if x < y:
return -1
elif x == y:
return 0
return 1
except TypeError:
return NotImplemented
distutils.version.cmp = _cmp
del _cmp

def add_datafiles(data_files, dest_dir, pattern):
"""Add directory structures to data files according to a pattern"""
src_dir, elements = pattern
Expand All @@ -233,17 +239,18 @@ def do_directory(root_dest_path, root_src_path, elements):
data_files.append((root_dest_path, files))
do_directory(dest_dir, src_dir, elements)

# allow optionally using setuptools for bdist_egg.
if "-setuptools" in sys.argv:
from setuptools import setup
sys.argv.remove ("-setuptools")
from setuptools import setup
# # allow optionally using setuptools for bdist_egg.
# if consume_arg("-setuptools") in sys.argv:
# from setuptools import setup
# sys.argv.remove ("-setuptools")

# we need to eat this argument in to distutils doesn't trip over it
consume_arg("-setuptools")


# NOTE: the bdist_mpkg_support is for darwin.
try:
import bdist_mpkg_support
from setuptools import setup
except ImportError:
pass
else:
Expand All @@ -261,6 +268,7 @@ def do_directory(root_dest_path, root_src_path, elements):

import distutils.command.install_headers

# monkey patch distutils header install to copy over directories
def run_install_headers(self):
headers = self.distribution.headers
if not headers:
Expand All @@ -283,10 +291,8 @@ def run_install_headers(self):
distutils.command.install_headers.install_headers.run = run_install_headers

# option for not installing the headers.
if "-noheaders" in sys.argv:
if consume_arg("-noheaders"):
headers = []
sys.argv.remove ("-noheaders")


#sanity check for any arguments
if len(sys.argv) == 1 and sys.stdout.isatty():
Expand Down Expand Up @@ -335,34 +341,22 @@ def run_install_headers(self):
for e in extensions:
e.define_macros.append(('PG_ENABLE_ARM_NEON', '1'))

#decide whether or not to enable new buffer protocol support
enable_newbuf = False
if sys.version_info >= (2, 6, 0):
try:
sys.pypy_version_info
except AttributeError:
enable_newbuf = True
# decide whether or not to enable new buffer protocol support (PEP 3118)
# old CPython versions without newbuf are no longer supported!
# new PYPY also supports PEP 3118
enable_newbuf = True
illume marked this conversation as resolved.
Show resolved Hide resolved

if enable_newbuf:
enable_newbuf_value = '1'
else:
enable_newbuf_value = '0'
# TODO: remove all PG_ENABLE_NEWBUF conditionals from C code
illume marked this conversation as resolved.
Show resolved Hide resolved
# and just fail when PEP 3118 (Py_TPFLAGS_HAVE_NEWBUFFER) is not present
# then remove this logic
for e in extensions:
e.define_macros.append(('ENABLE_NEWBUF', enable_newbuf_value))

#if new buffer protocol support is disabled then remove the testing framework
if not enable_newbuf:
posn = None
for i, e in enumerate(extensions):
if e.name == 'newbuffer':
posn = i
if (posn is not None):
del extensions[posn]
e.define_macros.append(('ENABLE_NEWBUF', '1'))

# if not building font, try replacing with ftfont
alternate_font = os.path.join('src_py', 'font.py')
if os.path.exists(alternate_font):
os.remove(alternate_font)

have_font = False
have_freetype = False
for e in extensions:
Expand Down Expand Up @@ -402,6 +396,8 @@ def run_install_headers(self):
if not f[-3:] == '.py' and not f[-4:] == '.doc' and os.path.isfile(f):
pygame_data_files.append(f)

# We don't need to deploy tests, example code, or docs inside a game

#tests/fixtures
add_datafiles(data_files, 'pygame/tests',
['test',
Expand Down Expand Up @@ -509,6 +505,13 @@ def write_version_module(pygame_version, revision):
#required. This will be filled if doing a Windows build.
cmdclass = {}

def add_command(name):
illume marked this conversation as resolved.
Show resolved Hide resolved
def decorator(command):
assert issubclass(command, Command)
cmdclass[name]=command
return command
return decorator

#try to find DLLs and copy them too (only on windows)
if sys.platform == 'win32':

Expand Down Expand Up @@ -609,6 +612,7 @@ def has_flag(compiler, flagname):
def flag_filter(compiler, *flags):
return [flag for flag in flags if has_flag(compiler, flag)]

@add_command('build_ext')
class WinBuildExt(build_ext):
"""This build_ext sets necessary environment variables for MinGW"""

Expand All @@ -628,8 +632,6 @@ def build_extensions(self):

build_ext.build_extensions(self)

cmdclass['build_ext'] = WinBuildExt

# Add the precompiled smooth scale MMX functions to transform.
def replace_scale_mmx():
for e in extensions:
Expand Down Expand Up @@ -658,31 +660,29 @@ def replace_scale_mmx():
#data installer with improved intelligence over distutils
#data files are copied into the project directory instead
#of willy-nilly
@add_command('install_data')
class smart_install_data(install_data):
def run(self):
#need to change self.install_dir to the actual library dir
install_cmd = self.get_finalized_command('install')
self.install_dir = getattr(install_cmd, 'install_lib')
return install_data.run(self)

cmdclass['install_data'] = smart_install_data


@add_command('sdist')
class OurSdist(sdist):
def initialize_options(self):
sdist.initialize_options(self)
super(sdist, self).initialize_options()
# we do not want MANIFEST.in to appear in the root cluttering up things.
self.template = os.path.join('buildconfig', 'MANIFEST.in')

cmdclass['sdist'] = OurSdist


if "bdist_msi" in sys.argv:
# if you are making an msi, we want it to overwrite files
# we also want to include the repository revision in the file name
from distutils.command import bdist_msi
import msilib

@add_command('bdist_msi')
class bdist_msi_overwrite_on_install(bdist_msi.bdist_msi):
def run(self):
bdist_msi.bdist_msi.run(self)
Expand Down Expand Up @@ -712,16 +712,10 @@ def get_installer_filename(self, fullname):
fullname += '-hg_' + revision
return bdist_msi.bdist_msi.get_installer_filename(self, fullname)

cmdclass['bdist_msi'] = bdist_msi_overwrite_on_install







# test command. For doing 'python setup.py test'

@add_command('test')
class TestCommand(Command):
user_options = [ ]

Expand All @@ -738,9 +732,9 @@ def run(self):
import subprocess
return subprocess.call([sys.executable, os.path.join('test', '__main__.py')])

cmdclass['test'] = TestCommand


@add_command('docs')
class DocsCommand(Command):
""" For building the pygame documentation with `python setup.py docs`.

Expand Down Expand Up @@ -773,22 +767,10 @@ def run(self):
print(docs_help)
raise

cmdclass['docs'] = DocsCommand



# Prune empty file lists.
date_files = [(path, files) for path, files in data_files if files]










#finally,
#call distutils with all needed info
PACKAGEDATA = {
Expand Down Expand Up @@ -822,6 +804,19 @@ def run(self):
"data_files": data_files,
"zip_safe": False,
}
if STRIPPED:
PACKAGEDATA = {
"cmdclass": cmdclass,
"packages": ['pygame',
'pygame.threads',
'pygame._sdl2'],
"package_dir": {'pygame': 'src_py',
'pygame._sdl2': 'src_py/_sdl2',
'pygame.threads': 'src_py/threads'},
"ext_modules": extensions,
"zip_safe": False,
illume marked this conversation as resolved.
Show resolved Hide resolved
}

PACKAGEDATA.update(METADATA)
PACKAGEDATA.update(EXTRAS)

Expand Down