release 0.1.0

metaist · Sep 23, 2021 · f91b134 · f91b134
1 parent 6472f61
commit f91b134
Show file tree

Hide file tree

Showing 7 changed files with 2,377 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog] and this project adheres to [Semantic Versioning].
+
+[keep a changelog]: http://keepachangelog.com/en/1.0.0/
+[semantic versioning]: http://semver.org/spec/v2.0.0.html
+
+---
+
+## [Unreleased]
+
+[unreleased]: https://github.com/metaist/attrbox/compare/production...main
+
+These are changes that are on `main` that are not yet in `production`.
+
+---
+
+## [0.1.0] - 2021-09-23T20:06:43Z
+
+[0.1.0]: https://github.com/metaist/attrbox/commits/0.1.0
+
+Initial release.
diff --git a/docs/attrbox/attrdict.html b/docs/attrbox/attrdict.html
diff --git a/docs/attrbox/attrlist.html b/docs/attrbox/attrlist.html
@@ -0,0 +1,334 @@
+<!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>attrbox.attrlist API documentation</title>
+<meta name="description" content="Attribute-based list." />
+<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>attrbox.attrlist</code></h1>
+</header>
+<section id="section-intro">
+<p>Attribute-based list.</p>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">#!/usr/bin/env python
+# coding: utf-8
+&#34;&#34;&#34;Attribute-based list.&#34;&#34;&#34;
+
+# native
+from typing import Any, Callable, List, Union
+from operator import attrgetter
+
+
+class AttrList(List[Any]):
+    &#34;&#34;&#34;Like a `list`, but with easy-to-query attributes of members.&#34;&#34;&#34;
+
+    def __getattr__(self, name: str) -&gt; List[Any]:
+        &#34;&#34;&#34;Return a list of the this attribute in the contained members.
+
+
+        Examples:
+            &gt;&gt;&gt; from . import AttrDict
+            &gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=3, b=4)])
+            &gt;&gt;&gt; items.a
+            [1, 2, 3]
+            &gt;&gt;&gt; items.b
+            [None, None, 4]
+        &#34;&#34;&#34;
+        return self.attr(name, first=False, unique=False)
+
+    def attr(
+        self, attrs: Union[str, List[str]], first: bool = False, unique: bool = False
+    ) -&gt; Union[Any, List[Any]]:
+        &#34;&#34;&#34;Return the attribute value of the contained members.
+
+        Args:
+            attrs (list[str]): attributes to extract
+            first (bool): get first value or None if there are none (default: False)
+            unique (bool): only return unique values (default: False)
+
+        Returns:
+            (Any or list[Any]): the values of the attribute
+
+        Examples:
+            &gt;&gt;&gt; from . import AttrDict
+            &gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=1, b=4)])
+            &gt;&gt;&gt; items.attr([&#34;a&#34;, &#34;b&#34;])
+            [(1, None), (2, None), (1, 4)]
+
+            &gt;&gt;&gt; items.attr(&#34;a&#34;, first=True)
+            1
+
+            &gt;&gt;&gt; items.attr(&#34;a&#34;, unique=True)
+            [1, 2]
+        &#34;&#34;&#34;
+        if isinstance(attrs, str):
+            attrs = [attrs]
+
+        key = attrgetter(*attrs)
+        if first:  # short-circuit
+            return key(self[0]) if self else None
+
+        result = [key(member) for member in self]
+        if unique:
+            result = list(dict.fromkeys(result))
+        return result
+
+    def find(self, predicate: Callable[[Any], bool]) -&gt; &#34;AttrList&#34;:
+        &#34;&#34;&#34;Return a new AttrList of atom where `predicate` returns `True`.
+
+        Examples:
+            &gt;&gt;&gt; from . import AttrDict
+            &gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=3, b=4)])
+            &gt;&gt;&gt; isodd = lambda m: m.a % 2 == 1
+            &gt;&gt;&gt; items.find(isodd).a
+            [1, 3]
+        &#34;&#34;&#34;
+        cls = self.__class__
+        return cls([member for member in self if predicate(member)])</code></pre>
+</details>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="attrbox.attrlist.AttrList"><code class="flex name class">
+<span>class <span class="ident">AttrList</span></span>
+<span>(</span><span>*args, **kwargs)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Like a <code>list</code>, but with easy-to-query attributes of members.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class AttrList(List[Any]):
+    &#34;&#34;&#34;Like a `list`, but with easy-to-query attributes of members.&#34;&#34;&#34;
+
+    def __getattr__(self, name: str) -&gt; List[Any]:
+        &#34;&#34;&#34;Return a list of the this attribute in the contained members.
+
+
+        Examples:
+            &gt;&gt;&gt; from . import AttrDict
+            &gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=3, b=4)])
+            &gt;&gt;&gt; items.a
+            [1, 2, 3]
+            &gt;&gt;&gt; items.b
+            [None, None, 4]
+        &#34;&#34;&#34;
+        return self.attr(name, first=False, unique=False)
+
+    def attr(
+        self, attrs: Union[str, List[str]], first: bool = False, unique: bool = False
+    ) -&gt; Union[Any, List[Any]]:
+        &#34;&#34;&#34;Return the attribute value of the contained members.
+
+        Args:
+            attrs (list[str]): attributes to extract
+            first (bool): get first value or None if there are none (default: False)
+            unique (bool): only return unique values (default: False)
+
+        Returns:
+            (Any or list[Any]): the values of the attribute
+
+        Examples:
+            &gt;&gt;&gt; from . import AttrDict
+            &gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=1, b=4)])
+            &gt;&gt;&gt; items.attr([&#34;a&#34;, &#34;b&#34;])
+            [(1, None), (2, None), (1, 4)]
+
+            &gt;&gt;&gt; items.attr(&#34;a&#34;, first=True)
+            1
+
+            &gt;&gt;&gt; items.attr(&#34;a&#34;, unique=True)
+            [1, 2]
+        &#34;&#34;&#34;
+        if isinstance(attrs, str):
+            attrs = [attrs]
+
+        key = attrgetter(*attrs)
+        if first:  # short-circuit
+            return key(self[0]) if self else None
+
+        result = [key(member) for member in self]
+        if unique:
+            result = list(dict.fromkeys(result))
+        return result
+
+    def find(self, predicate: Callable[[Any], bool]) -&gt; &#34;AttrList&#34;:
+        &#34;&#34;&#34;Return a new AttrList of atom where `predicate` returns `True`.
+
+        Examples:
+            &gt;&gt;&gt; from . import AttrDict
+            &gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=3, b=4)])
+            &gt;&gt;&gt; isodd = lambda m: m.a % 2 == 1
+            &gt;&gt;&gt; items.find(isodd).a
+            [1, 3]
+        &#34;&#34;&#34;
+        cls = self.__class__
+        return cls([member for member in self if predicate(member)])</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>builtins.list</li>
+<li>typing.Generic</li>
+</ul>
+<h3>Methods</h3>
+<dl>
+<dt id="attrbox.attrlist.AttrList.attr"><code class="name flex">
+<span>def <span class="ident">attr</span></span>(<span>self, attrs: Union[str, List[str]], first: bool = False, unique: bool = False) ‑> Union[Any, List[Any]]</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Return the attribute value of the contained members.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>attrs</code></strong> :&ensp;<code>list[str]</code></dt>
+<dd>attributes to extract</dd>
+<dt><strong><code>first</code></strong> :&ensp;<code>bool</code></dt>
+<dd>get first value or None if there are none (default: False)</dd>
+<dt><strong><code>unique</code></strong> :&ensp;<code>bool</code></dt>
+<dd>only return unique values (default: False)</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<p>(Any or list[Any]): the values of the attribute</p>
+<h2 id="examples">Examples</h2>
+<pre><code class="language-python-repl">&gt;&gt;&gt; from . import AttrDict
+&gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=1, b=4)])
+&gt;&gt;&gt; items.attr([&quot;a&quot;, &quot;b&quot;])
+[(1, None), (2, None), (1, 4)]
+</code></pre>
+<pre><code class="language-python-repl">&gt;&gt;&gt; items.attr(&quot;a&quot;, first=True)
+1
+</code></pre>
+<pre><code class="language-python-repl">&gt;&gt;&gt; items.attr(&quot;a&quot;, unique=True)
+[1, 2]
+</code></pre></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def attr(
+    self, attrs: Union[str, List[str]], first: bool = False, unique: bool = False
+) -&gt; Union[Any, List[Any]]:
+    &#34;&#34;&#34;Return the attribute value of the contained members.
+
+    Args:
+        attrs (list[str]): attributes to extract
+        first (bool): get first value or None if there are none (default: False)
+        unique (bool): only return unique values (default: False)
+
+    Returns:
+        (Any or list[Any]): the values of the attribute
+
+    Examples:
+        &gt;&gt;&gt; from . import AttrDict
+        &gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=1, b=4)])
+        &gt;&gt;&gt; items.attr([&#34;a&#34;, &#34;b&#34;])
+        [(1, None), (2, None), (1, 4)]
+
+        &gt;&gt;&gt; items.attr(&#34;a&#34;, first=True)
+        1
+
+        &gt;&gt;&gt; items.attr(&#34;a&#34;, unique=True)
+        [1, 2]
+    &#34;&#34;&#34;
+    if isinstance(attrs, str):
+        attrs = [attrs]
+
+    key = attrgetter(*attrs)
+    if first:  # short-circuit
+        return key(self[0]) if self else None
+
+    result = [key(member) for member in self]
+    if unique:
+        result = list(dict.fromkeys(result))
+    return result</code></pre>
+</details>
+</dd>
+<dt id="attrbox.attrlist.AttrList.find"><code class="name flex">
+<span>def <span class="ident">find</span></span>(<span>self, predicate: Callable[[Any], bool]) ‑> <a title="attrbox.attrlist.AttrList" href="#attrbox.attrlist.AttrList">AttrList</a></span>
+</code></dt>
+<dd>
+<div class="desc"><p>Return a new AttrList of atom where <code>predicate</code> returns <code>True</code>.</p>
+<h2 id="examples">Examples</h2>
+<pre><code class="language-python-repl">&gt;&gt;&gt; from . import AttrDict
+&gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=3, b=4)])
+&gt;&gt;&gt; isodd = lambda m: m.a % 2 == 1
+&gt;&gt;&gt; items.find(isodd).a
+[1, 3]
+</code></pre></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def find(self, predicate: Callable[[Any], bool]) -&gt; &#34;AttrList&#34;:
+    &#34;&#34;&#34;Return a new AttrList of atom where `predicate` returns `True`.
+
+    Examples:
+        &gt;&gt;&gt; from . import AttrDict
+        &gt;&gt;&gt; items = AttrList([AttrDict(a=1), AttrDict(a=2), AttrDict(a=3, b=4)])
+        &gt;&gt;&gt; isodd = lambda m: m.a % 2 == 1
+        &gt;&gt;&gt; items.find(isodd).a
+        [1, 3]
+    &#34;&#34;&#34;
+    cls = self.__class__
+    return cls([member for member in self if predicate(member)])</code></pre>
+</details>
+</dd>
+</dl>
+</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="attrbox" href="index.html">attrbox</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="attrbox.attrlist.AttrList" href="#attrbox.attrlist.AttrList">AttrList</a></code></h4>
+<ul class="">
+<li><code><a title="attrbox.attrlist.AttrList.attr" href="#attrbox.attrlist.AttrList.attr">attr</a></code></li>
+<li><code><a title="attrbox.attrlist.AttrList.find" href="#attrbox.attrlist.AttrList.find">find</a></code></li>
+</ul>
+</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>