{ "info": { "author": "Jupyter Development Team", "author_email": "jupyter@googlegroups.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 3", "Topic :: Software Development :: Testing" ], "description": "===================\njupyter_kernel_test\n===================\n\n``jupyter_kernel_test`` is a tool for testing Jupyter_ kernels. It tests kernels for successful code execution and conformance with the `Jupyter Messaging Protocol`_ (currently 5.0).\n\n-------\nInstall\n-------\n\nInstall it with pip (python3.4 or greater required)::\n\n pip3 install jupyter_kernel_test\n\n-----\nUsage\n-----\n\nTo use it, you need to write a (python) ``unittest`` file containing code samples in the relevant language which test various parts of the messaging protocol. A short example is given below, and otherwise you can consult the ``test_ipykernel.py`` and ``test_irkernel.py`` files for complete examples.\n\nSome parts of the messaging protocol are relevant only to the browser-based notebook (rich display) or console interfaces (code completeness, history searching). Only parts of the spec for which you provide code samples are tested.\n\nRun this file directly using python, or use ``nosetests`` or ``py.test`` to find and run it.\n\n-------\nExample\n-------\n\n.. code-block:: python\n\n import unittest\n import jupyter_kernel_test\n\n class MyKernelTests(jupyter_kernel_test.KernelTests):\n # Required --------------------------------------\n\n # The name identifying an installed kernel to run the tests against\n kernel_name = \"mykernel\"\n\n # language_info.name in a kernel_info_reply should match this\n language_name = \"mylanguage\"\n\n # Optional --------------------------------------\n\n # Code in the kernel's language to write \"hello, world\" to stdout\n code_hello_world = \"print 'hello, world'\"\n\n # Pager: code that should display something (anything) in the pager\n code_page_something = \"help(something)\"\n\n # Samples of code which generate a result value (ie, some text\n # displayed as Out[n])\n code_execute_result = [\n {'code': '6*7', 'result': '42'}\n ]\n\n # Samples of code which should generate a rich display output, and\n # the expected MIME type\n code_display_data = [\n {'code': 'show_image()', 'mime': 'image/png'}\n ]\n\n # You can also write extra tests. We recommend putting your kernel name\n # in the method name, to avoid clashing with any tests that\n # jupyter_kernel_test adds in the future.\n def test_mykernel_stderr(self):\n reply, output_msgs = self.execute_helper(code='print_err \"oops\"')\n self.assertEqual(output_msgs[0]['msg_type'], 'stream')\n self.assertEqual(output_msgs[0]['content']['name'], 'stderr')\n self.assertEqual(output_msgs[0]['content']['text'], 'oops\\n')\n\n if __name__ == '__main__':\n unittest.main()\n\n--------\nCoverage\n--------\n\nThe following aspects of the messaging protocol are not explicitly tested:\n\n- Widget comms: ``comm_open``, ``comm_msg``, ``comm_close``\n- stdin: ``input_request``, ``input_reply``\n- display_data metadata\n- Shutdown/restart: ``shutdown_request``, ``shutdown_reply``\n- History: not all option combinations covered\n- Inspection: multiple levels\n- Execution payloads (deprecated but still used): payloads ``load``, ``edit``, ``ask_exit``\n- User expressions\n- Execution: combinations of ``silent``, ``store_history`` and ``stop_on_error``\n\n.. _Jupyter: http://jupyter.org\n.. _Jupyter Messaging Protocol: https://jupyter-client.readthedocs.io/en/latest/messaging.html", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jupyter/jupyter_kernel_test", "keywords": null, "license": null, "maintainer": null, "maintainer_email": null, "name": "jupyter_kernel_test", "package_url": "https://pypi.org/project/jupyter_kernel_test/", "platform": null, "project_url": "https://pypi.org/project/jupyter_kernel_test/", "project_urls": { "Homepage": "https://github.com/jupyter/jupyter_kernel_test" }, "release_url": "https://pypi.org/project/jupyter_kernel_test/0.3/", "requires_dist": [ "traitlets", "jupyter_client", "nose" ], "requires_python": ">=3.4", "summary": "Machinery for testing Jupyter kernels via the messaging protocol.", "version": "0.3" }, "last_serial": 2836782, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "a71c0a5c227b90cb225fccb323430b14", "sha256": "9ea2cb620a5dc491e2619262f12a6a6c80516044c197b9fd1b322745e4800633" }, "downloads": -1, "filename": "jupyter_kernel_test-0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a71c0a5c227b90cb225fccb323430b14", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6988, "upload_time": "2015-07-12T21:03:23", "url": "https://files.pythonhosted.org/packages/ce/7a/5f59ce891f26a24f3fd2b94a21518d6ad15b44668c89038f18798d06c0ec/jupyter_kernel_test-0.1-py2.py3-none-any.whl" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "63bd464be21c399f93d6cdd65b5928a9", "sha256": "0219774802272247615c835cfd56f813a36a322b43d5cfdf45164f53a23ca5a3" }, "downloads": -1, "filename": "jupyter_kernel_test-0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "63bd464be21c399f93d6cdd65b5928a9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6082, "upload_time": "2016-06-13T14:32:01", "url": "https://files.pythonhosted.org/packages/c0/2d/ed2ef363a7696cdcd438ba7b1bfef1971b479e0ea5c3aea5d90fe013984d/jupyter_kernel_test-0.2-py2.py3-none-any.whl" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "dc614a26d9c5340a8fd535f7a414748d", "sha256": "6df978e35037393221518786b62a7185b64dbed2915d81e6cdd10f8b865bc0e8" }, "downloads": -1, "filename": "jupyter_kernel_test-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "dc614a26d9c5340a8fd535f7a414748d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7570, "upload_time": "2016-06-13T14:51:22", "url": "https://files.pythonhosted.org/packages/75/9d/78d13b78b4c953cbaee3f5e01a84acb8bf07eb0a5622606146616a7b1cd4/jupyter_kernel_test-0.2.1-py2.py3-none-any.whl" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "4cc7e539059c10681b2d67604f3fd302", "sha256": "cf766f5fb0f329cbf60b41acfc0c318f49daa7ce03ed5ef87e222e0d58630548" }, "downloads": -1, "filename": "jupyter_kernel_test-0.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4cc7e539059c10681b2d67604f3fd302", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7564, "upload_time": "2016-06-13T14:52:53", "url": "https://files.pythonhosted.org/packages/09/f7/101f866f27c88242f4e146e4ee5712285916ecc5c43bfed4d781bb663fd4/jupyter_kernel_test-0.2.2-py2.py3-none-any.whl" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "6327ee0a53ba5258dfcc8c8da1487f86", "sha256": "98724741416bbf722e7f6691b681d7fdd942f8bf551dbf7697fd7b921cd1572b" }, "downloads": -1, "filename": "jupyter_kernel_test-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "6327ee0a53ba5258dfcc8c8da1487f86", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.4", "size": 25379, "upload_time": "2017-04-28T10:30:28", "url": "https://files.pythonhosted.org/packages/48/b0/b1be4665382f7c80abb01a25a76af8e223ed495c2e38af6495813fb05a88/jupyter_kernel_test-0.3-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6327ee0a53ba5258dfcc8c8da1487f86", "sha256": "98724741416bbf722e7f6691b681d7fdd942f8bf551dbf7697fd7b921cd1572b" }, "downloads": -1, "filename": "jupyter_kernel_test-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "6327ee0a53ba5258dfcc8c8da1487f86", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.4", "size": 25379, "upload_time": "2017-04-28T10:30:28", "url": "https://files.pythonhosted.org/packages/48/b0/b1be4665382f7c80abb01a25a76af8e223ed495c2e38af6495813fb05a88/jupyter_kernel_test-0.3-py3-none-any.whl" } ] }