Package: ipython-unittest
IPython-UnittestThis extension provides testing support to IPython through cell magics. Currently, we have three magics that transforms the cell code and executes unittest:%%unittest_main,%%unittest_testcaseand%%unittest; one magic to run external tests:%%external; and one associated magic to write external files:%%write {mode}Please, take a look atjupyter_dojoto improve the jupyter support of this extension with:Test status in toolbarArgument --previous, to move to previous cells after executionTimer, pair programming log, function generation for coding dojo sessionsSyntax highlight for%%write {mode}magicHow to InstallInstall the python package by runningpip install ipython_unittestorconda install -c conda-forge ipython_unittestNote that conda releases take more time to update. Use the pypi version if you want to get the most recent release at any given time.It is strongly advisable to install thejupyter_dojopackage as well:pip install jupyter_dojoTo load the extension, please run:%load_extipython_unittestCell MagicsThe first magic is%%unittest_main. This magic runs testcases defined in a cell%%unittest_mainclassMyTest(unittest.TestCase):deftest_1_plus_1_equals_2(self):sum=1+1self.assertEqual(sum,2)deftest_2_plus_2_equals_4(self):self.assertEqual(2+2,4)The second magic is%%unittest_testcase. This magic creates a testcase with
functions defined in the cell and execute it.%%unittest_testcasedeftest_1_plus_1_equals_2(self):sum=1+1self.assertEqual(sum,2)deftest_2_plus_2_equals_4(self):self.assertEqual(2+2,4)The third magic is%%unittest. This magic converts Python assert into
unittest functions.%%unittest"1 plus 1 equals 2"sum=1+1assertsum==2"2 plus 2 equals 4"assert2+2==4By default, docstring in this magic will separate unittest methods.
However, if docstrings are not provided, the magic will create a method for
for each assert.These magics support optional arguments:-p (--previous) P: set cursor to P cells before (default: -1 = next cell)
-s (--stream) S:   set test output stream (default: 'sys.stdout')
-t (--testcase) T: define TestCase name.
                   Valid for '%%unittest' and '%%unittest_testcase'
-u (--unparse):    print cell source code after transformations.The--previousargument only works with thejupyter_dojoextension installed.The fourth magic is%%external. This magic runs external system commands and check their exit codes. This way, it is possible to run tests from other languages:%%external-p1mochatest.jsThe%externalmagic supports the argument--previousdescribed before.Finally, since it is possible to run external commands, we included an extra magic,%%writeto write files and keep the syntax highlight.
This magic receives a CodeMirror mode as first argument and the remaining arguments are redirected to IPython's%%writefileOnce again, the%externalmagic only provides syntax highlighting should you have thejupyter_dojoextension installed.%%writejavascripttest.jsvarassert=require('assert');describe('Array',function(){describe('#indexOf()',function(){it('should return -1 when the value is not present',function(){assert.equal(-1,[1,2,3].indexOf(4));});});});Alternativesipytestjupyter-pytest-2ipython-pytestpytest-exploratoryipython_nosetestbookLinksJupyter DojoPypi.orgConda Forge FeedstockContactDo not hesitate to contact me:João Felipe Pimenteljoaofelipenp@gmail.comLicense TermsPermission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.