pytest_notebook package

Subpackages

• pytest_notebook.example_nbs package
  • Module contents
• pytest_notebook.resources package
  • Module contents

Submodules

• pytest_notebook.diffing module
  • diff_notebooks()
  • diff_sequence_simple()
  • diff_to_string()
  • filter_diff()
  • star_path()
• pytest_notebook.execution module
  • CoverageError
    • CoverageError.from_cell_output()
    • CoverageError.from_exec_reply()
  • CoverageNotebookClient
    • CoverageNotebookClient._all_trait_default_generators
    • CoverageNotebookClient._descriptors
    • CoverageNotebookClient._instance_inits
    • CoverageNotebookClient._static_immutable_initial_values
    • CoverageNotebookClient._trait_default_generators
    • CoverageNotebookClient._traits
    • CoverageNotebookClient.async_execute()
    • CoverageNotebookClient.cov_config_file
    • CoverageNotebookClient.cov_source
    • CoverageNotebookClient.coverage
    • CoverageNotebookClient.coverage_setup()
    • CoverageNotebookClient.coverage_teardown()
    • CoverageNotebookClient.execute()
  • ExecuteResult
    • ExecuteResult.coverage_data()
    • ExecuteResult.coverage_dict
    • ExecuteResult.exec_error
    • ExecuteResult.has_coverage
    • ExecuteResult.notebook
    • ExecuteResult.resources
  • coverage_code_setup()
  • coverage_code_teardown()
  • execute_notebook()
• pytest_notebook.ipy_magic module
  • eval_literals()
  • load_ipython_extension()
  • parse_cell_content()
  • pytest()
  • run_pytest()
  • write_file()
• pytest_notebook.nb_regression module
  • NBRegressionError
  • NBRegressionFixture
    • NBRegressionFixture._validate_cov_merge()
    • NBRegressionFixture._validate_coverage()
    • NBRegressionFixture._validate_diff_ignore()
    • NBRegressionFixture._validate_diff_replace()
    • NBRegressionFixture._validate_exec_cwd()
    • NBRegressionFixture._validate_exec_timeout()
    • NBRegressionFixture._validate_post_processors()
    • NBRegressionFixture.check()
    • NBRegressionFixture.cov_config
    • NBRegressionFixture.cov_merge
    • NBRegressionFixture.cov_source
    • NBRegressionFixture.coverage
    • NBRegressionFixture.diff_color_words
    • NBRegressionFixture.diff_ignore
    • NBRegressionFixture.diff_replace
    • NBRegressionFixture.diff_use_color
    • NBRegressionFixture.exec_allow_errors
    • NBRegressionFixture.exec_cwd
    • NBRegressionFixture.exec_notebook
    • NBRegressionFixture.exec_timeout
    • NBRegressionFixture.force_regen
    • NBRegressionFixture.post_processors
    • NBRegressionFixture.process_resources
  • NBRegressionResult
    • NBRegressionResult.diff_filtered
    • NBRegressionResult.diff_full
    • NBRegressionResult.diff_string
    • NBRegressionResult.nb_final
    • NBRegressionResult.nb_initial
    • NBRegressionResult.process_resources
  • _get_coverage_aliases()
• pytest_notebook.notebook module
  • MetadataConfig
    • MetadataConfig._validate_diff_ignore()
    • MetadataConfig._validate_diff_replace()
    • MetadataConfig.diff_ignore
    • MetadataConfig.diff_replace
    • MetadataConfig.skip
    • MetadataConfig.skip_reason
  • NBConfigValidationError
  • _load_validator()
  • config_from_metadata()
  • create_cell()
  • create_notebook()
  • dump_notebook()
  • gather_json_paths()
  • load_notebook()
  • load_notebook_with_config()
  • mapping_to_dict()
  • prepare_cell()
  • prepare_nb()
  • regex_replace_nb()
  • validate_metadata()
  • validate_regex_replace()
• pytest_notebook.plugin module
  • JupyterNbCollector
    • JupyterNbCollector._nodeid
    • JupyterNbCollector._store
    • JupyterNbCollector.collect()
    • JupyterNbCollector.config
    • JupyterNbCollector.fspath
    • JupyterNbCollector.name
    • JupyterNbCollector.parent
    • JupyterNbCollector.path
    • JupyterNbCollector.session
  • JupyterNbTest
    • JupyterNbTest._nodeid
    • JupyterNbTest._store
    • JupyterNbTest.config
    • JupyterNbTest.fspath
    • JupyterNbTest.name
    • JupyterNbTest.parent
    • JupyterNbTest.path
    • JupyterNbTest.reportinfo()
    • JupyterNbTest.repr_failure()
    • JupyterNbTest.runtest()
    • JupyterNbTest.session
  • NotSet
  • gather_config_options()
  • nb_regression()
  • pytest_addoption()
  • pytest_collect_file()
  • pytest_report_header()
  • str2bool()
  • strip_quotes()
  • validate_diff_replace()
• pytest_notebook.post_processors module
  • beautifulsoup()
  • blacken_code()
  • cell_preprocessor()
  • coalesce_streams()
  • document_processors()
  • list_processor_names()
  • load_processor()
• pytest_notebook.utils module
  • autodoc()
  • running_as_test()
  • type_to_sphinx()

Module contents

A pytest plugin for testing Jupyter Notebooks.