|
| 1 | +<!doctype html> |
| 2 | +<html lang="en"> |
| 3 | +<head> |
| 4 | +<meta charset="utf-8"> |
| 5 | +<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" /> |
| 6 | +<meta name="generator" content="pdoc 0.10.0" /> |
| 7 | +<title>codeflare_sdk.utils.demos API documentation</title> |
| 8 | +<meta name="description" content="" /> |
| 9 | +<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin> |
| 10 | +<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin> |
| 11 | +<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin> |
| 12 | +<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;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:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 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 .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#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-weight:bold;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 .5em;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> |
| 13 | +<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}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style> |
| 14 | +<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> |
| 15 | +<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script> |
| 16 | +<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script> |
| 17 | +</head> |
| 18 | +<body> |
| 19 | +<main> |
| 20 | +<article id="content"> |
| 21 | +<header> |
| 22 | +<h1 class="title">Module <code>codeflare_sdk.utils.demos</code></h1> |
| 23 | +</header> |
| 24 | +<section id="section-intro"> |
| 25 | +<details class="source"> |
| 26 | +<summary> |
| 27 | +<span>Expand source code</span> |
| 28 | +</summary> |
| 29 | +<pre><code class="python">import pathlib |
| 30 | +import shutil |
| 31 | + |
| 32 | +package_dir = pathlib.Path(__file__).parent.parent.resolve() |
| 33 | +demo_dir = f"{package_dir}/demo-notebooks" |
| 34 | + |
| 35 | + |
| 36 | +def copy_demo_nbs(dir: str = "./demo-notebooks", overwrite: bool = False): |
| 37 | + """ |
| 38 | + Copy the demo notebooks from the package to the current working directory |
| 39 | + |
| 40 | + overwrite=True will overwrite any files that exactly match files written by copy_demo_nbs in the target directory. |
| 41 | + Any files that exist in the directory that don't match these values will remain untouched. |
| 42 | + |
| 43 | + Args: |
| 44 | + dir (str): The directory to copy the demo notebooks to. Defaults to "./demo-notebooks". overwrite (bool): |
| 45 | + overwrite (bool): Whether to overwrite files in the directory if it already exists. Defaults to False. |
| 46 | + Raises: |
| 47 | + FileExistsError: If the directory already exists. |
| 48 | + """ |
| 49 | + # does dir exist already? |
| 50 | + if overwrite is False and pathlib.Path(dir).exists(): |
| 51 | + raise FileExistsError( |
| 52 | + f"Directory {dir} already exists. Please remove it or provide a different location." |
| 53 | + ) |
| 54 | + |
| 55 | + shutil.copytree(demo_dir, dir, dirs_exist_ok=True)</code></pre> |
| 56 | +</details> |
| 57 | +</section> |
| 58 | +<section> |
| 59 | +</section> |
| 60 | +<section> |
| 61 | +</section> |
| 62 | +<section> |
| 63 | +<h2 class="section-title" id="header-functions">Functions</h2> |
| 64 | +<dl> |
| 65 | +<dt id="codeflare_sdk.utils.demos.copy_demo_nbs"><code class="name flex"> |
| 66 | +<span>def <span class="ident">copy_demo_nbs</span></span>(<span>dir: str = './demo-notebooks', overwrite: bool = False)</span> |
| 67 | +</code></dt> |
| 68 | +<dd> |
| 69 | +<div class="desc"><p>Copy the demo notebooks from the package to the current working directory</p> |
| 70 | +<p>overwrite=True will overwrite any files that exactly match files written by copy_demo_nbs in the target directory. |
| 71 | +Any files that exist in the directory that don't match these values will remain untouched.</p> |
| 72 | +<h2 id="args">Args</h2> |
| 73 | +<dl> |
| 74 | +<dt><strong><code>dir</code></strong> : <code>str</code></dt> |
| 75 | +<dd>The directory to copy the demo notebooks to. Defaults to "./demo-notebooks". overwrite (bool):</dd> |
| 76 | +<dt><strong><code>overwrite</code></strong> : <code>bool</code></dt> |
| 77 | +<dd>Whether to overwrite files in the directory if it already exists. Defaults to False.</dd> |
| 78 | +</dl> |
| 79 | +<h2 id="raises">Raises</h2> |
| 80 | +<dl> |
| 81 | +<dt><code>FileExistsError</code></dt> |
| 82 | +<dd>If the directory already exists.</dd> |
| 83 | +</dl></div> |
| 84 | +<details class="source"> |
| 85 | +<summary> |
| 86 | +<span>Expand source code</span> |
| 87 | +</summary> |
| 88 | +<pre><code class="python">def copy_demo_nbs(dir: str = "./demo-notebooks", overwrite: bool = False): |
| 89 | + """ |
| 90 | + Copy the demo notebooks from the package to the current working directory |
| 91 | + |
| 92 | + overwrite=True will overwrite any files that exactly match files written by copy_demo_nbs in the target directory. |
| 93 | + Any files that exist in the directory that don't match these values will remain untouched. |
| 94 | + |
| 95 | + Args: |
| 96 | + dir (str): The directory to copy the demo notebooks to. Defaults to "./demo-notebooks". overwrite (bool): |
| 97 | + overwrite (bool): Whether to overwrite files in the directory if it already exists. Defaults to False. |
| 98 | + Raises: |
| 99 | + FileExistsError: If the directory already exists. |
| 100 | + """ |
| 101 | + # does dir exist already? |
| 102 | + if overwrite is False and pathlib.Path(dir).exists(): |
| 103 | + raise FileExistsError( |
| 104 | + f"Directory {dir} already exists. Please remove it or provide a different location." |
| 105 | + ) |
| 106 | + |
| 107 | + shutil.copytree(demo_dir, dir, dirs_exist_ok=True)</code></pre> |
| 108 | +</details> |
| 109 | +</dd> |
| 110 | +</dl> |
| 111 | +</section> |
| 112 | +<section> |
| 113 | +</section> |
| 114 | +</article> |
| 115 | +<nav id="sidebar"> |
| 116 | +<h1>Index</h1> |
| 117 | +<div class="toc"> |
| 118 | +<ul></ul> |
| 119 | +</div> |
| 120 | +<ul id="index"> |
| 121 | +<li><h3>Super-module</h3> |
| 122 | +<ul> |
| 123 | +<li><code><a title="codeflare_sdk.utils" href="index.html">codeflare_sdk.utils</a></code></li> |
| 124 | +</ul> |
| 125 | +</li> |
| 126 | +<li><h3><a href="#header-functions">Functions</a></h3> |
| 127 | +<ul class=""> |
| 128 | +<li><code><a title="codeflare_sdk.utils.demos.copy_demo_nbs" href="#codeflare_sdk.utils.demos.copy_demo_nbs">copy_demo_nbs</a></code></li> |
| 129 | +</ul> |
| 130 | +</li> |
| 131 | +</ul> |
| 132 | +</nav> |
| 133 | +</main> |
| 134 | +<footer id="footer"> |
| 135 | +<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p> |
| 136 | +</footer> |
| 137 | +</body> |
| 138 | +</html> |
![openshift-merge-bot[bot]](https://avatars.githubusercontent.com/in/412865?v=4&size=40){kind=avatar}
0 commit comments