image-match/python/py/Lib/site-packages/nbconvert/writers/debug.py

"""
Contains debug writer.
"""

from pprint import pprint

from .base import WriterBase

# -----------------------------------------------------------------------------
# Copyright (c) 2013, the IPython Development Team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file COPYING.txt, distributed with this software.
# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------


# -----------------------------------------------------------------------------
# Classes
# -----------------------------------------------------------------------------


class DebugWriter(WriterBase):
    """Consumes output from nbconvert export...() methods and writes useful
    debugging information to the stdout.  The information includes a list of
    resources that were extracted from the notebook(s) during export."""

    def write(self, output, resources, notebook_name="notebook", **kw):
        """
        Consume and write Jinja output.

        See base for more...
        """

        if isinstance(resources["outputs"], dict):
            print("outputs extracted from %s" % notebook_name)
            print("-" * 80)
            pprint(resources["outputs"], indent=2, width=70)  # noqa: T203
        else:
            print("no outputs extracted from %s" % notebook_name)
        print("=" * 80)