Mailman 3 February 2011 - Python-checkins

devinabox: Tweak the base class.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed fb4d6ba4ed64 to devinabox: http://hg.python.org/devinabox/rev/fb4d6ba4ed64 changeset: 33:fb4d6ba4ed64 user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 21:52:49 2011 -0800 summary: Tweak the base class. files: make_a_box.py diff --git a/make_a_box.py b/make_a_box.py --- a/make_a_box.py +++ b/make_a_box.py @@ -54,6 +54,12 @@ """Directory to put everything.""" raise NotImplementedError + @abc.abstractproperty + def size(self): + """Roughly how big will the thing being provided be.""" + + # docs points to any documentation index for the provider + def _prompt(self, message): """Prompt the user to perform an action, waiting for a response.""" input("{} [press Enter when done]".format(message)) @@ -66,10 +72,6 @@ def build(self): """Optional step to "build" something.""" - def update(self): - """Update what is provided.""" - pass - class HgProvider(Provider): -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Remove a dead comment.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 512f981bf7b7 to devinabox: http://hg.python.org/devinabox/rev/512f981bf7b7 changeset: 34:512f981bf7b7 user: Brett Cannon <brett(a)python.org> date: Sun Feb 27 13:03:27 2011 -0800 summary: Remove a dead comment. files: make_a_box.py diff --git a/make_a_box.py b/make_a_box.py --- a/make_a_box.py +++ b/make_a_box.py @@ -56,9 +56,8 @@ @abc.abstractproperty def size(self): - """Roughly how big will the thing being provided be.""" - - # docs points to any documentation index for the provider + """Size of what is provided (built and everything).""" + raise NotImplementedError def _prompt(self, message): """Prompt the user to perform an action, waiting for a response.""" @@ -124,7 +123,6 @@ url, self.directory)) -# XXX test @rename('coverage.py') class CoveragePy(HgProvider): -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Note about what is required for coverage.py to work.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed aa36c83dbbc9 to devinabox: http://hg.python.org/devinabox/rev/aa36c83dbbc9 changeset: 35:aa36c83dbbc9 tag: tip user: Brett Cannon <brett(a)python.org> date: Mon Feb 28 14:03:41 2011 -0800 summary: Note about what is required for coverage.py to work. files: make_a_box.py diff --git a/make_a_box.py b/make_a_box.py --- a/make_a_box.py +++ b/make_a_box.py @@ -133,6 +133,7 @@ size = 133 # Includes the coverage report docs = os.path.join('coverage_report', 'index.html') + # XXX still requires __main__.py in coveragepy checkout def build(self): """Run coverage over CPython.""" # Build Python -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: List in the generated README where built documentation exists.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 254340e39c79 to devinabox: http://hg.python.org/devinabox/rev/254340e39c79 changeset: 32:254340e39c79 user: Brett Cannon <brett(a)python.org> date: Sat Feb 26 21:50:53 2011 -0800 summary: List in the generated README where built documentation exists. files: make_a_box.py diff --git a/make_a_box.py b/make_a_box.py --- a/make_a_box.py +++ b/make_a_box.py @@ -131,6 +131,7 @@ url = 'https://brettsky@bitbucket.org/ned/coveragepy' directory = 'coveragepy' size = 133 # Includes the coverage report + docs = os.path.join('coverage_report', 'index.html') def build(self): """Run coverage over CPython.""" @@ -220,6 +221,7 @@ url = 'http://svn.python.org/projects/peps/trunk/' directory = 'peps' size = 20 + docs = os.path.join(directory, 'pep-0000.html') def build(self): """Build the PEPs.""" @@ -235,6 +237,7 @@ url = 'http://hg.python.org/devguide' directory = 'devguide' + docs = os.path.join(directory, '_build', 'html', 'index.html') def build(self): """Build the devguide using Sphinx from CPython's docs.""" @@ -259,6 +262,7 @@ url = 'http://hg.python.org/cpython' directory = 'cpython' size = 330 # Only docs are built + docs = os.path.join(directory, 'Doc', 'build', 'html', 'index.html') def create(self): """Clone CPython and get the necessary tools to build the @@ -303,6 +307,7 @@ if response not in ('Y', 'y'): sys.exit(0) else: + print() for provider in desired_providers: ins = provider() print('Fetching {} ...'.format(provider.__name__)) @@ -312,4 +317,9 @@ with open('README', 'w') as file: header = 'Python-Dev In a Box: created on {}\n' file.write(header.format(datetime.date.today())) + file.write('\n') + file.write('Documentation indices can be found at:\n') + for provider in desired_providers: + if hasattr(provider, 'docs'): + file.write(' {}\n'.format(provider.docs)) sys.exit(0) -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Ignore everything that is auto-generated.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 7ae1f083d4dd to devinabox: http://hg.python.org/devinabox/rev/7ae1f083d4dd changeset: 0:7ae1f083d4dd user: Brett Cannon <brett(a)python.org> date: Fri Feb 25 16:36:15 2011 -0800 summary: Ignore everything that is auto-generated. files: .hgignore diff --git a/.hgignore b/.hgignore new file mode 100644 --- /dev/null +++ b/.hgignore @@ -0,0 +1,8 @@ +syntax: glob + +coveragepy +cpython +devguide +Mercurial +peps +Visual C++ Express -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Get basic creation of the Box working.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 77a0bf0169cd to devinabox: http://hg.python.org/devinabox/rev/77a0bf0169cd changeset: 1:77a0bf0169cd user: Brett Cannon <brett(a)python.org> date: Fri Feb 25 16:36:39 2011 -0800 summary: Get basic creation of the Box working. files: box.py diff --git a/box.py b/box.py new file mode 100644 --- /dev/null +++ b/box.py @@ -0,0 +1,302 @@ +"""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): + + * Mercurial: source download + Hg is Python's VCS (Version Control System). + + * TortoiseHg: Windows 32/64 + For ease-of-use for Windows users. + + * 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. + + * Python Developer's Guide + "The devguide"; documentation on how to contribute to 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). + + * CPython + The included repository clone has branches for all versions of Python + either under development or maintenance. + + * 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. + +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. + +""" +# XXX Script to build CPython? On Windows should just open devguide to proper +# page? +# XXX Vim files? Emacs files? +# XXX README or just the docstring for this script? +# XXX Script to run thorough test suite? + +import abc +import contextlib +from distutils.version import LooseVersion as Version +import os +import os.path +import subprocess +import urllib.request +import urllib.parse +import webbrowser +import xmlrpc.client + + +(a)contextlib.contextmanager +def change_cwd(directory): + cwd = os.getcwd() + os.chdir(directory) + try: + yield + finally: + os.chdir(cwd) + + +class Provider(metaclass=abc.ABCMeta): + + """Base class for items to be provided.""" + + @abc.abstractproperty + def directory(self): + """Directory to put everything.""" + raise NotImplementedError + + def _prompt(self, message): + """Prompt the user to perform an action, waiting for a response.""" + input("{} [press Enter when done]".format(message)) + + @abc.abstractmethod + def create(self): + """Create what is to be provided.""" + raise NotImplementedError + + def update(self): + """Update what is provided.""" + pass + + +class HgProvider(Provider): + + """Provide an Hg repository.""" + + @abc.abstractproperty + def url(self): + """Location of the repository.""" + raise NotImplementedError + + def create(self): + """Clone an Hg repository to 'directory'.""" + subprocess.check_call(['hg', 'clone', self.url, self.directory]) + + def update(self): + """Update the Hg clone in 'directory'.""" + with change_cwd(self.directory): + subprocess.check_call(['hg', 'pull']) + subprocess.check_call(['hg', 'update']) + + +class SvnProvider(Provider): + + """Provide an svn checkout.""" + + @abc.abstractproperty + def url(self): + """Location of the repository.""" + raise NotImplementedError + + def create(self): + """Check out the svn repository to 'directory'.""" + subprocess.check_call(['svn', 'checkout', self.url, self.directory]) + + def update(self): + """Update the svn checkout in 'directory'.""" + subprocess.check_call(['svn', 'update', self.directory]) + + +class Visual_Studio_Express(Provider): + + """Provide the Web installer for Visual C++ Express.""" + + size = (4, None) + directory = 'Visual C++ Express' + + def create(self): + """Bring up a browser window to download the release.""" + try: + os.mkdir(self.directory) + except OSError: + pass + url = 'http://www.microsoft.com/express/Downloads/' + try: + webbrowser.open(url) + except webbrowser.Error: + pass + self._prompt('download Visual C++ Express at {}'.format(url)) + + +class CoveragePy(HgProvider): + + """Cloned repository for coverage.py.""" + + url = 'https://brettsky@bitbucket.org/ned/coveragepy' + directory = 'coveragepy' + size = (5, None) # XXX coverage report for CPython + + # XXX script to run coverage tests? + # XXX 'coverage' runs coverage tests + + +class Mercurial(Provider): + + """Provide Mercurial (source release) and TortoiseHg (for Windows).""" + + directory = 'Mercurial' + size = (47, None) # Includes TortoiseHg for 32/64-bit Windows + + def _download_url(self): + """Discover the URL to download Mercurial from.""" + pypi = xmlrpc.client.ServerProxy('http://pypi.python.org/pypi') + hg_versions = pypi.package_releases('Mercurial') + hg_versions.sort(key=Version) + latest_release = hg_versions[-1] + # Mercurial keeps releases on their servers + release_data = pypi.release_data('Mercurial', latest_release) + try: + return release_data['download_url'] + except KeyError: + # XXX + pass + + def _url_filename(self, url): + """Find the filename from the URL.""" + return os.path.split(urllib.parse.urlparse(url).path)[1] + + def _create_mercurial(self): + """Download the latest source release of Mercurial.""" + file_url = self._download_url() + file_name = self._url_filename(file_url) + with urllib.request.urlopen(file_url) as url_file: + with open(os.path.join(self.directory, file_name), 'wb') as file: + file.write(url_file.read()) + + def _create_tortoisehg(self): + """Open a web page to the TortoiseHg download page.""" + url = 'http://tortoisehg.bitbucket.org/download/' + try: + webbrowser.open(url) + except webbrowser.Error: + pass + self._prompt('Download TortoiseHg from {}'.format(url)) + + def create(self): + """Fetch the latest source distribution for Mercurial.""" + try: + os.mkdir(self.directory) + except OSError: + pass + self._create_mercurial() + self._create_tortoisehg() + + + +class Devguide(HgProvider): + + """Clone the Python developer's guide.""" + + size = (1, 4) + + url = 'http://hg.python.org/devguide' + directory = 'devguide' + + # XXX build (and symlink the index); use Sphinx from docs + + +class PEPs(SvnProvider): + + """Checkout the Python Enhancement Proposals.""" + + 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 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 + + def create(self): + """Clone CPython and get the necessary tools to build the + documentation.""" + super().create() + with change_cwd(os.path.join(self.directory, 'Doc')): + subprocess.check_call(['make', 'checkout']) + + # XXX build docs (and symlink) + # XXX script to build CPython? multiprocessing.cpu_count() + # XXX script to run unit tests? multiprocessing.cpu_count() + + + +if __name__ == '__main__': + import argparse + parser = arparse.ArgumentParser(prog='Python-Dev In a Box') + subparsers = parser.add_subparsers() # XXX help + parser_create = subparsers.add_parser('create') # XXX help + # XXX --all option + # XXX --basic option (everything that doesn't require a Web browser) + # XXX --miniumum option (cpython, devguide, peps) + # XXX --build option + # XXX --with-coverage option + parser_update = subparsers.add_parser('update') # XXX help + # XXX also run build (--with-coverage) + + + + for provider in (CPython, Devguide, PEPs, Mercurial, CoveragePy, + Visual_Studio_Express,): + print('Creating', provider.__name__.replace('_', ' ')) + provider().create() + print() -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Scrap the idea of Vim and Emacs config files. That's just asking for trouble.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed d28bc8018e78 to devinabox: http://hg.python.org/devinabox/rev/d28bc8018e78 changeset: 2:d28bc8018e78 user: Brett Cannon <brett(a)python.org> date: Fri Feb 25 16:38:41 2011 -0800 summary: Scrap the idea of Vim and Emacs config files. That's just asking for trouble. files: box.py diff --git a/box.py b/box.py --- a/box.py +++ b/box.py @@ -58,7 +58,6 @@ """ # XXX Script to build CPython? On Windows should just open devguide to proper # page? -# XXX Vim files? Emacs files? # XXX README or just the docstring for this script? # XXX Script to run thorough test suite? -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Ignore more files.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed c29bac1b876f to devinabox: http://hg.python.org/devinabox/rev/c29bac1b876f changeset: 3:c29bac1b876f user: Brett Cannon <brett(a)python.org> date: Fri Feb 25 16:49:22 2011 -0800 summary: Ignore more files. files: .hgignore diff --git a/.hgignore b/.hgignore --- a/.hgignore +++ b/.hgignore @@ -6,3 +6,7 @@ Mercurial peps Visual C++ Express +.*.swp +*.pyc +*.pyo +__pycache__ -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Re-org some comments.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 1d912fdfa240 to devinabox: http://hg.python.org/devinabox/rev/1d912fdfa240 changeset: 4:1d912fdfa240 user: Brett Cannon <brett(a)python.org> date: Fri Feb 25 16:49:32 2011 -0800 summary: Re-org some comments. files: box.py diff --git a/box.py b/box.py --- a/box.py +++ b/box.py @@ -56,8 +56,6 @@ version of CPython. """ -# XXX Script to build CPython? On Windows should just open devguide to proper -# page? # XXX README or just the docstring for this script? # XXX Script to run thorough test suite? @@ -274,7 +272,7 @@ subprocess.check_call(['make', 'checkout']) # XXX build docs (and symlink) - # XXX script to build CPython? multiprocessing.cpu_count() + # XXX script to build CPython? multiprocessing.cpu_count(). Windows? # XXX script to run unit tests? multiprocessing.cpu_count() -- Repository URL: http://hg.python.org/devinabox

1 0

devinabox: Try to support Windows users building the docs.
by brett.cannon Feb. 28, 2011

Feb. 28, 2011

brett.cannon pushed 897f82506708 to devinabox: http://hg.python.org/devinabox/rev/897f82506708 changeset: 6:897f82506708 user: Brett Cannon <brett(a)python.org> date: Fri Feb 25 17:12:37 2011 -0800 summary: Try to support Windows users building the docs. files: box.py diff --git a/box.py b/box.py --- a/box.py +++ b/box.py @@ -286,8 +286,9 @@ subprocess.check_call(['make', 'checkout']) def build(self): + cmd = 'make' if sys.platform != 'win32' else 'make.bat' with change_cwd(os.path.join(self.directory, 'Doc'): - subprocess.check_call(['make', 'html']) + subprocess.check_call([cmd, 'html']) if __name__ == '__main__': -- Repository URL: http://hg.python.org/devinabox

1 0