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
()¶ Returns a named tuple of operating specific and CircuitPython port specific information.
-
os.
chdir
(path)¶ Change current directory.
-
os.
getcwd
()¶ Get the current directory.
-
os.
listdir
([dir])¶ With no argument, list the current directory. Otherwise list the given directory.
-
os.
mkdir
(path)¶ Create a new directory.
-
os.
remove
(path)¶ Remove a file.
-
os.
rmdir
(path)¶ Remove a directory.
-
os.
rename
(old_path, new_path)¶ Rename a file.
-
os.
stat
(path)¶ Get the status of a file or directory.
-
os.
statvfs
(path)¶ Get the status of a fileystem.
Returns a tuple with the filesystem information in the following order:
f_bsize
– file system block sizef_frsize
– fragment sizef_blocks
– size of fs in f_frsize unitsf_bfree
– number of free blocksf_bavail
– number of free blocks for unpriviliged usersf_files
– number of inodesf_ffree
– number of free inodesf_favail
– number of free inodes for unpriviliged usersf_flag
– mount flagsf_namemax
– maximum filename length
Parameters related to inodes:
f_files
,f_ffree
,f_avail
and thef_flags
parameter may return0
as they can be unavailable in a port-specific implementation.
-
os.
sync
()¶ Sync all filesystems.
-
os.
urandom
(size)¶ Returns a string of size random bytes based on a hardware True Random Number Generator. When not available, it will raise a NotImplementedError.
-
os.
sep
¶ Separator used to delineate path components such as folder and file names.