{
    "content": [
        {
            "type": "text",
            "text": "# getpass (pydoc)\n\n**Summary:** getpass - Utilities to get a password and/or the current user name.\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **MODULE REFERENCE** (8 lines)\n- **DESCRIPTION** (1 lines) — 2 subsections\n  - getpass (1 lines)\n  - getuser (5 lines)\n- **CLASSES** (3 lines) — 1 subsections\n  - class GetPassWarning (69 lines)\n- **FUNCTIONS** (15 lines) — 1 subsections\n  - getuser (5 lines)\n- **DATA** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\ngetpass - Utilities to get a password and/or the current user name.\n\n### MODULE REFERENCE\n\nhttps://docs.python.org/3.10/library/getpass.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\n#### getpass\n\n#### getuser\n\nGetPassWarning - This UserWarning is issued when getpass() cannot prevent\nechoing of the password contents while reading.\n\nOn Windows, the msvcrt module will be used.\n\n### CLASSES\n\nbuiltins.UserWarning(builtins.Warning)\nGetPassWarning\n\n#### class GetPassWarning\n\n|  Method resolution order:\n|      GetPassWarning\n|      builtins.UserWarning\n|      builtins.Warning\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.UserWarning:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.UserWarning:\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\ngetpass = unixgetpass(prompt='Password: ', stream=None)\nPrompt for a password, with echo turned off.\n\nArgs:\nprompt: Written on stream to ask for the input.  Default: 'Password: '\nstream: A writable file object to display the prompt.  Defaults to\nthe tty.  If no tty is available defaults to sys.stderr.\nReturns:\nThe seKr3t input.\nRaises:\nEOFError: If our input tty or stdin was closed.\nGetPassWarning: When we were unable to turn echo off on the input.\n\nAlways restores terminal settings before returning.\n\n#### getuser\n\nGet the username from the environment or password database.\n\nFirst try various environment variables, then the password\ndatabase.  This works on Windows as long as USERNAME is set.\n\n### DATA\n\nall = ['getpass', 'getuser', 'GetPassWarning']\n\n### FILE\n\n/usr/lib/python3.10/getpass.py\n\n"
        }
    ],
    "structuredContent": {
        "command": "getpass",
        "section": "",
        "mode": "pydoc",
        "summary": "getpass - Utilities to get a password and/or the current user name.",
        "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": 1,
                "subsections": [
                    {
                        "name": "getpass",
                        "lines": 1
                    },
                    {
                        "name": "getuser",
                        "lines": 5
                    }
                ]
            },
            {
                "name": "CLASSES",
                "lines": 3,
                "subsections": [
                    {
                        "name": "class GetPassWarning",
                        "lines": 69
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 15,
                "subsections": [
                    {
                        "name": "getuser",
                        "lines": 5
                    }
                ]
            },
            {
                "name": "DATA",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}