Merge pull request #39 from ESSS/ignore-jupytext-files

v1.8.0 - Ignore Python files generated by Jupytext

CHANGELOG.rst

@@ -2,6 +2,12 @@
 History
 =======
 
+1.8.0
+----------
+
+* Ignore Python files generated by `Jupytext`_.
+
+.. _`Jupytext`: https://github.com/mwouts/jupytext
 
 1.7.0
 ----------

esss_fix_format/cli.py

@@ -32,13 +32,29 @@
 def is_cpp(filename):
     """Return True if the filename is of a type that should be treated as C++ source."""
     from fnmatch import fnmatch
-    return any(fnmatch(os.path.split(filename)[-1], p) for p in CPP_PATTERNS)
+    return any(fnmatch(os.path.basename(filename), p) for p in CPP_PATTERNS)
 
 
 def should_format(filename):
-    """Return True if the filename is of a type that is supported by this tool."""
+    """
+    Return a tuple (fmt, reason) where fmt is True if the filename
+    is of a type that is supported by this tool.
+    """
     from fnmatch import fnmatch
-    return any(fnmatch(os.path.split(filename)[-1], p) for p in PATTERNS)
+    filename_no_ext, ext = os.path.splitext(filename)
+    ipynb_filename = filename_no_ext + '.ipynb'
+    # ignore .py file that has a jupytext configured notebook with the same base name
+    if ext == '.py' and os.path.isfile(ipynb_filename):
+        with open(ipynb_filename) as f:
+            if 'jupytext' not in f.read():
+                return True, ''
+        with open(filename) as f:
+            if 'jupytext:' not in f.read():
+                return True, ''
+        return False, 'Jupytext generated file'
+    if any(fnmatch(os.path.basename(filename), p) for p in PATTERNS):
+        return True, ''
+    return False, 'Unknown file type'
 
 
 # caches which directories have the `.clang-format` file, *in or above it*, to avoid hitting the
@@ -155,8 +171,10 @@ def _process_file(filename, check, format_code):
     errors = []
     formatter = None
 
-    if not should_format(filename):
-        click.secho(click.format_filename(filename) + ': Unknown file type', fg='white')
+    fmt, reason = should_format(filename)
+
+    if not fmt:
+        click.secho(click.format_filename(filename) + ': ' + reason, fg='white')
         return changed, errors, formatter
 
     if is_cpp(filename):

setup.py

@@ -20,7 +20,7 @@
 
 setup(
     name='esss_fix_format',
-    version='1.6.0',
+    version='1.8.0',
     description="ESSS code formatter and checker",
     long_description=readme + '\n\n' + changelog,
     author="ESSS",

tests/test_esss_fix_format.py

@@ -211,6 +211,44 @@ def test_empty_file(tmpdir, sort_cfg_to_tmpdir):
     run([str(filename)], expected_exit=0)
 
 
+@pytest.mark.parametrize(
+    'notebook_content, expected_exit', [
+        (u'"jupytext": {"formats": "ipynb,py"}', 0),
+        (u'Not a j-u-p-y-t-e-x-t configured notebook', 1),
+    ]
+)
+def test_ignore_jupytext(tmpdir, sort_cfg_to_tmpdir, notebook_content, expected_exit):
+    filename_py = tmpdir.join('test.py')
+    filename_ipynb = tmpdir.join('test.ipynb')
+
+    py_content = textwrap.dedent('''\
+        # -*- coding: utf-8 -*-
+        # ---
+        # jupyter:
+        #   jupytext:
+        #     formats: ipynb,py:light
+        #     text_representation:
+        #       extension: .py
+        #       format_name: light
+        #       format_version: '1.3'
+        #       jupytext_version: 0.8.6
+        #   kernelspec:
+        #     display_name: Python 3
+        #     language: python
+        #     name: python3
+        # ---
+        import    matplotlib.pyplot   as plt
+    ''')
+
+    filename_py.write(
+        py_content,
+        'w'
+    )
+    filename_ipynb.write(notebook_content, 'w')
+
+    run([str(filename_py), '--check'], expected_exit=expected_exit)
+
+
 @pytest.mark.parametrize('check', [True, False])
 def test_python_with_bom(tmpdir, sort_cfg_to_tmpdir, check):
     filename = tmpdir.join('test.py')