arabianq/yndx-disk
1
0
Fork 0
mirror of https://github.com/arabianq/yndx-disk.git synced 2026-04-28 14:41:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

added docs

Browse Source
This commit is contained in:
Tarasov Aleksandr
2024-12-13 20:25:56 +03:00
parent 72b1019dca
commit 8b765d8313
178 changed files with 16871 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/_build/html/yndx_disk.clients.html
Vendored
+935
View File
@@ -0,0 +1,935 @@
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>yndx_disk.clients package &#8212; yndx_disk 0.1 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=a3416100" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
<script src="_static/documentation_options.js?v=e1a75a79"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'yndx_disk.clients';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="yndx_disk.api package" href="yndx_disk.api.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="index.html">
<p class="title logo__title">yndx_disk 0.1 documentation</p>
</a></div>
<div class="sidebar-primary-item">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="modules.html">yndx_disk</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2 current active has-children"><a class="reference internal" href="yndx_disk.html">yndx_disk package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="yndx_disk.api.html">yndx_disk.api package</a></li>
<li class="toctree-l3 current active"><a class="current reference internal" href="#">yndx_disk.clients package</a></li>
</ul>
</details></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</button></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="_sources/yndx_disk.clients.rst" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.rst</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button>
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</button>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>yndx_disk.clients package</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#submodules">Submodules</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.clients.async_client">yndx_disk.clients.async_client module</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.copy"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.copy()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.delete"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.delete()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.delete_trash"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.delete_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.get_object"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.get_object()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.is_paid"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.is_paid</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.listdir"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.listdir()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.listdir_trash"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.listdir_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.max_file_size"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.max_file_size</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.move"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.move()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.paid_max_file_size"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.paid_max_file_size</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.payment_flow"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.payment_flow</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.photounlim_size"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.photounlim_size</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.publish"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.publish()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.reg_time"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.reg_time</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.restore_trash"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.restore_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.revision"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.revision</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.system_folders"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.system_folders</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.total_space"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.total_space</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.trash_size"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.trash_size</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.unlimited_autoupload_enabled"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.unlimited_autoupload_enabled</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.unpublish"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.unpublish()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.update_disk_info"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.update_disk_info()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.upload_file"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.upload_file()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.used_space"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.used_space</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.user"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.user</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.clients.sync_client">yndx_disk.clients.sync_client module</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient"><code class="docutils literal notranslate"><span class="pre">DiskClient</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.copy"><code class="docutils literal notranslate"><span class="pre">DiskClient.copy()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.delete"><code class="docutils literal notranslate"><span class="pre">DiskClient.delete()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.delete_trash"><code class="docutils literal notranslate"><span class="pre">DiskClient.delete_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.get_object"><code class="docutils literal notranslate"><span class="pre">DiskClient.get_object()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.listdir"><code class="docutils literal notranslate"><span class="pre">DiskClient.listdir()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.listdir_trash"><code class="docutils literal notranslate"><span class="pre">DiskClient.listdir_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.move"><code class="docutils literal notranslate"><span class="pre">DiskClient.move()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.publish"><code class="docutils literal notranslate"><span class="pre">DiskClient.publish()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.restore_trash"><code class="docutils literal notranslate"><span class="pre">DiskClient.restore_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.unpublish"><code class="docutils literal notranslate"><span class="pre">DiskClient.unpublish()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.update_disk_info"><code class="docutils literal notranslate"><span class="pre">DiskClient.update_disk_info()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.upload_file"><code class="docutils literal notranslate"><span class="pre">DiskClient.upload_file()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.clients">Module contents</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="yndx-disk-clients-package">
<h1>yndx_disk.clients package<a class="headerlink" href="#yndx-disk-clients-package" title="Link to this heading">#</a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
</section>
<section id="module-yndx_disk.clients.async_client">
<span id="yndx-disk-clients-async-client-module"></span><h2>yndx_disk.clients.async_client module<a class="headerlink" href="#module-yndx_disk.clients.async_client" title="Link to this heading">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.clients.async_client.</span></span><span class="sig-name descname"><span class="pre">AsyncDiskClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_update_info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient" title="Link to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A class representing an asynchronous client for interacting with a disk service.</p>
<p>Attributes:
- user (dict): Information about the user.
- system_folders (dict): Information about the system folders.
- is_paid (bool): Whether the user has a paid account.
- payment_flow (bool): Whether the user is in the payment flow.
- unlimited_autoupload_enabled (bool): Whether unlimited autoupload is enabled.
- reg_time (str): The registration time of the user.
- total_space (int): The total disk space available.
- used_space (int): The used disk space.
- max_file_size (int): The maximum file size allowed.
- paid_max_file_size (int): The maximum file size allowed for a paid account.
- photounlim_size (int): The photo unlimited size.
- trash_size (int): The size of the trash.
- revision (int): The revision number.</p>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.copy">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.copy" title="Link to this definition">#</a></dt>
<dd><p>Copy a file or directory from one location to another on the disk.</p>
<p>This method copies a file or directory from the source path to the destination path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- source_path (str): The path of the file or directory to be copied.
- destination_path (str): The path where the file or directory should be copied to.
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.delete">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permanently</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.delete" title="Link to this definition">#</a></dt>
<dd><p>Delete a file or directory from the disk.</p>
<p>This method deletes a file or directory from the disk using the provided path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- path (str): The path of the file or directory to be deleted.
- permanent (bool, optional): Whether to delete the file or directory permanently. Defaults to False.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.delete_trash">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete_trash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.delete_trash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.delete_trash" title="Link to this definition">#</a></dt>
<dd><p>Delete a file or directory from the trash on the server.</p>
<p>This method deletes a file or directory from the trash using the provided path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- path (str, optional): The path of the file or directory to be deleted from the trash. Defaults to “”.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.get_object">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.File" title="yndx_disk.classes.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.Directory" title="yndx_disk.classes.Directory"><span class="pre">Directory</span></a></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.get_object"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.get_object" title="Link to this definition">#</a></dt>
<dd><p>Get an object from the disk.</p>
<p>This method retrieves information about an object (file or directory) from the disk using the provided path. If the request is successful (status code 200), it returns a File or Directory object based on the type of the object. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str): The path of the object to retrieve.</p>
<p>Returns:
- File | Directory: The retrieved File or Directory object.</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the object type cannot be determined.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.is_paid">
<span class="sig-name descname"><span class="pre">is_paid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.is_paid" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.listdir">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">listdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.File" title="yndx_disk.classes.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.Directory" title="yndx_disk.classes.Directory"><span class="pre">Directory</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.listdir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.listdir" title="Link to this definition">#</a></dt>
<dd><p>List the contents of a directory on the disk.</p>
<p>This method retrieves the contents of a directory from the disk using the provided path. If the request is successful (status code 200), it returns a list of File or Directory objects representing the contents of the directory. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str, optional): The path of the directory to list. Defaults to “/”.
- limit (int, optional): The maximum number of items to return in the response. Defaults to 100.
- offset (int, optional): The number of items to skip before returning the response. Defaults to 0.</p>
<p>Returns:
- list[File | Directory]: A list of File or Directory objects representing the contents of the directory.</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the object type cannot be determined.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.listdir_trash">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">listdir_trash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.File" title="yndx_disk.classes.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.Directory" title="yndx_disk.classes.Directory"><span class="pre">Directory</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.listdir_trash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.listdir_trash" title="Link to this definition">#</a></dt>
<dd><p>List the contents of a directory in the trash on the disk.</p>
<p>This method retrieves the contents of a directory in the trash from the disk using the provided path. If the request is successful (status code 200), it returns a list of File or Directory objects representing the contents of the directory. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str, optional): The path of the directory in the trash to list. Defaults to “/”.
- limit (int, optional): The maximum number of items to return in the response. Defaults to 100.
- offset (int, optional): The number of items to skip before returning the response. Defaults to 0.</p>
<p>Returns:
- list[File | Directory]: A list of File or Directory objects representing the contents of the directory in the trash.</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the object type cannot be determined.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.max_file_size">
<span class="sig-name descname"><span class="pre">max_file_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.max_file_size" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.move">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">move</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.move"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.move" title="Link to this definition">#</a></dt>
<dd><p>Move a file or directory from one location to another on the disk.</p>
<p>This method moves a file or directory from the source path to the destination path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- source_path (str): The path of the file or directory to be moved.
- destination_path (str): The path where the file or directory should be moved to.
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.paid_max_file_size">
<span class="sig-name descname"><span class="pre">paid_max_file_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.paid_max_file_size" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.payment_flow">
<span class="sig-name descname"><span class="pre">payment_flow</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.payment_flow" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.photounlim_size">
<span class="sig-name descname"><span class="pre">photounlim_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.photounlim_size" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.publish">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_public_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.publish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.publish" title="Link to this definition">#</a></dt>
<dd><p>Publish a file or directory on the server.</p>
<p>This method publishes a file or directory on the server using the provided path. If the request is successful (status code 200), it returns the public URL of the published file or directory. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str): The path of the file or directory to be published.
- return_public_url (bool, optional): Whether to return the public URL of the published file or directory. Defaults to False.</p>
<p>Returns:
- str | None: The public URL of the published file or directory if return_public_url is True, otherwise None.</p>
<p>Raises:
- YandexDiskAPIException: If the request fails.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.reg_time">
<span class="sig-name descname"><span class="pre">reg_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.reg_time" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.restore_trash">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">restore_trash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.restore_trash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.restore_trash" title="Link to this definition">#</a></dt>
<dd><p>Restore a file or directory from the trash on the server.</p>
<p>This method restores a file or directory from the trash using the provided path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- path (str): The path of the file or directory to be restored.
- new_name (str, optional): The new name for the restored file or directory. Defaults to “”.
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.revision">
<span class="sig-name descname"><span class="pre">revision</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.revision" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.system_folders">
<span class="sig-name descname"><span class="pre">system_folders</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.system_folders" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.total_space">
<span class="sig-name descname"><span class="pre">total_space</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.total_space" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.trash_size">
<span class="sig-name descname"><span class="pre">trash_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.trash_size" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.unlimited_autoupload_enabled">
<span class="sig-name descname"><span class="pre">unlimited_autoupload_enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.unlimited_autoupload_enabled" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.unpublish">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unpublish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.unpublish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.unpublish" title="Link to this definition">#</a></dt>
<dd><p>Unpublish a file or directory on the server.</p>
<p>This method unpublishes a file or directory on the server using the provided path. If the request is successful (status code 200), it returns the public URL of the unpublished file or directory. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str): The path of the file or directory to be unpublished.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.update_disk_info">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_disk_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.update_disk_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.update_disk_info" title="Link to this definition">#</a></dt>
<dd><p>Update the disk information for the client.</p>
<p>This method retrieves the disk information from the server using the provided token. If the request is successful (status code 200), it updates the client’s information with the retrieved data. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Returns:
- None</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.upload_file">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upload_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chunk_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1024</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/async_client.html#AsyncDiskClient.upload_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.upload_file" title="Link to this definition">#</a></dt>
<dd><p>Upload a file to the server.</p>
<p>This method uploads a file to the server using the provided file path and destination path. If the file size is larger than the available space or the maximum file size allowed, it raises a YandexDiskAPIException. If the request is successful (status code 201), it updates the disk information if auto_update_info is True. If the request is successful (status code 202), it waits for the operation to finish and updates the disk information if auto_update_info is True. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- file_path (str): The path of the file to be uploaded.
- path (str): The destination path on the server.
- overwrite (bool, optional): Whether to overwrite the destination file if it already exists. Defaults to False.
- chunk_size (int, optional): The size of each chunk to be uploaded. Defaults to 1024.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the file size is too large or the request fails.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.used_space">
<span class="sig-name descname"><span class="pre">used_space</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.used_space" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="yndx_disk.clients.async_client.AsyncDiskClient.user">
<span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#yndx_disk.clients.async_client.AsyncDiskClient.user" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-yndx_disk.clients.sync_client">
<span id="yndx-disk-clients-sync-client-module"></span><h2>yndx_disk.clients.sync_client module<a class="headerlink" href="#module-yndx_disk.clients.sync_client" title="Link to this heading">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.clients.sync_client.</span></span><span class="sig-name descname"><span class="pre">DiskClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_update_info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#yndx_disk.clients.async_client.AsyncDiskClient" title="yndx_disk.clients.async_client.AsyncDiskClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncDiskClient</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.copy">
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.copy" title="Link to this definition">#</a></dt>
<dd><p>Copy a file or directory from one location to another on the disk.</p>
<p>This method copies a file or directory from the source path to the destination path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- source_path (str): The path of the file or directory to be copied.
- destination_path (str): The path where the file or directory should be copied to.
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permanently</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.delete" title="Link to this definition">#</a></dt>
<dd><p>Delete a file or directory from the disk.</p>
<p>This method deletes a file or directory from the disk using the provided path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- path (str): The path of the file or directory to be deleted.
- permanent (bool, optional): Whether to delete the file or directory permanently. Defaults to False.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.delete_trash">
<span class="sig-name descname"><span class="pre">delete_trash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.delete_trash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.delete_trash" title="Link to this definition">#</a></dt>
<dd><p>Delete a file or directory from the trash on the server.</p>
<p>This method deletes a file or directory from the trash using the provided path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- path (str, optional): The path of the file or directory to be deleted from the trash. Defaults to “”.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.get_object">
<span class="sig-name descname"><span class="pre">get_object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.File" title="yndx_disk.classes.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.Directory" title="yndx_disk.classes.Directory"><span class="pre">Directory</span></a></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.get_object"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.get_object" title="Link to this definition">#</a></dt>
<dd><p>Get an object from the disk.</p>
<p>This method retrieves information about an object (file or directory) from the disk using the provided path. If the request is successful (status code 200), it returns a File or Directory object based on the type of the object. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str): The path of the object to retrieve.</p>
<p>Returns:
- File | Directory: The retrieved File or Directory object.</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the object type cannot be determined.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.listdir">
<span class="sig-name descname"><span class="pre">listdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.File" title="yndx_disk.classes.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.Directory" title="yndx_disk.classes.Directory"><span class="pre">Directory</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.listdir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.listdir" title="Link to this definition">#</a></dt>
<dd><p>List the contents of a directory on the disk.</p>
<p>This method retrieves the contents of a directory from the disk using the provided path. If the request is successful (status code 200), it returns a list of File or Directory objects representing the contents of the directory. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str, optional): The path of the directory to list. Defaults to “/”.
- limit (int, optional): The maximum number of items to return in the response. Defaults to 100.
- offset (int, optional): The number of items to skip before returning the response. Defaults to 0.</p>
<p>Returns:
- list[File | Directory]: A list of File or Directory objects representing the contents of the directory.</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the object type cannot be determined.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.listdir_trash">
<span class="sig-name descname"><span class="pre">listdir_trash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.File" title="yndx_disk.classes.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="yndx_disk.html#yndx_disk.classes.Directory" title="yndx_disk.classes.Directory"><span class="pre">Directory</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.listdir_trash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.listdir_trash" title="Link to this definition">#</a></dt>
<dd><p>List the contents of a directory in the trash on the disk.</p>
<p>This method retrieves the contents of a directory in the trash from the disk using the provided path. If the request is successful (status code 200), it returns a list of File or Directory objects representing the contents of the directory. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str, optional): The path of the directory in the trash to list. Defaults to “/”.
- limit (int, optional): The maximum number of items to return in the response. Defaults to 100.
- offset (int, optional): The number of items to skip before returning the response. Defaults to 0.</p>
<p>Returns:
- list[File | Directory]: A list of File or Directory objects representing the contents of the directory in the trash.</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the object type cannot be determined.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.move">
<span class="sig-name descname"><span class="pre">move</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.move"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.move" title="Link to this definition">#</a></dt>
<dd><p>Move a file or directory from one location to another on the disk.</p>
<p>This method moves a file or directory from the source path to the destination path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- source_path (str): The path of the file or directory to be moved.
- destination_path (str): The path where the file or directory should be moved to.
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.publish">
<span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_public_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.publish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.publish" title="Link to this definition">#</a></dt>
<dd><p>Publish a file or directory on the server.</p>
<p>This method publishes a file or directory on the server using the provided path. If the request is successful (status code 200), it returns the public URL of the published file or directory. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str): The path of the file or directory to be published.
- return_public_url (bool, optional): Whether to return the public URL of the published file or directory. Defaults to False.</p>
<p>Returns:
- str | None: The public URL of the published file or directory if return_public_url is True, otherwise None.</p>
<p>Raises:
- YandexDiskAPIException: If the request fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.restore_trash">
<span class="sig-name descname"><span class="pre">restore_trash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.restore_trash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.restore_trash" title="Link to this definition">#</a></dt>
<dd><p>Restore a file or directory from the trash on the server.</p>
<p>This method restores a file or directory from the trash using the provided path. If the request is successful (status code 202), it waits for the operation to finish and raises a YandexDiskAPIException if the operation fails. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response. If the auto_update_info attribute is True, it updates the disk information after the operation is successful.</p>
<p>Parameters:
- path (str): The path of the file or directory to be restored.
- new_name (str, optional): The new name for the restored file or directory. Defaults to “”.
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails or if the operation fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.unpublish">
<span class="sig-name descname"><span class="pre">unpublish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.unpublish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.unpublish" title="Link to this definition">#</a></dt>
<dd><p>Unpublish a file or directory on the server.</p>
<p>This method unpublishes a file or directory on the server using the provided path. If the request is successful (status code 200), it returns the public URL of the unpublished file or directory. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- path (str): The path of the file or directory to be unpublished.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the request fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.update_disk_info">
<span class="sig-name descname"><span class="pre">update_disk_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.update_disk_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.update_disk_info" title="Link to this definition">#</a></dt>
<dd><p>Update the disk information for the client.</p>
<p>This method retrieves the disk information from the server using the provided token. If the request is successful (status code 200), it updates the client’s information with the retrieved data. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Returns:
- None</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="yndx_disk.clients.sync_client.DiskClient.upload_file">
<span class="sig-name descname"><span class="pre">upload_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chunk_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1024</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/yndx_disk/clients/sync_client.html#DiskClient.upload_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.clients.sync_client.DiskClient.upload_file" title="Link to this definition">#</a></dt>
<dd><p>Upload a file to the server.</p>
<p>This method uploads a file to the server using the provided file path and destination path. If the file size is larger than the available space or the maximum file size allowed, it raises a YandexDiskAPIException. If the request is successful (status code 201), it updates the disk information if auto_update_info is True. If the request is successful (status code 202), it waits for the operation to finish and updates the disk information if auto_update_info is True. If the request fails, it raises a YandexDiskAPIException with the status code and description from the response.</p>
<p>Parameters:
- file_path (str): The path of the file to be uploaded.
- path (str): The destination path on the server.
- overwrite (bool, optional): Whether to overwrite the destination file if it already exists. Defaults to False.
- chunk_size (int, optional): The size of each chunk to be uploaded. Defaults to 1024.</p>
<p>Returns:
- None</p>
<p>Raises:
- YandexDiskAPIException: If the file size is too large or the request fails.</p>
</dd></dl>
</dd></dl>
</section>
<section id="module-yndx_disk.clients">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-yndx_disk.clients" title="Link to this heading">#</a></h2>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="yndx_disk.api.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">yndx_disk.api package</p>
</div>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#submodules">Submodules</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.clients.async_client">yndx_disk.clients.async_client module</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.copy"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.copy()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.delete"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.delete()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.delete_trash"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.delete_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.get_object"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.get_object()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.is_paid"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.is_paid</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.listdir"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.listdir()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.listdir_trash"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.listdir_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.max_file_size"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.max_file_size</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.move"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.move()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.paid_max_file_size"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.paid_max_file_size</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.payment_flow"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.payment_flow</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.photounlim_size"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.photounlim_size</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.publish"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.publish()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.reg_time"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.reg_time</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.restore_trash"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.restore_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.revision"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.revision</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.system_folders"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.system_folders</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.total_space"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.total_space</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.trash_size"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.trash_size</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.unlimited_autoupload_enabled"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.unlimited_autoupload_enabled</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.unpublish"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.unpublish()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.update_disk_info"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.update_disk_info()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.upload_file"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.upload_file()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.used_space"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.used_space</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.async_client.AsyncDiskClient.user"><code class="docutils literal notranslate"><span class="pre">AsyncDiskClient.user</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.clients.sync_client">yndx_disk.clients.sync_client module</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient"><code class="docutils literal notranslate"><span class="pre">DiskClient</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.copy"><code class="docutils literal notranslate"><span class="pre">DiskClient.copy()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.delete"><code class="docutils literal notranslate"><span class="pre">DiskClient.delete()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.delete_trash"><code class="docutils literal notranslate"><span class="pre">DiskClient.delete_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.get_object"><code class="docutils literal notranslate"><span class="pre">DiskClient.get_object()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.listdir"><code class="docutils literal notranslate"><span class="pre">DiskClient.listdir()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.listdir_trash"><code class="docutils literal notranslate"><span class="pre">DiskClient.listdir_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.move"><code class="docutils literal notranslate"><span class="pre">DiskClient.move()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.publish"><code class="docutils literal notranslate"><span class="pre">DiskClient.publish()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.restore_trash"><code class="docutils literal notranslate"><span class="pre">DiskClient.restore_trash()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.unpublish"><code class="docutils literal notranslate"><span class="pre">DiskClient.unpublish()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.update_disk_info"><code class="docutils literal notranslate"><span class="pre">DiskClient.update_disk_info()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.clients.sync_client.DiskClient.upload_file"><code class="docutils literal notranslate"><span class="pre">DiskClient.upload_file()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.clients">Module contents</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By Alexander Tarasov
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2024, Alexander Tarasov.
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script>
<footer class="bd-footer">
</footer>
</body>
</html>