docs/boards.html
<!---- Copyright (C) 2020 Arm Mbed. All rights reserved.-- SPDX-License-Identifier: Apache-2.0--><!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.8.4" /><title>mbed_targets.boards API documentation</title><meta name="description" content="Interface to the Board Database." /><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/9.18.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/9.18.1/highlight.min.js" integrity="sha256-eOgo0OtLL4cdq7RdwRUiGKLX9XsIJ7nGhWEKbohmVAQ=" crossorigin></script><script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script></head><body><main><article id="content"><header><h1 class="title">Module <code>mbed_targets.boards</code></h1></header><section id="section-intro"><p>Interface to the Board Database.</p><details class="source"><summary><span>Expand source code</span></summary><pre><code class="python">## Copyright (C) 2020 Arm Mbed. All rights reserved.# SPDX-License-Identifier: Apache-2.0#"""Interface to the Board Database."""import json from dataclasses import asdictfrom collections.abc import Setfrom typing import Iterator, Iterable, Any, Callable from mbed_targets._internal import board_database from mbed_targets.exceptions import UnknownBoardfrom mbed_targets.board import Board class Boards(Set): """Interface to the Board Database. Boards is initialised with an Iterable[Board]. The classmethods can be used to construct Boards with data from either the online or offline database. """ @classmethod def from_offline_database(cls) -> "Boards": """Initialise with the offline board database. Raises: BoardDatabaseError: Could not retrieve data from the board database. """ return cls(Board.from_offline_board_entry(b) for b in board_database.get_offline_board_data()) @classmethod def from_online_database(cls) -> "Boards": """Initialise with the online board database. Raises: BoardDatabaseError: Could not retrieve data from the board database. """ return cls(Board.from_online_board_entry(b) for b in board_database.get_online_board_data()) def __init__(self, boards_data: Iterable["Board"]) -> None: """Initialise with a list of boards. Args: boards_data: iterable of board data from a board database source. """ self._boards_data = tuple(boards_data) def __iter__(self) -> Iterator["Board"]: """Yield an Board on each iteration.""" for board in self._boards_data: yield board def __len__(self) -> int: """Return the number of boards.""" return len(self._boards_data) def __contains__(self, board: object) -> Any: """Check if a board is in the collection of boards. Args: board: An instance of Board. """ if not isinstance(board, Board): return False return any(x == board for x in self) def get_board(self, matching: Callable) -> Board: """Returns first Board for which `matching` returns True. Args: matching: A function which will be called for each board in database Raises: UnknownBoard: the given product code was not found in the board database. """ try: return next(board for board in self if matching(board)) except StopIteration: raise UnknownBoard() def json_dump(self) -> str: """Return the contents of the board database as a json string.""" return json.dumps([asdict(b) for b in self], indent=4)</code></pre></details></section><section></section><section></section><section></section><section><h2 class="section-title" id="header-classes">Classes</h2><dl><dt id="mbed_targets.boards.Boards"><code class="flex name class"><span>class <span class="ident">Boards</span></span><span>(</span><span>boards_data: Iterable[ForwardRef('Board')])</span></code></dt><dd><div class="desc"><p>Interface to the Board Database.</p><p>Boards is initialised with an Iterable[Board]. The classmethodscan be used to construct Boards with data from either the online or offline database.</p><p>Initialise with a list of boards.</p><h2 id="args">Args</h2><dl><dt><strong><code>boards_data</code></strong></dt><dd>iterable of board data from a board database source.</dd></dl></div><details class="source"><summary><span>Expand source code</span></summary><pre><code class="python">class Boards(Set): """Interface to the Board Database. Boards is initialised with an Iterable[Board]. The classmethods can be used to construct Boards with data from either the online or offline database. """ @classmethod def from_offline_database(cls) -> "Boards": """Initialise with the offline board database. Raises: BoardDatabaseError: Could not retrieve data from the board database. """ return cls(Board.from_offline_board_entry(b) for b in board_database.get_offline_board_data()) @classmethod def from_online_database(cls) -> "Boards": """Initialise with the online board database. Raises: BoardDatabaseError: Could not retrieve data from the board database. """ return cls(Board.from_online_board_entry(b) for b in board_database.get_online_board_data()) def __init__(self, boards_data: Iterable["Board"]) -> None: """Initialise with a list of boards. Args: boards_data: iterable of board data from a board database source. """ self._boards_data = tuple(boards_data) def __iter__(self) -> Iterator["Board"]: """Yield an Board on each iteration.""" for board in self._boards_data: yield board def __len__(self) -> int: """Return the number of boards.""" return len(self._boards_data) def __contains__(self, board: object) -> Any: """Check if a board is in the collection of boards. Args: board: An instance of Board. """ if not isinstance(board, Board): return False return any(x == board for x in self) def get_board(self, matching: Callable) -> Board: """Returns first Board for which `matching` returns True. Args: matching: A function which will be called for each board in database Raises: UnknownBoard: the given product code was not found in the board database. """ try: return next(board for board in self if matching(board)) except StopIteration: raise UnknownBoard() def json_dump(self) -> str: """Return the contents of the board database as a json string.""" return json.dumps([asdict(b) for b in self], indent=4)</code></pre></details><h3>Ancestors</h3><ul class="hlist"><li>collections.abc.Set</li><li>collections.abc.Collection</li><li>collections.abc.Sized</li><li>collections.abc.Iterable</li><li>collections.abc.Container</li></ul><h3>Static methods</h3><dl><dt id="mbed_targets.boards.Boards.from_offline_database"><code class="name flex"><span>def <span class="ident">from_offline_database</span></span>(<span>) ‑> <a title="mbed_targets.boards.Boards" href="#mbed_targets.boards.Boards">Boards</a></span></code></dt><dd><div class="desc"><p>Initialise with the offline board database.</p><h2 id="raises">Raises</h2><dl><dt><code>BoardDatabaseError</code></dt><dd>Could not retrieve data from the board database.</dd></dl></div><details class="source"><summary><span>Expand source code</span></summary><pre><code class="python">@classmethoddef from_offline_database(cls) -> "Boards": """Initialise with the offline board database. Raises: BoardDatabaseError: Could not retrieve data from the board database. """ return cls(Board.from_offline_board_entry(b) for b in board_database.get_offline_board_data())</code></pre></details></dd><dt id="mbed_targets.boards.Boards.from_online_database"><code class="name flex"><span>def <span class="ident">from_online_database</span></span>(<span>) ‑> <a title="mbed_targets.boards.Boards" href="#mbed_targets.boards.Boards">Boards</a></span></code></dt><dd><div class="desc"><p>Initialise with the online board database.</p><h2 id="raises">Raises</h2><dl><dt><code>BoardDatabaseError</code></dt><dd>Could not retrieve data from the board database.</dd></dl></div><details class="source"><summary><span>Expand source code</span></summary><pre><code class="python">@classmethoddef from_online_database(cls) -> "Boards": """Initialise with the online board database. Raises: BoardDatabaseError: Could not retrieve data from the board database. """ return cls(Board.from_online_board_entry(b) for b in board_database.get_online_board_data())</code></pre></details></dd></dl><h3>Methods</h3><dl><dt id="mbed_targets.boards.Boards.get_board"><code class="name flex"><span>def <span class="ident">get_board</span></span>(<span>self, matching: Callable) ‑> <a title="mbed_targets.board.Board" href="board.html#mbed_targets.board.Board">Board</a></span></code></dt><dd><div class="desc"><p>Returns first Board for which <code>matching</code> returns True.</p><h2 id="args">Args</h2><dl><dt><strong><code>matching</code></strong></dt><dd>A function which will be called for each board in database</dd></dl><h2 id="raises">Raises</h2><dl><dt><code>UnknownBoard</code></dt><dd>the given product code was not found in the board database.</dd></dl></div><details class="source"><summary><span>Expand source code</span></summary><pre><code class="python">def get_board(self, matching: Callable) -> Board: """Returns first Board for which `matching` returns True. Args: matching: A function which will be called for each board in database Raises: UnknownBoard: the given product code was not found in the board database. """ try: return next(board for board in self if matching(board)) except StopIteration: raise UnknownBoard()</code></pre></details></dd><dt id="mbed_targets.boards.Boards.json_dump"><code class="name flex"><span>def <span class="ident">json_dump</span></span>(<span>self) ‑> str</span></code></dt><dd><div class="desc"><p>Return the contents of the board database as a json string.</p></div><details class="source"><summary><span>Expand source code</span></summary><pre><code class="python">def json_dump(self) -> str: """Return the contents of the board database as a json string.""" return json.dumps([asdict(b) for b in self], indent=4)</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="mbed_targets" href="index.html">mbed_targets</a></code></li></ul></li><li><h3><a href="#header-classes">Classes</a></h3><ul><li><h4><code><a title="mbed_targets.boards.Boards" href="#mbed_targets.boards.Boards">Boards</a></code></h4><ul class=""><li><code><a title="mbed_targets.boards.Boards.from_offline_database" href="#mbed_targets.boards.Boards.from_offline_database">from_offline_database</a></code></li><li><code><a title="mbed_targets.boards.Boards.from_online_database" href="#mbed_targets.boards.Boards.from_online_database">from_online_database</a></code></li><li><code><a title="mbed_targets.boards.Boards.get_board" href="#mbed_targets.boards.Boards.get_board">get_board</a></code></li><li><code><a title="mbed_targets.boards.Boards.json_dump" href="#mbed_targets.boards.Boards.json_dump">json_dump</a></code></li></ul></li></ul></li></ul></nav></main><footer id="footer"><p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.8.4</a>.</p></footer></body></html>