115wangpan Documentation¶

115 Wangpan¶

115 Wangpan (115网盘 or 115云) is an unofficial Python API and SDK for 115.com. Supported Python verisons are 2.6, 2.7, 3.3, 3.4.

Documentation: http://115wangpan.readthedocs.org
GitHub: https://github.com/shichao-an/115wangpan
PyPI: https://pypi.python.org/pypi/115wangpan/

Features¶

Authentication
Persistent session
Tasks management: BitTorrent and links
Files management: uploading, downloading, searching, and editing

Installation¶

libcurl is required. Install dependencies before installing the python package:

Ubuntu:

$ sudo apt-get install build-essential libcurl4-openssl-dev python-dev

Fedora:

$ sudo yum groupinstall "Development Tools"
$ sudo yum install libcurl libcurl-devel python-devel

Then, you can install with pip:

$ pip install 115wangpan

Or, if you want to install the latest from GitHub:

$ pip install git+https://github.com/shichao-an/115wangpan

Usage¶

>>> import u115
>>> api = u115.API()
>>> api.login('username@example.com', 'password')
True
>>> tasks = api.get_tasks()
>>> task = tasks[0]
>>> print task.name
咲-Saki- 阿知賀編 episode of side-A
>>> print task.status_human
TRANSFERRED
>>> print task.size_human
1.6 GiB
>>> files = task.list()
>>> files
[<File: 第8局 修行.mkv>]
>>> f = files[0]
>>> f.url
u'http://cdnuni.115.com/some-very-long-url.mkv'
>>> f.directory
<Directory: 咲-Saki- 阿知賀編 episode of side-A>
>>> f.directory.parent
<Directory: 离线下载>

CLI commands¶

115 down: for downloading files
115 up: for creating tasks from torrents and links

Contents¶

Tutorial¶

Login and credential file¶

To login with your account, simply call u115.API.login with username and password as argument.

>>> from u115 import API
>>> api = API()
>>> api.login('username@example.com', 'password')
True

You can also put username and password in the file ~/.115 as credentials with the following format:

[default]
username = username@example.com
password = defaultpassword

[another]
username = another@example.com
password = anotherpassword

Then, you can login without providing username and password, only specifying the section name (defaults to default).

>>> api.login(section='another')
True

To check whether API has logged:

>>> api.has_logged_in
True

Cookies¶

You can enable cookies to make a persistent session by providing persistent (True) and cookies_filename arguments.

>>> from u115 import API
>>> api = API(persistent=True, cookies_filename='cookies.txt')
>>> api.has_logged_in
False
>>> api.login(section='default')
>>> api.has_logged_in
True
>>> api.save_cookies()
>>> exit()
# Invoke Python interpreter again
>>> from u115 import API
>>> api = API(persistent=True, cookies_filename='cookies.txt')
>>> api.has_logged_in  # Already logged in using cookies
True

You can also save cookies or load cookies explicitly.

>>> from u115 import API
>>> api = API()
>>> api.login()
True
# Do something ...
>>> api.save_cookies()
>>> exit()
# Now invoke Python interpreter again
>>> from u115 import API
>>> api = API()
>>> api.load_cookies()
>>> api.has_logged_in
True

Getting tasks¶

You can retrieve tasks using u115.API.get_tasks(). This function takes an optional argument, count, which defaults to 30. You can specify a smaller or larger integer value:

>>> tasks = api.get_tasks(60)
>>> tasks
[<Task: TVアニメ「ローゼンメイデン」オリジナルサウンドトラック (320K+BK)>, <Task: Sword Art Online II - 10.mkv>, <Task: 咲-Saki- 阿知賀編 episode of side-A>]

To get count of total number of existing tasks and quota for this month:

>>> api.task_count
3
>>> api.task_quota
27

To get the information of a specific task:

>>> task = tasks[1]
>>> task.add_time
datetime.datetime(2014, 9, 6, 23, 48, 58)
>>> task.status_human
'TRANSFERRED'

Normally, if it is a BitTorrent task and has been transferred, it has an associated directory which contains “lixian” (offline) files:

>>> task.is_directory
True
>>> task.is_transferred
True
>>> task.directory
<Directory: Sword Art Online II - 10.mkv>
>>> task.list() # or task.directory.list()
[<File: Sword Art Online II - 10.mkv>]

Creating BitTorrent tasks¶

You can upload a torrent and create a task on the fly:

>>> api.add_task_bt('~/downloads/Black_Bullet_OP.torrent')
True
>>> api.get_tasks()
[<Task: Black Bullet OP>, <Task: TVアニメ「ローゼンメイデン」オリジナルサウンドトラック (320K+BK)>, ...]

Or you can edit the torrent and select files before submitting:

>>> u = api.add_task_bt('~/downloads/Black_Bullet_OP.torrent', select=True)
>>> files = u.files
[<TorrentFile: [*] black bullet.mp4>, <TorrentFile: [*] black bullet [commentary].mp4>, ...]
>>> files[0].unselect()
>>> files
[<TorrentFile: [ ] black bullet.mp4>, <TorrentFile: [*] black bullet [commentary].mp4>, ...]
>>> u.submit()

Creating URL tasks¶

You can create URL (link) tasks. HTTP, HTTPS, FTP, Magnet, and eD2k links are supported.

>>> api.add_task_url('http://example.com/file.txt')
>>> api.add_task_url('magnet:?xt.1=urn:sha1:YNCKHT.2=urn:sha1:TXGCZQT')

System directories¶

The account has its offline space that stores files transferred from tasks or uploaded by users. The root directory has access to all available files.

>>> api.root_directory
<Directory: 文件>
>>> api.root_directory.list()
[<Directory: 我的接收>]
>>> api.receiver_directory
<Directory: 我的接收>

After your tasks are transferred, the files go to the downloads directory (u115.API.downloads_directory). Its parent directory is the receiver directory (u115.API.receiver_directory)

>>> api.downloads_directory
<Directory: 离线下载>

If you have created BitTorrent tasks by uploading torrents, you will have a torrents directory (u115.API.torrents_directory), which holds uploaded torrent files.

>>> api.torrents_directory
<Directory: 种子文件>

Directory and files¶

You can list contents of a directory using list() method of a Directory.

>>> entries = api.downloads_directory.list()
>>> d = entries[0]
>>> d_entries = d.list()
>>> d_entries
[<Directory: BK>, <Directory: MP3>, <File: Cover.jpg>
>>> dd_entries = d_entries[0].list()
>>> dd_entries.list()
[<File: IMG_0003.jpg>, <File: IMG_0004.jpg>, <File: IMG_0005.jpg>, <File: IMG_0006.jpg>]

To get number of entries in a directory:

>>> d.count
45

The default behavior is to list 30 entries. You can list specified number of entries, either with or without count. The following two are equivalent:

>>> d.list(100)
>>> d.list(count=100)

List all files by passing count of itself:

>>> d.list(d.count)

There are other arguments that can be passed to list(), e.g. order (order of entries, which can be user_ptime (default), file_size and file_name), asc (whether in ascending order), show_dir (whether to show directories). For full list of arguments, see u115.Directory.list().

# List 100 smallest files
>>> d.list(count=100, order='file_size', asc=True)
# Do not include directories
>>> d.list(show_dir=False)

A directory has a parent directory, which can be accessed via parent attribute:

>>> d.parent
<Directory: 离线下载>
>>> d.parent.parent
<Directory: 我的接收>
# root directory has no parent
>>> d.root_directory.parent
# None

Delete the file or directory:

>>> f = d.list()[0]
>>> f.delete()
True
>>> f.is_deleted
True

Search directories and files¶

You can search directories and files by passing the keyword to u115.API.search():

>>> api.search('manga')
[<Directory: [WOLF][Mangaka-san][01-12+OVA01-06][GB][720P][END]>, <File: [WOLF][Mangaka-san][01][GB][720P].mp4>, ...]

By default, the search result limits to 30 items. To get more result, pass count to the methods:

>>> api.search('.mp4', count=100)

Download files¶

For offline files, you can retrieve download links:

>>> f = dd_entries.list()[0]
>>> f
<File: video.mov>
>>> f.url
u'http://cdnuni.115.com/very-long-name.mov'
>>> f.download()
         1%   14.3 MiB     437.3 KiB/s         0:53:45 ETA

There are also extra options for download(). The default behavior is downloading the file to the current working directory, resuming download progress if the file already exists (with the same path), and automatically retrying upon closed transfer until the file’s download is finished.

# Download to path ~/Downloads
>>> f.download(path='~/Downloads')
# Do not show progres
>>> f.download(show_progress=False)
# Override existing file without resuming downloads
>>> f.download(resume=False)

Upload files¶

You can upload files to any offline directory (defaults to downloads_directory):

>>> p = api.downloads_directory.parent
>>> p
<Directory: 我的接收>
>>> u = api.upload('/path/to/photo.jpg', directory=p)
>>> u
<File: photo.jpg>

The file you upload can be a torrent file, which you can open later and create a task from it:

>>> u = api.upload('/path/to/movie.torrent')
>>> u.is_torrent
True
>>> t = u.open_torrent()
>>> t.submit()

Moving files and directories¶

You can move files and directories within your offline space:

>>> files = api.downloads_directory.list()
>>> files
[<File: photo.jpg>, <Directory: album>]
>>> photo, album = files[0], files[1]
>>> photo
<File: photo.jpg>
>>> album
<Directory: album>
>>> photo.move(album)
>>> photo.directory
<Directory: album>
>>> album.list()
[<File: photo.jpg>]

Creating directories¶

You can create directories within your offline space:

>>> api.downloads_directory.list()
[<File: photo.jpg>]
>>> api.downloads_directory.mkdir('New Dir')
>>> api.downloads_directory.list()
[<Directory: New Dir>, <File: photo.jpg>]

Renaming files and diretories¶

You can rename files and directories:

>>> f1
<File: photo.jpg>
>>> f1.edit('good.jpg')
>>> f1
<File: good.jpg>

Account and storage info¶

You can get user info:

>>> api.user_id
u'123456789'
>>> api.username
u'yourname@exmaple.com'
>>> api.get_user_info()
{u'state': True, u'data': ...}

You can have an overview of your storage information:

>>> api.get_storage_info(human=True)
{u'total': '152.3 GiB', u'used': '3.6 GiB'}

CLI Commands¶

115 is the CLI command that comes with this package. There are two sub-commands:

115 down: for downloading files
115 up: for creating tasks from torrents and links

115¶

115 mainly handles authentication and getting account information. The default action is to attempt to authenticate the API through one of ways discussed later.

Authentication¶

115 needs to be authenticated every time it is invoked. You can pass username to -u option, and you will be prompted for password without echoing. Note that if cookies is enabled (discussed in the next section), it will bypass any specified username (-u yourname) or section (-d section) and use the cookies instead.

$ 115 -u yourname
Password:

If you don’t want to be prompted for password every time, set the credential file and section. If the section is other than default, you specify the section name with -d:

$ 115 -d section_name

Using cookies¶

You can use cookies to enable persistent session. The cookies file is ~/.115cookies. If this file exists, 115 down and 115 up will automatically use cookies. Otherwise, you have to save the cookies first using the -c option:

$ 115 -d section_name -c
Cookies is saved.
$ 115 down -t
API has logged in from cookies.
...

If using the default section (default), -d can be omitted:

$ 115 -c
Cookies is saved.

If you do not want to use cookies any more, simply remove the ~/.115cookies file.

Account information¶

-i option can be used to print account information:

$ 115 -i
Username: yourname@example.com
User ID: 1234567
Used storage: 1.0 GiB
Total storage: 30 TiB
Task count: 10
Task quota: 1000

Debug mode¶

-D can enable debug by setting the effective log level to DEBUG:

$ 115 -D -i
DEBUG:API:_debug:
   TYPE: Response
   FUNC: has_logged_in
  STATE: False
CONTENT: {'state': False, 'message': ''}

API has logged in from cookies.
DEBUG:API:_debug:
  TYPE: Request
  FUNC: _req_get_storage_info
   URL: http://115.com
METHOD: GET
PARAMS: {'ac': 'get_storage_info', '_': '12345678', 'ct': 'ajax'}
...

Print help¶

You can print a comprehensive help message using the -h option:

$ 115 -h

115 down¶

115 down is for listing tasks and downloading files and directories in the default downloads directory (u115.API.downloads_directory/.

Listing tasks¶

Use -t to list task. The result output will contain a list of numbered tasks, each with status, size and name. The tasks are reversely ordered by creation time.

$ 115 down -t
1 [TRANSFERRED] [3.2 GiB] <Task: [Airota&DHR&Mony][Jinrui wa Suitai Shimashita][1280x720]>
2 [TRANSFERRED] [3.7 GiB] <Task: [CASO][Kill_Me_Baby][01-13][GB_BIG5][1280x720][x264_AAC]>
3 [TRANSFERRED] [38.1 GiB] <Task: Shinryaku Ika Musume>
...

Downloading files¶

The default behavior of 115 down is to list entries (defaults to 30 entries) in the default downloads directory.

$ 115 down
1 <Directory: [AirotaDHRMony][Jinrui wa Suitai Shimashita][1280x720]>
2 <Directory: [CASO][Kill_Me_Baby][01-13][GB_BIG5][1280x720][x264_AAC]>
3 <Directory: Shinryaku Ika Musume>
4 <Directory: [Kamigami] Psycho-Pass 01-22 [1280x720 x264 AAC Sub(Chi,Jap)]>
...

To list more entries than default, pass a number to the -n option:

$ 115 down -n 60

To further list contents in a numbered entry:

$ 115 down 1
<Directory: [AirotaDHRMony][Jinrui wa Suitai Shimashita][1280x720]> (13 out of 13)
     1 [291.2 MiB] <File: [Airota&amp;DHR&amp;Mony][Jinrui wa Suitai Shimashita][01][1280x720][x264_AAC].mp4>
     2 [277.5 MiB] <File: [Airota&amp;DHR&amp;Mony][Jinrui wa Suitai Shimashita][02][1280x720][x264_AAC].mp4>
     ...

To download all items of the specified entry, pass star (*) as the second arguments after the entry number.

$ 115 down 1 \*
$ 115 down 1 '*'

To download only one, or a range of items of the specified entry, use a number or range of numbers, like in the following examples.

Download the first item:

$ 115 down 1 1

Download item 2 and 4:

$ 115 down 1 2,4

Download items 1 to 8:

$ 115 down 1 1-8

Download a combination of items:

$ 115 down 1 1,3-4,6,9-12

The default downloading behavior is keeping the directory structure. If you want to flatten the directory, pass the -f switch. This will download everything of this entry into the current working directory without creating any directories:

$ 115 down -f 1 `*`

If you want to print the files to be downloaded instead of really downloading them, use -s option to make a dry run.

$ 115 down -s 1 \*

115 up¶

You can create either BitTorrent or URL tasks using 115 up.

To create a BitTorrent task, pass the torrent path to -t. If the task is succesfully created, its name and status will be printed.

$ 115 up -t ~/torrents/Mangaka-san.torrent
Task is successfully created.
[WOLF][Mangaka-san][01-12+OVA01-06][GB][720P][END] BEING TRANSFERRED

To create a URL pass, pass the link to -l:

$ 115 up -l 'magnet:?xt=urn:btih...announce'
Task is successfully created.
[WOLF][Mangaka-san][01-12+OVA01-06][GB][720P][END] BEING TRANSFERRED

API Reference¶

Main interface¶

class u115.API(persistent=True, cookies_filename=None, cookies_type='LWPCookieJar')¶

Request and response interface

Variables:	http – `RequestHandler` object associated with this interface num_tasks_per_page (int) – default number of tasks per page/request web_api_url (str) – files API url aps_natsort_url (str) – natural sort files API url proapi_url (str) – pro API url for downloads

__init__(persistent=True, cookies_filename=None, cookies_type='LWPCookieJar')¶

Parameters:

auto_logout (bool) –
whether to logout automatically when API object is destroyed

Deprecated since version 0.6.0: Call API.logout() explicitly
persistent (bool) – whether to use persistent session that stores cookies on disk
cookies_filename (str) – path to the cookies file, use default path (~/.115cookies) if None
cookies_type (str) – a string representing cookielib.FileCookieJar subclass, LWPCookieJar (default) or MozillaCookieJar

add_task_bt(filename, select=False)¶

Add a new BT task

Parameters:	filename (str) – path to torrent file to upload select (bool) – whether to select files in the torrent. True: it returns the opened torrent (`Torrent`) and can then iterate files in `Torrent.files` and select/unselect them before calling `Torrent.submit()` False: it will submit the torrent with default selected files

add_task_url(target_url)¶

Add a new URL task

Parameters:	target_url (str) – the URL of the file that to be downloaded

add_task_urls(*target_urls)¶

aps_natsort_url = 'http://aps.115.com/natsort/files.php'¶

cookies¶: Cookies of the current API session (cookies getter shortcut)

download(obj, path=None, show_progress=True, resume=True, auto_retry=True, proapi=False)¶

Download a file

Parameters:	obj – `File` object path (str) – local path show_progress (bool) – whether to show download progress resume (bool) – whether to resume on unfinished downloads identified by filename auto_retry (bool) – whether to retry automatically upon closed transfer until the file’s download is finished proapi (bool) – whether to use pro API

downloads_directory¶: Default directory for downloaded files

edit(entry, name, mark=False)¶

Edit an entry (file or directory)

Parameters:	entry – `BaseFile` object name (str) – new name for the entry mark (bool) – whether to bookmark the entry

get_storage_info(human=False)¶

Get storage info

Parameters:	human (bool) – whether return human-readable size
Returns:	total and used storage
Return type:	dict

get_tasks(count=30)¶

Get count number of tasks

Parameters:	count (int) – number of tasks to get
Returns:	a list of `Task` objects

get_user_info()¶

Get user info

Returns:	a dictionary of user information
Return type:	dict

has_logged_in¶: Check whether the API has logged in

iter_search(keyword, count=115)¶

load_cookies(ignore_discard=True, ignore_expires=True)¶: Load cookies from the file API.cookies_filename

login(username=None, password=None, section='default')¶: TODO: implement login methods.

logout()¶: Log out

mkdir(parent, name)¶

Create a directory

Parameters:	parent – the parent directory name (str) – the name of the new directory
Returns:	the new directory
Return type:	`Directory`

move(entries, directory)¶

Move one or more entries (file or directory) to the destination directory

Parameters:	entries (list) – a list of source entries (`BaseFile` object) directory – destination directory
Returns:	whether the action is successful
Raise:	`APIError` if something bad happened

num_tasks_per_page = 30¶

proapi_url = 'http://proapi.115.com/app/chrome/down'¶

receiver_directory¶: Parent directory of the downloads directory

referer_url = 'http://115.com'¶

root_directory¶: Root directory

save_cookies(ignore_discard=True, ignore_expires=True)¶: Save cookies to the file API.cookies_filename

search(keyword, count=115)¶

Search files or directories

Parameters:	keyword (str) – keyword count (int) – number of entries to be listed

task_count¶: Number of tasks created

task_quota¶: Task quota (monthly)

torrents_directory¶: Default directory that stores uploaded torrents

upload(filename, directory=None)¶

Upload a file filename to directory

Parameters:	filename (str) – path to the file to upload directory – destionation `Directory`, defaults to :attribute:`.API.downloads_directory` if None
Returns:	the uploaded file
Return type:	`File`

user_id¶: User id of the current API user

username¶: Username of the current API user

web_api_url = 'http://web.api.115.com/files'¶

Request and response¶

class u115.RequestHandler¶

Request handler that maintains session

Variables:	session – underlying `requests.Session` instance

get(url, params=None)¶: Initiate a GET request

post(url, data, params=None)¶: Initiate a POST request

send(request, expect_json=True, ignore_content=False)¶

Send a formatted API request

Parameters:	request (`Request`) – a formatted request object expect_json (bool) – if True, raise `InvalidAPIAccess` if response is not in JSON format ignore_content (bool) – whether to ignore setting content of the Response object

class u115.Request(url, method='GET', params=None, data=None, files=None, headers=None)¶

Formatted API request class

__init__(url, method='GET', params=None, data=None, files=None, headers=None)¶

Create a Request object

Parameters:	url (str) – URL method (str) – request method params (dict) – request parameters data (dict) – form data files (dict) – mulitpart form data headers (dict) – custom request headers

class u115.Response(state, content)¶

Formatted API response class

Variables:	state (bool) – whether API access is successful content (dict) – result content

Cookies¶

class u115.RequestsLWPCookieJar(filename=None, delayload=False, policy=None)¶: requests.cookies.RequestsCookieJar compatible cookielib.LWPCookieJar

class u115.RequestsMozillaCookieJar(filename=None, delayload=False, policy=None)¶: requests.cookies.RequestsCookieJar compatible cookielib.MozillaCookieJar

Authentication¶

Task and file components¶

class u115.Task(api, add_time, file_id, info_hash, last_update, left_time, move, name, peers, percent_done, rate_download, size, status, cid, pid, url, *args, **kwargs)¶

BitTorrent or URL task

Variables:

add_time (datetime.datetime) – added time
cid (str) – associated directory id, if any. For a directory task ( e.g. BT task), this is its associated directory’s cid. For a file task (e.g. HTTP url task), this is the cid of the downloads directory. This value may be None if the task is failed and has no corresponding directory
file_id (str) – equivalent to cid of Directory. This value may be None if the task is failed and has no corresponding directory
info_hash (str) – hashed value
last_update (datetime.datetime) – last updated time
left_time (int) – left time ()
move (int) –
moving state
- 0: not transferred
- 1: transferred
- 2: partially transferred
name (str) – name of this task
peers (int) – number of peers
percent_done (int) – <=100, originally named percentDone
rate_download (int) – download rate (B/s), originally named rateDownload
size (int) – size of task
size_human (str) – human-readable size
status (int) –
status code
- -1: failed
- 1: downloading
- 2: downloaded
- 4: searching resources

count¶: Number of entries in the associated directory

delete()¶

Delete task (does not influence its corresponding directory)

Returns:	whether deletion is successful
Raise:	`TaskError` if the task is already deleted

directory¶: Associated directory, if any, with this task

is_bt¶: Alias of is_directory

is_deleted¶

Returns:	whether this task is deleted
Return type:	bool

is_directory¶

Returns:	whether this task is associated with a directory.
Return type:	bool

is_transferred¶

Returns:	whether this tasks has been transferred
Return type:	bool

list(count=115, order='user_ptime', asc=False, show_dir=True, natsort=True)¶

List files of the associated directory to this task.

Parameters:	count (int) – number of entries to be listed order (str) – originally named o asc (bool) – whether in ascending order show_dir (bool) – whether to show directories

parent¶: Parent directory of the associated directory

status_human¶

Human readable status

Returns:	DOWNLOADING: the task is downloading files BEING TRANSFERRED: the task is being transferred TRANSFERRED: the task has been transferred to downloads directory SEARCHING RESOURCES: the task is searching resources FAILED: the task is failed DELETED: the task is deleted UNKNOWN STATUS
Return type:	str

class u115.Torrent(api, name, size, info_hash, file_count, files=None, *args, **kwargs)¶

Opened torrent before becoming a task

Variables:	api – associated API object name (str) – task name, originally named torrent_name size (int) – task size, originally named torrent_size info_hash (str) – hashed value file_count (int) – number of files included files (list) – files included (list of `TorrentFile`), originally named torrent_filelist_web

selected_files¶: List of selected TorrentFile objects of this torrent

submit()¶: Submit this torrent and create a new task

unselected_files¶: List of unselected TorrentFile objects of this torrent

class u115.TorrentFile(torrent, path, size, selected, *args, **kwargs)¶

File in the torrent file list

Parameters:	torrent (`Torrent`) – the torrent that holds this file path (str) – file path in the torrent size (int) – file size selected (bool) – whether this file is selected

select()¶: Select this file

unselect()¶: Unselect this file

class u115.File(api, fid, cid, name, size, file_type, sha, date_created, thumbnail, pickcode, *args, **kwargs)¶

File in a directory

Variables:

fid (int) – file id
cid (str) – cid of the current directory
size (int) – size in bytes
size_human (str) – human-readable size
file_type (str) – originally named ico
sha (str) – SHA1 hash
date_created (datetime.datetime) – in “%Y-%m-%d %H:%M:%S” format, originally named t
thumbnail (str) – thumbnail URL, originally named u
pickcode (str) – originally named pc

delete()¶

Delete this file or directory

Returns:	whether deletion is successful
Raise:	`APIError` if this file or directory is already deleted

directory¶: Directory that holds this file

download(path=None, show_progress=True, resume=True, auto_retry=True, proapi=False)¶: Download this file

edit(name, mark=False)¶

Edit this file or directory

Parameters:	name (str) – new name for this entry mark (bool) – whether to bookmark this entry

get_download_url(proapi=False)¶

Get this file’s download URL

Parameters:	proapi (bool) – whether to use pro API

is_deleted¶: Whether this file or directory is deleted

is_torrent¶: Whether the file is a torrent

is_video¶: Whether the file is a video type

move(directory)¶

Move this file or directory to the destination directory

Parameters:	directory – destination directory
Returns:	whether the action is successful
Raise:	`APIError` if something bad happened

open_torrent()¶

Open the torrent (if it is a torrent)

Returns:	opened torrent
Return type:	`Torrent`

play()¶: Open play_url in local browser

play_url¶: Get the url for playing video.

reload()¶

Reload file info and metadata

name
sha
pickcode

rename(funcOrStr)¶

Rename this file or directory

Parameters:	func – str or callable function that takes original name as parameter

url¶: Alias for File.get_download_url() with proapi=False

class u115.Directory(api, cid, name, pid, count=-1, date_created=None, pickcode=None, is_root=False, *args, **kwargs)¶

Variables:	cid (str) – cid of this directory pid (str) – represents the parent directory it belongs to count (int) – number of entries in this directory date_created (datetime.datetime) – integer, originally named t pickcode (str) – string, originally named pc

all_files()¶: Get all files in current directory and all sub-directories

all_videos()¶: Get all videos in current directory and all sub-directories

count¶: Number of entries in this directory

cur_dirs()¶: Get all directories in current directory

cur_files()¶: Get all files in current directory

cur_videos()¶: Get all videos in current directory

delete()¶

Delete this file or directory

Returns:	whether deletion is successful
Raise:	`APIError` if this file or directory is already deleted

edit(name, mark=False)¶

Edit this file or directory

Parameters:	name (str) – new name for this entry mark (bool) – whether to bookmark this entry

find_file(name='', regex=None)¶

find_files(name='', regex=None)¶

is_deleted¶: Whether this file or directory is deleted

is_root¶: Whether this directory is the root directory

iter_all_files()¶: Get all files in current directory and all sub-directories by generator

iter_all_videos()¶: Get all videos in current directory and all sub-directories by generator

iter_cur_dirs()¶: Get all directories in current directory by generator

iter_cur_files()¶: Get all files in current directory by generator

iter_cur_videos()¶: Get all videos in current directory by generator

iter_find_files(name='', regex=None)¶

iter_list(count=115, order='user_ptime', asc=False, show_dir=True, natsort=True)¶

List directory contents by generator

Parameters:	count (int) – number of entries to be listed order (str) – order of entries, originally named o. This value may be one of user_ptime (default), file_size and file_name asc (bool) – whether in ascending order show_dir (bool) – whether to show directories natsort (bool) – whether to use natural sort

Return a generator of File or Directory objects

list(count=115, order='user_ptime', asc=False, show_dir=True, natsort=True)¶

List directory contents

Parameters:	count (int) – number of entries to be listed order (str) – order of entries, originally named o. This value may be one of user_ptime (default), file_size and file_name asc (bool) – whether in ascending order show_dir (bool) – whether to show directories natsort (bool) – whether to use natural sort

Return a list of File or Directory objects

max_entries_per_load = 115¶

mkdir(name)¶: Create a new directory in this directory

move(directory)¶

Move this file or directory to the destination directory

Parameters:	directory – destination directory
Returns:	whether the action is successful
Raise:	`APIError` if something bad happened

parent¶: Parent directory that holds this directory

reload()¶

Reload directory info and metadata

name
pid
count

Exceptions¶

class u115.APIError(*args, **kwargs)¶: General error related to API

class u115.TaskError(*args, **kwargs)¶: Task has unstable status or no directory operation

class u115.AuthenticationError(*args, **kwargs)¶: Authentication error

class u115.InvalidAPIAccess(*args, **kwargs)¶: Invalid and forbidden API access

class u115.RequestFailure(*args, **kwargs)¶: Request failure

class u115.JobError(*args, **kwargs)¶: Job running error (request multiple similar jobs simultaneously)

115wangpan Documentation¶

115 Wangpan¶

Features¶

Installation¶

Usage¶

CLI commands¶

Contents¶

Tutorial¶

Login and credential file¶

Cookies¶

Getting tasks¶

Creating BitTorrent tasks¶

Creating URL tasks¶

System directories¶

Directory and files¶

Search directories and files¶

Download files¶

Upload files¶

Moving files and directories¶

Creating directories¶

Renaming files and diretories¶

Account and storage info¶

CLI Commands¶

115¶

Authentication¶

Using cookies¶

Account information¶

Debug mode¶

Print help¶

115 down¶

Listing tasks¶

Downloading files¶

115 up¶

API Reference¶

Main interface¶

Request and response¶

Cookies¶

Authentication¶

Task and file components¶

Exceptions¶

Indices and tables¶