os

functions that an OS normally provides

The os module is a strict subset of the CPython os module. So, code written in CircuitPython will work in CPython but not necessarily the other way around.

os.uname() → Any

Returns a named tuple of operating specific and CircuitPython port specific information.

os.chdir(path: Any) → Any

Change current directory.

os.getcwd() → Any

Get the current directory.

os.listdir(dir: Any) → Any

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

os.mkdir(path: Any) → Any

Create a new directory.

os.remove(path: Any) → Any

Remove a file.

os.rmdir(path: Any) → Any

Remove a directory.

os.rename(old_path: Any, new_path: Any) → Any

Rename a file.

os.stat(path: Any) → Any

Get the status of a file or directory.

Note

On builds without long integers, the number of seconds for contemporary dates will not fit in a small integer. So the time fields return 946684800, which is the number of seconds corresponding to 1999-12-31.

os.statvfs(path: Any) → Any

Get the status of a fileystem.

Returns a tuple with the filesystem information in the following order:

• f_bsize – file system block size

• f_frsize – fragment size

• f_blocks – size of fs in f_frsize units

• f_bfree – number of free blocks

• f_bavail – number of free blocks for unpriviliged users

• f_files – number of inodes

• f_ffree – number of free inodes

• f_favail – number of free inodes for unpriviliged users

• f_flag – mount flags

• f_namemax – maximum filename length

Parameters related to inodes: f_files, f_ffree, f_avail and the f_flags parameter may return 0 as they can be unavailable in a port-specific implementation.

os.sync() → Any

Sync all filesystems.

os.urandom(size: Any) → Any

Returns a string of size random bytes based on a hardware True Random Number Generator. When not available, it will raise a NotImplementedError.