Skip to content

Latest commit

 

History

History
236 lines (162 loc) · 5.82 KB

jsapi_fsys.md

File metadata and controls

236 lines (162 loc) · 5.82 KB
layout
doc

pyChariot.api.fsys

文件系统，提供文件读写等相关功能。

len2str(length) {#len2str}

将字节数长度转换为人类可读的字符串形式

参数 类型 说明
length number 
await __A.fsys.len2str(1024);

sizeof(filepath) {#sizeof}

获取指定文件或者目录的大小，并以字节数形式返回。

参数 类型 说明
filepath string 文件路径名 
await __A.fsys.sizeof('C:\\Windows\\notepad.exe');
await __A.fsys.sizeof('C:\\Windows');

sizeofInStr(filepath) {#sizeofInStr}

获取指定文件或者目录的大小，并以人类可读的字符串返回。

参数 类型 说明
filepath string 文件路径名 
await __A.fsys.sizeofInStr('C:\\Windows\\notepad.exe');

checksum(filepath) {#checksum}

计算指定文件的校验和

参数 类型 说明
filepath string 文件路径名
返回值 说明
string 校验和 
await __A.fsys.checksum('C:\\Windows\\notepad.exe');

crc32(filepath) {#crc32}

计算指定文件的 CRC32 校验和

参数 类型 说明
filepath string 文件路径名
返回值 说明
string 校验和 
await __A.fsys.crc32('C:\\Windows\\notepad.exe');

isFile(filepath) {#isFile}

指定的文件是否为文件

参数 类型 说明
filepath string 文件路径名
返回值 说明
boolean 
await __A.fsys.crc32('C:\\Windows\\notepad.exe');

isDir(filepath) {#isDir}

指定的文件是否为目录

参数 类型 说明
filepath string 文件路径名
返回值 说明
boolean 
await __A.fsys.isDir('C:\\Windows\\notepad.exe');

read(filepath, charset) {#read}

返回指定文本文件的内容

参数 类型 说明
filepath string 文件路径名
charset string 编码，默认为 utf-8
返回值 说明
string 
await __A.fsys.read('C:\\Windows\\system.ini');

readLines(filepath, charset) {#readLines}

返回指定文本文件的内容

参数 类型 说明
filepath string 文件路径名
charset string 编码，默认为 utf-8
返回值 说明
Array[string] 
await __A.fsys.readLines('C:\\Windows\\system.ini');

write(filepath, content, append, charset) {#write}

写入文本文件，返回写入字节数。

参数 类型 说明
filepath string 文件路径名
content string 文本内容
append boolean 是否追加，默认为 False，即覆盖。
charset string 编码，默认为 utf-8
返回值 说明
number 
await __A.fsys.readLines('C:\\test.txt', 'This is a test file.');

writeLines(filepath, content, append, charset) {#writeLines}

写入文本文件，返回写入字节数。

参数 类型 说明
filepath string 文件路径名
content Array[string] 文本内容列表
append boolean 是否追加，默认为 False，即覆盖。
charset string 编码，默认为 utf-8
返回值 说明
number 
await __A.fsys.writeLines('C:\\test.txt', 'This is a test file.');

touch(filepath) {#touch}

类似于 UNIX “touch” 实用程序的行为

参数 类型 说明
filepath string 文件路径名 
await __A.fsys.touch('C:\\test.txt');

getsep() {#getsep}

获取文件路径的分隔符

返回值 说明
string 
await __A.fsys.getsep();

mkdirs(path, mode) {#mkdirs}

创建目录树

参数 类型 说明
path string 目录路径名
mode number 权限模式，默认为 0o777
返回值 说明
string 
await __A.fsys.mkdirs('C:\\dir1\\dir2\\dir3');

copy(src, dst) {#copy}

将 src 复制到 dst

remove(dst) {#remove}

删除指定目标

move(dst, dst) {#move}

将 src 更名为 dst