{
    "content": [
        {
            "type": "text",
            "text": "# encodings (pydoc)\n\n**Summary:** encodings - Standard \"encodings\" Package\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **MODULE REFERENCE** (8 lines)\n- **DESCRIPTION** (26 lines)\n- **PACKAGE CONTENTS** (122 lines)\n- **CLASSES** (5 lines) — 1 subsections\n  - class CodecRegistryError (69 lines)\n- **FUNCTIONS** (1 lines) — 2 subsections\n  - normalize_encoding (9 lines)\n  - search_function (1 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\nencodings - Standard \"encodings\" Package\n\n### MODULE REFERENCE\n\nhttps://docs.python.org/3.10/library/encodings.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\nStandard Python encoding modules are stored in this package\ndirectory.\n\nCodec modules must have names corresponding to normalized encoding\nnames as defined in the normalizeencoding() function below, e.g.\n'utf-8' must be implemented by the module 'utf8.py'.\n\nEach codec module must export the following interface:\n\n* getregentry() -> codecs.CodecInfo object\nThe getregentry() API must return a CodecInfo object with encoder, decoder,\nincrementalencoder, incrementaldecoder, streamwriter and streamreader\nattributes which adhere to the Python Codec Interface Standard.\n\nIn addition, a module may optionally also define the following\nAPIs which are then used by the package's codec search function:\n\n* getaliases() -> sequence of encoding name strings to use as aliases\n\nAlias names returned by getaliases() must be normalized encoding\nnames as defined by normalizeencoding().\n\nWritten by Marc-Andre Lemburg (mal@lemburg.com).\n\n(c) Copyright CNRI, All Rights Reserved. NO WARRANTY.\n\n### PACKAGE CONTENTS\n\naliases\nascii\nbase64codec\nbig5\nbig5hkscs\nbz2codec\ncharmap\ncp037\ncp1006\ncp1026\ncp1125\ncp1140\ncp1250\ncp1251\ncp1252\ncp1253\ncp1254\ncp1255\ncp1256\ncp1257\ncp1258\ncp273\ncp424\ncp437\ncp500\ncp720\ncp737\ncp775\ncp850\ncp852\ncp855\ncp856\ncp857\ncp858\ncp860\ncp861\ncp862\ncp863\ncp864\ncp865\ncp866\ncp869\ncp874\ncp875\ncp932\ncp949\ncp950\neucjis2004\neucjisx0213\neucjp\neuckr\ngb18030\ngb2312\ngbk\nhexcodec\nhproman8\nhz\nidna\niso2022jp\niso2022jp1\niso2022jp2\niso2022jp2004\niso2022jp3\niso2022jpext\niso2022kr\niso88591\niso885910\niso885911\niso885913\niso885914\niso885915\niso885916\niso88592\niso88593\niso88594\niso88595\niso88596\niso88597\niso88598\niso88599\njohab\nkoi8r\nkoi8t\nkoi8u\nkz1048\nlatin1\nmacarabic\nmaccroatian\nmaccyrillic\nmacfarsi\nmacgreek\nmaciceland\nmaclatin2\nmacroman\nmacromanian\nmacturkish\nmbcs\noem\npalmos\nptcp154\npunycode\nquopricodec\nrawunicodeescape\nrot13\nshiftjis\nshiftjis2004\nshiftjisx0213\ntis620\nundefined\nunicodeescape\nutf16\nutf16be\nutf16le\nutf32\nutf32be\nutf32le\nutf7\nutf8\nutf8sig\nuucodec\nzlibcodec\n\n### CLASSES\n\nbuiltins.LookupError(builtins.Exception)\nCodecRegistryError(builtins.LookupError, builtins.SystemError)\nbuiltins.SystemError(builtins.Exception)\nCodecRegistryError(builtins.LookupError, builtins.SystemError)\n\n#### class CodecRegistryError\n\n|  Method resolution order:\n|      CodecRegistryError\n|      builtins.LookupError\n|      builtins.SystemError\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.LookupError:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.LookupError:\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#### normalize_encoding\n\nNormalize an encoding name.\n\nNormalization works as follows: all non-alphanumeric\ncharacters except the dot used for Python package names are\ncollapsed and replaced with a single underscore, e.g. '  -;#'\nbecomes ''. Leading and trailing underscores are removed.\n\nNote that encoding names should be ASCII only.\n\n#### search_function\n\n### FILE\n\n/usr/lib/python3.10/encodings/init.py\n\n"
        }
    ],
    "structuredContent": {
        "command": "encodings",
        "section": "",
        "mode": "pydoc",
        "summary": "encodings - Standard \"encodings\" Package",
        "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": 26,
                "subsections": []
            },
            {
                "name": "PACKAGE CONTENTS",
                "lines": 122,
                "subsections": []
            },
            {
                "name": "CLASSES",
                "lines": 5,
                "subsections": [
                    {
                        "name": "class CodecRegistryError",
                        "lines": 69
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "normalize_encoding",
                        "lines": 9
                    },
                    {
                        "name": "search_function",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}