{
    "content": [
        {
            "type": "text",
            "text": "# zlib (pydoc)\n\n**Summary:** zlib\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **DESCRIPTION** (3 lines) — 6 subsections\n  - adler32 (1 lines)\n  - compress (1 lines)\n  - compressobj (1 lines)\n  - crc32 (1 lines)\n  - decompress (1 lines)\n  - decompressobj (4 lines)\n- **CLASSES** (3 lines) — 1 subsections\n  - class error (67 lines)\n- **FUNCTIONS** (1 lines) — 6 subsections\n  - adler32 (7 lines)\n  - compress (7 lines)\n  - compressobj (24 lines)\n  - crc32 (7 lines)\n  - decompress (9 lines)\n  - decompressobj (8 lines)\n- **DATA** (23 lines)\n- **VERSION** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\nzlib\n\n### DESCRIPTION\n\nThe functions in this module allow compression and decompression using the\nzlib library, which is based on GNU zip.\n\n#### adler32\n\n#### compress\n\n#### compressobj\n\n#### crc32\n\n#### decompress\n\n#### decompressobj\n\n'wbits' is window buffer size and container format.\nCompressor objects support compress() and flush() methods; decompressor\nobjects support decompress() and flush().\n\n### CLASSES\n\nbuiltins.Exception(builtins.BaseException)\nerror\n\n#### class error\n\n|  Method resolution order:\n|      error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors defined here:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n### FUNCTIONS\n\n#### adler32\n\nCompute an Adler-32 checksum of data.\n\nvalue\nStarting value of the checksum.\n\nThe returned checksum is an integer.\n\n#### compress\n\nReturns a bytes object containing compressed data.\n\ndata\nBinary data to be compressed.\nlevel\nCompression level, in 0-9 or -1.\n\n#### compressobj\n\nReturn a compressor object.\n\nlevel\nThe compression level (an integer in the range 0-9 or -1; default is\ncurrently equivalent to 6).  Higher compression levels are slower,\nbut produce smaller results.\nmethod\nThe compression algorithm.  If given, this must be DEFLATED.\nwbits\n+9 to +15: The base-two logarithm of the window size.  Include a zlib\ncontainer.\n-9 to -15: Generate a raw stream.\n+25 to +31: Include a gzip container.\nmemLevel\nControls the amount of memory used for internal compression state.\nValid values range from 1 to 9.  Higher values result in higher memory\nusage, faster compression, and smaller output.\nstrategy\nUsed to tune the compression algorithm.  Possible values are\nZDEFAULTSTRATEGY, ZFILTERED, and ZHUFFMANONLY.\nzdict\nThe predefined compression dictionary - a sequence of bytes\ncontaining subsequences that are likely to occur in the input data.\n\n#### crc32\n\nCompute a CRC-32 checksum of data.\n\nvalue\nStarting value of the checksum.\n\nThe returned checksum is an integer.\n\n#### decompress\n\nReturns a bytes object containing the uncompressed data.\n\ndata\nCompressed data.\nwbits\nThe window buffer size and container format.\nbufsize\nThe initial output buffer size.\n\n#### decompressobj\n\nReturn a decompressor object.\n\nwbits\nThe window buffer size and container format.\nzdict\nThe predefined compression dictionary.  This must be the same\ndictionary as used by the compressor that produced the input data.\n\n### DATA\n\nDEFLATED = 8\nDEFBUFSIZE = 16384\nDEFMEMLEVEL = 8\nMAXWBITS = 15\nZLIBRUNTIMEVERSION = '1.2.11'\nZLIBVERSION = '1.2.11'\nZBESTCOMPRESSION = 9\nZBESTSPEED = 1\nZBLOCK = 5\nZDEFAULTCOMPRESSION = -1\nZDEFAULTSTRATEGY = 0\nZFILTERED = 1\nZFINISH = 4\nZFIXED = 4\nZFULLFLUSH = 3\nZHUFFMANONLY = 2\nZNOCOMPRESSION = 0\nZNOFLUSH = 0\nZPARTIALFLUSH = 1\nZRLE = 3\nZSYNCFLUSH = 2\nZTREES = 6\n\n### VERSION\n\n1.0\n\n### FILE\n\n(built-in)\n\n"
        }
    ],
    "structuredContent": {
        "command": "zlib",
        "section": "",
        "mode": "pydoc",
        "summary": "zlib",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 3,
                "subsections": [
                    {
                        "name": "adler32",
                        "lines": 1
                    },
                    {
                        "name": "compress",
                        "lines": 1
                    },
                    {
                        "name": "compressobj",
                        "lines": 1
                    },
                    {
                        "name": "crc32",
                        "lines": 1
                    },
                    {
                        "name": "decompress",
                        "lines": 1
                    },
                    {
                        "name": "decompressobj",
                        "lines": 4
                    }
                ]
            },
            {
                "name": "CLASSES",
                "lines": 3,
                "subsections": [
                    {
                        "name": "class error",
                        "lines": 67
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "adler32",
                        "lines": 7
                    },
                    {
                        "name": "compress",
                        "lines": 7
                    },
                    {
                        "name": "compressobj",
                        "lines": 24
                    },
                    {
                        "name": "crc32",
                        "lines": 7
                    },
                    {
                        "name": "decompress",
                        "lines": 9
                    },
                    {
                        "name": "decompressobj",
                        "lines": 8
                    }
                ]
            },
            {
                "name": "DATA",
                "lines": 23,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}