diff options
| -rw-r--r-- | docs/library/os.rst | 4 | ||||
| -rw-r--r-- | stmhal/moduos.c | 17 | ||||
| -rw-r--r-- | stmhal/qstrdefsport.h | 1 |
3 files changed, 22 insertions, 0 deletions
diff --git a/docs/library/os.rst b/docs/library/os.rst index df5ade3277..e9b7d40bf5 100644 --- a/docs/library/os.rst +++ b/docs/library/os.rst @@ -46,6 +46,10 @@ Functions Remove a directory. +.. function:: rename(old_path, new_path) + + Rename a file. + .. function:: stat(path) Get the status of a file or directory. diff --git a/stmhal/moduos.c b/stmhal/moduos.c index 9d6856b3e1..24f2e0f1f2 100644 --- a/stmhal/moduos.c +++ b/stmhal/moduos.c @@ -239,6 +239,22 @@ STATIC mp_obj_t os_remove(mp_obj_t path_o) { } STATIC MP_DEFINE_CONST_FUN_OBJ_1(os_remove_obj, os_remove); +/// \function rename(old_path, new_path) +/// Rename a file +STATIC mp_obj_t os_rename(mp_obj_t path_in, mp_obj_t path_out) { + const char *old_path = mp_obj_str_get_str(path_in); + const char *new_path = mp_obj_str_get_str(path_out); + FRESULT res = f_rename(old_path, new_path); + switch (res) { + case FR_OK: + return mp_const_none; + default: + nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError, "Error renaming file '%s' to '%s'", old_path, new_path)); + } + +} +STATIC MP_DEFINE_CONST_FUN_OBJ_2(os_rename_obj, os_rename); + /// \function rmdir(path) /// Remove a directory. STATIC mp_obj_t os_rmdir(mp_obj_t path_o) { @@ -368,6 +384,7 @@ STATIC const mp_map_elem_t os_module_globals_table[] = { { MP_OBJ_NEW_QSTR(MP_QSTR_listdir), (mp_obj_t)&os_listdir_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_mkdir), (mp_obj_t)&os_mkdir_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_remove), (mp_obj_t)&os_remove_obj }, + { MP_OBJ_NEW_QSTR(MP_QSTR_rename),(mp_obj_t)&os_rename_obj}, { MP_OBJ_NEW_QSTR(MP_QSTR_rmdir), (mp_obj_t)&os_rmdir_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_stat), (mp_obj_t)&os_stat_obj }, { MP_OBJ_NEW_QSTR(MP_QSTR_unlink), (mp_obj_t)&os_remove_obj }, // unlink aliases to remove diff --git a/stmhal/qstrdefsport.h b/stmhal/qstrdefsport.h index a8b52f346a..c42ca734ba 100644 --- a/stmhal/qstrdefsport.h +++ b/stmhal/qstrdefsport.h @@ -379,6 +379,7 @@ Q(chdir) Q(getcwd) Q(listdir) Q(mkdir) +Q(rename) Q(remove) Q(rmdir) Q(unlink) |