{
    "content": [
        {
            "type": "text",
            "text": "# pprint (pydoc)\n\n**Summary:** pprint - Support to pretty-print lists, tuples, & dictionaries recursively.\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **MODULE REFERENCE** (8 lines)\n- **DESCRIPTION** (12 lines) — 3 subsections\n  - pformat (2 lines)\n  - pprint (2 lines)\n  - saferepr (3 lines)\n- **CLASSES** (3 lines) — 1 subsections\n  - class PrettyPrinter (49 lines)\n- **FUNCTIONS** (1 lines) — 6 subsections\n  - isreadable (2 lines)\n  - isrecursive (2 lines)\n  - pformat (2 lines)\n  - pp (2 lines)\n  - pprint (2 lines)\n  - saferepr (2 lines)\n- **DATA** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\npprint - Support to pretty-print lists, tuples, & dictionaries recursively.\n\n### MODULE REFERENCE\n\nhttps://docs.python.org/3.10/library/pprint.html\n\nThe following documentation is automatically generated from the Python\nsource files.  It may be incomplete, incorrect or include features that\nare considered implementation detail and may vary between Python\nimplementations.  When in doubt, consult the module reference at the\nlocation listed above.\n\n### DESCRIPTION\n\nVery simple, but useful, especially in debugging data structures.\n\nClasses\n-------\n\nPrettyPrinter()\nHandle pretty-printing operations onto a stream using a configured\nset of formatting parameters.\n\nFunctions\n---------\n\n#### pformat\n\nFormat a Python object into a pretty-printed representation.\n\n#### pprint\n\nPretty-print a Python object to a stream [default is sys.stdout].\n\n#### saferepr\n\nGenerate a 'standard' repr()-like value, but protect against recursive\ndata structures.\n\n### CLASSES\n\nbuiltins.object\nPrettyPrinter\n\n#### class PrettyPrinter\n\n|  PrettyPrinter(indent=1, width=80, depth=None, stream=None, *, compact=False, sortdicts=True, underscorenumbers=False)\n|\n|  Methods defined here:\n|\n|  init(self, indent=1, width=80, depth=None, stream=None, *, compact=False, sortdicts=True, underscorenumbers=False)\n|      Handle pretty printing operations onto a stream using a set of\n|      configured parameters.\n|\n|      indent\n|          Number of spaces to indent for each level of nesting.\n|\n|      width\n|          Attempted maximum number of columns in the output.\n|\n|      depth\n|          The maximum depth to print out nested structures.\n|\n|      stream\n|          The desired output stream.  If omitted (or false), the standard\n|          output stream available at construction will be used.\n|\n|      compact\n|          If true, several items will be combined in one line.\n|\n|      sortdicts\n|          If true, dict keys are sorted.\n|\n|  format(self, object, context, maxlevels, level)\n|      Format object for a specific context, returning a string\n|      and flags indicating whether the representation is 'readable'\n|      and whether the object represents a recursive construct.\n|\n|  isreadable(self, object)\n|\n|  isrecursive(self, object)\n|\n|  pformat(self, object)\n|\n|  pprint(self, object)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n\n### FUNCTIONS\n\n#### isreadable\n\nDetermine if saferepr(object) is readable by eval().\n\n#### isrecursive\n\nDetermine if object requires a recursive representation.\n\n#### pformat\n\nFormat a Python object into a pretty-printed representation.\n\n#### pp\n\nPretty-print a Python object\n\n#### pprint\n\nPretty-print a Python object to a stream [default is sys.stdout].\n\n#### saferepr\n\nVersion of repr() which can handle recursive data structures.\n\n### DATA\n\nall = ['pprint', 'pformat', 'isreadable', 'isrecursive', 'saferepr...\n\n### FILE\n\n/usr/lib/python3.10/pprint.py\n\n"
        }
    ],
    "structuredContent": {
        "command": "pprint",
        "section": "",
        "mode": "pydoc",
        "summary": "pprint - Support to pretty-print lists, tuples, & dictionaries recursively.",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "MODULE REFERENCE",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 12,
                "subsections": [
                    {
                        "name": "pformat",
                        "lines": 2
                    },
                    {
                        "name": "pprint",
                        "lines": 2
                    },
                    {
                        "name": "saferepr",
                        "lines": 3
                    }
                ]
            },
            {
                "name": "CLASSES",
                "lines": 3,
                "subsections": [
                    {
                        "name": "class PrettyPrinter",
                        "lines": 49
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "isreadable",
                        "lines": 2
                    },
                    {
                        "name": "isrecursive",
                        "lines": 2
                    },
                    {
                        "name": "pformat",
                        "lines": 2
                    },
                    {
                        "name": "pp",
                        "lines": 2
                    },
                    {
                        "name": "pprint",
                        "lines": 2
                    },
                    {
                        "name": "saferepr",
                        "lines": 2
                    }
                ]
            },
            {
                "name": "DATA",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}