昇腾社区首页
中文
注册

rename接口

接口功能

重命名MemFS中处于同一父目录中的文件或文件夹,不会重命名后端存储中的文件或文件夹。

接口格式

mindio_acp.rename(src, dst, option='no_replace')

接口参数

参数

是否必选

说明

取值要求

src

必选

重命名的源路径或源文件,源路径或源文件必须存在。

有效路径或文件,src与dst需处于同一父目录中。

dst

必选

重命名的目标路径或目标文件。

  • 重命名方式为no_replace时,目标路径或目标文件不能存在。
  • 重命名方式为exchange时,目标路径或目标文件必须存在。
  • 其他情况下,目标路径或目标文件可以存在。

有效路径或文件,src与dst需处于同一父目录中。

option

可选

重命名方式,默认值为no_replace,具体方式如下:

  • zero:

    当目标路径不存在时,命名成功;若源与目标均为文件,目标文件将被源文件覆盖;若源与目标都是文件夹,且目标文件夹为空,则文件夹将被覆盖,否则返回错误;若源与目标路径或文件都存在但类型不同,则返回错误。

  • no_replace:

    与zero相同,但是目标路径或目标文件存在时,会返回错误。

  • exchange:

    交换源和目标路径或文件,源和目标路径或文件必须都存在且类型必须相同,否则返回错误。

  • force:

    与zero相同,但是目标路径或目标文件存在时,会用源覆盖。

  • zero
  • no_replace
  • exchange
  • force

使用样例

>>> # rename file or directory in memfs
>>> mindio_acp.rename('/mnt/dpc01/checkpoint/checkpoint-last-tmp', '/mnt/dpc01/checkpoint/checkpoint-last', option='no_replace')

返回值

  • 0:重命名成功。
  • 1:重命名失败,目标路径已存在。
  • 2:重命名失败,源路径不存在。
  • 3:其他错误。