Rename executenb() -> execute() (#15)

Rename executenb() -> execute()

Author: mgeier

nbclient/execute.py

@@ -698,7 +698,7 @@ def _get_buffer_data(self, msg):
         return encoded_buffers
 
 
-def executenb(nb, cwd=None, km=None, **kwargs):
+def execute(nb, cwd=None, km=None, **kwargs):
     """Execute a notebook's code, updating outputs within the notebook object.
 
     This is a convenient wrapper around Executor. It returns the

nbclient/tests/test_execute.py

@@ -12,7 +12,7 @@
 import xmltodict
 
 from .base import ExecutorTestsBase
-from ..execute import Executor, executenb
+from ..execute import Executor, execute
 from ..exceptions import CellExecutionError
 
 import IPython
@@ -465,14 +465,14 @@ def process_message(self, msg, cell, cell_index):
         assert_notebooks_equal(original, executed)
 
     def test_execute_function(self):
-        # Test the executenb() convenience API
+        # Test the execute() convenience API
         filename = os.path.join(current_dir, 'files', 'HelloWorld.ipynb')
 
         with io.open(filename) as f:
             input_nb = nbformat.read(f, 4)
 
         original = copy.deepcopy(input_nb)
-        executed = executenb(original, os.path.dirname(filename))
+        executed = execute(original, os.path.dirname(filename))
         assert_notebooks_equal(original, executed)
 
     def test_widgets(self):