micropython/docs/library/os.rst

:mod:`os` -- basic "operating system" services
==============================================

.. module:: os
   :synopsis: basic "operating system" services

The ``os`` module contains functions for filesystem access and ``urandom``.

Pyboard specifics
-----------------

The filesystem on the pyboard has ``/`` as the root directory and the
available physical drives are accessible from here.  They are currently:

    ``/flash``      -- the internal flash filesystem

    ``/sd``         -- the SD card (if it exists)

On boot up, the current directory is ``/flash`` if no SD card is inserted,
otherwise it is ``/sd``.

Functions
---------

.. function:: chdir(path)

   Change current directory.

.. function:: getcwd()

   Get the current directory.

.. function:: listdir([dir])

   With no argument, list the current directory.  Otherwise list the given directory.

.. function:: mkdir(path)

   Create a new directory.

.. function:: remove(path)

   Remove a file.

.. function:: rmdir(path)

   Remove a directory.

.. function:: stat(path)

   Get the status of a file or directory.

.. function:: sync()

   Sync all filesystems.

.. function:: urandom(n)

   Return a bytes object with n random bytes, generated by the hardware
   random number generator.

Constants
---------

.. data:: sep

   separation character used in paths