alist.account

class alist.account.AlistAccount(**kwargs)

基类：dict

描述Alist账户信息。不同账户需要的信息各不相同。 更详细的信息请参考 AlistAdminDrivers。

class alist.account.AlistAdminAccount(alist, endpoint: str)

基类：object

/api/admin/account API的实现。创建、删除、修改账号。

create_Onedrive(name, zone, internal_type, client_id, client_secret, redirect_uri, refresh_token, proxy=False, webdav_proxy=False, webdav_direct=False, **kwargs)

创建一个Onedrive账号。

参数:

• name -- 账号名字。即虚拟地址。

• zone -- 区域。可以是 global、cn、us 或 de。

• internal_type -- onedrive 或 sharepoint。

• client_id -- client id

• client_secret -- client secret

• redirect_uri -- 重定向URI

• refresh_token -- 刷新token

• proxy -- 是否开启代码。默认为False。

• webdav_proxy -- 默认为False。

• webdav_direct -- 默认为False。

• down_proxy_url -- 可选参数，默认为None。

• extract_folder -- 可选参数，默认为None。可以填 front 或 back。

• site_id -- 可选参数。sharepoint站点ID。默认为None。

• root_folder -- 可选参数。根目录路径。默认为None。

• order_by -- 可选参数。排序依据。默认为None。可以填 name、size 、lastModifiedDateTime。

• order_direction -- 可选参数。排序方向。默认为None。可以填 asc 或 desc。

返回:

创建成功返回True。否则触发异常。

create_Native(name, root_folder, webdav_direct=False, **kwargs)

创建一个本地账号。

client.admin.account.create_Native('/native_tmp', '/tmp')

参数:

• name -- 账号名字。即虚拟地址。

• root_folder -- 根目录路径。

• webdav_direct -- 默认为False。

• down_proxy_url -- 可选参数，默认为None。

• extract_folder -- 可选参数，默认为None。可以填 front 或 back。

• order_by -- 可选参数。排序依据。默认为None。可以填 name、size 、lastModifiedDateTime。

• order_direction -- 可选参数。排序方向。默认为None。可以填 asc 或 desc。

返回:

创建成功返回True。否则触发异常。

create_Alist(name, site_url, access_token, proxy=False, webdav_proxy=False, webdav_direct=False, **kwargs)

创建一个Alist账号

client.admin.account.create_Alist('/another_alist', 'http://alist.xxxx.com', 'xxxxxx')

参数:

• name -- 账号名字。即虚拟地址。

• site_url -- Alist网站的URL。

• access_token -- 访问网站的token。

• proxy -- 是否开启代码。默认为False。

• webdav_proxy -- 默认为False。

• webdav_direct -- 默认为False。

• down_proxy_url -- 可选参数，默认为None。

• extract_folder -- 可选参数，默认为None。可以填 front 或 back。

• root_folder -- 可选参数。根目录路径。

返回:

创建成功返回True。否则触发异常。

delete(name)

删除一个账户。

client.admin.account.delete('/another_alist')

参数:

name -- 账号名字。即虚拟地址。

返回:

删除成功返回True。否则触发异常。

save(account: AlistAccount)

保存修改后的账户。

# 首先获取已有的账号。
account = client.admin.accounts.get_account('/native_tmp')
# 将 root_folder 修改为 /var
account['root_folder'] = '/var'
# 保存
client.admin.account.save(account)

参数:

account -- 修改后的账号。

返回:

修改成功返回True。否则触发异常。

class alist.account.AlistAdminAccounts(alist, endpoint)

基类：object

alist账号列表。获取账号。

accounts = []

get() → list

获取账号列表。

accounts = client.admin.accounts.get()
# or
accounts = client.admin.accounts()

返回:

账号列表。AlistAccount 组成的列表。

get_account(id_or_name) → AlistAccount

根据账号ID或名字获取账号。

参数:

id_or_name -- 账号ID或名字。

返回:

账号。