rebuild and retest

Author: JohnMount

coverage.txt

@@ -1,20 +1,42 @@
 ============================= test session starts ==============================
-platform darwin -- Python 3.11.2, pytest-7.1.2, pluggy-1.0.0
+platform darwin -- Python 3.11.3, pytest-7.3.1, pluggy-1.0.0
 rootdir: /Users/johnmount/Documents/work/wvpy/pkg
 plugins: anyio-3.5.0, cov-4.0.0
-collected 10 items
+collected 13 items
 
-tests/test_nb_fns.py ..........                                          [100%]
+tests/test_nb_fns.py .............                                       [100%]
 
----------- coverage: platform darwin, python 3.11.2-final-0 ----------
+=============================== warnings summary ===============================
+tests/test_nb_fns.py::test_jupyter_notebook_good
+  /Users/johnmount/opt/anaconda3/envs/wvpy_dev_env/lib/python3.11/site-packages/debugpy/_vendored/pydevd/pydevd_plugins/extensions/__init__.py:4: DeprecationWarning: Deprecated call to `pkg_resources.declare_namespace('pydevd_plugins.extensions')`.
+  Implementing implicit namespace packages (as specified in PEP 420) is preferred to `pkg_resources.declare_namespace`. See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages
+    __import__('pkg_resources').declare_namespace(__name__)
+
+tests/test_nb_fns.py::test_jupyter_notebook_good
+  /Users/johnmount/opt/anaconda3/envs/wvpy_dev_env/lib/python3.11/site-packages/pkg_resources/__init__.py:2349: DeprecationWarning: Deprecated call to `pkg_resources.declare_namespace('pydevd_plugins')`.
+  Implementing implicit namespace packages (as specified in PEP 420) is preferred to `pkg_resources.declare_namespace`. See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages
+    declare_namespace(parent)
+
+tests/test_nb_fns.py::test_jupyter_notebook_good
+  /Users/johnmount/opt/anaconda3/envs/wvpy_dev_env/lib/python3.11/site-packages/debugpy/_vendored/pydevd/pydevd_plugins/extensions/types/__init__.py:4: DeprecationWarning: Deprecated call to `pkg_resources.declare_namespace('pydevd_plugins.extensions.types')`.
+  Implementing implicit namespace packages (as specified in PEP 420) is preferred to `pkg_resources.declare_namespace`. See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages
+    __import__('pkg_resources').declare_namespace(__name__)
+
+tests/test_nb_fns.py::test_jupyter_notebook_good
+  /Users/johnmount/opt/anaconda3/envs/wvpy_dev_env/lib/python3.11/site-packages/pkg_resources/__init__.py:2349: DeprecationWarning: Deprecated call to `pkg_resources.declare_namespace('pydevd_plugins.extensions')`.
+  Implementing implicit namespace packages (as specified in PEP 420) is preferred to `pkg_resources.declare_namespace`. See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages
+    declare_namespace(parent)
+
+-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
+
+---------- coverage: platform darwin, python 3.11.3-final-0 ----------
 Name                      Stmts   Miss  Cover
 ---------------------------------------------
 wvpy/__init__.py              3      0   100%
-wvpy/jtools.py              305     98    68%
+wvpy/jtools.py              328    104    68%
 wvpy/pysheet.py              99     99     0%
 wvpy/render_workbook.py      54     54     0%
 ---------------------------------------------
-TOTAL                       461    251    46%
-
+TOTAL                       484    257    47%
 
-============================= 10 passed in 31.13s ==============================
+======================= 13 passed, 4 warnings in 39.93s ========================

pkg/build/lib/wvpy/jtools.py

@@ -9,6 +9,8 @@
 from nbconvert.preprocessors import ExecutePreprocessor
 from multiprocessing import Pool
 import sys
+import pickle
+import tempfile
 
 from typing import Iterable, List, Optional
 from functools import total_ordering
@@ -287,6 +289,7 @@ def render_as_html(
     timeout:int = 60000,
     kernel_name: Optional[str] = None,
     verbose: bool = True,
+    sheet_vars = None,
     init_code: Optional[str] = None,
     exclude_input: bool = False,
     prompt_strip_regexp: Optional[str] = r'<\s*div\s+class\s*=\s*"jp-OutputPrompt[^<>]*>[^<>]*Out[^<>]*<\s*/div\s*>',
@@ -301,7 +304,8 @@ def render_as_html(
     :param timeout: Maximum time in seconds each notebook cell is allowed to run.
                     passed to nbconvert.preprocessors.ExecutePreprocessor.
     :param kernel_name: Jupyter kernel to use. passed to nbconvert.preprocessors.ExecutePreprocessor.
-    :param verbose logical, if True print while running 
+    :param verbose logical, if True print while running
+    :param sheet_vars: if not None value is de-serialized as a variable named "sheet_vars"
     :param init_code: Python init code for first cell
     :param exclude_input: if True, exclude input cells
     :param prompt_strip_regexp: regexp to strip prompts, only used if exclude_input is True
@@ -335,7 +339,20 @@ def render_as_html(
         nb = convert_py_code_to_notebook(text)
     else:
         raise ValueError('{ipynb_exists}: file must end with .py or .ipynb')
+    tmp_path = None
     # do the conversion
+    if sheet_vars is not None:
+        with tempfile.NamedTemporaryFile(delete=False) as ntf:
+            tmp_path = ntf.name
+            pickle.dump(sheet_vars, file=ntf)
+        if (init_code is None) or (len(init_code) <= 0):
+            init_code = ""
+        pickle_code = f"""
+import pickle
+with open({tmp_path.__repr__()}, 'rb') as pf:
+   sheet_vars = pickle.load(pf)
+""" 
+        init_code = init_code + "\n\n" + pickle_code
     if (init_code is not None) and (len(init_code) > 0):
         assert isinstance(init_code, str)
         nb = prepend_code_cell_to_notebook(
@@ -384,12 +401,21 @@ def render_as_html(
         caught = ep.caught_exception
     except Exception as e:
         caught = e
+    if tmp_path is not None:
+        try:
+            os.remove(tmp_path)
+        except FileNotFoundError:
+            pass
     if caught is not None:
         raise caught
     if verbose:
         print(f'\tdone render_as_html "{html_name}" {datetime.datetime.now()}')
 
 
+_jtask_comparison_attributes = [
+    "sheet_name", "output_suffix", "exclude_input", "init_code", "path_prefix"]
+
+
 @total_ordering
 class JTask:
     def __init__(
@@ -398,6 +424,7 @@ def __init__(
         *,
         output_suffix: Optional[str] = None,
         exclude_input: bool = True,
+        sheet_vars = None,
         init_code: Optional[str] = None,
         path_prefix: Optional[str] = None,
         strict: bool = True,
@@ -408,6 +435,7 @@ def __init__(
         :param sheet_name: name of sheet to run can be .ipynb or .py, and suffix can be omitted.
         :param output_suffix: optional string to append to rendered HTML file name.
         :param exclude_input: if True strip input cells out of HTML render.
+        :param sheet_vars: if not None value is de-serialized as a variable named "sheet_vars"
         :param init_code: optional code to insert at the top of the Jupyter sheet, used to pass parameters.
         :param path_prefix: optional prefix to add to sheet_name to find Jupyter source. 
         :param strict: if True check paths path_prefix and path_prefix/sheetname[.py|.ipynb] exist.
@@ -432,6 +460,7 @@ def __init__(
         self.sheet_name = sheet_name
         self.output_suffix = output_suffix
         self.exclude_input = exclude_input
+        self.sheet_vars = sheet_vars
         self.init_code = init_code
         self.path_prefix = path_prefix
 
@@ -443,6 +472,7 @@ def render_as_html(self) -> None:
             path,
             exclude_input=self.exclude_input,
             output_suffix=self.output_suffix,
+            sheet_vars=self.sheet_vars,
             init_code=self.init_code,
         )
 
@@ -454,33 +484,39 @@ def _is_valid_operand(self, other):
 
     def __eq__(self, other):
         if not self._is_valid_operand(other):
-            return NotImplemented
+            return False
         if str(type(self)) != str(type(other)):
             return False
-        for v in ["sheet_name", "output_suffix", "exclude_input", "init_code", "path_prefix"]:
+        for v in _jtask_comparison_attributes:
             if self[v] != other[v]:
                 return False
+        if str(self.sheet_vars) != str(other.sheet_vars):
+            return False
         return True
 
     def __lt__(self, other):
         if not self._is_valid_operand(other):
             return NotImplemented
         if str(type(self)) < str(type(other)):
             return True
-        for v in ["sheet_name", "output_suffix", "exclude_input", "init_code", "path_prefix"]:
+        for v in _jtask_comparison_attributes:
             v_self = self[v]
             v_other = other[v]
             # can't order compare None to None
-            if ((v_self is None) or (v_other is None)) and ((v_self is None) != (v_other is None)):
-                return v_self is None
-            if self[v] < other[v]:
-                return True
+            if ((v_self is None) or (v_other is None)):
+                if ((v_self is None) != (v_other is None)):
+                    return v_self is None
+            else:
+                if self[v] < other[v]:
+                    return True
+        if str(self.sheet_vars) < str(other.sheet_vars):
+            return True
         return False
 
     def __str__(self) -> str:
         args_str = ",\n".join([
-            f" {v}= {repr(self[v])}"
-            for v in ["sheet_name", "output_suffix", "exclude_input", "init_code", "path_prefix"]
+            f" {v}={repr(self[v])}"
+            for v in _jtask_comparison_attributes + ["sheet_vars"]
         ])
         return 'JTask(\n' + args_str + ",\n)"
 

pkg/dist/wvpy-0.4.2-py3-none-any.whl

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta name="generator" content="pdoc 13.1.0"/>
+    <meta name="generator" content="pdoc 14.0.0"/>
     <title>wvpy API documentation</title>
 
     <style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>