uos
– basic “operating system” services¶
This module implements a subset of the corresponding CPython
module,
as described below. For more information, refer to the original
CPython documentation: os
.
The uos
module contains functions for filesystem access and urandom
function.
Functions¶
-
uos.
chdir
(path)¶ Change current directory.
-
uos.
getcwd
()¶ Get the current directory.
-
uos.
ilistdir
([dir])¶ This function returns an iterator which then yields 3-tuples corresponding to the entries in the directory that it is listing. With no argument it lists the current directory, otherwise it lists the directory given by dir.
The 3-tuples have the form (name, type, inode):
- name is a string (or bytes if dir is a bytes object) and is the name of the entry;
- type is an integer that specifies the type of the entry, with 0x4000 for directories and 0x8000 for regular files;
- inode is an integer corresponding to the inode of the file, and may be 0 for filesystems that don’t have such a notion.
-
uos.
listdir
([dir])¶ With no argument, list the current directory. Otherwise list the given directory.
-
uos.
mkdir
(path)¶ Create a new directory.
-
uos.
remove
(path)¶ Remove a file.
-
uos.
rmdir
(path)¶ Remove a directory.
-
uos.
rename
(old_path, new_path)¶ Rename a file.
-
uos.
stat
(path)¶ Get the status of a file or directory.
-
uos.
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.
-
uos.
sync
()¶ Sync all filesystems.
-
uos.
urandom
(n)¶ Return a bytes object with n random bytes. Whenever possible, it is generated by the hardware random number generator.
-
uos.
dupterm
(stream_object, index=0)¶ Duplicate or switch the MicroPython terminal (the REPL) on the given stream-like object. The stream_object argument must implement the
readinto()
andwrite()
methods. The stream should be in non-blocking mode andreadinto()
should returnNone
if there is no data available for reading.After calling this function all terminal output is repeated on this stream, and any input that is available on the stream is passed on to the terminal input.
The index parameter should be a non-negative integer and specifies which duplication slot is set. A given port may implement more than one slot (slot 0 will always be available) and in that case terminal input and output is duplicated on all the slots that are set.
If
None
is passed as the stream_object then duplication is cancelled on the slot given by index.The function returns the previous stream-like object in the given slot.