Add pre-commit and linting configuration (#104)

Add pre-commit and linting configuration

Author: nicoddemus

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+exclude: doc/en/example/py2py3/test_py2.py
+repos:
+-   repo: https://github.com/python/black
+    rev: 19.3b0
+    hooks:
+    -   id: black
+        args: [--safe, --quiet]
+-   repo: https://github.com/asottile/blacken-docs
+    rev: v1.0.0
+    hooks:
+    -   id: blacken-docs
+        additional_dependencies: [black==19.3b0]
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: fix-encoding-pragma
+    -   id: check-yaml
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: v1.4.0
+    hooks:
+    -   id: reorder-python-imports
+        args: ['--application-directories=execnet']
+-   repo: local
+    hooks:
+    -   id: rst
+        name: rst
+        entry: rst-lint --encoding utf-8
+        files: ^(CHANGELOG.rst|HOWTORELEASE.rst|README.rst)$
+        language: python
+        additional_dependencies: [pygments, restructuredtext_lint]

.travis.yml

@@ -16,6 +16,8 @@ jobs:
     - stage: baseline
       env: TOXENV=docs
       python: '3.6'
+    - env: TOXENV=linting
+      python: '3.6'
     - env: TOXENV=py27
       python: '2.7'
     - env: TOXENV=py37

ISSUES.txt

@@ -19,25 +19,25 @@ The PID identifies the subprocess which is used for further communication.
 Client             http-exec              subprocess
 
 makegw("...") ->   POST /popen     ->     Popen() with bootstrap
-                   (bootstrap) 
+                   (bootstrap)
                    <- PID
 
 c=rexec(...)       POST /exec/PID         exec source
-(source)                                                 
+(source)
 
 c.send(1)          POST /exec/PID         x = c.receive()
                    (1)                    assert x == 1
                                           c.send(2)
 
-z = c.receive()    GET /exec/PID           
+z = c.receive()    GET /exec/PID
                    <- (2)
 assert z == 2
 
-The client connects via "POST /exec/PID" 
-and pushes data to the remotely-executing code 
+The client connects via "POST /exec/PID"
+and pushes data to the remotely-executing code
 in the subprocess.
 
-The client connects via "GET /exec/PID" 
+The client connects via "GET /exec/PID"
 and receives data from the remotely-executing code.
 
 The client constructs a Channel() object which triggers
@@ -48,21 +48,21 @@ The code executing in the http-execserver controled
 subprocess is a PopenGateway.  It does not know that it
 is connected via the http client/server machinery.
 
-The http-execserver proxies data from the subprocess 
+The http-execserver proxies data from the subprocess
 to the client.  If there is no active GET request, the
 data is queued.
 
 The http-execserver forwards data from the client to the
-subprocess, using the PID.  If the subprocess is not 
+subprocess, using the PID.  If the subprocess is not
 connected, an ERROR code is returned.
 
 Example session:
 
     gw = group.makegateway("http=codespeak.net")
-           
+
     def fun(channel):
         return channel.send(channel.receive()+1)
-                            
+
     ch = gw.remote_exec(fun)
     ch.send(1)
     x = ch.receive()
@@ -121,8 +121,8 @@ tags: 1.1 wish
 
 If using channel.setcallback() it currently is not
 possible to notice the exact errors that might happen
-on the other side.  Either introduce an "errback" 
-or (probably better) optionally allow an extra 'error' 
+on the other side.  Either introduce an "errback"
+or (probably better) optionally allow an extra 'error'
 parameter to execnet callbacks.
 
 fix rsync between python/jython

LICENSE

@@ -5,15 +5,14 @@
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:
-     
+
   The above copyright notice and this permission notice shall be included in all
   copies or substantial portions of the Software.
- 
+
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.
-

README.rst

@@ -22,6 +22,9 @@ of the pytest-xdist plugin. Do not use in new projects.**
 .. image:: https://ci.appveyor.com/api/projects/status/n9qy8df16my4gds9/branch/master?svg=true
     :target: https://ci.appveyor.com/project/pytestbot/execnet
 
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/python/black
+
 .. _execnet: http://codespeak.net/execnet
 
 execnet_ provides carefully tested means to ad-hoc interact with Python

doc/__init__.py

@@ -1 +1,2 @@
+# -*- coding: utf-8 -*-
 #

doc/basics.rst

@@ -246,4 +246,3 @@ For more examples see :ref:`dumps/loads examples`.
 
 .. autofunction:: execnet.dumps(spec)
 .. autofunction:: execnet.loads(spec)
-

doc/conf.py

@@ -10,45 +10,40 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
-import sys
 import os
+import sys
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.append(os.path.dirname(os.path.dirname(__file__)))
 
+from execnet._version import version
+
+release = ".".join(version.split(".")[:2])
+
 # -- General configuration ----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings.
 # They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'execnet'
-copyright = '2012, holger krekel and others'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '1.4'
-# The full version, inpipcluding alpha/beta/rc tags.
-release = '1.4.0.dev1'
+project = "execnet"
+copyright = "2012, holger krekel and others"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -65,7 +60,7 @@
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
-exclude_trees = ['_build']
+exclude_trees = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents
 # dfault_role = None
@@ -84,7 +79,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -94,12 +89,10 @@
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'sphinxdoc'
+html_theme = "sphinxdoc"
 
 # html_index = 'index.html'
-html_sidebars = {
-    'index': ['indexsidebar.html'],
-}
+html_sidebars = {"index": ["indexsidebar.html"]}
 # html_additional_pages = {'index': 'index.html'}
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -129,7 +122,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -160,7 +153,7 @@
 # html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'execnetdoc'
+htmlhelp_basename = "execnetdoc"
 
 
 # -- Options for LaTeX output -------------------------------------------------
@@ -174,8 +167,13 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual])
 latex_documents = [
-  ('index', 'execnet.tex', 'execnet Documentation',
-   'holger krekel and others', 'manual'),
+    (
+        "index",
+        "execnet.tex",
+        "execnet Documentation",
+        "holger krekel and others",
+        "manual",
+    )
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

doc/example/conftest.py

@@ -1,5 +1,7 @@
+# -*- coding: utf-8 -*-
+import sys
 
-import py, sys
+import py
 
 # make execnet and example code importable
 cand = py.path.local(__file__).dirpath().dirpath().dirpath()
@@ -10,4 +12,4 @@
 if str(cand) not in sys.path:
     sys.path.insert(0, str(cand))
 
-pytest_plugins = ['doctest']
+pytest_plugins = ["doctest"]

doc/example/funcmultiplier.py

@@ -1,11 +1,13 @@
-
+# -*- coding: utf-8 -*-
 import execnet
 
+
 def multiplier(channel, factor):
     while not channel.isclosed():
         param = channel.receive()
         channel.send(param * factor)
 
+
 gw = execnet.makegateway()
 channel = gw.remote_exec(multiplier, factor=10)