-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ 94606fd 🚀
- Loading branch information
1 parent
8b9ecdd
commit 82e9bdb
Showing
3 changed files
with
368 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,233 @@ | ||
<!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="pdoc 0.10.0" /> | ||
<title>fhir_utils.conf API documentation</title> | ||
<meta name="description" content="" /> | ||
<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> | ||
<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> | ||
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin> | ||
<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> | ||
<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> | ||
<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/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script> | ||
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script> | ||
</head> | ||
<body> | ||
<main> | ||
<article id="content"> | ||
<header> | ||
<h1 class="title">Module <code>fhir_utils.conf</code></h1> | ||
</header> | ||
<section id="section-intro"> | ||
<details class="source"> | ||
<summary> | ||
<span>Expand source code</span> | ||
</summary> | ||
<pre><code class="python"># -*- coding: utf-8 -*- | ||
from os import getenv | ||
from typing import Callable, Union | ||
|
||
from loguru import logger | ||
|
||
|
||
def getenv_or_action( | ||
key: str, action: Union[Callable[[str], str], str], default: str = None | ||
) -> str: | ||
""" | ||
Get an environment variable or execute an action. | ||
|
||
Args: | ||
key (str): The name of the environment variable. | ||
action (Union[Callable[[str], str], str]): The action to execute if the | ||
environment variable is not set. Can be a callable or a string. If a | ||
callable is provided, it will be called with the key as the only | ||
argument. If a string is provided, it will check if this callback | ||
is implemented here and call it. If not, it will raise an exception. | ||
default (str, optional): The default value to return if the environment | ||
variable is not set and no action is provided. Defaults to None. | ||
|
||
Returns: | ||
str: The value of the environment variable or the result of the action. | ||
""" | ||
|
||
def _raise(key: str) -> str: | ||
raise Exception( | ||
f"Environment variable {key} is not set and no action is provided." | ||
) | ||
|
||
def _warn(key: str) -> str: | ||
logger.warning(f"Environment variable {key} is not set. Using default value.") | ||
return default | ||
|
||
def _pass(key: str) -> str: | ||
return default | ||
|
||
_val = getenv(key) | ||
if _val is None: | ||
if action in [None, "pass"]: | ||
return _pass(key) | ||
elif callable(action): | ||
return action(key) | ||
elif isinstance(action, str): | ||
if action == "raise": | ||
return _raise(key) | ||
elif action == "warn": | ||
return _warn(key) | ||
else: | ||
raise ValueError( | ||
f'Action "{action}" is not implemented in getenv_or_action.' | ||
) | ||
else: | ||
return default | ||
return _val | ||
|
||
|
||
class Settings: | ||
__slots__ = () | ||
|
||
|
||
settings = Settings()</code></pre> | ||
</details> | ||
</section> | ||
<section> | ||
</section> | ||
<section> | ||
</section> | ||
<section> | ||
<h2 class="section-title" id="header-functions">Functions</h2> | ||
<dl> | ||
<dt id="fhir_utils.conf.getenv_or_action"><code class="name flex"> | ||
<span>def <span class="ident">getenv_or_action</span></span>(<span>key: str, action: Union[Callable[[str], str], str], default: str = None) ‑> str</span> | ||
</code></dt> | ||
<dd> | ||
<div class="desc"><p>Get an environment variable or execute an action.</p> | ||
<h2 id="args">Args</h2> | ||
<dl> | ||
<dt><strong><code>key</code></strong> : <code>str</code></dt> | ||
<dd>The name of the environment variable.</dd> | ||
<dt><strong><code>action</code></strong> : <code>Union[Callable[[str], str], str]</code></dt> | ||
<dd>The action to execute if the | ||
environment variable is not set. Can be a callable or a string. If a | ||
callable is provided, it will be called with the key as the only | ||
argument. If a string is provided, it will check if this callback | ||
is implemented here and call it. If not, it will raise an exception.</dd> | ||
<dt><strong><code>default</code></strong> : <code>str</code>, optional</dt> | ||
<dd>The default value to return if the environment | ||
variable is not set and no action is provided. Defaults to None.</dd> | ||
</dl> | ||
<h2 id="returns">Returns</h2> | ||
<dl> | ||
<dt><code>str</code></dt> | ||
<dd>The value of the environment variable or the result of the action.</dd> | ||
</dl></div> | ||
<details class="source"> | ||
<summary> | ||
<span>Expand source code</span> | ||
</summary> | ||
<pre><code class="python">def getenv_or_action( | ||
key: str, action: Union[Callable[[str], str], str], default: str = None | ||
) -> str: | ||
""" | ||
Get an environment variable or execute an action. | ||
|
||
Args: | ||
key (str): The name of the environment variable. | ||
action (Union[Callable[[str], str], str]): The action to execute if the | ||
environment variable is not set. Can be a callable or a string. If a | ||
callable is provided, it will be called with the key as the only | ||
argument. If a string is provided, it will check if this callback | ||
is implemented here and call it. If not, it will raise an exception. | ||
default (str, optional): The default value to return if the environment | ||
variable is not set and no action is provided. Defaults to None. | ||
|
||
Returns: | ||
str: The value of the environment variable or the result of the action. | ||
""" | ||
|
||
def _raise(key: str) -> str: | ||
raise Exception( | ||
f"Environment variable {key} is not set and no action is provided." | ||
) | ||
|
||
def _warn(key: str) -> str: | ||
logger.warning(f"Environment variable {key} is not set. Using default value.") | ||
return default | ||
|
||
def _pass(key: str) -> str: | ||
return default | ||
|
||
_val = getenv(key) | ||
if _val is None: | ||
if action in [None, "pass"]: | ||
return _pass(key) | ||
elif callable(action): | ||
return action(key) | ||
elif isinstance(action, str): | ||
if action == "raise": | ||
return _raise(key) | ||
elif action == "warn": | ||
return _warn(key) | ||
else: | ||
raise ValueError( | ||
f'Action "{action}" is not implemented in getenv_or_action.' | ||
) | ||
else: | ||
return default | ||
return _val</code></pre> | ||
</details> | ||
</dd> | ||
</dl> | ||
</section> | ||
<section> | ||
<h2 class="section-title" id="header-classes">Classes</h2> | ||
<dl> | ||
<dt id="fhir_utils.conf.Settings"><code class="flex name class"> | ||
<span>class <span class="ident">Settings</span></span> | ||
</code></dt> | ||
<dd> | ||
<div class="desc"></div> | ||
<details class="source"> | ||
<summary> | ||
<span>Expand source code</span> | ||
</summary> | ||
<pre><code class="python">class Settings: | ||
__slots__ = ()</code></pre> | ||
</details> | ||
</dd> | ||
</dl> | ||
</section> | ||
</article> | ||
<nav id="sidebar"> | ||
<h1>Index</h1> | ||
<div class="toc"> | ||
<ul></ul> | ||
</div> | ||
<ul id="index"> | ||
<li><h3>Super-module</h3> | ||
<ul> | ||
<li><code><a title="fhir_utils" href="index.html">fhir_utils</a></code></li> | ||
</ul> | ||
</li> | ||
<li><h3><a href="#header-functions">Functions</a></h3> | ||
<ul class=""> | ||
<li><code><a title="fhir_utils.conf.getenv_or_action" href="#fhir_utils.conf.getenv_or_action">getenv_or_action</a></code></li> | ||
</ul> | ||
</li> | ||
<li><h3><a href="#header-classes">Classes</a></h3> | ||
<ul> | ||
<li> | ||
<h4><code><a title="fhir_utils.conf.Settings" href="#fhir_utils.conf.Settings">Settings</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.10.0</a>.</p> | ||
</footer> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
<!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="pdoc 0.10.0" /> | ||
<title>fhir_utils API documentation</title> | ||
<meta name="description" content="" /> | ||
<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> | ||
<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> | ||
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin> | ||
<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> | ||
<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> | ||
<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/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script> | ||
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script> | ||
</head> | ||
<body> | ||
<main> | ||
<article id="content"> | ||
<header> | ||
<h1 class="title">Package <code>fhir_utils</code></h1> | ||
</header> | ||
<section id="section-intro"> | ||
<details class="source"> | ||
<summary> | ||
<span>Expand source code</span> | ||
</summary> | ||
<pre><code class="python"># -*- coding: utf-8 -*- | ||
from .conf import settings # noqa | ||
from .version import __version__ # noqa</code></pre> | ||
</details> | ||
</section> | ||
<section> | ||
<h2 class="section-title" id="header-submodules">Sub-modules</h2> | ||
<dl> | ||
<dt><code class="name"><a title="fhir_utils.conf" href="conf.html">fhir_utils.conf</a></code></dt> | ||
<dd> | ||
<div class="desc"></div> | ||
</dd> | ||
<dt><code class="name"><a title="fhir_utils.version" href="version.html">fhir_utils.version</a></code></dt> | ||
<dd> | ||
<div class="desc"></div> | ||
</dd> | ||
</dl> | ||
</section> | ||
<section> | ||
</section> | ||
<section> | ||
</section> | ||
<section> | ||
</section> | ||
</article> | ||
<nav id="sidebar"> | ||
<h1>Index</h1> | ||
<div class="toc"> | ||
<ul></ul> | ||
</div> | ||
<ul id="index"> | ||
<li><h3><a href="#header-submodules">Sub-modules</a></h3> | ||
<ul> | ||
<li><code><a title="fhir_utils.conf" href="conf.html">fhir_utils.conf</a></code></li> | ||
<li><code><a title="fhir_utils.version" href="version.html">fhir_utils.version</a></code></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.10.0</a>.</p> | ||
</footer> | ||
</body> | ||
</html> |
Oops, something went wrong.