{
    "content": [
        {
            "type": "text",
            "text": "# platform (pydoc)\n\n**Summary:** platform\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **MODULE REFERENCE** (8 lines)\n- **DESCRIPTION** (7 lines)\n- **CLASSES** (1 lines) — 2 subsections\n  - uname_result_base (2 lines)\n  - class uname_result (144 lines)\n- **FUNCTIONS** (1 lines) — 24 subsections\n  - architecture (18 lines)\n  - freedesktop_os_release (2 lines)\n  - java_ver (9 lines)\n  - libc_ver (12 lines)\n  - mac_ver (7 lines)\n  - machine (4 lines)\n  - node (5 lines)\n  - platform (16 lines)\n  - processor (7 lines)\n  - python_branch (8 lines)\n  - python_build (3 lines)\n  - python_compiler (3 lines)\n  - python_implementation (8 lines)\n  - python_revision (8 lines)\n  - python_version (5 lines)\n  - python_version_tuple (6 lines)\n  - release (4 lines)\n  - system (4 lines)\n  - system_alias (6 lines)\n  - uname (9 lines)\n  - version (4 lines)\n  - win32_edition (1 lines)\n  - win32_is_iot (1 lines)\n  - win32_ver (1 lines)\n- **DATA** (2 lines)\n- **VERSION** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\nplatform\n\n### MODULE REFERENCE\n\nhttps://docs.python.org/3.10/library/platform.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\nThis module tries to retrieve as much platform-identifying data as\npossible. It makes this information available via function APIs.\n\nIf called from the command line, it prints the platform\ninformation concatenated as single string to stdout. The output\nformat is useable as part of a filename.\n\n### CLASSES\n\n#### uname_result_base\n\nunameresult\n\n#### class uname_result\n\n|  unameresult(system, node, release, version, machine)\n|\n|  A unameresult that's largely compatible with a\n|  simple namedtuple except that 'processor' is\n|  resolved late and cached to avoid calling \"uname\"\n|  except when needed.\n|\n|  Method resolution order:\n|      unameresult\n|      unameresultbase\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  processor = <functools.cachedproperty object>\n|  getitem(self, key)\n|      Return self[key].\n|\n|  iter(self)\n|      Implement iter(self).\n|\n|  len(self)\n|      Return len(self).\n|\n|  reduce(self)\n|      Helper for pickle.\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new unameresultbase object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  fields = ('system', 'node', 'release', 'version', 'machine', 'process...\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from unameresultbase:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new unameresultbase object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from unameresultbase:\n|\n|  new(cls, system, node, release, version, machine)\n|      Create new instance of unameresultbase(system, node, release, version, machine)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from unameresultbase:\n|\n|  system\n|      Alias for field number 0\n|\n|  node\n|      Alias for field number 1\n|\n|  release\n|      Alias for field number 2\n|\n|  version\n|      Alias for field number 3\n|\n|  machine\n|      Alias for field number 4\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from unameresultbase:\n|\n|  matchargs = ('system', 'node', 'release', 'version', 'machine')\n|\n|  fielddefaults = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  index(self, value, start=0, stop=9223372036854775807, /)\n|      Return first index of value.\n|\n|      Raises ValueError if the value is not present.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n### FUNCTIONS\n\n#### architecture\n\nQueries the given executable (defaults to the Python interpreter\nbinary) for various architecture information.\n\nReturns a tuple (bits, linkage) which contains information about\nthe bit architecture and the linkage format used for the\nexecutable. Both values are returned as strings.\n\nValues that cannot be determined are returned as given by the\nparameter presets. If bits is given as '', the sizeof(pointer)\n(or sizeof(long) on Python version < 1.5.2) is used as\nindicator for the supported pointer size.\n\nThe function relies on the system's \"file\" command to do the\nactual work. This is available on most if not all Unix\nplatforms. On some non-Unix platforms where the \"file\" command\ndoes not exist and the executable is set to the Python interpreter\nbinary defaults from defaultarchitecture are used.\n\n#### freedesktop_os_release\n\nReturn operation system identification from freedesktop.org os-release\n\n#### java_ver\n\nVersion interface for Jython.\n\nReturns a tuple (release, vendor, vminfo, osinfo) with vminfo being\na tuple (vmname, vmrelease, vmvendor) and osinfo being a\ntuple (osname, osversion, osarch).\n\nValues which cannot be determined are set to the defaults\ngiven as parameters (which all default to '').\n\n#### libc_ver\n\nTries to determine the libc version that the file executable\n(which defaults to the Python interpreter) is linked against.\n\nReturns a tuple of strings (lib,version) which default to the\ngiven parameters in case the lookup fails.\n\nNote that the function has intimate knowledge of how different\nlibc versions add symbols to the executable and thus is probably\nonly useable for executables compiled using gcc.\n\nThe file is read and scanned in chunks of chunksize bytes.\n\n#### mac_ver\n\nGet macOS version information and return it as tuple (release,\nversioninfo, machine) with versioninfo being a tuple (version,\ndevstage, nonreleaseversion).\n\nEntries which cannot be determined are set to the parameter values\nwhich default to ''. All tuple entries are strings.\n\n#### machine\n\nReturns the machine type, e.g. 'i386'\n\nAn empty string is returned if the value cannot be determined.\n\n#### node\n\nReturns the computer's network name (which may not be fully\nqualified)\n\nAn empty string is returned if the value cannot be determined.\n\n#### platform\n\nReturns a single string identifying the underlying platform\nwith as much useful information as possible (but no more :).\n\nThe output is intended to be human readable rather than\nmachine parseable. It may look different on different\nplatforms and this is intended.\n\nIf \"aliased\" is true, the function will use aliases for\nvarious platforms that report system names which differ from\ntheir common names, e.g. SunOS will be reported as\nSolaris. The systemalias() function is used to implement\nthis.\n\nSetting terse to true causes the function to return only the\nabsolute minimum information needed to identify the platform.\n\n#### processor\n\nReturns the (true) processor name, e.g. 'amdk6'\n\nAn empty string is returned if the value cannot be\ndetermined. Note that many platforms do not provide this\ninformation or simply return the same value as for machine(),\ne.g.  NetBSD does this.\n\n#### python_branch\n\nReturns a string identifying the Python implementation\nbranch.\n\nFor CPython this is the SCM branch from which the\nPython binary was built.\n\nIf not available, an empty string is returned.\n\n#### python_build\n\nReturns a tuple (buildno, builddate) stating the Python\nbuild number and date as strings.\n\n#### python_compiler\n\nReturns a string identifying the compiler used for compiling\nPython.\n\n#### python_implementation\n\nReturns a string identifying the Python implementation.\n\nCurrently, the following implementations are identified:\n'CPython' (C implementation of Python),\n'IronPython' (.NET implementation of Python),\n'Jython' (Java implementation of Python),\n'PyPy' (Python implementation of Python).\n\n#### python_revision\n\nReturns a string identifying the Python implementation\nrevision.\n\nFor CPython this is the SCM revision from which the\nPython binary was built.\n\nIf not available, an empty string is returned.\n\n#### python_version\n\nReturns the Python version as string 'major.minor.patchlevel'\n\nNote that unlike the Python sys.version, the returned value\nwill always include the patchlevel (it defaults to 0).\n\n#### python_version_tuple\n\nReturns the Python version as tuple (major, minor, patchlevel)\nof strings.\n\nNote that unlike the Python sys.version, the returned value\nwill always include the patchlevel (it defaults to 0).\n\n#### release\n\nReturns the system's release, e.g. '2.2.0' or 'NT'\n\nAn empty string is returned if the value cannot be determined.\n\n#### system\n\nReturns the system/OS name, e.g. 'Linux', 'Windows' or 'Java'.\n\nAn empty string is returned if the value cannot be determined.\n\n#### system_alias\n\nReturns (system, release, version) aliased to common\nmarketing names used for some systems.\n\nIt also does some reordering of the information in some cases\nwhere it would otherwise cause confusion.\n\n#### uname\n\nFairly portable uname interface. Returns a tuple\nof strings (system, node, release, version, machine, processor)\nidentifying the underlying platform.\n\nNote that unlike the os.uname function this also returns\npossible processor information as an additional tuple entry.\n\nEntries which cannot be determined are set to ''.\n\n#### version\n\nReturns the system's release version, e.g. '#3 on degas'\n\nAn empty string is returned if the value cannot be determined.\n\n#### win32_edition\n\n#### win32_is_iot\n\n#### win32_ver\n\n### DATA\n\ncopyright = '\\n    Copyright (c) 1999-2000, Marc-Andre Lemburg... ...\n\n### VERSION\n\n1.0.8\n\n### FILE\n\n/usr/lib/python3.10/platform.py\n\n"
        }
    ],
    "structuredContent": {
        "command": "platform",
        "section": "",
        "mode": "pydoc",
        "summary": "platform",
        "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": 7,
                "subsections": []
            },
            {
                "name": "CLASSES",
                "lines": 1,
                "subsections": [
                    {
                        "name": "uname_result_base",
                        "lines": 2
                    },
                    {
                        "name": "class uname_result",
                        "lines": 144
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "architecture",
                        "lines": 18
                    },
                    {
                        "name": "freedesktop_os_release",
                        "lines": 2
                    },
                    {
                        "name": "java_ver",
                        "lines": 9
                    },
                    {
                        "name": "libc_ver",
                        "lines": 12
                    },
                    {
                        "name": "mac_ver",
                        "lines": 7
                    },
                    {
                        "name": "machine",
                        "lines": 4
                    },
                    {
                        "name": "node",
                        "lines": 5
                    },
                    {
                        "name": "platform",
                        "lines": 16
                    },
                    {
                        "name": "processor",
                        "lines": 7
                    },
                    {
                        "name": "python_branch",
                        "lines": 8
                    },
                    {
                        "name": "python_build",
                        "lines": 3
                    },
                    {
                        "name": "python_compiler",
                        "lines": 3
                    },
                    {
                        "name": "python_implementation",
                        "lines": 8
                    },
                    {
                        "name": "python_revision",
                        "lines": 8
                    },
                    {
                        "name": "python_version",
                        "lines": 5
                    },
                    {
                        "name": "python_version_tuple",
                        "lines": 6
                    },
                    {
                        "name": "release",
                        "lines": 4
                    },
                    {
                        "name": "system",
                        "lines": 4
                    },
                    {
                        "name": "system_alias",
                        "lines": 6
                    },
                    {
                        "name": "uname",
                        "lines": 9
                    },
                    {
                        "name": "version",
                        "lines": 4
                    },
                    {
                        "name": "win32_edition",
                        "lines": 1
                    },
                    {
                        "name": "win32_is_iot",
                        "lines": 1
                    },
                    {
                        "name": "win32_ver",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "DATA",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}