Commit 4837ab2d authored by Jim Fulton's avatar Jim Fulton

Various whitespace, formatting and typo cleanups. Thanks Gary!

parent 845467c6
...@@ -52,11 +52,11 @@ if is_jython: ...@@ -52,11 +52,11 @@ if is_jython:
import subprocess import subprocess
class MissingOption(zc.buildout.UserError, KeyError): class MissingOption(zc.buildout.UserError, KeyError):
"""A required option was missing """A required option was missing.
""" """
class MissingSection(zc.buildout.UserError, KeyError): class MissingSection(zc.buildout.UserError, KeyError):
"""A required section is missinh """A required section is missing.
""" """
def __str__(self): def __str__(self):
...@@ -145,8 +145,8 @@ class Buildout(UserDict.DictMixin): ...@@ -145,8 +145,8 @@ class Buildout(UserDict.DictMixin):
print 'Creating %r.' % config_file print 'Creating %r.' % config_file
open(config_file, 'w').write('[buildout]\nparts = \n') open(config_file, 'w').write('[buildout]\nparts = \n')
elif command == 'setup': elif command == 'setup':
# Sigh. this model of a buildout nstance # Sigh. This model of a buildout instance
# with methods is breaking down :( # with methods is breaking down. :(
config_file = None config_file = None
data['buildout']['directory'] = ('.', 'COMPUTED_VALUE') data['buildout']['directory'] = ('.', 'COMPUTED_VALUE')
else: else:
...@@ -334,7 +334,7 @@ class Buildout(UserDict.DictMixin): ...@@ -334,7 +334,7 @@ class Buildout(UserDict.DictMixin):
return os.path.join(self._buildout_dir, name) return os.path.join(self._buildout_dir, name)
def bootstrap(self, args): def bootstrap(self, args):
__doing__ = 'Bootstraping.' __doing__ = 'Bootstrapping.'
self._setup_directories() self._setup_directories()
...@@ -905,7 +905,7 @@ class Buildout(UserDict.DictMixin): ...@@ -905,7 +905,7 @@ class Buildout(UserDict.DictMixin):
if not args: if not args:
raise zc.buildout.UserError( raise zc.buildout.UserError(
"The setup command requires the path to a setup script or \n" "The setup command requires the path to a setup script or \n"
"directory containing a setup script, and it's arguments." "directory containing a setup script, and its arguments."
) )
setup = args.pop(0) setup = args.pop(0)
if os.path.isdir(setup): if os.path.isdir(setup):
......
...@@ -575,7 +575,8 @@ When we rerun the buildout: ...@@ -575,7 +575,8 @@ When we rerun the buildout:
.. Wait for the file to really disappear. My linux is weird. .. Wait for the file to really disappear. My linux is weird.
>>> wait_until("foo goes away", lambda : not os.path.exists('foo')) >>> wait_until("foo goes away", lambda : not os.path.exists('foo'),
... timeout=100)
we get the same error, but we don't get the directory left behind: we get the same error, but we don't get the directory left behind:
...@@ -716,7 +717,8 @@ all key-value pairs are displayed, sorted alphabetically, along with ...@@ -716,7 +717,8 @@ all key-value pairs are displayed, sorted alphabetically, along with
the origin of the value (file name or COMPUTED_VALUE, DEFAULT_VALUE, the origin of the value (file name or COMPUTED_VALUE, DEFAULT_VALUE,
COMMAND_LINE_VALUE). COMMAND_LINE_VALUE).
>>> print system(buildout+ ' annotate'), # doctest: +ELLIPSIS >>> print system(buildout+ ' annotate'),
... # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
<BLANKLINE> <BLANKLINE>
Annotated sections Annotated sections
================== ==================
...@@ -1156,7 +1158,7 @@ Annotated sections output shows which files are responsible for which ...@@ -1156,7 +1158,7 @@ Annotated sections output shows which files are responsible for which
operations. operations.
>>> print system(os.path.join('bin', 'buildout') + ' annotate'), >>> print system(os.path.join('bin', 'buildout') + ' annotate'),
... # doctest: +ELLIPSIS ... # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
<BLANKLINE> <BLANKLINE>
Annotated sections Annotated sections
================== ==================
...@@ -1191,7 +1193,6 @@ operations. ...@@ -1191,7 +1193,6 @@ operations.
[part4] [part4]
option= h1 h2 option= h1 h2
/sample-buildout/extension1.cfg /sample-buildout/extension1.cfg
...
Cleanup. Cleanup.
...@@ -1902,6 +1903,7 @@ the buildout in the usual way: ...@@ -1902,6 +1903,7 @@ the buildout in the usual way:
d recipes d recipes
>>> cat(sample_buildout, '.installed.cfg') >>> cat(sample_buildout, '.installed.cfg')
... # doctest: +NORMALIZE_WHITESPACE
[buildout] [buildout]
installed_develop_eggs = /sample-buildout/develop-eggs/recipes.egg-link installed_develop_eggs = /sample-buildout/develop-eggs/recipes.egg-link
parts = debug d1 d2 d3 parts = debug d1 d2 d3
...@@ -1987,6 +1989,7 @@ were created. ...@@ -1987,6 +1989,7 @@ were created.
The .installed.cfg is only updated for the recipes that ran: The .installed.cfg is only updated for the recipes that ran:
>>> cat(sample_buildout, '.installed.cfg') >>> cat(sample_buildout, '.installed.cfg')
... # doctest: +NORMALIZE_WHITESPACE
[buildout] [buildout]
installed_develop_eggs = /sample-buildout/develop-eggs/recipes.egg-link installed_develop_eggs = /sample-buildout/develop-eggs/recipes.egg-link
parts = debug d1 d2 d3 d4 parts = debug d1 d2 d3 d4
...@@ -2189,7 +2192,7 @@ database is shown. ...@@ -2189,7 +2192,7 @@ database is shown.
... parts = ... parts =
... """) ... """)
>>> print system(buildout+' -vv'), >>> print system(buildout+' -vv'), # doctest: +NORMALIZE_WHITESPACE
Installing 'zc.buildout', 'setuptools'. Installing 'zc.buildout', 'setuptools'.
We have a develop egg: zc.buildout 1.0.0. We have a develop egg: zc.buildout 1.0.0.
We have the best distribution that satisfies 'setuptools'. We have the best distribution that satisfies 'setuptools'.
...@@ -2510,8 +2513,7 @@ buildout installed option: ...@@ -2510,8 +2513,7 @@ buildout installed option:
d recipes d recipes
Note that there will be no installation database if there are no Note that there will be no installation database if there are no parts:
parts:
>>> write('buildout.cfg', >>> write('buildout.cfg',
... """ ... """
......
...@@ -67,6 +67,7 @@ buildout_and_setuptools_path = [ ...@@ -67,6 +67,7 @@ buildout_and_setuptools_path = [
pkg_resources.Requirement.parse('zc.buildout')).location, pkg_resources.Requirement.parse('zc.buildout')).location,
] ]
class IncompatibleVersionError(zc.buildout.UserError): class IncompatibleVersionError(zc.buildout.UserError):
"""A specified version is incompatible with a given requirement. """A specified version is incompatible with a given requirement.
""" """
...@@ -95,6 +96,7 @@ def _get_version(executable): ...@@ -95,6 +96,7 @@ def _get_version(executable):
FILE_SCHEME = re.compile('file://', re.I).match FILE_SCHEME = re.compile('file://', re.I).match
class AllowHostsPackageIndex(setuptools.package_index.PackageIndex): class AllowHostsPackageIndex(setuptools.package_index.PackageIndex):
"""Will allow urls that are local to the system. """Will allow urls that are local to the system.
...@@ -139,6 +141,7 @@ _easy_install_cmd = _safe_arg( ...@@ -139,6 +141,7 @@ _easy_install_cmd = _safe_arg(
'from setuptools.command.easy_install import main; main()' 'from setuptools.command.easy_install import main; main()'
) )
class Installer: class Installer:
_versions = {} _versions = {}
...@@ -1164,6 +1167,7 @@ sys.argv[0] = %(setup)r ...@@ -1164,6 +1167,7 @@ sys.argv[0] = %(setup)r
execfile(%(setup)r) execfile(%(setup)r)
""" """
class VersionConflict(zc.buildout.UserError): class VersionConflict(zc.buildout.UserError):
def __init__(self, err, ws): def __init__(self, err, ws):
...@@ -1181,6 +1185,7 @@ class VersionConflict(zc.buildout.UserError): ...@@ -1181,6 +1185,7 @@ class VersionConflict(zc.buildout.UserError):
result.append("but %s requires %r." % (dist, str(req))) result.append("but %s requires %r." % (dist, str(req)))
return '\n'.join(result) return '\n'.join(result)
class MissingDistribution(zc.buildout.UserError): class MissingDistribution(zc.buildout.UserError):
def __init__(self, req, ws): def __init__(self, req, ws):
......
...@@ -29,12 +29,14 @@ doesn't import setuptools. Let's try running it to create an egg. ...@@ -29,12 +29,14 @@ doesn't import setuptools. Let's try running it to create an egg.
We'll use the buildout script from our sample buildout: We'll use the buildout script from our sample buildout:
>>> print system(buildout+' setup'), >>> print system(buildout+' setup'),
... # doctest: +NORMALIZE_WHITESPACE
Error: The setup command requires the path to a setup script or Error: The setup command requires the path to a setup script or
directory containing a setup script, and it's arguments. directory containing a setup script, and its arguments.
Oops, we forgot to give the name of the setup script: Oops, we forgot to give the name of the setup script:
>>> print system(buildout+' setup setup.py bdist_egg'), # doctest: +ELLIPSIS >>> print system(buildout+' setup setup.py bdist_egg'),
... # doctest: +ELLIPSIS
Running setup script 'setup.py'. Running setup script 'setup.py'.
... ...
......
...@@ -274,7 +274,7 @@ def buildoutSetUp(test): ...@@ -274,7 +274,7 @@ def buildoutSetUp(test):
# Create the develop-eggs dir, which didn't get created the usual # Create the develop-eggs dir, which didn't get created the usual
# way due to thr trick above: # way due to the trick above:
os.mkdir('develop-eggs') os.mkdir('develop-eggs')
def start_server(path): def start_server(path):
......
...@@ -260,18 +260,18 @@ def make_dist_that_requires(dest, name, requires=[], version=1, egg=''): ...@@ -260,18 +260,18 @@ def make_dist_that_requires(dest, name, requires=[], version=1, egg=''):
def show_who_requires_when_there_is_a_conflict(): def show_who_requires_when_there_is_a_conflict():
""" """
It's a pain when we require eggs that have requirements that are It's a pain when we require eggs that have requirements that are
incompatible. We want the error we get to tell us what is missing. incompatible. We want the error we get to tell us what is missing.
Let's make a few develop distros, some of which have incompatible Let's make a few develop distros, some of which have incompatible
requirements. requirements.
>>> make_dist_that_requires(sample_buildout, 'sampley', >>> make_dist_that_requires(sample_buildout, 'sampley',
... ['demoneeded ==1.0']) ... ['demoneeded ==1.0'])
>>> make_dist_that_requires(sample_buildout, 'samplez', >>> make_dist_that_requires(sample_buildout, 'samplez',
... ['demoneeded ==1.1']) ... ['demoneeded ==1.1'])
Now, let's create a buildout that requires y and z: Now, let's create a buildout that requires y and z:
>>> write('buildout.cfg', >>> write('buildout.cfg',
... ''' ... '''
...@@ -298,8 +298,8 @@ def show_who_requires_when_there_is_a_conflict(): ...@@ -298,8 +298,8 @@ def show_who_requires_when_there_is_a_conflict():
We already have: demoneeded 1.1 We already have: demoneeded 1.1
but sampley 1 requires 'demoneeded==1.0'. but sampley 1 requires 'demoneeded==1.0'.
Here, we see that sampley required an older version of demoneeded. Here, we see that sampley required an older version of demoneeded. What
What if we hadn't required sampley ourselves: if we hadn't required sampley ourselves:
>>> make_dist_that_requires(sample_buildout, 'samplea', ['sampleb']) >>> make_dist_that_requires(sample_buildout, 'samplea', ['sampleb'])
>>> make_dist_that_requires(sample_buildout, 'sampleb', >>> make_dist_that_requires(sample_buildout, 'sampleb',
...@@ -317,7 +317,7 @@ def show_who_requires_when_there_is_a_conflict(): ...@@ -317,7 +317,7 @@ def show_who_requires_when_there_is_a_conflict():
... samplez ... samplez
... ''' % globals()) ... ''' % globals())
If we use the verbose switch, we can see where requirements are comning from: If we use the verbose switch, we can see where requirements are coming from:
>>> print system(buildout+' -v'), # doctest: +ELLIPSIS >>> print system(buildout+' -v'), # doctest: +ELLIPSIS
Installing 'zc.buildout', 'setuptools'. Installing 'zc.buildout', 'setuptools'.
...@@ -351,10 +351,9 @@ If we use the verbose switch, we can see where requirements are comning from: ...@@ -351,10 +351,9 @@ If we use the verbose switch, we can see where requirements are comning from:
def show_who_requires_missing_distributions(): def show_who_requires_missing_distributions():
""" """
When working with a lot of eggs, which require eggs recursively, When working with a lot of eggs, which require eggs recursively, it can
it can be hard to tell why we're requireing things we can't find. be hard to tell why we're requiring things we can't find. Fortunately,
Fortunately, buildout will tell us who's asking for something that buildout will tell us who's asking for something that we can't find.
we can't find.
>>> make_dist_that_requires(sample_buildout, 'sampley', ['demoneeded']) >>> make_dist_that_requires(sample_buildout, 'sampley', ['demoneeded'])
>>> make_dist_that_requires(sample_buildout, 'samplea', ['sampleb']) >>> make_dist_that_requires(sample_buildout, 'samplea', ['sampleb'])
...@@ -387,8 +386,8 @@ def show_who_requires_missing_distributions(): ...@@ -387,8 +386,8 @@ def show_who_requires_missing_distributions():
def test_comparing_saved_options_with_funny_characters(): def test_comparing_saved_options_with_funny_characters():
""" """
If an option has newlines, extra/odd spaces or a %, we need to make If an option has newlines, extra/odd spaces or a %, we need to make sure
sure the comparison with the saved value works correctly. the comparison with the saved value works correctly.
>>> mkdir(sample_buildout, 'recipes') >>> mkdir(sample_buildout, 'recipes')
>>> write(sample_buildout, 'recipes', 'debug.py', >>> write(sample_buildout, 'recipes', 'debug.py',
...@@ -2158,7 +2157,7 @@ def prefer_final(): ...@@ -2158,7 +2157,7 @@ def prefer_final():
""" """
This test tests several permutations: This test tests several permutations:
Using different version numbers to work around zip impporter cache problems. :( Using different version numbers to work around zip importer cache problems. :(
- With prefer final: - With prefer final:
......
...@@ -25,13 +25,13 @@ __test__ = dict( ...@@ -25,13 +25,13 @@ __test__ = dict(
test_selecting_python_via_easy_install= test_selecting_python_via_easy_install=
"""\ """\
We can specify an specific Python executable. We can specify a specific Python executable.
>>> dest = tmpdir('sample-install') >>> dest = tmpdir('sample-install')
>>> ws = zc.buildout.easy_install.install( >>> ws = zc.buildout.easy_install.install(
... ['demo'], dest, links=[link_server], ... ['demo'], dest, links=[link_server],
... index='http://www.python.org/pypi/', ... index='http://www.python.org/pypi/',
... always_unzip=True, executable= other_executable) ... always_unzip=True, executable=other_executable)
>>> ls(dest) >>> ls(dest)
d demo-0.3-py%(other_version)s.egg d demo-0.3-py%(other_version)s.egg
......
...@@ -21,10 +21,9 @@ By default, zc.buildout doesn't unzip zip-safe eggs. ...@@ -21,10 +21,9 @@ By default, zc.buildout doesn't unzip zip-safe eggs.
d setuptools-0.6c8-py2.4.egg d setuptools-0.6c8-py2.4.egg
- zc.buildout.egg-link - zc.buildout.egg-link
This follows the This follows the policy followed by setuptools itself. Experience shows
policy followed by setuptools itself. Experience shows this policy this policy to to be inconvenient. Zipped eggs make debugging more
to to be inconvenient. Zipped eggs make debugging more difficult and difficult and often import more slowly.
often import more slowly.
You can include an unzip option in the buildout section to change the You can include an unzip option in the buildout section to change the
default unzipping policy. default unzipping policy.
......
...@@ -81,9 +81,9 @@ class Eggs(object): ...@@ -81,9 +81,9 @@ class Eggs(object):
ws = zc.buildout.easy_install.install( ws = zc.buildout.easy_install.install(
distributions, options['eggs-directory'], distributions, options['eggs-directory'],
links = self.links, links=self.links,
index = self.index, index=self.index,
executable = options['executable'], executable=options['executable'],
path=[options['develop-eggs-directory']], path=[options['develop-eggs-directory']],
newest=self.buildout['buildout'].get('newest') == 'true', newest=self.buildout['buildout'].get('newest') == 'true',
allow_hosts=self.allow_hosts, allow_hosts=self.allow_hosts,
...@@ -150,7 +150,7 @@ class Scripts(Eggs): ...@@ -150,7 +150,7 @@ class Scripts(Eggs):
reqs.append(parsed.groups()) reqs.append(parsed.groups())
if get_bool(options, 'dependent-scripts'): if get_bool(options, 'dependent-scripts'):
# generate scripts for all packages in the working set, # Generate scripts for all packages in the working set,
# except setuptools. # except setuptools.
reqs = list(reqs) reqs = list(reqs)
for dist in ws: for dist in ws:
...@@ -183,6 +183,6 @@ def get_bool(options, name, default=False): ...@@ -183,6 +183,6 @@ def get_bool(options, name, default=False):
return False return False
else: else:
raise zc.buildout.UserError( raise zc.buildout.UserError(
"Invalid value for %s: %s" % (name, value)) "Invalid value for %s option: %s" % (name, value))
Egg = Scripts Egg = Scripts
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment