349 lines
12 KiB
HTML
349 lines
12 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="./">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Index — tzst 1.3.3 Documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
|
|
|
|
|
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
|
<link rel="canonical" href="https://tzst.xi-xu.me/genindex.html" />
|
|
<script src="_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="_static/documentation_options.js?v=3b3401d5"></script>
|
|
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
|
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
|
<script src="_static/js/theme.js"></script>
|
|
<link rel="search" type="application/opensearchdescription+xml"
|
|
title="Search within tzst 1.3.3 Documentation"
|
|
href="_static/opensearch.xml"/>
|
|
<link rel="index" title="Index" href="#" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
|
|
<!-- Additional SEO and social meta tags -->
|
|
<meta name="application-name" content="tzst" />
|
|
<meta name="generator" content="Sphinx 9.1.0" />
|
|
<meta name="rating" content="General" />
|
|
<meta name="revisit-after" content="7 days" />
|
|
|
|
<!-- Schema.org markup for search engines -->
|
|
<script type="application/ld+json">
|
|
{
|
|
"@context": "https://schema.org",
|
|
"@type": "SoftwareApplication",
|
|
"name": "tzst",
|
|
"description": "A Python library for creating and extracting tar.zst archives with high performance and comprehensive features",
|
|
"applicationCategory": "DeveloperApplication",
|
|
"operatingSystem": "Cross-platform",
|
|
"programmingLanguage": "Python",
|
|
"license": "https://opensource.org/licenses/BSD-3-Clause",
|
|
"url": "https://tzst.xi-xu.me/",
|
|
"downloadUrl": "https://pypi.org/project/tzst/",
|
|
"codeRepository": "https://github.com/xixu-me/tzst",
|
|
"softwareVersion": "1.3.3",
|
|
"author": {
|
|
"@type": "Person",
|
|
"name": "Xi Xu",
|
|
"url": "https://xi-xu.me"
|
|
},
|
|
"offers": {
|
|
"@type": "Offer",
|
|
"price": "0",
|
|
"priceCurrency": "USD"
|
|
},
|
|
"aggregateRating": {
|
|
"@type": "AggregateRating",
|
|
"ratingValue": "5",
|
|
"reviewCount": "1"
|
|
},
|
|
"keywords": "tzst, tar, zstandard, compression, archive, python, extraction, backup"
|
|
}
|
|
</script>
|
|
|
|
<!-- Breadcrumb Schema -->
|
|
|
|
<script type="application/ld+json">
|
|
{
|
|
"@context": "https://schema.org",
|
|
"@type": "BreadcrumbList",
|
|
"itemListElement": [
|
|
{
|
|
"@type": "ListItem",
|
|
"position": 1,
|
|
"name": "Home",
|
|
"item": "https://tzst.xi-xu.me/"
|
|
},
|
|
{
|
|
"@type": "ListItem",
|
|
"position": 2,
|
|
"name": "Index",
|
|
"item": "https://tzst.xi-xu.me/genindex.html"
|
|
}
|
|
]
|
|
}
|
|
</script>
|
|
|
|
|
|
<!-- Article/TechArticle Schema for documentation pages -->
|
|
|
|
|
|
<!-- FAQ Schema for pages with common questions -->
|
|
|
|
|
|
<!-- HowTo Schema for examples page -->
|
|
|
|
|
|
<!-- Canonical URL for better SEO -->
|
|
|
|
<link rel="canonical" href="https://tzst.xi-xu.me/genindex.html" />
|
|
|
|
|
|
<!-- Preconnect to external domains for performance -->
|
|
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
<link rel="preconnect" href="https://cdnjs.cloudflare.com" />
|
|
<link rel="dns-prefetch" href="https://pypi.org" />
|
|
<link rel="dns-prefetch" href="https://github.com" />
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" style="background: #2980B9" >
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home">
|
|
tzst
|
|
<img src="_static/tzst-logo.png" class="logo" alt="Logo"/>
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start Guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="performance.html">Performance Guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API Reference</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="development.html">Development Guide</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Index</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #2980B9" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">tzst</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item active">Index</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/xixu-me/tzst/blob/main/docs/genindex" class="fa fa-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
|
|
<h1 id="index">Index</h1>
|
|
|
|
<div class="genindex-jumpbox">
|
|
<a href="#_"><strong>_</strong></a>
|
|
| <a href="#A"><strong>A</strong></a>
|
|
| <a href="#C"><strong>C</strong></a>
|
|
| <a href="#E"><strong>E</strong></a>
|
|
| <a href="#F"><strong>F</strong></a>
|
|
| <a href="#G"><strong>G</strong></a>
|
|
| <a href="#L"><strong>L</strong></a>
|
|
| <a href="#M"><strong>M</strong></a>
|
|
| <a href="#O"><strong>O</strong></a>
|
|
| <a href="#P"><strong>P</strong></a>
|
|
| <a href="#T"><strong>T</strong></a>
|
|
| <a href="#V"><strong>V</strong></a>
|
|
|
|
</div>
|
|
<h2 id="_">_</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.__enter__">__enter__() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.__exit__">__exit__() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
<li><a href="api/core.html#tzst.TzstArchive.__init__">__init__() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="A">A</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.add">add() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="C">C</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.close">close() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.create_archive">create_archive() (in module tzst)</a>
|
|
</li>
|
|
<li><a href="api/cli.html#tzst.cli.create_parser">create_parser() (in module tzst.cli)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="E">E</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.extract">extract() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
<li><a href="api/core.html#tzst.extract_archive">extract_archive() (in module tzst)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.extractall">extractall() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
<li><a href="api/core.html#tzst.TzstArchive.extractfile">extractfile() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="F">F</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/cli.html#tzst.cli.format_size">format_size() (in module tzst.cli)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="G">G</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.getmembers">getmembers() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.getnames">getnames() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="L">L</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.list">list() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.list_archive">list_archive() (in module tzst)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="M">M</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/cli.html#tzst.cli.main">main() (in module tzst.cli)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="O">O</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.open">open() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="P">P</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/cli.html#tzst.cli.print_banner">print_banner() (in module tzst.cli)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="T">T</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/core.html#tzst.TzstArchive.test">test() (tzst.TzstArchive method)</a>
|
|
</li>
|
|
<li><a href="api/core.html#tzst.test_archive">test_archive() (in module tzst)</a>
|
|
</li>
|
|
<li><a href="api/core.html#tzst.TzstArchive">TzstArchive (class in tzst)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/exceptions.html#tzst.exceptions.TzstArchiveError">TzstArchiveError</a>
|
|
</li>
|
|
<li><a href="api/exceptions.html#tzst.exceptions.TzstCompressionError">TzstCompressionError</a>
|
|
</li>
|
|
<li><a href="api/exceptions.html#tzst.exceptions.TzstDecompressionError">TzstDecompressionError</a>
|
|
</li>
|
|
<li><a href="api/exceptions.html#tzst.exceptions.TzstError">TzstError</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="V">V</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="api/cli.html#tzst.cli.validate_compression_level">validate_compression_level() (in module tzst.cli)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2026, Xi Xu.</p>
|
|
</div>
|
|
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |