extmod/modvfs: Add new "vfs" module with mount/umount and Vfs classes.

They have been moved from the "os" module.

Signed-off-by: Damien George <damien@micropython.org>

7 files changed, 80 insertions, 1 deletions

diff --git a/extmod/extmod.cmake b/extmod/extmod.cmake
index d73ff258ff..53c7740132 100644
--- a/extmod/extmod.cmake
+++ b/extmod/extmod.cmake
@@ -42,6 +42,7 @@ set(MICROPY_SOURCE_EXTMOD
     ${MICROPY_EXTMOD_DIR}/modtls_axtls.c
     ${MICROPY_EXTMOD_DIR}/modtls_mbedtls.c
     ${MICROPY_EXTMOD_DIR}/modtime.c
+    ${MICROPY_EXTMOD_DIR}/modvfs.c
     ${MICROPY_EXTMOD_DIR}/modwebsocket.c
     ${MICROPY_EXTMOD_DIR}/modwebrepl.c
     ${MICROPY_EXTMOD_DIR}/network_cyw43.c
diff --git a/extmod/extmod.mk b/extmod/extmod.mk
index b3246bc0d9..f0428bcd05 100644
--- a/extmod/extmod.mk
+++ b/extmod/extmod.mk
@@ -40,6 +40,7 @@ SRC_EXTMOD_C += \
 	extmod/modtls_mbedtls.c \
 	extmod/modtime.c \
 	extmod/moductypes.c \
+	extmod/modvfs.c \
 	extmod/modwebrepl.c \
 	extmod/modwebsocket.c \
 	extmod/network_cyw43.c \
diff --git a/extmod/modos.c b/extmod/modos.c
index 5a088b5202..24a36cb8ce 100644
--- a/extmod/modos.c
+++ b/extmod/modos.c
@@ -195,6 +195,10 @@ STATIC const mp_rom_map_elem_t os_module_globals_table[] = {
 
     #if MICROPY_VFS
     { MP_ROM_QSTR(MP_QSTR_ilistdir), MP_ROM_PTR(&mp_vfs_ilistdir_obj) },
+    #endif
+
+    // The following MicroPython extensions are deprecated.  Use the `vfs` module instead.
+    #if !MICROPY_PREVIEW_VERSION_2 && MICROPY_VFS
     { MP_ROM_QSTR(MP_QSTR_mount), MP_ROM_PTR(&mp_vfs_mount_obj) },
     { MP_ROM_QSTR(MP_QSTR_umount), MP_ROM_PTR(&mp_vfs_umount_obj) },
     #if MICROPY_VFS_FAT
diff --git a/extmod/modvfs.c b/extmod/modvfs.c
new file mode 100644
index 0000000000..02dc67d073
--- /dev/null
+++ b/extmod/modvfs.c
@@ -0,0 +1,67 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2023 Damien P. George
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "py/runtime.h"
+
+#if MICROPY_PY_VFS
+
+#include "extmod/vfs.h"
+#include "extmod/vfs_fat.h"
+#include "extmod/vfs_lfs.h"
+#include "extmod/vfs_posix.h"
+
+#if !MICROPY_VFS
+#error "MICROPY_PY_VFS requires MICROPY_VFS"
+#endif
+
+STATIC const mp_rom_map_elem_t vfs_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_vfs) },
+
+    { MP_ROM_QSTR(MP_QSTR_mount), MP_ROM_PTR(&mp_vfs_mount_obj) },
+    { MP_ROM_QSTR(MP_QSTR_umount), MP_ROM_PTR(&mp_vfs_umount_obj) },
+    #if MICROPY_VFS_FAT
+    { MP_ROM_QSTR(MP_QSTR_VfsFat), MP_ROM_PTR(&mp_fat_vfs_type) },
+    #endif
+    #if MICROPY_VFS_LFS1
+    { MP_ROM_QSTR(MP_QSTR_VfsLfs1), MP_ROM_PTR(&mp_type_vfs_lfs1) },
+    #endif
+    #if MICROPY_VFS_LFS2
+    { MP_ROM_QSTR(MP_QSTR_VfsLfs2), MP_ROM_PTR(&mp_type_vfs_lfs2) },
+    #endif
+    #if MICROPY_VFS_POSIX
+    { MP_ROM_QSTR(MP_QSTR_VfsPosix), MP_ROM_PTR(&mp_type_vfs_posix) },
+    #endif
+};
+STATIC MP_DEFINE_CONST_DICT(vfs_module_globals, vfs_module_globals_table);
+
+const mp_obj_module_t mp_module_vfs = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t *)&vfs_module_globals,
+};
+
+MP_REGISTER_MODULE(MP_QSTR_vfs, mp_module_vfs);
+
+#endif // MICROPY_PY_VFS
diff --git a/ports/cc3200/mpconfigport.h b/ports/cc3200/mpconfigport.h
index d472d29f70..9cbc1afc0b 100644
--- a/ports/cc3200/mpconfigport.h
+++ b/ports/cc3200/mpconfigport.h
@@ -124,6 +124,7 @@
 #define MICROPY_PY_TIME_GMTIME_LOCALTIME_MKTIME     (1)
 #define MICROPY_PY_TIME_TIME_TIME_NS                (1)
 #define MICROPY_PY_TIME_INCLUDEFILE                 "ports/cc3200/mods/modtime.c"
+#define MICROPY_PY_VFS                              (1)
 #define MICROPY_PY_MACHINE                          (1)
 #define MICROPY_PY_MACHINE_INCLUDEFILE              "ports/cc3200/mods/modmachine.c"
 #define MICROPY_PY_MACHINE_BARE_METAL_FUNCS         (1)
diff --git a/py/mpconfig.h b/py/mpconfig.h
index 9a1f04568e..837115ab59 100644
--- a/py/mpconfig.h
+++ b/py/mpconfig.h
@@ -1744,6 +1744,11 @@ typedef double mp_float_t;
 #define MICROPY_PY_SSL_FINALISER (MICROPY_ENABLE_FINALISER)
 #endif
 
+// Whether to provide the "vfs" module
+#ifndef MICROPY_PY_VFS
+#define MICROPY_PY_VFS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES && MICROPY_VFS)
+#endif
+
 #ifndef MICROPY_PY_WEBSOCKET
 #define MICROPY_PY_WEBSOCKET (0)
 #endif
diff --git a/tests/ports/unix/extra_coverage.py.exp b/tests/ports/unix/extra_coverage.py.exp
index 75c7c32df1..3db1c5a63e 100644
--- a/tests/ports/unix/extra_coverage.py.exp
+++ b/tests/ports/unix/extra_coverage.py.exp
@@ -59,7 +59,7 @@ heapq           io              json            machine
 math            os              platform        random
 re              select          socket          struct
 sys             termios         time            tls
-uctypes         websocket
+uctypes         vfs             websocket
 me
 
 micropython     machine         math