allow notebook env

.github/workflows/test.yml

@@ -17,5 +17,7 @@ jobs:
           architecture: 'x64'
       - name: Install pytest
         run: pip install -U pytest
+      - name: Install dependencies
+        run: pip install -r requirements.txt
       - name: Run tests
         run: make pytest

README.md

@@ -128,6 +128,19 @@ Check out detailed example below
 
 ![subdir](img/subdir_demo.png)
 
+### 2.3 Testing functions from notebook
+If you want to pass the functions from the notebook to the test case you need to enable `notebook_env`
+
+```python
+function_to_test = lambda x: x * 2
+
+from nbresult import ChallengeResult
+
+result = ChallengeResult("double", notebook_env=True, double_function=function_to_test)
+```
+
+This allows multiple test cases of the function to be tested in `double_test.py` by accessing `self.result.double_function`
+
 ## Testing
 
 Run `make`

nbresult/__init__.py

@@ -1,7 +1,7 @@
 """
 nbresult package is for Le Wagon bootcamps students
 """
-import pickle
+import dill
 import os
 import unittest
 import re
@@ -17,9 +17,10 @@ class ChallengeResult:
     by `make` to validate challenge outcome)
     """
 
-    def __init__(self, name, subdir=None, **kwargs):
+    def __init__(self, name, subdir=None, notebook_env=False, **kwargs):
         self.name = name
         self.subdir = subdir
+        self.notebook_env = notebook_env
         for key, value in kwargs.items():
             setattr(self, key, value)
 
@@ -49,7 +50,10 @@ def write(self):
                 {self.name}, one is way too big.""")
         result_file = os.path.join(tests_path, f"{self.name}.pickle")
         with open(result_file, 'wb') as file:
-            pickle.dump(self, file)
+            dill.dump(self, file)
+        if self.notebook_env:
+            result_env = os.path.join(tests_path, f"{self.name}_env.pickle")
+            dill.dump_session(result_env)
 
     def check(self):
         """returns test output on the ChallengeResult"""
@@ -87,7 +91,10 @@ def setUp(self):
         name = re.sub(r'(?<!^)(?=[A-Z])', '_', klass).lower()[len('test_'):]
         result_file = _locate_pickle(name)
         with open(result_file, 'rb') as file:
-            self.result = pickle.load(file)
+            self.result = dill.load(file)
+        env_path = result_file.replace('.pickle', '_env.pickle')
+        if os.path.exists(env_path):
+            dill.load_module(env_path)
 
 
 def _locate_pickle(name):

requirements.txt

@@ -1 +1 @@
-
+dill

setup.py

@@ -4,6 +4,9 @@
 with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
 
+with open('requirements.txt') as f:
+    required = [c.strip() for c in f.readlines()]
+
 setup(name='nbresult',
       version='0.0.9',
       description='Extract results from Jupyter notebooks',
@@ -14,5 +17,6 @@
       author='Kevin Robert',
       author_email='[email protected]',
       packages=find_packages(include=["nbresult"]),
+      install_requires=required,
       include_package_data=True
 )