Handling Windows newlines.

Handling Windows newlines in regex in linters. Was working in AppVeyor
but not my Win10 VM.

Handling read only permissions on Windows with shutil.rmtree.

Fixing pylint on Windows with __import__().

Handling Windows newlines in tests.

Author: Robpol86

setup.py

@@ -60,11 +60,12 @@ def run(cls):
             if getattr(project, var) != expected:
                 raise SystemExit('Mismatch: {0}'.format(var))
         # Check changelog.
-        if not re.compile(r'^%s - \d{4}-\d{2}-\d{2}$' % VERSION, re.MULTILINE).search(readme()):
+        if not re.compile(r'^%s - \d{4}-\d{2}-\d{2}[\r\n]' % VERSION, re.MULTILINE).search(readme()):
             raise SystemExit('Version not found in readme/changelog file.')
         # Check tox.
         if INSTALL_REQUIRES:
-            section = re.compile(r'\ninstall_requires =\n(.+?)\n\w', re.DOTALL).findall(readme('tox.ini'))
+            contents = readme('tox.ini')
+            section = re.compile(r'[\r\n]+install_requires =[\r\n]+(.+?)[\r\n]+\w', re.DOTALL).findall(contents)
             if not section:
                 raise SystemExit('Missing install_requires section in tox.ini.')
             in_tox = re.findall(r'    ([^=]+)==[\w\d.-]+', section[0])

sphinxcontrib/versioning/lib.py

@@ -3,6 +3,7 @@
 import atexit
 import functools
 import logging
+import os
 import shutil
 import tempfile
 import weakref
@@ -163,4 +164,6 @@ def __exit__(self, *_):
 
     def cleanup(self):
         """Recursively delete directory."""
-        shutil.rmtree(self.name)
+        shutil.rmtree(self.name, onerror=lambda *a: os.chmod(a[1], __import__('stat').S_IWRITE) or os.unlink(a[1]))
+        if os.path.exists(self.name):
+            raise IOError(17, "File exists: '{}'".format(self.name))

sphinxcontrib/versioning/versions.py

@@ -1,6 +1,5 @@
 """Collect and sort version strings."""
 
-import posixpath
 import re
 
 RE_SEMVER = re.compile(r'^v?V?(\d+)(?:\.(\d+))?(?:\.(\d+))?(?:\.(\d+))?(?:\.(\d+))?(?:\.(\d+))?(?:\.(\d+))?([\w.+-]*)$')
@@ -239,4 +238,4 @@ def vpathto(self, other_version):
         components = ['..'] * pagename.count('/')
         components += [other_root_dir] if is_root else ['..', other_root_dir]
         components += [pagename if self.vhasdoc(other_version) else other_remote['master_doc']]
-        return '{}.html'.format(posixpath.join(*components))
+        return '{}.html'.format(__import__('posixpath').join(*components))

tests/test__main__/test_main_build_scenarios.py

@@ -5,6 +5,8 @@
 
 import pytest
 
+from sphinxcontrib.versioning.git import IS_WINDOWS
+
 
 def test_sub_page_and_tag(tmpdir, local_docs, run, urls):
     """Test with sub pages and one git tag. Testing from local git repo.
@@ -282,7 +284,7 @@ def test_root_ref(tmpdir, local_docs, run, no_tags):
         else:
             assert 'No git tags with docs found in remote. Falling back to --root-ref value.' not in output
         # Check output.
-        assert 'Root ref is: {}\n'.format(expected) in output
+        assert 'Root ref is: {}'.format(expected) in output
 
 
 @pytest.mark.parametrize('parallel', [False, True])
@@ -295,6 +297,8 @@ def test_add_remove_docs(tmpdir, local_docs, run, urls, parallel):
     :param urls: conftest fixture.
     :param bool parallel: Run sphinx-build with -j option.
     """
+    if parallel and IS_WINDOWS:
+        return pytest.skip('Sphinx parallel feature not available on Windows.')
     run(local_docs, ['git', 'tag', 'v1.0.0'])
 
     # Move once.
@@ -544,8 +548,8 @@ def test_whitelisting(local_docs, run, urls):
     assert 'Traceback' not in output
 
     # Check output.
-    assert 'With docs: ignored included master v1.0 v1.0-dev\n' in output
-    assert 'Passed whitelisting: included master v1.0\n' in output
+    assert 'With docs: ignored included master v1.0 v1.0-dev' in output
+    assert 'Passed whitelisting: included master v1.0' in output
 
     # Check root.
     urls(local_docs.join('html', 'contents.html'), [
@@ -639,12 +643,12 @@ def test_error_bad_path(tmpdir, run):
     """
     with pytest.raises(CalledProcessError) as exc:
         run(tmpdir, ['sphinx-versioning', '-N', '-c', 'unknown', 'build', '.', str(tmpdir)])
-    assert 'Directory "unknown" does not exist.\n' in exc.value.output
+    assert 'Directory "unknown" does not exist.' in exc.value.output
 
     tmpdir.ensure('is_file')
     with pytest.raises(CalledProcessError) as exc:
         run(tmpdir, ['sphinx-versioning', '-N', '-c', 'is_file', 'build', '.', str(tmpdir)])
-    assert 'Directory "is_file" is a file.\n' in exc.value.output
+    assert 'Directory "is_file" is a file.' in exc.value.output
 
     with pytest.raises(CalledProcessError) as exc:
         run(tmpdir, ['sphinx-versioning', '-N', 'build', '.', str(tmpdir)])
@@ -667,7 +671,7 @@ def test_error_no_docs_found(tmpdir, local, run):
     """
     with pytest.raises(CalledProcessError) as exc:
         run(local, ['sphinx-versioning', '-N', '-v', 'build', '.', str(tmpdir)])
-    assert 'No docs found in any remote branch/tag. Nothing to do.\n' in exc.value.output
+    assert 'No docs found in any remote branch/tag. Nothing to do.' in exc.value.output
 
 
 def test_error_bad_root_ref(tmpdir, local_docs, run):
@@ -679,4 +683,4 @@ def test_error_bad_root_ref(tmpdir, local_docs, run):
     """
     with pytest.raises(CalledProcessError) as exc:
         run(local_docs, ['sphinx-versioning', '-N', '-v', 'build', '.', str(tmpdir), '-r', 'unknown'])
-    assert 'Root ref unknown not found in: master\n' in exc.value.output
+    assert 'Root ref unknown not found in: master' in exc.value.output

tests/test__main__/test_main_push_scenarios.py

@@ -102,7 +102,7 @@ def test_root_ref(local_docs_ghp, run):
     assert 'Failed to push to remote repository.' not in output
 
     # Check output.
-    assert 'Root ref is: v1.0.0\n' in output
+    assert 'Root ref is: v1.0.0' in output
 
 
 @pytest.mark.parametrize('give_up', [False, True])
@@ -129,7 +129,7 @@ def test_race(tmpdir, local_docs_ghp, remote, run, urls, give_up):
     proc = Popen(command, cwd=str(local_docs_ghp), env=env, stdout=PIPE, stderr=STDOUT)
     for line in iter(proc.stdout.readline, b''):
         output_lines.append(line)
-        if line == b'=> Building docs...\n':
+        if line.strip() == b'=> Building docs...':
             if give_up or not caused:
                 # Cause race condition.
                 local_other.join('README').write('changed', mode='a')
@@ -307,7 +307,7 @@ def test_error_build_failure(local_docs_ghp, run):
     assert "name 'undefined' is not defined" in exc.value.output
     assert 'Building docs...' in exc.value.output
     assert 'sphinx-build failed for branch/tag: master' in exc.value.output
-    assert exc.value.output.endswith('Failure.\n')
+    assert exc.value.output.strip().endswith('Failure.')
 
 
 def test_bad_git_config(local_docs_ghp, run):