{
    "content": [
        {
            "type": "text",
            "text": "# idna (pydoc)\n\n**Summary:** idna\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **PACKAGE CONTENTS** (8 lines)\n- **CLASSES** (6 lines) — 4 subsections\n  - class IDNABidiError (72 lines)\n  - class IDNAError (71 lines)\n  - class InvalidCodepoint (72 lines)\n  - class InvalidCodepointContext (72 lines)\n- **FUNCTIONS** (1 lines) — 15 subsections\n  - alabel (1 lines)\n  - check_bidi (1 lines)\n  - check_hyphen_ok (1 lines)\n  - check_initial_combiner (1 lines)\n  - check_label (1 lines)\n  - check_nfc (1 lines)\n  - decode (1 lines)\n  - encode (1 lines)\n  - intranges_contain (2 lines)\n  - ulabel (1 lines)\n  - uts46_remap (2 lines)\n  - valid_contextj (1 lines)\n  - valid_contexto (1 lines)\n  - valid_label_length (1 lines)\n  - valid_string_length (1 lines)\n- **DATA** (2 lines)\n- **VERSION** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\nidna\n\n### PACKAGE CONTENTS\n\ncodec\ncompat\ncore\nidnadata\nintranges\npackagedata\nuts46data\n\n### CLASSES\n\nbuiltins.UnicodeError(builtins.ValueError)\nidna.core.IDNAError\nidna.core.IDNABidiError\nidna.core.InvalidCodepoint\nidna.core.InvalidCodepointContext\n\n#### class IDNABidiError\n\n|  Exception when bidirectional requirements are not satisfied\n|\n|  Method resolution order:\n|      IDNABidiError\n|      IDNAError\n|      builtins.UnicodeError\n|      builtins.ValueError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from IDNAError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.UnicodeError:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.UnicodeError:\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#### class IDNAError\n\n|  Base exception for all IDNA-encoding related problems\n|\n|  Method resolution order:\n|      IDNAError\n|      builtins.UnicodeError\n|      builtins.ValueError\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.UnicodeError:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.UnicodeError:\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#### class InvalidCodepoint\n\n|  Exception when a disallowed or unallocated codepoint is used\n|\n|  Method resolution order:\n|      InvalidCodepoint\n|      IDNAError\n|      builtins.UnicodeError\n|      builtins.ValueError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from IDNAError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.UnicodeError:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.UnicodeError:\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#### class InvalidCodepointContext\n\n|  Exception when the codepoint is not valid in the context it is used\n|\n|  Method resolution order:\n|      InvalidCodepointContext\n|      IDNAError\n|      builtins.UnicodeError\n|      builtins.ValueError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from IDNAError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.UnicodeError:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.UnicodeError:\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#### alabel\n\n#### check_bidi\n\n#### check_hyphen_ok\n\n#### check_initial_combiner\n\n#### check_label\n\n#### check_nfc\n\n#### decode\n\n#### encode\n\n#### intranges_contain\n\nDetermine if `int` falls into one of the ranges in `ranges`.\n\n#### ulabel\n\n#### uts46_remap\n\nRe-map the characters in the string according to UTS46 processing.\n\n#### valid_contextj\n\n#### valid_contexto\n\n#### valid_label_length\n\n#### valid_string_length\n\n### DATA\n\nall = ['IDNABidiError', 'IDNAError', 'InvalidCodepoint', 'InvalidC...\n\n### VERSION\n\n3.3\n\n### FILE\n\n/usr/lib/python3/dist-packages/idna/init.py\n\n"
        }
    ],
    "structuredContent": {
        "command": "idna",
        "section": "",
        "mode": "pydoc",
        "summary": "idna",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "PACKAGE CONTENTS",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "CLASSES",
                "lines": 6,
                "subsections": [
                    {
                        "name": "class IDNABidiError",
                        "lines": 72
                    },
                    {
                        "name": "class IDNAError",
                        "lines": 71
                    },
                    {
                        "name": "class InvalidCodepoint",
                        "lines": 72
                    },
                    {
                        "name": "class InvalidCodepointContext",
                        "lines": 72
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "alabel",
                        "lines": 1
                    },
                    {
                        "name": "check_bidi",
                        "lines": 1
                    },
                    {
                        "name": "check_hyphen_ok",
                        "lines": 1
                    },
                    {
                        "name": "check_initial_combiner",
                        "lines": 1
                    },
                    {
                        "name": "check_label",
                        "lines": 1
                    },
                    {
                        "name": "check_nfc",
                        "lines": 1
                    },
                    {
                        "name": "decode",
                        "lines": 1
                    },
                    {
                        "name": "encode",
                        "lines": 1
                    },
                    {
                        "name": "intranges_contain",
                        "lines": 2
                    },
                    {
                        "name": "ulabel",
                        "lines": 1
                    },
                    {
                        "name": "uts46_remap",
                        "lines": 2
                    },
                    {
                        "name": "valid_contextj",
                        "lines": 1
                    },
                    {
                        "name": "valid_contexto",
                        "lines": 1
                    },
                    {
                        "name": "valid_label_length",
                        "lines": 1
                    },
                    {
                        "name": "valid_string_length",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "DATA",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}