Mailman 3 February 2011 - Python-checkins

devinabox: Clean up the docstring.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed cfcf7b5e2e43 to devinabox: http://hg.python.org/devinabox/rev/cfcf7b5e2e43 changeset: 12:cfcf7b5e2e43 user: Brett Cannon <brett(a)python.org> date: Fri Feb 25 18:25:43 2011 -0800 summary: Clean up the docstring. files: box.py diff --git a/box.py b/box.py old mode 100644 new mode 100755 --- a/box.py +++ b/box.py @@ -1,56 +1,17 @@ +#!/usr/bin/env python3 """Python-Dev In a Box: (almost) everything you need to contribute to (C)Python in under 700 MB. This script will create a directory which will end up containing (or remind you to download) everything you need to contribute to (C)Python's development (sans -a compiler): +a C compiler) through the ``create`` command. You can also "build" what is +provided in the Box to save users some hassle (e.g., build the documentation). - * Mercurial: source download & TortoiseHG for 32/64-bit Windows - Hg is Python's VCS (Version Control System). +Once a Box has been created, users of it can update what it contains (e.g., +update the repository of CPython). - * Visual C++ Express: English Web installer - So Windows users can compile CPython. - OS X users should install XCode (http://developer.apple.com/) and - optionally Homebrew (http://mxcl.github.com/homebrew/) to install - LLVM/clang. - Linux user should install gcc or clang using their distribution's - package managers. - - * coverage.py: cloned repository - For measuring the coverage of Python's test suite. Includes a - cloned repository instead of the latest release as cutting-edge support - is occasionally needed to support the in-development version of Python. - - * Python Enhancement Proposals - Also known as PEPs. This is included as reference material, especially - for PEPs 7 & 8 (the C and Python style guides, respectively). - - * Python Developer's Guide - "The devguide"; documentation on how to contribute to Python. - - * CPython - The included repository clone has branches for all versions of Python - either under development or maintenance. - -Once the requisite code has been checked out, various optional steps can be -performed to make the lives of users easier: - - * Update all cloned repositories (devguide, PEPs, CPython, coverage.py) - - * Build Python's documentation (will also lead to the download of the - required software; requires Python to already be installed on the user's - machine) - - * Build the devguide (requires Python's docs to be built so as to have a - copy of Sphinx available to use) - - * Build the PEPs (requires Python to be installed) - - * Generate a coverage report (requires that CPython be built) - - -This script is assumed to be run by a built version of the in-development -version of CPython. +There are also some scripts provide along side this one to help get people +started. See the README for more information. """ # XXX README or just the docstring for this script? @@ -143,7 +104,7 @@ class Visual_Studio_Express(Provider): - """Provide the Web installer for Visual C++ Express.""" + """The Web installer for Visual C++ Express.""" size = (4, None) directory = 'Visual C++ Express' @@ -164,7 +125,8 @@ class CoveragePy(HgProvider): - """Cloned repository for coverage.py.""" + """Cloned repository for coverage.py so you can generate coverage report + for the stdlib.""" url = 'https://brettsky@bitbucket.org/ned/coveragepy' directory = 'coveragepy' @@ -176,7 +138,8 @@ class Mercurial(Provider): - """Provide Mercurial (source release) and TortoiseHg (for Windows).""" + """Provide Mercurial (source release) and TortoiseHg (for Windows) so you + can update CPython's repository.""" directory = 'Mercurial' size = (47, None) # Includes TortoiseHg for 32/64-bit Windows @@ -229,7 +192,7 @@ class Devguide(HgProvider): - """Clone the Python developer's guide.""" + """Clone of the Python developer's guide so you know what to do.""" size = (1, 4) @@ -254,7 +217,8 @@ class PEPs(SvnProvider): - """Checkout the Python Enhancement Proposals.""" + """Checkout the Python Enhancement Proposals so you have the style guides + (PEPs 7 & 8) along with all other PEPs for reference.""" url = 'http://svn.python.org/projects/peps/trunk/' directory = 'peps' @@ -269,7 +233,7 @@ class CPython(HgProvider): - """Clone CPython (and requisite tools to build the documentation).""" + """Clone of CPython (and requisite tools to build the documentation).""" url = 'http://hg.python.org/cpython' directory = 'cpython' @@ -290,7 +254,7 @@ if __name__ == '__main__': - import argparse + import argparse # XXX snag from CPython repo if missing all_providers = (CPython, Devguide, PEPs, CoveragePy, Mercurial, Visual_Studio_Express) -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Modularize build_cpython.py.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 2396229f0a74 to devinabox: http://hg.python.org/devinabox/rev/2396229f0a74 changeset: 13:2396229f0a74 user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 13:04:19 2011 -0800 summary: Modularize build_cpython.py. files: build_cpython.py diff --git a/build_cpython.py b/build_cpython.py --- a/build_cpython.py +++ b/build_cpython.py @@ -5,19 +5,24 @@ import subprocess import sys -if sys.platform == 'win32': - print("See the devguide's Getting Set Up guide for building under Windows") +def main(): + if sys.platform == 'win32': + print("See the devguide's Getting Set Up guide for building under " + "Windows") -directory = 'cpython' -cwd = os.getcwd() -os.chdir(directory) -try: - if os.path.isfile('Makefile'): - print('Makefile already exists; skipping ./configure') - else: - subprocess.check_call(['./configure', '--prefix=/dev/null', - '--with-pydebug']) - make_cmd = ['make', '-s', '-j', str(multiprocessing.cpu_count())] - subprocess.call(make_cmd) -finally: - os.chdir(cwd) + directory = 'cpython' + cwd = os.getcwd() + os.chdir(directory) + try: + if os.path.isfile('Makefile'): + print('Makefile already exists; skipping ./configure') + else: + subprocess.check_call(['./configure', '--prefix=/dev/null', + '--with-pydebug']) + make_cmd = ['make', '-s', '-j', str(multiprocessing.cpu_count())] + subprocess.call(make_cmd) + finally: + os.chdir(cwd) + +if __name__ == '__main__': + main() -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Actually return the path to the executable.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 72f72ce682f7 to devinabox: http://hg.python.org/devinabox/rev/72f72ce682f7 changeset: 15:72f72ce682f7 user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 13:22:50 2011 -0800 summary: Actually return the path to the executable. files: run_tests.py diff --git a/run_tests.py b/run_tests.py --- a/run_tests.py +++ b/run_tests.py @@ -21,6 +21,7 @@ cmd = os.path.join(directory, 'PCBuild', 'AMD64', 'python_d.exe') if not os.path.isfile(cmd): return None + return os.path.abspath(cmd) if __name__ == '__main__': cmd = executable() -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Refactor run_tests.py.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 1c2795eb8298 to devinabox: http://hg.python.org/devinabox/rev/1c2795eb8298 changeset: 14:1c2795eb8298 user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 13:04:41 2011 -0800 summary: Refactor run_tests.py. files: run_tests.py diff --git a/run_tests.py b/run_tests.py --- a/run_tests.py +++ b/run_tests.py @@ -6,21 +6,27 @@ import sys -directory = 'cpython' -cmd = os.path.join(directory, 'python') -# UNIX -if not os.path.isfile(cmd): - # OS X - cmd += '.exe' +def executable(): + directory = 'cpython' + cmd = os.path.join(directory, 'python') + # UNIX if not os.path.isfile(cmd): - # 32-bit Windows - cmd = os.path.join(directory, 'PCBuild', 'python_d.exe') + # OS X + cmd += '.exe' if not os.path.isfile(cmd): - # 64-bit Windows - cmd = os.path.join(directory, 'PCBuild', 'AMD64', 'python_d.exe') + # 32-bit Windows + cmd = os.path.join(directory, 'PCBuild', 'python_d.exe') if not os.path.isfile(cmd): - print('CPython is not built') - sys.exit(1) + # 64-bit Windows + cmd = os.path.join(directory, 'PCBuild', 'AMD64', 'python_d.exe') + if not os.path.isfile(cmd): + return None -subprocess.call([cmd, '-W', 'default', '-bb', '-E', '-m', 'test', '-r', '-w', - '-u', 'all', '-j', str(multiprocessing.cpu_count())]) +if __name__ == '__main__': + cmd = executable() + if cmd is None: + print('CPython is not built') + sys.exit(1) + subprocess.call([cmd, '-W', 'default', '-bb', '-E', '-m', 'test', '-r', + '-w', '-u', 'all', '-j', + str(multiprocessing.cpu_count())]) -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Ignore .coverage.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 50f2f565e39c to devinabox: http://hg.python.org/devinabox/rev/50f2f565e39c changeset: 17:50f2f565e39c user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 14:36:32 2011 -0800 summary: Ignore .coverage. files: .hgignore diff --git a/.hgignore b/.hgignore --- a/.hgignore +++ b/.hgignore @@ -8,6 +8,7 @@ peps Visual C++ Express # Generated +.coverage coverage_report build coverage.html -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Skip auto-generated stuff.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 5975eb8ce9e8 to devinabox: http://hg.python.org/devinabox/rev/5975eb8ce9e8 changeset: 16:5975eb8ce9e8 user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 14:36:02 2011 -0800 summary: Skip auto-generated stuff. files: .hgignore diff --git a/.hgignore b/.hgignore --- a/.hgignore +++ b/.hgignore @@ -1,11 +1,20 @@ syntax: glob +# Repositories/files coveragepy cpython devguide Mercurial peps Visual C++ Express +# Generated +coverage_report +build +coverage.html +devguide.html +peps.html +python_docs.html +# Misc .*.swp *.pyc *.pyo -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Script to easily execute coverage.py (requires __main__.py in coveragepy).
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 5c66d683172c to devinabox: http://hg.python.org/devinabox/rev/5c66d683172c changeset: 19:5c66d683172c user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 14:37:11 2011 -0800 summary: Script to easily execute coverage.py (requires __main__.py in coveragepy). files: run_coverage.py diff --git a/run_coverage.py b/run_coverage.py new file mode 100755 --- /dev/null +++ b/run_coverage.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python +"""Create a coverage report for CPython""" +import subprocess +import os +import sys +import build_cpython +import run_tests + +build_cpython.main() +print(os.getcwd()) +executable = run_tests.executable() +if not executable: + print('no CPython executable found') + sys.exit(1) + +print('Running coverage ...') +subprocess.check_call([executable, 'coveragepy', 'run', '--pylib', + os.path.join('cpython', 'Lib', 'test', 'regrtest.py'), + ]) +print('Generating report ...') +subprocess.call([executable, 'coveragepy', 'html', '-i', '--omit', + '"*/test/*,*/tests/*"', '-d', 'coverage_report']) +print('Creating symlink ...') +os.symlink(os.path.join('coverage_report', 'index.html'), 'coverage.html') -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Ignore the auto-generated README.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 761007ae2a64 to devinabox: http://hg.python.org/devinabox/rev/761007ae2a64 changeset: 21:761007ae2a64 user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 16:39:17 2011 -0800 summary: Ignore the auto-generated README. files: .hgignore diff --git a/.hgignore b/.hgignore --- a/.hgignore +++ b/.hgignore @@ -15,6 +15,7 @@ devguide.html peps.html python_docs.html +README # Misc .*.swp *.pyc -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Simply the UX.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed fdf18450ac82 to devinabox: http://hg.python.org/devinabox/rev/fdf18450ac82 changeset: 20:fdf18450ac82 user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 16:32:46 2011 -0800 summary: Simply the UX. Assume that box.py is only used by creators of a Box. Allow the user to personally specify through prompting what they do and do not want to add to the Box. Also always build what is provided. files: box.py diff --git a/box.py b/box.py --- a/box.py +++ b/box.py @@ -2,24 +2,24 @@ """Python-Dev In a Box: (almost) everything you need to contribute to (C)Python in under 700 MB. -This script will create a directory which will end up containing (or remind you -to download) everything you need to contribute to (C)Python's development (sans -a C compiler) through the ``create`` command. You can also "build" what is -provided in the Box to save users some hassle (e.g., build the documentation). +This script will clone, checkout, download, or ask you to download everything +you need to contribute to (C)Python's development short of a C compiler. It +will also "build" everything so that users do not need to do **everything** +from scratch. This also allows for easy offline use. -Once a Box has been created, users of it can update what it contains (e.g., -update the repository of CPython). - -There are also some scripts provide along side this one to help get people -started. See the README for more information. +There are also some scripts provided along side this one to help in executing +common tasks. """ import abc import contextlib +import datetime from distutils.version import LooseVersion as Version +import operator import os import os.path import subprocess +import sys import urllib.request import urllib.parse import webbrowser @@ -54,6 +54,9 @@ """Create what is to be provided.""" raise NotImplementedError + def build(self): + """Optional step to "build" something.""" + def update(self): """Update what is provided.""" pass @@ -98,11 +101,11 @@ subprocess.check_call(['svn', 'update', '-q', self.directory]) -class Visual_Studio_Express(Provider): +class VisualCPPExpress(Provider): - """The Web installer for Visual C++ Express.""" + """The Web installer for Visual C++ Express""" - size = (4, None) + size = 4 directory = 'Visual C++ Express' def create(self): @@ -116,28 +119,29 @@ webbrowser.open(url) except webbrowser.Error: pass - self._prompt('download Visual C++ Express at {}'.format(url)) + self._prompt('download Visual C++ Express at {} and put in {}'.format( + url, self.directory)) +VisualCPPExpress.__name__ = 'Visual C++ Express' class CoveragePy(HgProvider): - """Cloned repository for coverage.py so you can generate coverage report - for the stdlib.""" + """Cloned repository of coverage.py (WARNING: building takes a while)""" url = 'https://brettsky@bitbucket.org/ned/coveragepy' directory = 'coveragepy' - size = (5, None) # XXX coverage report for CPython + size = 0 # XXX coverage report for CPython # XXX build runs coverage tests +CoveragePy.__name__ = 'coverage.py' class Mercurial(Provider): - """Provide Mercurial (source release) and TortoiseHg (for Windows) so you - can update CPython's repository.""" + """Source release of Mercurial along with TortoiseHg""" directory = 'Mercurial' - size = (47, None) # Includes TortoiseHg for 32/64-bit Windows + size = 47 # Includes TortoiseHg for 32/64-bit Windows def _download_url(self): """Discover the URL to download Mercurial from.""" @@ -172,7 +176,8 @@ webbrowser.open(url) except webbrowser.Error: pass - self._prompt('Download TortoiseHg from {}'.format(url)) + self._prompt('Download TortoiseHg from {} and put in {}'.format(url, + self.directory)) def create(self): """Fetch the latest source distribution for Mercurial.""" @@ -184,12 +189,26 @@ self._create_tortoisehg() +class PEPs(SvnProvider): + + """Checkout of the Python Enhancement Proposals (for PEPs 7 & 8)""" + + url = 'http://svn.python.org/projects/peps/trunk/' + directory = 'peps' + size = 20 + + def build(self): + """Build the PEPs and symlink PEP 0.""" + with change_cwd(self.directory): + subprocess.check_call(['make']) + os.symlink(os.path.join(self.directory, 'pep-0000.html'), 'peps.html') + class Devguide(HgProvider): - """Clone of the Python developer's guide so you know what to do.""" + """Clone of the Python Developer's Guide""" - size = (1, 4) + size = 4 url = 'http://hg.python.org/devguide' directory = 'devguide' @@ -210,30 +229,13 @@ os.symlink(index_path, 'devguide.html') -class PEPs(SvnProvider): - - """Checkout the Python Enhancement Proposals so you have the style guides - (PEPs 7 & 8) along with all other PEPs for reference.""" - - url = 'http://svn.python.org/projects/peps/trunk/' - directory = 'peps' - size = (14, 20) - - def build(self): - """Build the PEPs and symlink PEP 0.""" - with change_cwd(self.directory): - subprocess.check_call(['make']) - os.symlink(os.path.join(self.directory, 'pep-0000.html'), 'peps.html') - - class CPython(HgProvider): - """Clone of CPython (and requisite tools to build the documentation).""" + """Clone of CPython (and requisite tools to build the documentation)""" url = 'http://hg.python.org/cpython' directory = 'cpython' - size = (245, # Includes stuff required to build docs/ docs built - 325) # Only docs are built + size = 325 # Only docs are built def create(self): """Clone CPython and get the necessary tools to build the @@ -243,31 +245,49 @@ subprocess.check_call(['make', 'checkout']) def build(self): + """Build CPython's documentation. + + CPython itself is not built as one will most likely not want to + distribute that on a CD. The build_cpython.py script can be used by the + Box user for building CPython. + + """ cmd = 'make' if sys.platform != 'win32' else 'make.bat' with change_cwd(os.path.join(self.directory, 'Doc')): subprocess.check_call([cmd, 'html']) - # XXX symlink to python_docs.html + os.symlink(os.path.join(self.directory, 'Doc', 'html', 'index.html'), + 'python_docs.html') if __name__ == '__main__': - import argparse # XXX snag from CPython repo if missing - all_providers = (CPython, Devguide, PEPs, CoveragePy, Mercurial, - Visual_Studio_Express) - parser = argparse.ArgumentParser(prog='Python-Dev In a Box') - subparsers = parser.add_subparsers() # XXX help - parser_create = subparsers.add_parser('create', - help='Create a %(prog)s') - parser_create.add_argument('--build', action='store_true', default=False) - group = parser_create.add_mutually_exclusive_group() - group.add_argument('--all', dest='providers', action='store_const', - const=all_providers, - help='Provide everything (the default)') - group.add_argument('--basic', dest='providers', action='store_const', - const=(CPython, Devguide, PEPs, CoveragePy), - help='Provide the basics people probably are lacking') - group.add_argument('--minimum', dest='providers', action='store_const', - const=(CPython, Devguide, PEPs), - help='Provide the bare minimum to be productive') - # XXX --build option - # XXX parser_update = subparsers.add_parser('update', help='Update the %(prog)s') # XXX also run build + VisualCPPExpress) + print(__doc__) + print('Please choose what to provide [y/n]:\n') + desired_providers = [] + for provider in all_providers: + docstring = provider.__doc__#.replace('\n', ' ') + msg = '{} ({} MB built)? '.format(docstring, provider.size) + response = input(msg) + if response in ('Y', 'y'): + desired_providers.append(provider) + print() + getting = ', '.join(map(operator.attrgetter('__name__'), + desired_providers)) + print('Getting {}'.format(getting)) + total_size = sum(map(operator.attrgetter('size'), desired_providers)) + msg = 'The requested Box will be about {} MB. OK [y/n]? '.format(total_size) + response = input(msg) + if response not in ('Y', 'y'): + sys.exit(0) + else: + for provider in desired_providers: + ins = provider() + print('Fetching {} ...'.format(provider.__name__)) + ins.create() + print('Building {} ...'.format(provider.__name__)) + ins.build() + with open('README', 'w') as file: + header = 'Python-Dev In a Box: created on {}\n' + file.write(header.format(datetime.date.today())) + sys.exit(0) -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Update some XXX comments.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed f22b4803ab4a to devinabox: http://hg.python.org/devinabox/rev/f22b4803ab4a changeset: 18:f22b4803ab4a user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 14:36:41 2011 -0800 summary: Update some XXX comments. files: box.py diff --git a/box.py b/box.py --- a/box.py +++ b/box.py @@ -14,10 +14,6 @@ started. See the README for more information. """ -# XXX README or just the docstring for this script? -# XXX script to build CPython? multiprocessing.cpu_count(). Windows? -# XXX script to run unit tests? multiprocessing.cpu_count() - import abc import contextlib from distutils.version import LooseVersion as Version @@ -132,8 +128,7 @@ directory = 'coveragepy' size = (5, None) # XXX coverage report for CPython - # XXX script to run coverage tests? - # XXX 'coverage' runs coverage tests + # XXX build runs coverage tests class Mercurial(Provider): @@ -251,6 +246,7 @@ cmd = 'make' if sys.platform != 'win32' else 'make.bat' with change_cwd(os.path.join(self.directory, 'Doc')): subprocess.check_call([cmd, 'html']) + # XXX symlink to python_docs.html if __name__ == '__main__': -- Repository URL: http://hg.python.org/devinabox

1 0