pdocs v7

ValueRaider · Aug 23, 2024 · 772f404 · 772f404
1 parent e6177db
commit 772f404
Show file tree

Hide file tree

Showing 12 changed files with 12,221 additions and 453 deletions.
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/yfinance_cache/index.html b/docs/yfinance_cache/index.html
diff --git a/docs/yfinance_cache/yfc_cache_manager.html b/docs/yfinance_cache/yfc_cache_manager.html
@@ -0,0 +1,259 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>yfinance_cache.yfc_cache_manager API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>yfinance_cache.yfc_cache_manager</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="yfinance_cache.yfc_cache_manager.GetCacheDirpath"><code class="name flex">
+<span>def <span class="ident">GetCacheDirpath</span></span>(<span>)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.GetFilepath"><code class="name flex">
+<span>def <span class="ident">GetFilepath</span></span>(<span>ticker, objectName, obj=None, prune=False)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.GetFilepathPacked"><code class="name flex">
+<span>def <span class="ident">GetFilepathPacked</span></span>(<span>ticker, objectName)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.GetPackedDataCat"><code class="name flex">
+<span>def <span class="ident">GetPackedDataCat</span></span>(<span>objectName)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.IsDatumCached"><code class="name flex">
+<span>def <span class="ident">IsDatumCached</span></span>(<span>ticker, objectName)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.IsObjectInPackedData"><code class="name flex">
+<span>def <span class="ident">IsObjectInPackedData</span></span>(<span>objectName)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.ReadCacheDatum"><code class="name flex">
+<span>def <span class="ident">ReadCacheDatum</span></span>(<span>ticker, objectName, return_metadata_too=False)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.ReadCacheMetadata"><code class="name flex">
+<span>def <span class="ident">ReadCacheMetadata</span></span>(<span>ticker, objectName, key)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.ReadCachePackedDatum"><code class="name flex">
+<span>def <span class="ident">ReadCachePackedDatum</span></span>(<span>ticker, objectName, return_metadata_too=False)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.ResetCacheDirpath"><code class="name flex">
+<span>def <span class="ident">ResetCacheDirpath</span></span>(<span>)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.SetCacheDirpath"><code class="name flex">
+<span>def <span class="ident">SetCacheDirpath</span></span>(<span>dp)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.StoreCacheDatum"><code class="name flex">
+<span>def <span class="ident">StoreCacheDatum</span></span>(<span>ticker, objectName, datum, expiry=None, metadata=None)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.StoreCachePackedDatum"><code class="name flex">
+<span>def <span class="ident">StoreCachePackedDatum</span></span>(<span>ticker, objectName, datum, expiry=None, metadata=None)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.WriteCacheMetadata"><code class="name flex">
+<span>def <span class="ident">WriteCacheMetadata</span></span>(<span>ticker, objectName, key, value)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.WriteCachePackedMetadata"><code class="name flex">
+<span>def <span class="ident">WriteCachePackedMetadata</span></span>(<span>ticker, objectName, key, value)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="yfinance_cache.yfc_cache_manager.NestedOptions"><code class="flex name class">
+<span>class <span class="ident">NestedOptions</span></span>
+<span>(</span><span>name, data)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class NestedOptions:
+    def __init__(self, name, data):
+        self.__dict__[&#39;name&#39;] = name
+        self.__dict__[&#39;data&#39;] = data
+
+    def __getattr__(self, key):
+        return self.data.get(key)
+
+    def __setattr__(self, key, value):
+        if self.name == &#39;max_ages&#39;:
+            # Type-check value
+            pd.Timedelta(value)
+
+        self.data[key] = value
+        global _option_manager
+        _option_manager._save_option()
+
+    def __len__(self):
+        return len(self.__dict__[&#39;data&#39;])
+
+    def __repr__(self):
+        return json.dumps(self.data, indent=4)</code></pre>
+</details>
+</dd>
+<dt id="yfinance_cache.yfc_cache_manager.OptionsManager"><code class="flex name class">
+<span>class <span class="ident">OptionsManager</span></span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class OptionsManager:
+    def __init__(self):
+        self._initialised = False
+
+    def _load_option(self):
+        self._initialised = True  # prevent infinite loop
+        d = GetCacheDirpath()
+        self.option_file = os.path.join(d, &#39;options.json&#39;)
+        try:
+            with open(self.option_file, &#39;r&#39;) as file:
+                self.options = json.load(file)
+        except (FileNotFoundError, json.JSONDecodeError):
+            self.options = {}
+            # Initialise
+            self.__getattr__(&#39;max_ages&#39;).calendar = &#39;7d&#39;
+            self.__getattr__(&#39;max_ages&#39;).info = &#39;45d&#39;
+
+    def _save_option(self):
+        with open(self.option_file, &#39;w&#39;) as file:
+            json.dump(self.options, file, indent=4)
+
+    def __getattr__(self, key):
+        if not self._initialised:
+            self._load_option()
+
+        if key not in self.options:
+            self.options[key] = {}
+        return NestedOptions(key, self.options[key])
+
+    def __repr__(self):
+        if not self._initialised:
+            self._load_option()
+
+        return json.dumps(self.options, indent=4)</code></pre>
+</details>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="yfinance_cache" href="index.html">yfinance_cache</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="yfinance_cache.yfc_cache_manager.GetCacheDirpath" href="#yfinance_cache.yfc_cache_manager.GetCacheDirpath">GetCacheDirpath</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.GetFilepath" href="#yfinance_cache.yfc_cache_manager.GetFilepath">GetFilepath</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.GetFilepathPacked" href="#yfinance_cache.yfc_cache_manager.GetFilepathPacked">GetFilepathPacked</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.GetPackedDataCat" href="#yfinance_cache.yfc_cache_manager.GetPackedDataCat">GetPackedDataCat</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.IsDatumCached" href="#yfinance_cache.yfc_cache_manager.IsDatumCached">IsDatumCached</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.IsObjectInPackedData" href="#yfinance_cache.yfc_cache_manager.IsObjectInPackedData">IsObjectInPackedData</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.ReadCacheDatum" href="#yfinance_cache.yfc_cache_manager.ReadCacheDatum">ReadCacheDatum</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.ReadCacheMetadata" href="#yfinance_cache.yfc_cache_manager.ReadCacheMetadata">ReadCacheMetadata</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.ReadCachePackedDatum" href="#yfinance_cache.yfc_cache_manager.ReadCachePackedDatum">ReadCachePackedDatum</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.ResetCacheDirpath" href="#yfinance_cache.yfc_cache_manager.ResetCacheDirpath">ResetCacheDirpath</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.SetCacheDirpath" href="#yfinance_cache.yfc_cache_manager.SetCacheDirpath">SetCacheDirpath</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.StoreCacheDatum" href="#yfinance_cache.yfc_cache_manager.StoreCacheDatum">StoreCacheDatum</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.StoreCachePackedDatum" href="#yfinance_cache.yfc_cache_manager.StoreCachePackedDatum">StoreCachePackedDatum</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.WriteCacheMetadata" href="#yfinance_cache.yfc_cache_manager.WriteCacheMetadata">WriteCacheMetadata</a></code></li>
+<li><code><a title="yfinance_cache.yfc_cache_manager.WriteCachePackedMetadata" href="#yfinance_cache.yfc_cache_manager.WriteCachePackedMetadata">WriteCachePackedMetadata</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="yfinance_cache.yfc_cache_manager.NestedOptions" href="#yfinance_cache.yfc_cache_manager.NestedOptions">NestedOptions</a></code></h4>
+</li>
+<li>
+<h4><code><a title="yfinance_cache.yfc_cache_manager.OptionsManager" href="#yfinance_cache.yfc_cache_manager.OptionsManager">OptionsManager</a></code></h4>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>