storage
– Storage management¶
The storage
provides storage management functionality such as mounting and
unmounting which is typically handled by the operating system hosting Python.
CircuitPython does not have an OS, so this module provides this functionality
directly.
-
storage.
mount
(filesystem: VfsFat, mount_path: str, \*, readonly: bool = False) → None¶ Mounts the given filesystem object at the given path.
This is the CircuitPython analog to the UNIX
mount
command.- Parameters
readonly (bool) – True when the filesystem should be readonly to CircuitPython.
-
storage.
umount
(mount: Union[str, VfsFat]) → None¶ Unmounts the given filesystem object or if mount is a path, then unmount the filesystem mounted at that location.
This is the CircuitPython analog to the UNIX
umount
command.
-
storage.
remount
(mount_path: str, readonly: bool = False, \*, disable_concurrent_write_protection: bool = False) → None¶ Remounts the given path with new parameters.
- Parameters
readonly (bool) – True when the filesystem should be readonly to CircuitPython.
disable_concurrent_write_protection (bool) – When True, the check that makes sure the underlying filesystem data is written by one computer is disabled. Disabling the protection allows CircuitPython and a host to write to the same filesystem with the risk that the filesystem will be corrupted.
-
storage.
getmount
(mount_path: str) → VfsFat¶ Retrieves the mount object associated with the mount path
-
storage.
erase_filesystem
() → None¶ Erase and re-create the
CIRCUITPY
filesystem.On boards that present USB-visible
CIRCUITPY
drive (e.g., SAMD21 and SAMD51), then callmicrocontroller.reset()
to restart CircuitPython and have the host computer remount CIRCUITPY.This function can be called from the REPL when
CIRCUITPY
has become corrupted.Warning
All the data on
CIRCUITPY
will be lost, and CircuitPython will restart on certain boards.
-
class
storage.
VfsFat
(block_device: str)¶ Create a new VfsFat filesystem around the given block device.
- Parameters
block_device – Block device the the filesystem lives on
-
label
:str¶ The filesystem label, up to 11 case-insensitive bytes. Note that this property can only be set when the device is writable by the microcontroller.
-
ilistdir
(self, path: str) → Iterator[Union[Tuple[AnyStr, int, int, int], Tuple[AnyStr, int, int]]]¶ Return an iterator whose values describe files and folders within
path
-
mount
(self, readonly: bool, mkfs: VfsFat) → None¶ Don’t call this directly, call
storage.mount
.
-
umount
(self) → None¶ Don’t call this directly, call
storage.umount
.