Skip to content

Latest commit

 

History

History
329 lines (217 loc) · 11.1 KB

README.en.rst

File metadata and controls

329 lines (217 loc) · 11.1 KB

YaDisk-async

Read the Docs PyPI

YaDisk-async is a Yandex.Disk REST API client library with async/await support.

This library is no longer maintained, use yadisk>=2.0.0 instead, it also supports async API.

Documentation is available at Read the Docs (EN) and Read the Docs (RU).

Installation

pip install yadisk-async

or

python setup.py install

Examples

import yadisk_async

y = yadisk_async.YaDisk(token="<token>")
# or
# y = yadisk_async.YaDisk("<application-id>", "<application-secret>", "<token>")

# Check if the token is valid
print(await y.check_token())

# Get disk information
print(await y.get_disk_info())

# Print files and directories at "/some/path"
print([i async for i in await y.listdir("/some/path")])

# Upload "file_to_upload.txt" to "/destination.txt"
await y.upload("file_to_upload.txt", "/destination.txt")

# Same thing
async with aiofiles.open("file_to_upload.txt", "rb") as f:
    await y.upload(f, "/destination.txt")

# Same thing but with regular files
with open("file_to_upload.txt", "rb") as f:
    await y.upload(f, "/destination.txt")

# Download "/some-file-to-download.txt" to "downloaded.txt"
await y.download("/some-file-to-download.txt", "downloaded.txt")

# Same thing
async with aiofiles.open("downloaded.txt", "wb") as f:
    await y.download("/some-file-to-download.txt", f)

# Permanently remove "/file-to-remove"
await y.remove("/file-to-remove", permanently=True)

# Create a new directory at "/test-dir"
print(await y.mkdir("/test-dir"))

# Always remember to close all the connections or you'll get a warning
await y.close()

Changelog

  • Release 1.4.5 (2023-12-14)
    • Added a deprecation warning on import
    • This library is no longer maintained, use yadisk>=2.0.0 instead, it also supports async API.
  • Release 1.4.4 (2023-10-15)
    • upload() and download() (and related) methods can now upload/download non-seekable file-like objects (e.g. stdin or stdout when open in binary mode), see PR #31
  • Release 1.4.3 (2023-04-22)
    • app:/ paths now work correctly (see issue #26)
  • Release 1.4.2 (2023-03-20)
    • Fixed issue #29: TypeError: 'type' object is not subscriptable
    • Fixed a bug affecting Python <3.9: TypeError: Too many parameters for typing.AsyncIterable; actual 2, expected 1
  • Release 1.4.1 (2023-02-28)
    • Fixed issue #28: calling download_public() with path keyword argument raises TypeError
    • Fixed AttributeError raised when calling ResourceLinkObject.public_listdir()
  • Release 1.4.0 (2023-01-30)
    • Added convenience methods to ...Object objects (e.g. see ResourceObject in docs)
    • Added type hints
    • Improved error checking and response validation
    • Added InvalidResponseError, PayloadTooLargeError, UploadTrafficLimitExceededError
    • Added a few missing fields to DiskInfoObject and SystemFoldersObject
    • Added rename(), upload_by_link() and download_by_link() methods
    • Added default_args field for YaDisk object
    • download() and upload() now return ResourceLinkObject
    • Returned LinkObject instances have been replaced by more specific subclasses
    • TimeoutError now also triggers a retry
    • Added support for async files for download() and upload()
    • Use aiofiles to open files by default
  • Release 1.3.6 (2023-01-20)
    • Fixed issue #26: ':' character in filenames causes BadRequestError. This is due the behavior of Yandex.Disk's REST API itself but is avoided on the library level with this fix.
  • Release 1.3.5 (2022-11-10)
    • Fixed a bug in is_file() and is_dir(): a typo was causing AttributeError (PR #6).
  • Release 1.3.4 (2022-08-17)
    • Fixed a bug in check_token(): could throw ForbiddenError if the application lacks necessary permissions (issue #23).
  • Release 1.3.3 (2021-12-31)
    • Fixed an issue where http:// links were not recognized as operation links (they were assumed to always be https://, since all the other requests are always HTTPS). Occasionally, Yandex.Disk can for some reason return an http:// link to an asynchronous operation instead of https://. Both links are now recognized correctly and an https:// version will always be used by get_operation_status(), regardless of which one Yandex.Disk returned.
  • Release 1.3.2 (2021-07-10)
    • Fixed __version__ having the old value
  • Release 1.3.1 (2021-07-10)
    • Fixed AttributeError in SessionWithHeaders (PR #1)
    • Fixed trash bin tests
  • Release 1.3.0 (2019-07-06)
    • Modified the original library (yadisk) to support async/await
    • The library was renamed to yadisk-async

The following releases are for yadisk, the original library:

  • Release 1.2.14 (2019-03-26)
    • Fixed a TypeError in get_public_* functions when passing path parameter (see issue #7)
    • Added unlimited_autoupload_enabled attribute for DiskInfoObject
  • Release 1.2.13 (2019-02-23)
    • Added md5 parameter for remove()
    • Added UserPublicInfoObject
    • Added country attribute for UserObject
    • Added photoslice_time attribute for ResourceObject, PublicResourceObject and TrashResourceObject
  • Release 1.2.13 (2019-02-23)
    • Added md5 parameter for remove()
    • Added UserPublicInfoObject
    • Added country attribute for UserObject
    • Added photoslice_time attribute for ResourceObject, PublicResourceObject and TrashResourceObject
  • Release 1.2.12 (2018-10-11)
    • Fixed fields parameter not working properly in listdir() (issue #4)
  • Release 1.2.11 (2018-06-30)
    • Added the missing parameter sort for get_meta()
    • Added file and antivirus_status attributes for ResourceObject, PublicResourceObject and TrashResourceObject
    • Added headers parameter
    • Fixed a typo in download() and download_public() (issue #2)
    • Removed *args parameter everywhere
  • Release 1.2.10 (2018-06-14)
    • Fixed timeout=None behavior. None is supposed to mean 'no timeout' but in the older versions it was synonymous with the default timeout.
  • Release 1.2.9 (2018-04-28)
    • Changed the license to LGPLv3 (see COPYING and COPYING.lesser)
    • Other package info updates
  • Release 1.2.8 (2018-04-17)
    • Fixed a couple of typos: PublicResourceListObject.items and TrashResourceListObject.items had wrong types
    • Substitute field aliases in fields parameter when performing API requests (e.g. embedded -> _embedded)
  • Release 1.2.7 (2018-04-15)
    • Fixed a file rewinding bug when uploading/downloading files after a retry
  • Release 1.2.6 (2018-04-13)
    • Now caching requests sessions so that open connections can be reused (which can significantly speed things up sometimes)
    • Disable keep-alive when uploading/downloading files by default
  • Release 1.2.5 (2018-03-31)
    • Fixed an off-by-one bug in utils.auto_retry() (which could sometimes result in AttributeError)
    • Retry the whole request for upload(), download() and download_public()
    • Set stream=True for download() and download_public()
    • Other minor fixes
  • Release 1.2.4 (2018-02-19)
    • Fixed TokenObject having exprires_in instead of expires_in (fixed a typo)
  • Release 1.2.3 (2018-01-20)
    • Fixed a TypeError when WrongResourceTypeError is raised
  • Release 1.2.2 (2018-01-19)
    • refresh_token() no longer requires a valid or empty token.
  • Release 1.2.1 (2018-01-14)
    • Fixed auto retries not working. Whoops.
  • Release 1.2.0 (2018-01-14)
    • Fixed passing n_retries=0 to upload(), download() and download_public()
    • upload(), download() and download_public() no longer return anything (see the docs)
    • Added utils module (see the docs)
    • Added RetriableYaDiskError, WrongResourceTypeError, BadGatewayError and GatewayTimeoutError
    • listdir() now raises WrongResourceTypeError instead of NotADirectoryError
  • Release 1.1.1 (2017-12-29)
    • Fixed argument handling in upload(), download() and download_public(). Previously, passing n_retries and retry_interval would raise an exception (TypeError).
  • Release 1.1.0 (2017-12-27)
    • Better exceptions (see the docs)
    • Added support for force_async parameter
    • Minor bug fixes
  • Release 1.0.8 (2017-11-29)
    • Fixed yet another listdir() bug
  • Release 1.0.7 (2017-11-04)
    • Added install_requires argument to setup.py
  • Release 1.0.6 (2017-11-04)
    • Return OperationLinkObject in some functions
  • Release 1.0.5 (2017-10-29)
    • Fixed setup.py to exclude tests
  • Release 1.0.4 (2017-10-23)
    • Fixed bugs in upload, download and listdir functions
    • Set default listdir limit to 10000
  • Release 1.0.3 (2017-10-22)
    • Added settings
  • Release 1.0.2 (2017-10-19)
    • Fixed get_code_url function (added missing parameters)
  • Release 1.0.1 (2017-10-18)
    • Fixed a major bug in GetTokenRequest (added missing parameter)
  • Release 1.0.0 (2017-10-18)
    • Initial release