summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/platform.rst
blob: c091477d84cb17b97101986ff85d95a66f5079a6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
:mod:`platform` -- access to underlying platform’s identifying data
===================================================================

.. module:: platform
   :synopsis: access to underlying platform’s identifying data

|see_cpython_module| :mod:`python:platform`.

This module tries to retrieve as much platform-identifying data as possible. It
makes this information available via function APIs.

Functions
---------

.. function:: platform()

   Returns a string identifying the underlying platform. This string is composed
   of several substrings in the following order, delimited by dashes (``-``):

   - the name of the platform system (e.g. Unix, Windows or MicroPython)
   - the MicroPython version
   - the architecture of the platform
   - the version of the underlying platform
   - the concatenation of the name of the libc that MicroPython is linked to
     and its corresponding version.

   For example, this could be
   ``"MicroPython-1.20.0-xtensa-IDFv4.2.4-with-newlib3.0.0"``.

.. function:: python_compiler()

   Returns a string identifying the compiler used for compiling MicroPython.

.. function:: libc_ver()

   Returns a tuple of strings *(lib, version)*, where *lib* is the name of the
   libc that MicroPython is linked to, and *version* the corresponding version
   of this libc.