Merge pull request #1221 from pypa/lint

Add linter and code formatter

Author: gaborbernat

.gitattributes

@@ -1 +1 @@
-virtualenv_embedded/*.bat text eol=crlf
+virtualenv_embedded/*.bat text eol=crlf

.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+repos:
+-   repo: https://github.com/ambv/black
+    rev: 18.9b0
+    hooks:
+    -   id: black
+        args: [--safe]
+        language_version: python3.7
+-   repo: https://github.com/asottile/blacken-docs
+    rev: v0.3.0
+    hooks:
+    -   id: blacken-docs
+        additional_dependencies: [black==18.9b0]
+        language_version: python3.7
+-   repo: https://github.com/gaborbernat/seed-isort-config
+    rev: master
+    hooks:
+    -   id: seed-isort-config
+        args: [--application-directories, "src:tests:virtualenv_embedded"]
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v4.3.4
+    hooks:
+    -   id: isort
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: check-merge-conflict
+    -   id: trailing-whitespace
+    -   id: check-docstring-first
+    -   id: flake8
+        additional_dependencies: ["flake8-bugbear == 18.8.0"]
+        language_version: python3.7
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v1.9.1
+    hooks:
+    -   id: pyupgrade
+-   repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.1.0
+    hooks:
+    -   id: rst-backticks

AUTHORS.txt

@@ -7,6 +7,7 @@ Maintainers
 -----------
 
 Brian Rosner
+Bernat Gabor
 Carl Meyer
 Jannis Leidel
 Paul Moore
@@ -88,4 +89,4 @@ Thomas Aglassinger
 Vinay Sajip
 Vitaly Babiy
 Vladimir Rutsky
-Wang Xuerui
+Wang Xuerui

CONTRIBUTING.rst

@@ -10,7 +10,7 @@ Contributor notes
   Use Python 3 print-function syntax, and always ``use sys.exc_info()[1]``
   inside the ``except`` block to get at exception objects.
 
-* Pull requests should be made against `master` branch, which is also our
+* Pull requests should be made against ``master`` branch, which is also our
   latest stable version.
 
 * All changes to files inside virtualenv_embedded should be integrated to

README.rst

@@ -4,10 +4,20 @@ virtualenv
 A tool for creating isolated 'virtual' python environments.
 
 .. image:: https://img.shields.io/pypi/v/virtualenv.svg
-        :target: https://pypi.org/project/virtualenv
-
-.. image:: https://img.shields.io/travis/pypa/virtualenv/develop.svg
-   :target: http://travis-ci.org/pypa/virtualenv
+  :target: https://pypi.org/project/virtualenv
+  :alt: Latest version on PyPi
+.. image:: https://img.shields.io/pypi/pyversions/virtualenv.svg
+  :target: https://pypi.org/project/virtualenv/
+  :alt: Supported Python versions
+.. image:: https://dev.azure.com/pypa/virtualenv/_apis/build/status/pypa.virtualenv
+  :target: https://dev.azure.com/pypa/virtualenv/_apis/build/status/pypa.virtualenv?branchName=master
+  :alt: Azure Pipelines build status
+.. image:: https://readthedocs.org/projects/virtualenv/badge/?version=latest&style=flat-square
+  :target: https://virtualenv.readthedocs.io/en/latest/?badge=latest
+  :alt: Documentation status
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+  :target: https://github.com/ambv/black
+  :alt: Code style: black
 
 * `Installation <https://virtualenv.pypa.io/en/latest/installation.html>`_
 * `Documentation <https://virtualenv.pypa.io/>`_

azure-pipelines.yml

@@ -20,6 +20,8 @@ trigger:
     - .github/*
 
 jobs:
+- template: azure-run-tox-env.yml
+  parameters: {tox: fix_lint, python: 3.7}
 - template: azure-run-tox-env.yml
   parameters: {tox: embed, python: 3.7}
 - template: azure-run-tox-env.yml
@@ -117,4 +119,4 @@ jobs:
       codeCoverageTool: 'cobertura'
       summaryFileLocation: '$(System.DefaultWorkingDirectory)/.tox/coverage.xml'
       reportDirectory: '$(System.DefaultWorkingDirectory)/.tox/htmlcov'
-      failIfCoverageEmpty: true
+      failIfCoverageEmpty: true

bin/rebuild-script.py

@@ -4,80 +4,77 @@
 """
 from __future__ import print_function
 
+import codecs
 import os
 import re
-import codecs
 from zlib import crc32 as _crc32
 
 
 def crc32(data):
     """Python version idempotent"""
-    return _crc32(data) & 0xffffffff
+    return _crc32(data) & 0xFFFFFFFF
 
 
 here = os.path.dirname(__file__)
-script = os.path.join(here, '..', 'src', 'virtualenv.py')
+script = os.path.join(here, "..", "src", "virtualenv.py")
 
-gzip = codecs.lookup('zlib')
-b64 = codecs.lookup('base64')
+gzip = codecs.lookup("zlib")
+b64 = codecs.lookup("base64")
 
-file_regex = re.compile(
-    br'##file (.*?)\n([a-zA-Z][a-zA-Z0-9_]+)\s*=\s*convert\("""\n(.*?)"""\)',
-    re.S)
-file_template = b'##file %(filename)s\n%(varname)s = convert("""\n%(data)s""")'
+file_regex = re.compile(br'# file (.*?)\n([a-zA-Z][a-zA-Z0-9_]+) = convert\(\n    """\n(.*?)"""\n\)', re.S)
+file_template = b'# file %(filename)s\n%(variable)s = convert(\n    """\n%(data)s"""\n)'
 
 
 def rebuild(script_path):
     exit_code = 0
-    with open(script_path, 'rb') as f:
+    with open(script_path, "rb") as f:
         script_content = f.read()
     parts = []
     last_pos = 0
     match = None
-    for match in file_regex.finditer(script_content):
-        parts += [script_content[last_pos:match.start()]]
+    _count = 0
+    for _count, match in enumerate(file_regex.finditer(script_content)):
+        parts += [script_content[last_pos : match.start()]]
         last_pos = match.end()
         filename, fn_decoded = match.group(1), match.group(1).decode()
-        varname = match.group(2)
+        variable = match.group(2)
         data = match.group(3)
 
-        print('Found file %s' % fn_decoded)
-        pathname = os.path.join(here, '..', 'virtualenv_embedded', fn_decoded)
+        print("Found file %s" % fn_decoded)
+        pathname = os.path.join(here, "..", "virtualenv_embedded", fn_decoded)
 
-        with open(pathname, 'rb') as f:
+        with open(pathname, "rb") as f:
             embedded = f.read()
         new_crc = crc32(embedded)
         new_data = b64.encode(gzip.encode(embedded)[0])[0]
 
         if new_data == data:
-            print('  File up to date (crc: %08x)' % new_crc)
+            print("  File up to date (crc: %08x)" % new_crc)
             parts += [match.group(0)]
             continue
         exit_code = 1
         # Else: content has changed
         crc = crc32(gzip.decode(b64.decode(data)[0])[0])
-        print('  Content changed (crc: %08x -> %08x)' %
-              (crc, new_crc))
-        new_match = file_template % {
-            b'filename': filename,
-            b'varname': varname,
-            b'data': new_data
-        }
+        print("  Content changed (crc: {:08x} -> {:08x})".format(crc, new_crc))
+        new_match = file_template % {b"filename": filename, b"variable": variable, b"data": new_data}
         parts += [new_match]
 
     parts += [script_content[last_pos:]]
-    new_content = b''.join(parts)
+    new_content = b"".join(parts)
 
     if new_content != script_content:
-        print('Content updated; overwriting... ', end='')
-        with open(script_path, 'wb') as f:
+        print("Content updated; overwriting... ", end="")
+        with open(script_path, "wb") as f:
             f.write(new_content)
-        print('done.')
+        print("done.")
     else:
-        print('No changes in content')
+        print("No changes in content")
     if match is None:
-        print('No variables were matched/found')
+        print("No variables were matched/found")
+    if not _count:
+        exit_code = 1
     raise SystemExit(exit_code)
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     rebuild(script)

docs/changes.rst

@@ -75,7 +75,7 @@ Release History
 15.0.0 (2016-03-05)
 -------------------
 
-* Remove the `virtualenv-N.N` script from the package; this can no longer be
+* Remove the ``virtualenv-N.N`` script from the package; this can no longer be
   correctly created from a wheel installation.
   Resolves :issue:`851`, :issue:`692`
 
@@ -124,7 +124,7 @@ Release History
 
 * Upgrade setuptools to 19.6
 
-* Supress any errors from `unset` on different shells (:pull:`843`)
+* Suppress any errors from ``unset`` on different shells (:pull:`843`)
 
 * Normalize letter case for prefix path checking. Fixes :issue:`837`
 
@@ -485,7 +485,7 @@ Release History
 1.8.1 (2012-09-03)
 ------------------
 
-* Fixed distribute version used with `--never-download`. Thanks michr for
+* Fixed distribute version used with ``--never-download``. Thanks michr for
   report and patch.
 
 * Fix creating Python 3.3 based virtualenvs by unsetting the
@@ -498,7 +498,7 @@ Release History
 * **Dropped support for Python 2.4** The minimum supported Python version is
   now Python 2.5.
 
-* Fix `--relocatable` on systems that use lib64. Fixes #78. Thanks Branden
+* Fix ``--relocatable`` on systems that use lib64. Fixes #78. Thanks Branden
   Rolston.
 
 * Symlink some additional modules under Python 3. Fixes #194. Thanks Vinay
@@ -556,7 +556,7 @@ Release History
 1.7.1.2 (2012-02-17)
 --------------------
 
-* Fixed minor issue in `--relocatable`. Thanks, Cap Petschulat.
+* Fixed minor issue in ``--relocatable``. Thanks, Cap Petschulat.
 
 
 1.7.1.1 (2012-02-16)
@@ -572,7 +572,7 @@ Release History
 
 * Update embedded pip to version 1.1.
 
-* Fix `--relocatable` under Python 3. Thanks Doug Hellmann.
+* Fix ``--relocatable`` under Python 3. Thanks Doug Hellmann.
 
 * Added environ PATH modification to activate_this.py. Thanks Doug
   Napoleone. Fixes #14.
@@ -592,8 +592,8 @@ Release History
   Napoleone for testing and confirmation. Fixes #87.
 
 * Fixed creation of virtualenvs using -p in installs where some modules
-  that ought to be in the standard library (e.g. `readline`) are actually
-  installed in `site-packages` next to `virtualenv.py`. Thanks Greg Haskins
+  that ought to be in the standard library (e.g. ``readline``) are actually
+  installed in ``site-packages`` next to ``virtualenv.py``. Thanks Greg Haskins
   for report and fix. Fixes #167.
 
 * Added activation script for Powershell (signed by Jannis Leidel). Many