execnb 0.1.8__py3-none-any.whl → 0.1.10__py3-none-any.whl

execnb/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.8"
+__version__ = "0.1.10"

execnb/_modidx.py

@@ -2,8 +2,8 @@
 
 d = { 'settings': { 'branch': 'master',
                 'doc_baseurl': '/execnb/',
-                'doc_host': 'https://fastai.github.io',
-                'git_url': 'https://github.com/fastai/execnb/',
+                'doc_host': 'https://AnswerDotAI.github.io',
+                'git_url': 'https://github.com/AnswerDotAI/execnb/',
                 'lib_path': 'execnb'},
   'syms': { 'execnb.nbio': { 'execnb.nbio.NbCell': ('nbio.html#nbcell', 'execnb/nbio.py'),
                              'execnb.nbio.NbCell.__eq__': ('nbio.html#nbcell.__eq__', 'execnb/nbio.py'),
@@ -22,6 +22,7 @@ d = { 'settings': { 'branch': 'master',
                              'execnb.nbio.write_nb': ('nbio.html#write_nb', 'execnb/nbio.py')},
             'execnb.shell': { 'execnb.shell.CaptureShell': ('shell.html#captureshell', 'execnb/shell.py'),
                               'execnb.shell.CaptureShell.__init__': ('shell.html#captureshell.__init__', 'execnb/shell.py'),
+                              'execnb.shell.CaptureShell._run': ('shell.html#captureshell._run', 'execnb/shell.py'),
                               'execnb.shell.CaptureShell.cell': ('shell.html#captureshell.cell', 'execnb/shell.py'),
                               'execnb.shell.CaptureShell.complete': ('shell.html#captureshell.complete', 'execnb/shell.py'),
                               'execnb.shell.CaptureShell.enable_gui': ('shell.html#captureshell.enable_gui', 'execnb/shell.py'),
@@ -29,6 +30,7 @@ d = { 'settings': { 'branch': 'master',
                               'execnb.shell.CaptureShell.prettytb': ('shell.html#captureshell.prettytb', 'execnb/shell.py'),
                               'execnb.shell.CaptureShell.run': ('shell.html#captureshell.run', 'execnb/shell.py'),
                               'execnb.shell.CaptureShell.run_all': ('shell.html#captureshell.run_all', 'execnb/shell.py'),
+                              'execnb.shell.CaptureShell.run_async': ('shell.html#captureshell.run_async', 'execnb/shell.py'),
                               'execnb.shell.CaptureShell.run_cell': ('shell.html#captureshell.run_cell', 'execnb/shell.py'),
                               'execnb.shell.CaptureShell.set_path': ('shell.html#captureshell.set_path', 'execnb/shell.py'),
                               'execnb.shell.ExecutionInfo.__repr__': ('shell.html#executioninfo.__repr__', 'execnb/shell.py'),
@@ -48,6 +50,8 @@ d = { 'settings': { 'branch': 'master',
                               'execnb.shell._out_exc': ('shell.html#_out_exc', 'execnb/shell.py'),
                               'execnb.shell._out_nb': ('shell.html#_out_nb', 'execnb/shell.py'),
                               'execnb.shell._out_stream': ('shell.html#_out_stream', 'execnb/shell.py'),
+                              'execnb.shell._pre': ('shell.html#_pre', 'execnb/shell.py'),
+                              'execnb.shell._strip': ('shell.html#_strip', 'execnb/shell.py'),
                               'execnb.shell.exec_nb': ('shell.html#exec_nb', 'execnb/shell.py'),
                               'execnb.shell.find_output': ('shell.html#find_output', 'execnb/shell.py'),
                               'execnb.shell.format_exc': ('shell.html#format_exc', 'execnb/shell.py'),

execnb/shell.py

@@ -53,7 +53,7 @@ def __repr__(self: ExecutionResult): return f'result: {self.result}; err: {self.
 class CaptureShell(InteractiveShell):
     displayhook_class = _CustDisplayHook
 
-    def __init__(self, path:str|Path=None, mpl_format='retina', history=False, timeout=None):
+    def __init__(self, path:str|Path=None, mpl_format='retina', history=False, timeout:Optional[int]=None):
         super().__init__()
         self.history_manager.enabled = history
         self.timeout = timeout
@@ -63,21 +63,15 @@ class CaptureShell(InteractiveShell):
         if not IN_NOTEBOOK: InteractiveShell._instance = self
         if set_matplotlib_formats:
             self.enable_matplotlib("inline")
-            self.run_cell("from matplotlib_inline.backend_inline import set_matplotlib_formats")
-            self.run_cell(f"set_matplotlib_formats('{mpl_format}')")
+            self._run("from matplotlib_inline.backend_inline import set_matplotlib_formats")
+            self._run(f"set_matplotlib_formats('{mpl_format}')")
 
-    def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True, cell_id=None,
-                 stdout=True, stderr=True, display=True, timeout=None):
-        if not timeout: timeout = self.timeout
+    def _run(self, raw_cell, store_history=False, silent=False, shell_futures=True, cell_id=None,
+                 stdout=True, stderr=True, display=True):
         # TODO what if there's a comment?
         semic = raw_cell.rstrip().endswith(';')
-        if timeout:
-            def handler(*args): raise TimeoutError()
-            signal.signal(signal.SIGALRM, handler)
-            signal.alarm(timeout)
         with capture_output(display=display, stdout=stdout, stderr=stderr) as c:
             result = super().run_cell(raw_cell, store_history, silent, shell_futures=shell_futures, cell_id=cell_id)
-        if timeout: signal.alarm(0)
         return AttrDict(result=result, stdout='' if semic else c.stdout, stderr=c.stderr,
                         display_objects=c.outputs, exception=result.error_in_exec, quiet=semic)
     
@@ -85,14 +79,28 @@ class CaptureShell(InteractiveShell):
         "Add `path` to python path, or `path.parent` if it's a file"
         path = Path(path)
         if path.is_file(): path = path.parent
-        self.run_cell(f"import sys; sys.path.insert(0, '{path.as_posix()}')")
+        self._run(f"import sys; sys.path.insert(0, '{path.as_posix()}')")
     
     def enable_gui(self, gui=None): pass
 
+# %% ../nbs/02_shell.ipynb
+@patch
+def run_cell(self:CaptureShell, raw_cell, store_history=False, silent=False, shell_futures=True, cell_id=None,
+             stdout=True, stderr=True, display=True, timeout=None):
+    if not timeout: timeout = self.timeout
+    if timeout:
+        def handler(*args): raise TimeoutError()
+        signal.signal(signal.SIGALRM, handler)
+        signal.alarm(timeout)
+    try: return self._run(raw_cell, store_history, silent, shell_futures, cell_id=cell_id,
+                          stdout=stdout, stderr=stderr, display=display)
+    finally:
+        if timeout: signal.alarm(0)
+
 # %% ../nbs/02_shell.ipynb
 def format_exc(e):
-    "Format exception `e` as a string"
-    return ''.join(traceback.format_exception(type(e), e, e.__traceback__))
+    "Format exception `e` as a string list"
+    return traceback.format_exception(type(e), e, e.__traceback__)
 
 # %% ../nbs/02_shell.ipynb
 def _out_stream(text, name): return dict(name=name, output_type='stream', text=text.splitlines(True))
@@ -122,6 +130,9 @@ def _out_nb(o, fmt):
     for x in o.display_objects: res.append(_mk_out(x.data, x.metadata))
     if r is not None and not o.quiet:
         res.append(_mk_out(*fmt.format(r), 'execute_result'))
+    if 'execution_count' not in o: o['execution_count']=None
+    for p in res:
+        if p["output_type"]=="execute_result": p['execution_count'] = o['execution_count']
     return res
 
 # %% ../nbs/02_shell.ipynb
@@ -129,33 +140,52 @@ def _out_nb(o, fmt):
 def run(self:CaptureShell,
         code:str, # Python/IPython code to run
         stdout=True, # Capture stdout and save as output?
-        stderr=True): # Capture stderr and save as output?
+        stderr=True, # Capture stderr and save as output?
+       timeout:Optional[int]=None): # Shell command will time out after {timeout} seconds
     "Run `code`, returning a list of all outputs in Jupyter notebook format"
-    res = self.run_cell(code, stdout=stdout, stderr=stderr)
+    res = self.run_cell(code, stdout=stdout, stderr=stderr, timeout=timeout)
     self.result = res.result.result
     self.exc = res.exception
     return _out_nb(res, self.display_formatter)
 
 # %% ../nbs/02_shell.ipynb
-def render_outputs(outputs, ansi_renderer=strip_ansi):
-    try: import mistletoe
+@patch
+async def run_async(self:CaptureShell,
+        code: str,  # Python/IPython code to run
+        stdout=True,  # Capture stdout and save as output?
+        stderr=True,  # Capture stderr and save as output?
+        timeout:Optional[int]=None): # Shell command will time out after {timeout} seconds
+    return self.run(code, stdout=stdout, stderr=stderr, timeout=timeout)
+
+# %% ../nbs/02_shell.ipynb
+def _pre(s, xtra=''): return f"<pre {xtra}><code>{escape(s)}</code></pre>"
+def _strip(s): return strip_ansi(escape(s))
+
+def render_outputs(outputs, ansi_renderer=_strip, include_imgs=True, pygments=False):
+    try:
+        from mistletoe import markdown, HTMLRenderer
+        from mistletoe.contrib.pygments_renderer import PygmentsRenderer
     except ImportError: return print('mistletoe not found -- please install it')
+    renderer = PygmentsRenderer if pygments else HTMLRenderer
     def render_output(out):
         otype = out['output_type']
         if otype == 'stream':
             txt = ansi_renderer(''.join(out['text']))
-            return f"<pre>{txt}</pre>" if out['name']=='stdout' else f"<pre class='stderr'>{txt}</pre>"
+            xtra = '' if out['name']=='stdout' else "class='stderr'"
+            return f"<pre {xtra}><code>{txt}</code></pre>"
         elif otype in ('display_data','execute_result'):
             data = out['data']
             _g = lambda t: ''.join(data[t]) if t in data else None
             if d := _g('text/html'): return d
             if d := _g('application/javascript'): return f'<script>{d}</script>'
-            if d := _g('text/markdown'): return mistletoe.markdown(d)
-            if d := _g('image/svg+xml'): return d
-            if d := _g('image/jpeg'): return f'<img src="data:image/jpeg;base64,{d}"/>'
-            if d := _g('image/png'): return f'<img src="data:image/png;base64,{d}"/>'
+            if d := _g('text/markdown'): return markdown(d, renderer=renderer)
             if d := _g('text/latex'): return f'<div class="math">${d}$</div>'
-            if d := _g('text/plain'): return f"<pre>{escape(d)}</pre>"
+            if include_imgs:
+                if d := _g('image/jpeg'): return f'<img src="data:image/jpeg;base64,{d}"/>'
+                if d := _g('image/png'): return f'<img src="data:image/png;base64,{d}"/>'
+            if d := _g('text/plain'): return _pre(d)
+            if d := _g('image/svg+xml'): return d
+            
         return ''
     
     return '\n'.join(map(render_output, outputs))
@@ -167,10 +197,7 @@ def cell(self:CaptureShell, cell, stdout=True, stderr=True):
     if cell.cell_type!='code': return
     self._cell_idx = cell.idx_ + 1
     outs = self.run(cell.source)
-    if outs:
-        cell.outputs = _dict2obj(outs)
-        for o in outs:
-            if 'execution_count' in o: cell['execution_count'] = o['execution_count']
+    if outs: cell.outputs = _dict2obj(outs)
 
 # %% ../nbs/02_shell.ipynb
 def find_output(outp, # Output from `run`

{execnb-0.1.8.dist-info → execnb-0.1.10.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: execnb
-Version: 0.1.8
+Version: 0.1.10
 Summary: A description of your project
-Home-page: https://github.com/fastai/execnb/
+Home-page: https://github.com/AnswerDotAI/execnb/
 Author: Jeremy Howard
 Author-email: j@fast.ai
 License: Apache Software License 2.0
@@ -48,7 +48,7 @@ mamba installed.)
 ## How to use
 
 Use
-[`CaptureShell`](https://fastai.github.io/execnb/shell.html#captureshell)
+[`CaptureShell`](https://AnswerDotAI.github.io/execnb/shell.html#captureshell)
 to run Jupyter code and capture notebook outputs, without running a
 Jupyter server (or even having it installed):
 
@@ -69,7 +69,7 @@ s.run('1+1')
       'execution_count': 1}]
 
 To execute a notebook and save it with outputs filled in, use
-[`CaptureShell.execute`](https://fastai.github.io/execnb/shell.html#captureshell.execute):
+[`CaptureShell.execute`](https://AnswerDotAI.github.io/execnb/shell.html#captureshell.execute):
 
 ``` python
 try:
@@ -81,7 +81,7 @@ finally: Path('tmp.ipynb').unlink()
     [{'name': 'stdout', 'output_type': 'stream', 'text': ['1\n']}, {'data': {'text/plain': ['2']}, 'execution_count': 3, 'metadata': {}, 'output_type': 'execute_result'}]
 
 You can also execute notebooks from the command line with
-[`exec_nb`](https://fastai.github.io/execnb/shell.html#exec_nb):
+[`exec_nb`](https://AnswerDotAI.github.io/execnb/shell.html#exec_nb):
 
 ``` python
 !exec_nb --help

execnb-0.1.10.dist-info/RECORD

@@ -0,0 +1,10 @@
+execnb/__init__.py,sha256=z0zCHFTcKSR0tJ6h5qrpNmRVP21QIPP8N0p7quCnnm0,23
+execnb/_modidx.py,sha256=mGvzO-ucSjMp0NX4t0Ed7XNi2v-gvMPLQUiGQpN1QKU,6211
+execnb/nbio.py,sha256=gs3EGN0sP2j47XUH31rTn2KT57b3wWnBZsn9AoZm2JQ,3677
+execnb/shell.py,sha256=Hbn0pF_-Iwr7aENw_Pxo9iwRfPCjP0SHK_jDHZgzIog,13357
+execnb-0.1.10.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+execnb-0.1.10.dist-info/METADATA,sha256=XRVqx4VzVcDvLjoglJrxijIifOgSW8gP3JaFXqTvtcQ,3313
+execnb-0.1.10.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+execnb-0.1.10.dist-info/entry_points.txt,sha256=jZ8LPZCqnu4hXN_AgQpm05hVnTE-C25YK_4aiVX4i78,84
+execnb-0.1.10.dist-info/top_level.txt,sha256=VGWmzsw8FOlT1r5TdOxaTWIAyRdclcxNdJ2r1hojf5U,7
+execnb-0.1.10.dist-info/RECORD,,

execnb-0.1.8.dist-info/RECORD

@@ -1,10 +0,0 @@
-execnb/__init__.py,sha256=C69ADlbQREQlR15trneyA2sk8x0-oH4rDAX5fsv19_U,22
-execnb/_modidx.py,sha256=3wJwFT95tiaCPmj7VMQEIim5qLTcOatC2od-ze5WJcc,5771
-execnb/nbio.py,sha256=gs3EGN0sP2j47XUH31rTn2KT57b3wWnBZsn9AoZm2JQ,3677
-execnb/shell.py,sha256=qpCkd1FZsGXyOWjOrfAluGbk7h4D7a3SnCwbyRz0L9s,12055
-execnb-0.1.8.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-execnb-0.1.8.dist-info/METADATA,sha256=i3gK5I8cEbHu-pXhkuJy1od601HKmloMhpk40AsYrWw,3292
-execnb-0.1.8.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-execnb-0.1.8.dist-info/entry_points.txt,sha256=jZ8LPZCqnu4hXN_AgQpm05hVnTE-C25YK_4aiVX4i78,84
-execnb-0.1.8.dist-info/top_level.txt,sha256=VGWmzsw8FOlT1r5TdOxaTWIAyRdclcxNdJ2r1hojf5U,7
-execnb-0.1.8.dist-info/RECORD,,