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
() → _Uname¶ Returns a named tuple of operating specific and CircuitPython port specific information.
-
class
os.
_Uname
¶ Bases:
typing.NamedTuple
The type of values that
uname()
returnsCreate and return a new object. See help(type) for accurate signature.
-
sysname
:str¶
-
nodename
:str¶
-
release
:str¶
-
version
:str¶
-
machine
:str¶
-
-
os.
listdir
(dir: str) → str¶ With no argument, list the current directory. Otherwise list the given directory.
-
os.
stat
(path: str) → Tuple[int, int, int, int, int, int, int, int, int, int]¶ 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: str) → Tuple[int, int, int, int, int, int, int, int, int, int]¶ 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.
urandom
(size: int) → str¶ 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
:str¶ Separator used to delineate path components such as folder and file names.