mirror of
https://github.com/arabianq/yndx-disk.git
synced 2026-04-28 06:31:23 +00:00
881 lines
108 KiB
HTML
881 lines
108 KiB
HTML
|
|
<!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.api package — 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.api';</script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="yndx_disk.clients package" href="yndx_disk.clients.html" />
|
|
<link rel="prev" title="yndx_disk package" href="yndx_disk.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 current active"><a class="current reference internal" href="#">yndx_disk.api package</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="yndx_disk.clients.html">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.api.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.api 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.api.disk">yndx_disk.api.disk 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.api.disk.get_disk_info"><code class="docutils literal notranslate"><span class="pre">get_disk_info()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.exceptions">yndx_disk.api.exceptions 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.api.exceptions.YandexDiskAPIException"><code class="docutils literal notranslate"><span class="pre">YandexDiskAPIException</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.operations">yndx_disk.api.operations 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.api.operations.get_operation_status"><code class="docutils literal notranslate"><span class="pre">get_operation_status()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.public_resources">yndx_disk.api.public_resources 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.api.public_resources.get_info"><code class="docutils literal notranslate"><span class="pre">get_info()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.public_resources.get_url"><code class="docutils literal notranslate"><span class="pre">get_url()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.public_resources.save_to_disk"><code class="docutils literal notranslate"><span class="pre">save_to_disk()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.resources">yndx_disk.api.resources 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.api.resources.copy"><code class="docutils literal notranslate"><span class="pre">copy()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.delete"><code class="docutils literal notranslate"><span class="pre">delete()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_all_files"><code class="docutils literal notranslate"><span class="pre">get_all_files()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_all_public"><code class="docutils literal notranslate"><span class="pre">get_all_public()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_info"><code class="docutils literal notranslate"><span class="pre">get_info()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_last_uploads"><code class="docutils literal notranslate"><span class="pre">get_last_uploads()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_upload_url"><code class="docutils literal notranslate"><span class="pre">get_upload_url()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_url"><code class="docutils literal notranslate"><span class="pre">get_url()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.mkdir"><code class="docutils literal notranslate"><span class="pre">mkdir()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.move"><code class="docutils literal notranslate"><span class="pre">move()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.publish"><code class="docutils literal notranslate"><span class="pre">publish()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.unpublish"><code class="docutils literal notranslate"><span class="pre">unpublish()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.update_info"><code class="docutils literal notranslate"><span class="pre">update_info()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.upload"><code class="docutils literal notranslate"><span class="pre">upload()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.trash_resources">yndx_disk.api.trash_resources 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.api.trash_resources.delete"><code class="docutils literal notranslate"><span class="pre">delete()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.trash_resources.get_info"><code class="docutils literal notranslate"><span class="pre">get_info()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.trash_resources.restore"><code class="docutils literal notranslate"><span class="pre">restore()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.utils">yndx_disk.api.utils 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.api.utils.generate_headers"><code class="docutils literal notranslate"><span class="pre">generate_headers()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.utils.parse_path"><code class="docutils literal notranslate"><span class="pre">parse_path()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api">Module contents</a></li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div id="searchbox"></div>
|
|
<article class="bd-article">
|
|
|
|
<section id="yndx-disk-api-package">
|
|
<h1>yndx_disk.api package<a class="headerlink" href="#yndx-disk-api-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.api.disk">
|
|
<span id="yndx-disk-api-disk-module"></span><h2>yndx_disk.api.disk module<a class="headerlink" href="#module-yndx_disk.api.disk" title="Link to this heading">#</a></h2>
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.disk.get_disk_info">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.disk.</span></span><span class="sig-name descname"><span class="pre">get_disk_info</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">fields</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/disk.html#get_disk_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.disk.get_disk_info" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get information about the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the server.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing the disk information.</p>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-yndx_disk.api.exceptions">
|
|
<span id="yndx-disk-api-exceptions-module"></span><h2>yndx_disk.api.exceptions module<a class="headerlink" href="#module-yndx_disk.api.exceptions" title="Link to this heading">#</a></h2>
|
|
<dl class="py exception">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.exceptions.YandexDiskAPIException">
|
|
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.exceptions.</span></span><span class="sig-name descname"><span class="pre">YandexDiskAPIException</span></span><a class="reference internal" href="_modules/yndx_disk/api/exceptions.html#YandexDiskAPIException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.exceptions.YandexDiskAPIException" title="Link to this definition">#</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-yndx_disk.api.operations">
|
|
<span id="yndx-disk-api-operations-module"></span><h2>yndx_disk.api.operations module<a class="headerlink" href="#module-yndx_disk.api.operations" title="Link to this heading">#</a></h2>
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.operations.get_operation_status">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.operations.</span></span><span class="sig-name descname"><span class="pre">get_operation_status</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">operation_id</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">fields</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/operations.html#get_operation_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.operations.get_operation_status" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get the status of an operation on the server.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the server.
|
|
- operation_id (str): The ID of the operation to get the status for.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing the status of the operation.</p>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-yndx_disk.api.public_resources">
|
|
<span id="yndx-disk-api-public-resources-module"></span><h2>yndx_disk.api.public_resources module<a class="headerlink" href="#module-yndx_disk.api.public_resources" title="Link to this heading">#</a></h2>
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.public_resources.get_info">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.public_resources.</span></span><span class="sig-name descname"><span class="pre">get_info</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">public_key</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">fields</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">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">preview_size</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">sort</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">preview_crop</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">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>, <em class="sig-param"><span class="n"><span class="pre">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/public_resources.html#get_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.public_resources.get_info" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get information about a file or directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- public_key (str): The public key of the file or directory to get information about.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- path (str, optional): The path of the file or directory to get information about. Defaults to “”.
|
|
- preview_size (str, optional): The size of the preview to be included in the response. Defaults to “”.
|
|
- sort (str, optional): The sorting order of the response. Defaults to “”.
|
|
- preview_crop (bool, optional): Whether to crop the preview. Defaults to False.
|
|
- 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.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing the information about the file or directory.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.public_resources.get_url">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.public_resources.</span></span><span class="sig-name descname"><span class="pre">get_url</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">public_key</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">fields</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">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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/public_resources.html#get_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.public_resources.get_url" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get the download URL for a file or directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- public_key (str): The public key of the file or directory to get the download URL for.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- path (str, optional): The path of the file or directory to get the download URL for. Defaults to “”.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing the download URL for the file or directory.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.public_resources.save_to_disk">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.public_resources.</span></span><span class="sig-name descname"><span class="pre">save_to_disk</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">public_key</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">fields</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">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">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">save_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">force_async</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/public_resources.html#save_to_disk"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.public_resources.save_to_disk" title="Link to this definition">#</a></dt>
|
|
<dd><p>Save a file or directory from the disk to your own disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- public_key (str): The public key of the file or directory to be saved.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- name (str, optional): The name of the file or directory to be saved. Defaults to “”.
|
|
- path (str, optional): The path of the file or directory to be saved. Defaults to “”.
|
|
- save_path (str, optional): The path where the file or directory should be saved to. Defaults to “”.
|
|
- force_async (bool, optional): Whether to force asynchronous saving. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the save operation.</p>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-yndx_disk.api.resources">
|
|
<span id="yndx-disk-api-resources-module"></span><h2>yndx_disk.api.resources module<a class="headerlink" href="#module-yndx_disk.api.resources" title="Link to this heading">#</a></h2>
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.copy">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><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">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">from_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">to_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">fields</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">force_async</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">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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.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>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- from_path (str): The path of the file or directory to be copied.
|
|
- to_path (str): The path where the file or directory should be copied to.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- force_async (bool, optional): Whether to force asynchronous copying. Defaults to False.
|
|
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the copy operation.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.delete">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><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">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">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">fields</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">md5</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">force_async</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">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>, <em class="sig-param"><span class="n"><span class="pre">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.delete" title="Link to this definition">#</a></dt>
|
|
<dd><p>Delete a file or directory from the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path of the file or directory to be deleted.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- md5 (str, optional): The MD5 hash of the file to be deleted. Defaults to “”.
|
|
- force_async (bool, optional): Whether to force asynchronous deletion. Defaults to False.
|
|
- permanently (bool, optional): Whether to delete the file permanently. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the deletion operation.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.get_all_files">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">get_all_files</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">fields</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">media_type</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">preview_size</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">sort</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">preview_crop</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">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>, <em class="sig-param"><span class="n"><span class="pre">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#get_all_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.get_all_files" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get a list of all files and directories on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- media_type (str, optional): The media type of the files to be included in the response. Defaults to “”.
|
|
- preview_size (str, optional): The size of the preview to be included in the response. Defaults to “”.
|
|
- sort (str, optional): The sorting order of the response. Defaults to “”.
|
|
- preview_crop (bool, optional): Whether to crop the preview. Defaults to False.
|
|
- 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.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing a list of all files and directories.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.get_all_public">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">get_all_public</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">fields</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">preview_size</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">type_filter</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">preview_crop</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">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>, <em class="sig-param"><span class="n"><span class="pre">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#get_all_public"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.get_all_public" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get a list of all public files and directories on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- preview_size (str, optional): The size of the preview to be included in the response. Defaults to “”.
|
|
- type_filter (str, optional): The type of files to be included in the response. Defaults to “”.
|
|
- preview_crop (bool, optional): Whether to crop the preview. Defaults to False.
|
|
- 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.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing a list of all public files and directories.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.get_info">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">get_info</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">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">fields</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">preview_size</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">sort</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">preview_crop</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">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>, <em class="sig-param"><span class="n"><span class="pre">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#get_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.get_info" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get information about a file or directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path of the file or directory to get information about.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- preview_size (str, optional): The size of the preview to be included in the response. Defaults to “”.
|
|
- sort (str, optional): The sorting order of the response. Defaults to “”.
|
|
- preview_crop (bool, optional): Whether to crop the preview. Defaults to False.
|
|
- 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.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing the information about the file or directory.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.get_last_uploads">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">get_last_uploads</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">fields</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">media_type</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">preview_size</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">preview_crop</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">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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#get_last_uploads"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.get_last_uploads" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get a list of the last uploaded files and directories on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- media_type (str, optional): The media type of the files to be included in the response. Defaults to “”.
|
|
- preview_size (str, optional): The size of the preview to be included in the response. Defaults to “”.
|
|
- preview_crop (bool, optional): Whether to crop the preview. Defaults to False.
|
|
- limit (int, optional): The maximum number of items to return in the response. Defaults to 100.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing a list of the last uploaded files and directories.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.get_upload_url">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">get_upload_url</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">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">fields</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>, <em class="sig-param"><span class="n"><span class="pre">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#get_upload_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.get_upload_url" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get the upload URL for a file or directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path of the file or directory to get the upload URL for.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- overwrite (bool, optional): Whether to overwrite the file or directory if it already exists. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing the upload URL for the file or directory.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.get_url">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">get_url</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">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">fields</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#get_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.get_url" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get the download URL for a file or directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path of the file or directory to get the download URL for.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing the download URL for the file or directory.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.mkdir">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">mkdir</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">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">fields</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#mkdir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.mkdir" title="Link to this definition">#</a></dt>
|
|
<dd><p>Create a new directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path of the new directory to be created.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the creation operation.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.move">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><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">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">from_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">to_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">fields</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">force_async</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">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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#move"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.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>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- from_path (str): The path of the file or directory to be moved.
|
|
- to_path (str): The path where the file or directory should be moved to.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- force_async (bool, optional): Whether to force asynchronous moving. Defaults to False.
|
|
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the move operation.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.publish">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><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">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">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">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</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">allow_address_access</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#publish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.publish" title="Link to this definition">#</a></dt>
|
|
<dd><p>Publish a file or directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path of the file or directory to be published.
|
|
- body (dict): The information to be published.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- allow_address_access (bool, optional): Whether to allow address access. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the publish operation.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.unpublish">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><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">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">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">fields</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#unpublish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.unpublish" title="Link to this definition">#</a></dt>
|
|
<dd><p>Unpublish a file or directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path of the file or directory to be unpublished.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the unpublish operation.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.update_info">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">update_info</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">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">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#update_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.update_info" title="Link to this definition">#</a></dt>
|
|
<dd><p>Update information about a file or directory on the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path of the file or directory to update.
|
|
- body (dict): The new information to be updated.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the update operation.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.resources.upload">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.resources.</span></span><span class="sig-name descname"><span class="pre">upload</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">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">upload_url</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">fields</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">disable_redirects</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/resources.html#upload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.resources.upload" title="Link to this definition">#</a></dt>
|
|
<dd><p>Upload a file or directory to the disk.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the disk.
|
|
- path (str): The path where the file or directory should be uploaded.
|
|
- upload_url (str): The URL to upload the file or directory to.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- disable_redirects (bool, optional): Whether to disable redirects. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the upload operation.</p>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-yndx_disk.api.trash_resources">
|
|
<span id="yndx-disk-api-trash-resources-module"></span><h2>yndx_disk.api.trash_resources module<a class="headerlink" href="#module-yndx_disk.api.trash_resources" title="Link to this heading">#</a></h2>
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.trash_resources.delete">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.trash_resources.</span></span><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">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">fields</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">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">force_async</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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/trash_resources.html#delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.trash_resources.delete" title="Link to this definition">#</a></dt>
|
|
<dd><p>Empty the trash on the server.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the server.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- path (str, optional): The path of the trash to be emptied. Defaults to “”.
|
|
- force_async (bool, optional): Whether to force asynchronous emptying. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the emptying operation.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.trash_resources.get_info">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.trash_resources.</span></span><span class="sig-name descname"><span class="pre">get_info</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">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">fields</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">preview_size</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">sort</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">preview_crop</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">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>, <em class="sig-param"><span class="n"><span class="pre">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/trash_resources.html#get_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.trash_resources.get_info" title="Link to this definition">#</a></dt>
|
|
<dd><p>Get the content of the trash on the server.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the server.
|
|
- path (str): The path of the trash to get the content from.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- preview_size (str, optional): The size of the preview to be included in the response. Defaults to “”.
|
|
- sort (str, optional): The sorting order of the response. Defaults to “”.
|
|
- preview_crop (bool, optional): Whether to crop the preview. Defaults to False.
|
|
- 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.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server containing the content of the trash.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.trash_resources.restore">
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">yndx_disk.api.trash_resources.</span></span><span class="sig-name descname"><span class="pre">restore</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">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">fields</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">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">force_async</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">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">timeout</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">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/trash_resources.html#restore"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.trash_resources.restore" title="Link to this definition">#</a></dt>
|
|
<dd><p>Restore a file or directory from the trash on the server.</p>
|
|
<p>Parameters:
|
|
- token (str): The authentication token for the server.
|
|
- path (str): The path of the file or directory to be restored.
|
|
- fields (str, optional): The fields to be included in the response. Defaults to “”.
|
|
- name (str, optional): The name of the file or directory to be restored. Defaults to “”.
|
|
- force_async (bool, optional): Whether to force asynchronous restoring. Defaults to False.
|
|
- overwrite (bool, optional): Whether to overwrite the destination file or directory if it already exists. Defaults to False.
|
|
- timeout (int, optional): The timeout for the request in seconds. Defaults to 30.</p>
|
|
<p>Returns:
|
|
- httpx.Response: The response from the server after the restore operation.</p>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-yndx_disk.api.utils">
|
|
<span id="yndx-disk-api-utils-module"></span><h2>yndx_disk.api.utils module<a class="headerlink" href="#module-yndx_disk.api.utils" title="Link to this heading">#</a></h2>
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.utils.generate_headers">
|
|
<span class="sig-prename descclassname"><span class="pre">yndx_disk.api.utils.</span></span><span class="sig-name descname"><span class="pre">generate_headers</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><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/utils.html#generate_headers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.utils.generate_headers" title="Link to this definition">#</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py function">
|
|
<dt class="sig sig-object py" id="yndx_disk.api.utils.parse_path">
|
|
<span class="sig-prename descclassname"><span class="pre">yndx_disk.api.utils.</span></span><span class="sig-name descname"><span class="pre">parse_path</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">prefix</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">'disk:/'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/yndx_disk/api/utils.html#parse_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#yndx_disk.api.utils.parse_path" title="Link to this definition">#</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</section>
|
|
<section id="module-yndx_disk.api">
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-yndx_disk.api" 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.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 package</p>
|
|
</div>
|
|
</a>
|
|
<a class="right-next"
|
|
href="yndx_disk.clients.html"
|
|
title="next page">
|
|
<div class="prev-next-info">
|
|
<p class="prev-next-subtitle">next</p>
|
|
<p class="prev-next-title">yndx_disk.clients package</p>
|
|
</div>
|
|
<i class="fa-solid fa-angle-right"></i>
|
|
</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.api.disk">yndx_disk.api.disk 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.api.disk.get_disk_info"><code class="docutils literal notranslate"><span class="pre">get_disk_info()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.exceptions">yndx_disk.api.exceptions 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.api.exceptions.YandexDiskAPIException"><code class="docutils literal notranslate"><span class="pre">YandexDiskAPIException</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.operations">yndx_disk.api.operations 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.api.operations.get_operation_status"><code class="docutils literal notranslate"><span class="pre">get_operation_status()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.public_resources">yndx_disk.api.public_resources 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.api.public_resources.get_info"><code class="docutils literal notranslate"><span class="pre">get_info()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.public_resources.get_url"><code class="docutils literal notranslate"><span class="pre">get_url()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.public_resources.save_to_disk"><code class="docutils literal notranslate"><span class="pre">save_to_disk()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.resources">yndx_disk.api.resources 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.api.resources.copy"><code class="docutils literal notranslate"><span class="pre">copy()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.delete"><code class="docutils literal notranslate"><span class="pre">delete()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_all_files"><code class="docutils literal notranslate"><span class="pre">get_all_files()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_all_public"><code class="docutils literal notranslate"><span class="pre">get_all_public()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_info"><code class="docutils literal notranslate"><span class="pre">get_info()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_last_uploads"><code class="docutils literal notranslate"><span class="pre">get_last_uploads()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_upload_url"><code class="docutils literal notranslate"><span class="pre">get_upload_url()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.get_url"><code class="docutils literal notranslate"><span class="pre">get_url()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.mkdir"><code class="docutils literal notranslate"><span class="pre">mkdir()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.move"><code class="docutils literal notranslate"><span class="pre">move()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.publish"><code class="docutils literal notranslate"><span class="pre">publish()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.unpublish"><code class="docutils literal notranslate"><span class="pre">unpublish()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.update_info"><code class="docutils literal notranslate"><span class="pre">update_info()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.resources.upload"><code class="docutils literal notranslate"><span class="pre">upload()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.trash_resources">yndx_disk.api.trash_resources 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.api.trash_resources.delete"><code class="docutils literal notranslate"><span class="pre">delete()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.trash_resources.get_info"><code class="docutils literal notranslate"><span class="pre">get_info()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.trash_resources.restore"><code class="docutils literal notranslate"><span class="pre">restore()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api.utils">yndx_disk.api.utils 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.api.utils.generate_headers"><code class="docutils literal notranslate"><span class="pre">generate_headers()</span></code></a></li>
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#yndx_disk.api.utils.parse_path"><code class="docutils literal notranslate"><span class="pre">parse_path()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-yndx_disk.api">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> |