Skip to content

Commit 5360c62

Browse files
GTofGTof
committed
Documentation: docstrings
1 parent c39b3b7 commit 5360c62

File tree

14 files changed

+5433
-72
lines changed

14 files changed

+5433
-72
lines changed

‎Makefile‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: test clean format check publish
1+
.PHONY: test clean format check publish docs
22

33
test:
44
python -m pytest
@@ -10,9 +10,14 @@ clean:
1010
format:
1111
black `find raffiot/ tests/ -iname "*.py" -type f`
1212

13-
check: format test clean
13+
check: format test docs clean
1414

1515
publish: check
1616
python setup.py sdist
1717
twine upload dist/*
1818

19+
docs:
20+
rm -r docs/ || true
21+
pdoc3 --html raffiot -o docs/
22+
mv docs/raffiot/* docs/
23+
rm -r docs/raffiot/

‎README.md‎

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,54 @@
1-
# raffiot.py
2-
Robust And Fast Functional IO Toolkit
1+
# Robust And Fast Functional IO Toolkit
2+
3+
*Raffiot* is small (almost) dependency-free python library providing some
4+
usual functional tools. It currently provides
5+
- an `IO` monad which is, stack-safe, fast and has many other features.
6+
- a `Resource` data type for easy but reliable resource management.
7+
- a `Result` data structure to represent errors
8+
9+
## API Documentation
10+
11+
Not yet online, but easy to access, just open `docs/index.html`.
12+
13+
## Features
14+
15+
- *pure python*: *Raffiot* is written entirely in Python 3.7+.
16+
- *small*: it is just a few small files.
17+
- *(almost) dependency-free*: it only depends on `typing-extensions` (for the
18+
`@final` annotation).
19+
- *crystal clear code*
20+
21+
### IO
22+
23+
- *stack safe*: you just won't run into stack overflows anymore.
24+
- *fast*: you won't notice the overhead.
25+
- *context aware*: easy dependency injection and configuration propagation.
26+
- *no None*: do you really like messages `'NoneType' object has to attribute xyz`?
27+
- *no exceptions*: but clean error handling.
28+
- *domain errors vs panics*: the API make a clear distinction between expected
29+
errors (that usually belongs to business domain) and unexpected errors
30+
(usually coming from bugs). Yes that's heavily inspired by *Rust*.
31+
32+
### Resource
33+
34+
Python has indeed the `with` construction, but `Resource` goes a step further.
35+
36+
- *easy user-defined resource creation*: just provide some open and close
37+
function.
38+
- *composability*: the resource you want to create depends on another resource?
39+
Not a problem, you can compose resources the way you want. It scales.
40+
- *error handling in resources*: `Resource` has everything `IO` has, including
41+
error management.
42+
43+
### Result
44+
45+
Very simple type, only 3 cases:
46+
47+
- `Ok(value)`: some value.
48+
- `Error(error)`: some busyness domain error (you choose the error type!).
49+
- `Panic(exception)`: when things go the unexpected way.
50+
51+
52+
53+
54+

‎conda/raffiot/meta.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% set name = "raffiot" %}
2-
{% set version = "0.0.3" %}
2+
{% set version = "0.0.4" %}
33

44
package:
55
name: "{{ name|lower }}"

‎docs/index.html‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
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.9.2" />
7+
<title>raffiot 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">Package <code>raffiot</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">from dataclasses import dataclass
30+
31+
32+
@dataclass
33+
class _MatchError(Exception):
34+
&#34;&#34;&#34;
35+
Exception for pattern matching errors (used internally, should NEVER happen).
36+
&#34;&#34;&#34;
37+
38+
message: str</code></pre>
39+
</details>
40+
</section>
41+
<section>
42+
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
43+
<dl>
44+
<dt><code class="name"><a title="raffiot.io" href="io.html">raffiot.io</a></code></dt>
45+
<dd>
46+
<div class="desc"><p>Data structure representing a computation.</p></div>
47+
</dd>
48+
<dt><code class="name"><a title="raffiot.resource" href="resource.html">raffiot.resource</a></code></dt>
49+
<dd>
50+
<div class="desc"><p>Resource management module.
51+
Ensure that create resources are always nicely released after use.</p></div>
52+
</dd>
53+
<dt><code class="name"><a title="raffiot.result" href="result.html">raffiot.result</a></code></dt>
54+
<dd>
55+
<div class="desc"><p>Data structure to represent the result of computation.</p></div>
56+
</dd>
57+
</dl>
58+
</section>
59+
<section>
60+
</section>
61+
<section>
62+
</section>
63+
<section>
64+
</section>
65+
</article>
66+
<nav id="sidebar">
67+
<h1>Index</h1>
68+
<div class="toc">
69+
<ul></ul>
70+
</div>
71+
<ul id="index">
72+
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
73+
<ul>
74+
<li><code><a title="raffiot.io" href="io.html">raffiot.io</a></code></li>
75+
<li><code><a title="raffiot.resource" href="resource.html">raffiot.resource</a></code></li>
76+
<li><code><a title="raffiot.result" href="result.html">raffiot.result</a></code></li>
77+
</ul>
78+
</li>
79+
</ul>
80+
</nav>
81+
</main>
82+
<footer id="footer">
83+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
84+
</footer>
85+
</body>
86+
</html>

0 commit comments

Comments
 (0)