Merge lp:~gary/zc.buildout/python-support-1-cleanup into lp:zc.buildout

[Gary Poster]

[Gary Poster (gary)]

This branch does three simple things.

- It fixes a few typos.

- It removes a bit of trailing whitespace.

- It makes a test result a bit more robust on Windows.

These changes are extracted out of the rest of the branches for python-support to try and simplify the review.

[lp:~gary/zc.buildout/python-support-1-cleanup]

538. By Gary Poster on 2010-02-17

merge from trunk

[Francis J. Lacoste (flacoste)]

> === modified file 'src/zc/buildout/testing.py'
> --- src/zc/buildout/testing.py 2009-11-06 22:33:23 +0000
> +++ src/zc/buildout/testing.py 2010-02-17 21:22:11 +0000
> @@ -492,10 +492,14 @@
> path = path[1:]
> return '/' + path.replace(os.path.sep, '/')
>
> +if sys.platform == 'win32':
> + sep = r'[\\/]' # Windows uses both sometimes.
> +else:
> + sep = re.escape(os.path.sep)
> normalize_path = (
> re.compile(
> - r'''[^'" \t\n\r]+\%(sep)s_[Tt][Ee][Ss][Tt]_\%(sep)s([^"' \t\n\r]+)'''
> - % dict(sep=os.path.sep)),
> + r'''[^'" \t\n\r]+%(sep)s_[Tt][Ee][Ss][Tt]_%(sep)s([^"' \t\n\r]+)'''
> + % dict(sep=sep)),
> _normalize_path,
> )

I don't understand why you removed the backslash from the normalize_path
regex. IS it that you want the backslash to be a separator only on windows?

Rest looks good.

review: Approve

[Gary Poster (gary)]

Thank you!

I didn't remove the backslash--I switched to using re.escape (for non-Windows). The backslash I removed was escaping the path separator.

For Windows, then, the result will be this.

[^'" \t\n\r]+[\\/]_[Tt][Ee][Ss][Tt]_[\\/]([^"' \t\n\r]+)

IOW, the path separator might be a backslash (Windows path) or a forward slash (typically when it is a URI).

For everything else (if we assume that everything else uses a forward slash for path separators), it will *continue* to be the following, at least effectively (forward slashes actually don't need to be escaped, IIRC, so re.escape won't do anything, and the backslashes didn't do anything before).

[^'" \t\n\r]+/_[Tt][Ee][Ss][Tt]_/([^"' \t\n\r]+)

Actually, now that I think of it, a better change would be this:

sep = os.path.sep
if sep != "/":
    sep = r'[%s/]' % re.escape(sep) # May be a path or a URI\
...
and then the compilation

Unmerged revisions

538. By Gary Poster on 2010-02-17

merge from trunk

537. By gary on 2010-02-10

the whitespace-police, the typo-police, the grammar police, and the Windows testing police all joined together for this check-in of mostly trivial changes.

536. By gary on 2010-02-10

another typo branch

=== modified file 'README.txt'
--- README.txt	2010-01-08 05:54:43 +0000
+++ README.txt	2010-02-17 21:22:11 +0000
@@ -126,7 +126,7 @@
 `--version` option of the bootstrap.py script::
 
     $ python bootstrap.py --version 1.1.3
-    
+
 The `zc.buildout project <http://svn.zope.org/zc.buildout/trunk>`_
 is a slightly more complex example of this type of buildout.
 
 
=== modified file 'src/zc/buildout/easy_install.py'
--- src/zc/buildout/easy_install.py	2009-11-11 21:21:11 +0000
+++ src/zc/buildout/easy_install.py	2010-02-17 21:22:11 +0000
@@ -495,7 +495,7 @@
 
                 if dist is None:
                     raise zc.buildout.UserError(
-                        "Couln't download distribution %s." % avail)
+                        "Couldn't download distribution %s." % avail)
 
                 if dist.precedence == pkg_resources.EGG_DIST:
                     # It's already an egg, just fetch it into the dest
@@ -628,9 +628,9 @@
         logger.debug('Installing %s.', repr(specs)[1:-1])
 
         path = self._path
-        dest = self._dest
-        if dest is not None and dest not in path:
-            path.insert(0, dest)
+        destination = self._dest
+        if destination is not None and destination not in path:
+            path.insert(0, destination)
 
         requirements = [self._constrain(pkg_resources.Requirement.parse(spec))
                         for spec in specs]
@@ -661,7 +661,7 @@
             except pkg_resources.DistributionNotFound, err:
                 [requirement] = err
                 requirement = self._constrain(requirement)
-                if dest:
+                if destination:
                     logger.debug('Getting required %r', str(requirement))
                 else:
                     logger.debug('Adding required %r', str(requirement))
 
=== modified file 'src/zc/buildout/testing.py'
--- src/zc/buildout/testing.py	2009-11-06 22:33:23 +0000
+++ src/zc/buildout/testing.py	2010-02-17 21:22:11 +0000
@@ -492,10 +492,14 @@
             path = path[1:]
     return '/' + path.replace(os.path.sep, '/')
 
+if sys.platform == 'win32':
+    sep = r'[\\/]' # Windows uses both sometimes.
+else:
+    sep = re.escape(os.path.sep)
 normalize_path = (
     re.compile(
-        r'''[^'" \t\n\r]+\%(sep)s_[Tt][Ee][Ss][Tt]_\%(sep)s([^"' \t\n\r]+)'''
-        % dict(sep=os.path.sep)),
+        r'''[^'" \t\n\r]+%(sep)s_[Tt][Ee][Ss][Tt]_%(sep)s([^"' \t\n\r]+)'''
+        % dict(sep=sep)),
     _normalize_path,
     )
 
 
=== modified file 'src/zc/buildout/tests.py'
--- src/zc/buildout/tests.py	2009-11-11 21:21:11 +0000
+++ src/zc/buildout/tests.py	2010-02-17 21:22:11 +0000
@@ -2880,7 +2880,7 @@
                 'We have a develop egg: zc.buildout X.X.'),
                (re.compile(r'\\[\\]?'), '/'),
                (re.compile('WindowsError'), 'OSError'),
-               (re.compile(r'\[Error 17\] Cannot create a file '
+               (re.compile(r'\[Error \d+\] Cannot create a file '
                            r'when that file already exists: '),
                 '[Errno 17] File exists: '
                 ),
@@ -2933,6 +2933,7 @@
                (re.compile('extdemo[.]pyd'), 'extdemo.so'),
                (re.compile('[-d]  setuptools-\S+[.]egg'), 'setuptools.egg'),
                (re.compile(r'\\[\\]?'), '/'),
+               (re.compile(r'\#!\S+\bpython\S*'), '#!/usr/bin/python'),
                ]+(sys.version_info < (2, 5) and [
                   (re.compile('.*No module named runpy.*', re.S), ''),
                   (re.compile('.*usage: pdb.py scriptfile .*', re.S), ''),
 
=== modified file 'zc.recipe.egg_/src/zc/recipe/egg/README.txt'
--- zc.recipe.egg_/src/zc/recipe/egg/README.txt	2009-11-06 22:33:23 +0000
+++ zc.recipe.egg_/src/zc/recipe/egg/README.txt	2010-02-17 21:22:11 +0000
@@ -46,7 +46,7 @@
     <a href="other-1.0-py2.3.egg">other-1.0-py2.3.egg</a><br>
     </body></html>
 
-We have a sample buildout.  Let's update it's configuration file to
+We have a sample buildout.  Let's update its configuration file to
 install the demo package.
 
     >>> write(sample_buildout, 'buildout.cfg',
@@ -187,7 +187,7 @@
     ... interpreter = py-demo
     ... """ % dict(server=link_server))
 
-Note that we ommitted the entry point name from the recipe
+Note that we omitted the entry point name from the recipe
 specification. We were able to do this because the scripts recipe is
 the default entry point for the zc.recipe.egg egg.
 
 
=== modified file 'zc.recipe.egg_/src/zc/recipe/egg/api.txt'
--- zc.recipe.egg_/src/zc/recipe/egg/api.txt	2008-07-15 23:09:58 +0000
+++ zc.recipe.egg_/src/zc/recipe/egg/api.txt	2010-02-17 21:22:11 +0000
@@ -15,7 +15,7 @@
 around the egg recipe:
 
     >>> mkdir(sample_buildout, 'sample')
-    >>> write(sample_buildout, 'sample', 'sample.py', 
+    >>> write(sample_buildout, 'sample', 'sample.py',
     ... """
     ... import logging, os
     ... import zc.recipe.egg
@@ -53,7 +53,7 @@
     >>> write(sample_buildout, 'sample', 'setup.py',
     ... """
     ... from setuptools import setup
-    ... 
+    ...
     ... setup(
     ...     name = "sample",
     ...     entry_points = {'zc.buildout': ['default = sample:Sample']},
@@ -95,12 +95,13 @@
 computed by the egg recipe by looking at .installed.cfg:
 
     >>> cat(sample_buildout, '.installed.cfg')
+    ... # doctest: +NORMALIZE_WHITESPACE
     [buildout]
     installed_develop_eggs = /sample-buildout/develop-eggs/sample.egg-link
     parts = sample-part
     <BLANKLINE>
     [sample-part]
-    __buildout_installed__ = 
+    __buildout_installed__ =
     __buildout_signature__ = sample-6aWMvV2EJ9Ijq+bR8ugArQ==
             zc.recipe.egg-cAsnudgkduAa/Fd+WJIM6Q==
             setuptools-0.6-py2.4.egg
 
=== modified file 'zc.recipe.egg_/src/zc/recipe/egg/custom.txt'
--- zc.recipe.egg_/src/zc/recipe/egg/custom.txt	2008-08-27 06:48:40 +0000
+++ zc.recipe.egg_/src/zc/recipe/egg/custom.txt	2010-02-17 21:22:11 +0000
@@ -50,7 +50,7 @@
 swig
    The path to the swig executable
 
-swig-cpp           
+swig-cpp
    Make SWIG create C++ files (default is C)
 
 swig-opts
@@ -73,14 +73,14 @@
    alternate index with this option.  If you use the links option and
    if the links point to the needed distributions, then the index can
    be anything and will be largely ignored.  In the examples, here,
-   we'll just point to an empty directory on our link server.  This 
+   we'll just point to an empty directory on our link server.  This
    will make our examples run a little bit faster.
 
 python
    The name of a section to get the Python executable from.
    If not specified, then the buildout python option is used.  The
    Python executable is found in the executable option of the named
-   section. 
+   section.
 
 environment
    The name of a section with additional environment variables. The
@@ -188,7 +188,7 @@
     ...
     ... [demo]
     ... recipe = zc.recipe.egg
-    ... eggs = demo 
+    ... eggs = demo
     ...        extdemo
     ... entry-points = demo=demo:main
     ... """ % dict(server=link_server))
@@ -270,7 +270,7 @@
     ...
     ... [demo]
     ... recipe = zc.recipe.egg
-    ... eggs = demo 
+    ... eggs = demo
     ...        extdemo ==1.4
     ... entry-points = demo=demo:main
     ... """ % dict(server=link_server))
@@ -440,7 +440,7 @@
     Uninstalling extdemo.
     Installing extdemo.
     zip_safe flag not set; analyzing archive contents...
-    
+
     >>> rmdir(sample_buildout, 'recipes')
 
 
@@ -496,7 +496,7 @@
 swig
    The path to the swig executable
 
-swig-cpp           
+swig-cpp
    Make SWIG create C++ files (default is C)
 
 swig-opts
@@ -506,7 +506,7 @@
    The name of a section to get the Python executable from.
    If not specified, then the buildout python option is used.  The
    Python executable is found in the executable option of the named
-   section. 
+   section.
 
 To illustrate this, we'll use a directory containing the extdemo
 example from the earlier section:
@@ -532,7 +532,7 @@
     ...
     ... [demo]
     ... recipe = zc.recipe.egg
-    ... eggs = demo 
+    ... eggs = demo
     ...        extdemo
     ... entry-points = demo=demo:main
     ... """ % dict(extdemo=extdemo))
 
=== modified file 'zc.recipe.egg_/src/zc/recipe/egg/selecting-python.txt'
--- zc.recipe.egg_/src/zc/recipe/egg/selecting-python.txt	2009-08-28 20:55:09 +0000
+++ zc.recipe.egg_/src/zc/recipe/egg/selecting-python.txt	2010-02-17 21:22:11 +0000
@@ -24,8 +24,8 @@
     <a href="other-1.0-py2.4.egg">other-1.0-py2.4.egg</a><br>
     </body></html>
 
-We have a sample buildout.  Let's update it's configuration file to
-install the demo package using Python 2.4. 
+We have a sample buildout.  Let's update its configuration file to
+install the demo package using Python 2.4.
 
     >>> write(sample_buildout, 'buildout.cfg',
     ... """
@@ -69,7 +69,7 @@
     d  setuptools-0.6-py2.4.egg
     d  setuptools-0.6-py2.5.egg
     -  zc.buildout-1.0-py2.5.egg
- 
+
 And the generated scripts invoke Python 2.4:
 
     >>> import sys
 
=== modified file 'zc.recipe.egg_/src/zc/recipe/egg/tests.py'
--- zc.recipe.egg_/src/zc/recipe/egg/tests.py	2009-06-22 14:10:12 +0000
+++ zc.recipe.egg_/src/zc/recipe/egg/tests.py	2010-02-17 21:22:11 +0000
@@ -36,7 +36,7 @@
 def setUpSelecting(test):
     zc.buildout.testselectingpython.setup(test)
     zc.buildout.testing.install_develop('zc.recipe.egg', test)
-    
+
 def test_suite():
     suite = unittest.TestSuite((
         doctest.DocFileSuite(
@@ -67,7 +67,7 @@
                            'setuptools-\S+\s+'
                            'zc.buildout-\S+\s*'
                            ),
-                '__buildout_signature__ = sample- zc.recipe.egg-'),
+                '__buildout_signature__ = sample- zc.recipe.egg-\n'),
                (re.compile('executable = [\S ]+python\S*', re.I),
                 'executable = python'),
                (re.compile('find-links = http://localhost:\d+/'),
@@ -89,7 +89,7 @@
                (re.compile('extdemo[.]pyd'), 'extdemo.so')
                ]),
             ),
-        
+
         ))
 
     if sys.version_info[:2] == (2, 5):
@@ -115,7 +115,7 @@
                    ]),
                 ),
             )
-    
+
     return suite
 
 if __name__ == '__main__':