try adding black conversion

Author: JohnMount

coverage.txt

@@ -1,5 +1,5 @@
 ============================= test session starts ==============================
-platform darwin -- Python 3.9.12, pytest-7.1.1, pluggy-1.0.0
+platform darwin -- Python 3.9.7, pytest-6.2.5, py-1.11.0, pluggy-1.0.0
 rootdir: /Users/johnmount/Documents/work/wvpy/pkg
 plugins: anyio-3.5.0, cov-3.0.0
 collected 20 items
@@ -19,26 +19,16 @@ tests/test_stats1.py .                                                   [ 90%]
 tests/test_threshold_stats.py .                                          [ 95%]
 tests/test_typs_in_frame.py .                                            [100%]
 
-=============================== warnings summary ===============================
-../../../../opt/anaconda3/envs/research_env/lib/python3.9/site-packages/seaborn/rcmod.py:82
-  /Users/johnmount/opt/anaconda3/envs/research_env/lib/python3.9/site-packages/seaborn/rcmod.py:82: DeprecationWarning: distutils Version classes are deprecated. Use packaging.version instead.
-    if LooseVersion(mpl.__version__) >= "3.0":
-
-../../../../opt/anaconda3/envs/research_env/lib/python3.9/site-packages/setuptools/_distutils/version.py:351
-  /Users/johnmount/opt/anaconda3/envs/research_env/lib/python3.9/site-packages/setuptools/_distutils/version.py:351: DeprecationWarning: distutils Version classes are deprecated. Use packaging.version instead.
-    other = LooseVersion(other)
-
--- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
-
----------- coverage: platform darwin, python 3.9.12-final-0 ----------
+---------- coverage: platform darwin, python 3.9.7-final-0 -----------
 Name                      Stmts   Miss  Cover
 ---------------------------------------------
 wvpy/__init__.py              3      0   100%
-wvpy/jtools.py              178     58    67%
-wvpy/pysheet.py              89     89     0%
+wvpy/jtools.py              206     76    63%
+wvpy/pysheet.py              91     91     0%
 wvpy/render_workbook.py      47     47     0%
 wvpy/util.py                321      7    98%
 ---------------------------------------------
-TOTAL                       638    201    68%
+TOTAL                       668    221    67%
+
 
-======================= 20 passed, 2 warnings in 16.34s ========================
+============================= 20 passed in 13.26s ==============================

pkg/build/lib/wvpy/__init__.py

@@ -1,5 +1,5 @@
 __docformat__ = "restructuredtext"
-__version__ = "0.3.5"
+__version__ = "0.3.6"
 
 __doc__ = """
 This<https://github.com/WinVector/wvpy> is a package of example files for teaching data science.

pkg/build/lib/wvpy/jtools.py

@@ -15,21 +15,55 @@
 except ModuleNotFoundError:
     pass
 
+have_black = False
+try:
+    import black
+    have_black = True
+except ModuleNotFoundError:
+    pass
+
+
+# noinspection PyBroadException
+def pretty_format_python(python_txt: str, *, black_mode=None) -> str:
+    """
+    Format Python code, using black.
+
+    :param python_txt: Python code
+    :param black_mode: options for black
+    :return: formatted Python code
+    """
+    assert have_black
+    assert isinstance(python_txt, str)
+    formatted_python = python_txt.strip('\n') + '\n'
+    if len(formatted_python.strip()) > 0:
+        if black_mode is None:
+            black_mode = black.FileMode()
+        try:
+            formatted_python = black.format_str(formatted_python, mode=black_mode)
+            formatted_python = formatted_python.strip('\n') + '\n'
+        except Exception:
+            pass
+    return formatted_python
 
 
-def convert_py_code_to_notebook(text: str) -> nbformat.notebooknode.NotebookNode:
+def convert_py_code_to_notebook(
+    text: str,
+    *,
+    use_black:bool = False) -> nbformat.notebooknode.NotebookNode:
     """
     Convert python text to a notebook. 
     "''' begin text" ends any open blocks, and starts a new markdown block (triple double quotes also allowed)
     "''' # end text" ends text, and starts a new code block (triple double quotes also allowed)
     "'''end code'''" ends code blocks, and starts a new code block (triple double quotes also allowed)
 
     :param text: Python text to convert.
+    :param use_black: if True use black to re-format Python code
     :return: a notebook 
     """
     # https://stackoverflow.com/a/23729611/6901725
     # https://nbviewer.org/gist/fperez/9716279
     assert isinstance(text, str)
+    assert isinstance(use_black, bool)
     lines = text.splitlines()
     begin_text_regexp = re.compile(r"^\s*r?((''')|(\"\"\"))\s*begin\s+text\s*$")
     end_text_regexp = re.compile(r"^\s*r?((''')|(\"\"\"))\s*#\s*end\s+text\s*$")
@@ -55,9 +89,11 @@ def convert_py_code_to_notebook(text: str) -> nbformat.notebooknode.NotebookNode
             code_end = end_code_regexp.match(line)
         if is_end or text_start or code_start or code_end:
             if (collecting_python is not None) and (len(collecting_python) > 0):
-                txt_block = ('\n'.join(collecting_python)).strip('\n') + '\n'
-                if len(txt_block.strip()) > 0:
-                    cells.append(nbf_v.new_code_cell(txt_block))
+                python_block = ('\n'.join(collecting_python)).strip('\n') + '\n'
+                if len(python_block.strip()) > 0:
+                    if use_black and have_black:
+                        python_block = pretty_format_python(python_block)
+                    cells.append(nbf_v.new_code_cell(python_block))
             if (collecting_text is not None) and (len(collecting_text) > 0):
                 txt_block = ('\n'.join(collecting_text)).strip('\n') + '\n'
                 if len(txt_block.strip()) > 0:
@@ -96,7 +132,12 @@ def prepend_code_cell_to_notebook(
     return nb_out
 
 
-def convert_py_file_to_notebook(*, py_file: str, ipynb_file: str) -> None:
+def convert_py_file_to_notebook(
+    py_file: str, 
+    *,
+    ipynb_file: str,
+    use_black: bool = False,
+    ) -> None:
     """
     Convert python text to a notebook. 
     "''' begin text" ends any open blocks, and starts a new markdown block (triple double quotes also allowed)
@@ -105,36 +146,47 @@ def convert_py_file_to_notebook(*, py_file: str, ipynb_file: str) -> None:
 
     :param py_file: Path to python source file.
     :param ipynb_file: Path to notebook result file.
+    :param use_black: if True use black to re-format Python code
     :return: nothing 
     """
     assert isinstance(py_file, str)
     assert isinstance(ipynb_file, str)
+    assert isinstance(use_black, bool)
     assert py_file != ipynb_file  # prevent clobber
     with open(py_file, 'r') as f:
         text = f.read()
-    nb = convert_py_code_to_notebook(text)
+    nb = convert_py_code_to_notebook(text, use_black=use_black)
     with open(ipynb_file, 'w') as f:
         nbformat.write(nb, f)
 
 
-def convert_notebook_code_to_py(nb: nbformat.notebooknode.NotebookNode) -> str:
+def convert_notebook_code_to_py(
+    nb: nbformat.notebooknode.NotebookNode,
+    *,
+    use_black: bool = False,
+    ) -> str:
     """
     Convert ipython notebook inputs to a py code. 
     "''' begin text" ends any open blocks, and starts a new markdown block (triple double quotes also allowed)
     "''' # end text" ends text, and starts a new code block (triple double quotes also allowed)
     "'''end code'''" ends code blocks, and starts a new code block (triple double quotes also allowed)
 
     :param nb: notebook
+    :param use_black: if True use black to re-format Python code
     :return: Python source code
     """
+    assert isinstance(use_black, bool)
     res = []
     code_needs_end = False
     for cell in nb.cells:
         if len(cell.source.strip()) > 0:
             if cell.cell_type == 'code':
                 if code_needs_end:
                     res.append('\n"""end code"""\n')
-                res.append(cell.source.strip('\n'))
+                py_text = cell.source.strip('\n') + '\n'
+                if use_black and have_black:
+                    py_text = pretty_format_python(py_text)
+                res.append(py_text)
                 code_needs_end = True
             else:
                 res.append('\n""" begin text')
@@ -145,7 +197,12 @@ def convert_notebook_code_to_py(nb: nbformat.notebooknode.NotebookNode) -> str:
     return res_text
 
 
-def convert_notebook_file_to_py(*, ipynb_file: str, py_file: str) -> None:
+def convert_notebook_file_to_py(
+    ipynb_file: str,
+    *,  
+    py_file: str,
+    use_black: bool = False,
+    ) -> None:
     """
     Convert ipython notebook inputs to a py file. 
     "''' begin text" ends any open blocks, and starts a new markdown block (triple double quotes also allowed)
@@ -154,14 +211,16 @@ def convert_notebook_file_to_py(*, ipynb_file: str, py_file: str) -> None:
 
     :param ipynb_file: Path to notebook input file.
     :param py_file: Path to python result file.
+    :param use_black: if True use black to re-format Python code
     :return: nothing
     """
     assert isinstance(py_file, str)
     assert isinstance(ipynb_file, str)
+    assert isinstance(use_black, bool)
     assert py_file != ipynb_file  # prevent clobber
     with open(ipynb_file, "rb") as f:
         nb = nbformat.read(f, as_version=4)
-    py_source = convert_notebook_code_to_py(nb)
+    py_source = convert_notebook_code_to_py(nb, use_black=use_black)
     with open(py_file, 'w') as f:
         f.write(py_source)        
 

pkg/build/lib/wvpy/pysheet.py

@@ -13,8 +13,9 @@
 
 def main() -> int:
     parser = argparse.ArgumentParser(description="Convert between .py and .ipynb or back (can have suffix, or guess suffix)")
-    parser.add_argument('--quiet', action='store_true', help='delete input file')
+    parser.add_argument('--quiet', action='store_true', help='quite operation')
     parser.add_argument('--delete', action='store_true', help='delete input file')
+    parser.add_argument('--black', action='store_true', help='use black to re-format cells')
     parser.add_argument(
         'infile', 
         metavar='infile', 
@@ -27,6 +28,7 @@ def main() -> int:
     assert len(set(args.infile)) == len(args.infile)
     assert isinstance(args.quiet, bool)
     assert isinstance(args.delete, bool)
+    assert isinstance(args.black, bool)
     # set up the work request
     base_names_seen = set()
     input_suffices_seen = set()
@@ -79,13 +81,16 @@ def main() -> int:
             convert_py_file_to_notebook(
                 py_file=input_file_name,
                 ipynb_file=output_file_name,
+                use_black=args.black,
             )
         elif input_file_name.endswith('.ipynb'):
             if not args.quiet:
                 print(f'   converting Jupyter notebook "{input_file_name}" to Python "{output_file_name}"')
             convert_notebook_file_to_py(
                 ipynb_file=input_file_name,
-                py_file=output_file_name)
+                py_file=output_file_name,
+                use_black=args.black,
+            )
         else:
             raise ValueError("input file name must end with .py or .ipynb")
         # do any deletions

pkg/build/lib/wvpy/render_workbook.py

@@ -18,8 +18,8 @@ def main() -> int:
         type=str, 
         nargs='+',
         help='name of input file(s)')
-    parser.add_argument('--strip_input', action='store_true')
-    parser.add_argument('--quiet', action='store_true')
+    parser.add_argument('--strip_input', action='store_true', help="strip input cells and cell markers")
+    parser.add_argument('--quiet', action='store_true', help='quiet operation')
     args = parser.parse_args()
     # checks
     assert isinstance(args.quiet, bool)