主文件

AList

AList的SDK，此为主类。

属性：

名称	类型	描述
endpoint	str	AList地址
headers	Dict[str, Optional[str]]	全局请求头
token	str	JWT Token

__init__(endpoint, proxy=None)

初始化

参数：

名称	类型	描述	默认
endpoint	str	AList地址	必需

add_offline_download(urls, path, tool='SimpleHttp', delete_policy='delete_on_upload_succeed') async

添加离线下载

copy(src, dstDir) async

复制文件

参数：

名称	类型	描述	默认
src	(str, AListFile)	源文件	必需
dstDir	str	要复制到的路径	必需

返回：

类型	描述
bool	是否成功

create_meta(path, password, p_sub, write, w_sub, hide, h_sub, readme, r_sub) async

更新元数据 Args: path (str): 元数据路径 password (Optional[str]): 密码 p_sub (Optional[bool]): 密码是否应用到子文件夹 write (Optional[bool]): 是否开启写入 w_sub (Optional[bool]): 开启写入是否应用到子文件夹 hide (Optional[bool]): 是否隐藏 h_sub (Optional[bool]): 隐藏是否应用到子文件夹 readme (Optional[bool]): 说明 r_sub (Optional[bool]): 说明是否应用到子文件夹

返回：

类型	描述
bool	是否成功

create_storage(mount_path, driver, addition, order=0, remark='', cache_expires=None, web_proxy=False, webdav_policy='native_proxy', down_proxy_url=None, order_by='name', extract_folder=None, order_direction='asc', enable_sign=False) async

创建存储

参数：

名称	类型	描述	默认
mount_path	str	挂载路径	必需
driver	str	驱动	必需
addition	dict	额外参数	必需
order	int	排序. Defaults to 0.	0
remark	str	备注.	''
cache_expires	int	缓存过期时间.	None
web_proxy	bool	是否开启web代理.	False
webdav_policy	str	webdav策略.	'native_proxy'
down_proxy_url	str	下载代理地址.	None
order_by	str	排序字段.	'name'
extract_folder	str	解压文件夹.	None
order_direction	str	排序方向.	'asc'
enable_sign	bool	是否开启签名.	False

返回：

名称	类型	描述
int	int	存储id

create_user(username, password=None, base_path=None, role=None, permission=None, disabled=None, sso_id=None) async

创建用户

参数：

名称	类型	描述	默认
username	str	用户名	必需
password	Optional[str]	密码	None
base_path	Optional[str]	基础路径	None
role	Optional[str]	角色	None
permission	Optional[int]	权限	None
disabled	Optional[bool]	是否禁用	None
sso_id	Optional[str]	SSO ID	None

返回：

类型	描述
bool	是否成功

delete_meta(idx) async

删除元数据

参数：

名称	类型	描述	默认
idx	int	元数据ID	必需

返回：

类型	描述
bool	是否成功

delete_storage(storage_id) async

删除存储

delete_user(idx) async

删除用户

参数：

名称	类型	描述	默认
idx	int	用户ID	必需

返回：

类型	描述
bool	是否成功

delete_user_cache(username) async

删除用户缓存

参数：

名称	类型	描述	默认
username	str	用户名	必需

返回：

类型	描述
bool	是否成功

disable_storage(storage_id) async

禁用存储

enable_storage(storage_id) async

启用存储

get_driver_info(driver_name) async

获取驱动信息

get_meta(idx) async

获取元数据

参数：

名称	类型	描述	默认
idx	int	元数据id	必需

返回：

类型	描述
ToClass	数据

get_storage(storage_id) async

获取存储

参数：

名称	类型	描述	默认
storage_id	str	存储ID	必需

get_user(idx) async

获取用户

参数：

名称	类型	描述	默认
idx	int	用户id	必需

返回：

类型	描述
ToClass	数据

get_users() async

获取用户列表

返回：

类型	描述
ToClass	数据

list_dir(path, page=1, per_page=50, refresh=False, password='') async

列出指定目录下的所有文件或文件夹。

参数：

名称	类型	描述	默认
path	(str, AListFolder)	需要列出的目录	必需
page	int	页数	1
per_page	int	每页的数量	50
refresh	bool	是否强制刷新	False
password	str	目录密码	''

返回：

类型	描述
Generator[ToClass, None, None]	指定目录下的文件

list_driver() async

获取驱动列表

list_driver_names() async

获取驱动名称列表

list_meta(page=None, per_page=None) async

列出元数据

参数：

名称	类型	描述	默认
page	int	页数	None
per_page	int	每页的数量	None

返回：

类型	描述
ToClass	数据

list_my_ssh_keys() async

列出当前用户的 SSH 密钥

list_storages(page=None, per_page=None) async

获取存储列表

login(user, otp_code='') async

登录

参数：

名称	类型	描述	默认
user	AListUser	AList用户	必需
otp_code	str	OTP验证码	''

返回：

类型	描述
bool	是否成功

logout() async

注销登录

mkdir(path) async

创建文件夹

参数：

名称	类型	描述	默认
path	str	要创建的目录	必需

返回：

类型	描述
bool	是否成功

move(src, dstDir) async

移动文件

参数：

名称	类型	描述	默认
src	(str, AListFile)	源文件	必需
dstDir	str	要移动到的路径	必需

返回：

类型	描述
bool	是否成功

open(path, password='') async

打开文件/文件夹

参数：

名称	类型	描述	默认
path	(str, AListFolder, AListFile)	路径	必需
password	str	密码	''

返回：

类型	描述
AListFolder	AList目录对象
AListFile	AList文件对象

recursive_move(src, dstDir) async

递归移动文件夹

reload_storage() async

重载存储

remove(path) async

删除

参数：

名称	类型	描述	默认
path	(str, AListFile)	要删除的文件	必需

返回：

类型	描述
bool	是否成功

remove_folder(path) async

删除文件夹(需为空)

参数：

名称	类型	描述	默认
path	(str, AListFolder)	文件夹路径	必需

返回：

类型	描述
bool	是否成功

rename(src, dst) async

重命名

参数：

名称	类型	描述	默认
src	(str, AListFolder, AListFile)	原名	必需
dst	str	要更改的名字	必需

返回：

类型	描述
bool	是否成功

rename_batch(src_dir, src, dst) async

批量重命名

rename_regex(src_dir, src_name_regex, dst_name_regex) async

正则重命名

site_config() async

获取公开站点配置

返回：

类型	描述
ToClass	配置

test() async

测试服务器可用性

返回：

类型	描述
bool	是否可用

to_sync()

转换为同步对象"

update_meta(path, password, p_sub, write, w_sub, hide, h_sub, readme, r_sub) async

更新元数据 Args: path (str): 元数据路径 password (Optional[str]): 密码 p_sub (Optional[bool]): 密码是否应用到子文件夹 write (Optional[bool]): 是否开启写入 w_sub (Optional[bool]): 开启写入是否应用到子文件夹 hide (Optional[bool]): 是否隐藏 h_sub (Optional[bool]): 隐藏是否应用到子文件夹 readme (Optional[bool]): 说明 r_sub (Optional[bool]): 说明是否应用到子文件夹

返回：

类型	描述
bool	是否成功

update_storage(mount_path=None, driver=None, addition=None, order=0, remark='', cache_expires=None, web_proxy=False, webdav_policy='native_proxy', down_proxy_url=None, order_by='name', extract_folder=None, order_direction='asc', enable_sign=False) async

更新存储

参数：

名称	类型	描述	默认
mount_path	str	挂载路径	None
driver	str	驱动	None
addition	dict	额外参数	None
order	int	排序. Defaults to 0.	0
remark	str	备注.	''
cache_expires	int	缓存过期时间.	None
web_proxy	bool	是否开启web代理.	False
webdav_policy	str	webdav策略.	'native_proxy'
down_proxy_url	str	下载代理地址.	None
order_by	str	排序字段.	'name'
extract_folder	str	解压文件夹.	None
order_direction	str	排序方向.	'asc'
enable_sign	bool	是否开启签名.	False

返回：

名称	类型	描述
int	int	存储id

update_user(idx, username, password=None, base_path=None, role=None, permission=None, disabled=None, sso_id=None) async

更新用户

参数：

名称	类型	描述	默认
idx	int	用户ID	必需
username	str	用户名	必需
password	Optional[str]	密码	None
base_path	Optional[str]	基础路径	None
role	Optional[str]	角色	None
permission	Optional[int]	权限	None
disabled	Optional[bool]	是否禁用	None
sso_id	Optional[str]	SSO ID	None

返回：

类型	描述
bool	是否成功

upload(path, local) async

上传文件

参数：

名称	类型	描述	默认
path	(str, AListFile)	上传的路径	必需
local	(str, bytes, BinaryIO)	本地路径或字节数据或文件指针	必需

返回：

类型	描述
bool	是否成功

user_info() async

获取当前登录的用户的信息

返回：

类型	描述
ToClass	一个字典，包含了当前用户的信息。