1691 lines
75 KiB
HTML
1691 lines
75 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
|
|
|
<link rel="canonical" href="https://preserves.dev/python/latest/text/">
|
|
|
|
|
|
<link rel="prev" href="../schema/">
|
|
|
|
|
|
<link rel="next" href="../values/">
|
|
|
|
|
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.8">
|
|
|
|
|
|
|
|
<title>Human-readable text syntax - Python Preserves</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.4b4a2bd9.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
|
|
|
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
<body dir="ltr">
|
|
|
|
|
|
|
|
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#human-readable-text-syntax" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<header class="md-header md-header--shadow" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href=".." title="Python Preserves" class="md-header__button md-logo" aria-label="Python Preserves" data-md-component="logo">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
Python Preserves
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Human-readable text syntax
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
|
|
</label>
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list" role="presentation"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-header__source">
|
|
<a href="https://gitlab.com/preserves/preserves" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
GitLab
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href=".." title="Python Preserves" class="md-nav__button md-logo" aria-label="Python Preserves" data-md-component="logo">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
|
|
|
|
</a>
|
|
Python Preserves
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://gitlab.com/preserves/preserves" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
GitLab
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href=".." class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../api/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
The top-level preserves package
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../binary/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Machine-oriented binary syntax
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../compare/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Comparing Values
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../error/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Codec errors
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../fold/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Traversing values
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../merge/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Merging values
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../path/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Preserves Path
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../schema/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Preserves Schema
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Human-readable text syntax
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Human-readable text syntax
|
|
</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text" class="md-nav__link">
|
|
text
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Formatter" class="md-nav__link">
|
|
Formatter
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Formatter">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Formatter.append" class="md-nav__link">
|
|
append()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Formatter.contents" class="md-nav__link">
|
|
contents()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Formatter.is_indenting" class="md-nav__link">
|
|
is_indenting()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Parser" class="md-nav__link">
|
|
Parser
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Parser">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Parser.extend" class="md-nav__link">
|
|
extend()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Parser.next" class="md-nav__link">
|
|
next()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Parser.try_next" class="md-nav__link">
|
|
try_next()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.parse" class="md-nav__link">
|
|
parse()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.parse_with_annotations" class="md-nav__link">
|
|
parse_with_annotations()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.stringify" class="md-nav__link">
|
|
stringify()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../values/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Representations of Values
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text" class="md-nav__link">
|
|
text
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Formatter" class="md-nav__link">
|
|
Formatter
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Formatter">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Formatter.append" class="md-nav__link">
|
|
append()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Formatter.contents" class="md-nav__link">
|
|
contents()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Formatter.is_indenting" class="md-nav__link">
|
|
is_indenting()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Parser" class="md-nav__link">
|
|
Parser
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Parser">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Parser.extend" class="md-nav__link">
|
|
extend()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Parser.next" class="md-nav__link">
|
|
next()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.Parser.try_next" class="md-nav__link">
|
|
try_next()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.parse" class="md-nav__link">
|
|
parse()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.parse_with_annotations" class="md-nav__link">
|
|
parse_with_annotations()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#preserves.text.stringify" class="md-nav__link">
|
|
stringify()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="human-readable-text-syntax">Human-readable text syntax</h1>
|
|
|
|
|
|
<div class="doc doc-object doc-module">
|
|
|
|
|
|
|
|
<a id="preserves.text"></a>
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>The <a class="autorefs autorefs-internal" href="#preserves.text">preserves.text</a> module implements the <a href="https://preserves.dev/preserves-text.html">Preserves human-readable text
|
|
syntax</a>.</p>
|
|
<p>The main entry points are functions <a class="autorefs autorefs-internal" href="#preserves.text.stringify">stringify</a>,
|
|
<a class="autorefs autorefs-internal" href="#preserves.text.parse">parse</a>, and
|
|
<a class="autorefs autorefs-internal" href="#preserves.text.parse_with_annotations">parse_with_annotations</a>.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="n">stringify</span><span class="p">(</span><span class="n">Record</span><span class="p">(</span><span class="n">Symbol</span><span class="p">(</span><span class="s1">'hi'</span><span class="p">),</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]]))</span>
|
|
<span class="s1">'<hi 1 [2 3]>'</span>
|
|
<span class="o">>>></span> <span class="n">parse</span><span class="p">(</span><span class="s1">'<hi 1 [2 3]>'</span><span class="p">)</span>
|
|
<span class="c1">#hi(1, (2, 3))</span>
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
|
|
<h2 id="preserves.text.Formatter" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">Formatter</span><span class="p">(</span><span class="n">format_embedded</span><span class="o">=</span><span class="k">lambda</span> <span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">with_commas</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">trailing_comma</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">include_annotations</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
|
|
|
|
</h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><span title="preserves.text.TextCodec">TextCodec</span></code></p>
|
|
|
|
|
|
<p>Printer (and indenting pretty-printer) for producing human-readable syntax from
|
|
Preserves <code>Value</code>s.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="n">f</span> <span class="o">=</span> <span class="n">Formatter</span><span class="p">()</span>
|
|
<span class="o">>>></span> <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">:</span> <span class="mi">2</span><span class="p">})</span>
|
|
<span class="o">>>></span> <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Record</span><span class="p">(</span><span class="n">Symbol</span><span class="p">(</span><span class="s1">'label'</span><span class="p">),</span> <span class="p">[</span><span class="s1">'field1'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'field2item1'</span><span class="p">,</span> <span class="s1">'field2item2'</span><span class="p">]]))</span>
|
|
<span class="o">>>></span> <span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">contents</span><span class="p">())</span>
|
|
<span class="p">{</span><span class="s2">"a"</span><span class="p">:</span> <span class="mi">1</span> <span class="s2">"b"</span><span class="p">:</span> <span class="mi">2</span><span class="p">}</span> <span class="o"><</span><span class="n">label</span> <span class="s2">"field1"</span> <span class="p">[</span><span class="s2">"field2item1"</span> <span class="s2">"field2item2"</span><span class="p">]</span><span class="o">></span>
|
|
|
|
<span class="o">>>></span> <span class="n">f</span> <span class="o">=</span> <span class="n">Formatter</span><span class="p">(</span><span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
|
|
<span class="o">>>></span> <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">:</span> <span class="mi">2</span><span class="p">})</span>
|
|
<span class="o">>>></span> <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Record</span><span class="p">(</span><span class="n">Symbol</span><span class="p">(</span><span class="s1">'label'</span><span class="p">),</span> <span class="p">[</span><span class="s1">'field1'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'field2item1'</span><span class="p">,</span> <span class="s1">'field2item2'</span><span class="p">]]))</span>
|
|
<span class="o">>>></span> <span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">contents</span><span class="p">())</span>
|
|
<span class="p">{</span>
|
|
<span class="s2">"a"</span><span class="p">:</span> <span class="mi">1</span>
|
|
<span class="s2">"b"</span><span class="p">:</span> <span class="mi">2</span>
|
|
<span class="p">}</span>
|
|
<span class="o"><</span><span class="n">label</span> <span class="s2">"field1"</span> <span class="p">[</span>
|
|
<span class="s2">"field2item1"</span>
|
|
<span class="s2">"field2item2"</span>
|
|
<span class="p">]</span><span class="o">></span>
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>format_embedded</code></td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>function accepting an <a class="autorefs autorefs-internal" href="../values/#preserves.values.Embedded">Embedded</a>.embeddedValue and
|
|
returning a <code>Value</code> for serialization.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>lambda : x</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>indent</code></td>
|
|
<td>
|
|
<code>int | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p><code>None</code> disables indented pretty-printing; otherwise, an <code>int</code> specifies indentation
|
|
per nesting-level.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>with_commas</code></td>
|
|
<td>
|
|
<code>bool</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p><code>True</code> causes commas to separate sequence and set items and dictionary entries;
|
|
<code>False</code> omits commas.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>trailing_comma</code></td>
|
|
<td>
|
|
<code>bool</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p><code>True</code> causes a comma to be printed <em>after</em> the final item or entry in a sequence,
|
|
set or dictionary; <code>False</code> omits this trailing comma</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include_annotations</code></td>
|
|
<td>
|
|
<code>bool</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p><code>True</code> causes annotations to be included in the output; <code>False</code> causes them to be
|
|
omitted.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>True</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
<p><strong>Attributes:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>indent_delta</code></td>
|
|
<td>
|
|
<code>int</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>indentation per nesting-level</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>chunks</code></td>
|
|
<td>
|
|
<code>list[str]</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>fragments of output</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">467</span>
|
|
<span class="normal">468</span>
|
|
<span class="normal">469</span>
|
|
<span class="normal">470</span>
|
|
<span class="normal">471</span>
|
|
<span class="normal">472</span>
|
|
<span class="normal">473</span>
|
|
<span class="normal">474</span>
|
|
<span class="normal">475</span>
|
|
<span class="normal">476</span>
|
|
<span class="normal">477</span>
|
|
<span class="normal">478</span>
|
|
<span class="normal">479</span>
|
|
<span class="normal">480</span>
|
|
<span class="normal">481</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">format_embedded</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span>
|
|
<span class="n">indent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">with_commas</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
|
<span class="n">trailing_comma</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
|
<span class="n">include_annotations</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
|
<span class="nb">super</span><span class="p">(</span><span class="n">Formatter</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">indent_delta</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="n">indent</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">indent</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">indent_distance</span> <span class="o">=</span> <span class="mi">0</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">nesting</span> <span class="o">=</span> <span class="mi">0</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">with_commas</span> <span class="o">=</span> <span class="n">with_commas</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">trailing_comma</span> <span class="o">=</span> <span class="n">trailing_comma</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">chunks</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_format_embedded</span> <span class="o">=</span> <span class="n">format_embedded</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">include_annotations</span> <span class="o">=</span> <span class="n">include_annotations</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h3 id="preserves.text.Formatter.append" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">append</span><span class="p">(</span><span class="n">v</span><span class="p">)</span></code>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Extend <code>self.chunks</code> with at least one chunk, together making up the text
|
|
representation of <code>v</code>.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">537</span>
|
|
<span class="normal">538</span>
|
|
<span class="normal">539</span>
|
|
<span class="normal">540</span>
|
|
<span class="normal">541</span>
|
|
<span class="normal">542</span>
|
|
<span class="normal">543</span>
|
|
<span class="normal">544</span>
|
|
<span class="normal">545</span>
|
|
<span class="normal">546</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Extend `self.chunks` with at least one chunk, together making up the text</span>
|
|
<span class="sd"> representation of `v`."""</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">chunks</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">nesting</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">write_indent_space</span><span class="p">()</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">nesting</span> <span class="o">+=</span> <span class="mi">1</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_append</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
|
|
<span class="k">finally</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">nesting</span> <span class="o">-=</span> <span class="mi">1</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h3 id="preserves.text.Formatter.contents" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">contents</span><span class="p">()</span></code>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Returns a <code>str</code> constructed from the join of the chunks in <code>self.chunks</code>.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">488</span>
|
|
<span class="normal">489</span>
|
|
<span class="normal">490</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">contents</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Returns a `str` constructed from the join of the chunks in `self.chunks`."""</span>
|
|
<span class="k">return</span> <span class="sa">u</span><span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">chunks</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h3 id="preserves.text.Formatter.is_indenting" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">is_indenting</span><span class="p">()</span></code>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Returns <code>True</code> iff this <a class="autorefs autorefs-internal" href="#preserves.text.Formatter">Formatter</a> is in pretty-printing
|
|
indenting mode.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">492</span>
|
|
<span class="normal">493</span>
|
|
<span class="normal">494</span>
|
|
<span class="normal">495</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">is_indenting</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Returns `True` iff this [Formatter][preserves.text.Formatter] is in pretty-printing</span>
|
|
<span class="sd"> indenting mode."""</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">indent_delta</span> <span class="o">></span> <span class="mi">0</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
|
|
<h2 id="preserves.text.Parser" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">Parser</span><span class="p">(</span><span class="n">input_buffer</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">include_annotations</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">parse_embedded</span><span class="o">=</span><span class="k">lambda</span> <span class="p">:</span> <span class="n">x</span><span class="p">)</span></code>
|
|
|
|
</h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><span title="preserves.text.TextCodec">TextCodec</span></code></p>
|
|
|
|
|
|
<p>Parser for the human-readable Preserves text syntax.</p>
|
|
|
|
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>input_buffer</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>initial contents of the input buffer; may subsequently be extended by calling
|
|
<a class="autorefs autorefs-internal" href="#preserves.text.Parser.extend">extend</a>.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>''</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include_annotations</code></td>
|
|
<td>
|
|
<code>bool</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>if <code>True</code>, wrap each value and subvalue in an
|
|
<a class="autorefs autorefs-internal" href="../values/#preserves.values.Annotated">Annotated</a> object.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parse_embedded</code></td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>function accepting a <code>Value</code> and returning a possibly-decoded form of that value
|
|
suitable for placing into an <a class="autorefs autorefs-internal" href="../values/#preserves.values.Embedded">Embedded</a> object.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>lambda : x</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Normal usage is to supply input text, and keep calling <a class="autorefs autorefs-internal" href="#preserves.text.Parser.next">next</a>
|
|
until a <a class="autorefs autorefs-internal" href="../error/#preserves.error.ShortPacket">ShortPacket</a> exception is raised:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="n">d</span> <span class="o">=</span> <span class="n">Parser</span><span class="p">(</span><span class="s1">'123 "hello" @x []'</span><span class="p">)</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
|
|
<span class="mi">123</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
|
|
<span class="s1">'hello'</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
|
|
<span class="p">()</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
|
|
<span class="n">Traceback</span> <span class="p">(</span><span class="n">most</span> <span class="n">recent</span> <span class="n">call</span> <span class="n">last</span><span class="p">):</span>
|
|
<span class="o">...</span>
|
|
<span class="n">preserves</span><span class="o">.</span><span class="n">error</span><span class="o">.</span><span class="n">ShortPacket</span><span class="p">:</span> <span class="n">Short</span> <span class="nb">input</span> <span class="n">buffer</span>
|
|
</code></pre></div>
|
|
<p>Alternatively, keep calling <a class="autorefs autorefs-internal" href="#preserves.text.Parser.try_next">try_next</a> until it yields
|
|
<code>None</code>, which is not in the domain of Preserves <code>Value</code>s:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="n">d</span> <span class="o">=</span> <span class="n">Parser</span><span class="p">(</span><span class="s1">'123 "hello" @x []'</span><span class="p">)</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">try_next</span><span class="p">()</span>
|
|
<span class="mi">123</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">try_next</span><span class="p">()</span>
|
|
<span class="s1">'hello'</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">try_next</span><span class="p">()</span>
|
|
<span class="p">()</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">try_next</span><span class="p">()</span>
|
|
</code></pre></div>
|
|
<p>For convenience, <a class="autorefs autorefs-internal" href="#preserves.text.Parser">Parser</a> implements the iterator interface,
|
|
backing it with <a class="autorefs autorefs-internal" href="#preserves.text.Parser.try_next">try_next</a>, so you can simply iterate
|
|
over all complete values in an input:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="n">d</span> <span class="o">=</span> <span class="n">Parser</span><span class="p">(</span><span class="s1">'123 "hello" @x []'</span><span class="p">)</span>
|
|
<span class="o">>>></span> <span class="nb">list</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
|
|
<span class="p">[</span><span class="mi">123</span><span class="p">,</span> <span class="s1">'hello'</span><span class="p">,</span> <span class="p">()]</span>
|
|
</code></pre></div>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">Parser</span><span class="p">(</span><span class="s1">'123 "hello" @x []'</span><span class="p">):</span>
|
|
<span class="o">...</span> <span class="nb">print</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="n">v</span><span class="p">))</span>
|
|
<span class="mi">123</span>
|
|
<span class="s1">'hello'</span>
|
|
<span class="p">()</span>
|
|
</code></pre></div>
|
|
<p>Supply <code>include_annotations=True</code> to read annotations alongside the annotated values:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="n">d</span> <span class="o">=</span> <span class="n">Parser</span><span class="p">(</span><span class="s1">'123 "hello" @x []'</span><span class="p">,</span> <span class="n">include_annotations</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="o">>>></span> <span class="nb">list</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
|
|
<span class="p">[</span><span class="mi">123</span><span class="p">,</span> <span class="s1">'hello'</span><span class="p">,</span> <span class="o">@</span><span class="c1">#x ()]</span>
|
|
</code></pre></div>
|
|
<p>If you are incrementally reading from, say, a socket, you can use
|
|
<a class="autorefs autorefs-internal" href="#preserves.text.Parser.extend">extend</a> to add new input as if comes available:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="n">d</span> <span class="o">=</span> <span class="n">Parser</span><span class="p">(</span><span class="s1">'123 "he'</span><span class="p">)</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">try_next</span><span class="p">()</span>
|
|
<span class="mi">123</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">try_next</span><span class="p">()</span> <span class="c1"># returns None because the input is incomplete</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="s1">'llo"'</span><span class="p">)</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">try_next</span><span class="p">()</span>
|
|
<span class="s1">'hello'</span>
|
|
<span class="o">>>></span> <span class="n">d</span><span class="o">.</span><span class="n">try_next</span><span class="p">()</span>
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
<p><strong>Attributes:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>input_buffer</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>buffered input waiting to be processed</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>index</code></td>
|
|
<td>
|
|
<code>int</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>read position within <code>input_buffer</code></p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">132</span>
|
|
<span class="normal">133</span>
|
|
<span class="normal">134</span>
|
|
<span class="normal">135</span>
|
|
<span class="normal">136</span>
|
|
<span class="normal">137</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">input_buffer</span><span class="o">=</span><span class="sa">u</span><span class="s1">''</span><span class="p">,</span> <span class="n">include_annotations</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">parse_embedded</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">):</span>
|
|
<span class="nb">super</span><span class="p">(</span><span class="n">Parser</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">input_buffer</span> <span class="o">=</span> <span class="n">input_buffer</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="mi">0</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">include_annotations</span> <span class="o">=</span> <span class="n">include_annotations</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">parse_embedded</span> <span class="o">=</span> <span class="n">parse_embedded</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h3 id="preserves.text.Parser.extend" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">extend</span><span class="p">(</span><span class="n">text</span><span class="p">)</span></code>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Appends <code>text</code> to the remaining contents of <code>self.input_buffer</code>, trimming already-processed
|
|
text from the front of <code>self.input_buffer</code> and resetting <code>self.index</code> to zero.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">139</span>
|
|
<span class="normal">140</span>
|
|
<span class="normal">141</span>
|
|
<span class="normal">142</span>
|
|
<span class="normal">143</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">extend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Appends `text` to the remaining contents of `self.input_buffer`, trimming already-processed</span>
|
|
<span class="sd"> text from the front of `self.input_buffer` and resetting `self.index` to zero."""</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">input_buffer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">input_buffer</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">index</span><span class="p">:]</span> <span class="o">+</span> <span class="n">text</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h3 id="preserves.text.Parser.next" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="nb">next</span><span class="p">()</span></code>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Reads the next complete <code>Value</code> from the internal buffer, raising
|
|
<a class="autorefs autorefs-internal" href="../error/#preserves.error.ShortPacket">ShortPacket</a> if too few bytes are available, or
|
|
<a class="autorefs autorefs-internal" href="../error/#preserves.error.DecodeError">DecodeError</a> if the input is invalid somehow.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">323</span>
|
|
<span class="normal">324</span>
|
|
<span class="normal">325</span>
|
|
<span class="normal">326</span>
|
|
<span class="normal">327</span>
|
|
<span class="normal">328</span>
|
|
<span class="normal">329</span>
|
|
<span class="normal">330</span>
|
|
<span class="normal">331</span>
|
|
<span class="normal">332</span>
|
|
<span class="normal">333</span>
|
|
<span class="normal">334</span>
|
|
<span class="normal">335</span>
|
|
<span class="normal">336</span>
|
|
<span class="normal">337</span>
|
|
<span class="normal">338</span>
|
|
<span class="normal">339</span>
|
|
<span class="normal">340</span>
|
|
<span class="normal">341</span>
|
|
<span class="normal">342</span>
|
|
<span class="normal">343</span>
|
|
<span class="normal">344</span>
|
|
<span class="normal">345</span>
|
|
<span class="normal">346</span>
|
|
<span class="normal">347</span>
|
|
<span class="normal">348</span>
|
|
<span class="normal">349</span>
|
|
<span class="normal">350</span>
|
|
<span class="normal">351</span>
|
|
<span class="normal">352</span>
|
|
<span class="normal">353</span>
|
|
<span class="normal">354</span>
|
|
<span class="normal">355</span>
|
|
<span class="normal">356</span>
|
|
<span class="normal">357</span>
|
|
<span class="normal">358</span>
|
|
<span class="normal">359</span>
|
|
<span class="normal">360</span>
|
|
<span class="normal">361</span>
|
|
<span class="normal">362</span>
|
|
<span class="normal">363</span>
|
|
<span class="normal">364</span>
|
|
<span class="normal">365</span>
|
|
<span class="normal">366</span>
|
|
<span class="normal">367</span>
|
|
<span class="normal">368</span>
|
|
<span class="normal">369</span>
|
|
<span class="normal">370</span>
|
|
<span class="normal">371</span>
|
|
<span class="normal">372</span>
|
|
<span class="normal">373</span>
|
|
<span class="normal">374</span>
|
|
<span class="normal">375</span>
|
|
<span class="normal">376</span>
|
|
<span class="normal">377</span>
|
|
<span class="normal">378</span>
|
|
<span class="normal">379</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">next</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Reads the next complete `Value` from the internal buffer, raising</span>
|
|
<span class="sd"> [ShortPacket][preserves.error.ShortPacket] if too few bytes are available, or</span>
|
|
<span class="sd"> [DecodeError][preserves.error.DecodeError] if the input is invalid somehow.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip_whitespace</span><span class="p">()</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">peek</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'"'</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="s1">'"'</span><span class="p">))</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'|'</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="n">Symbol</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="s1">'|'</span><span class="p">)))</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'@'</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">unshift_annotation</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">';'</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">DecodeError</span><span class="p">(</span><span class="s1">'Semicolon is reserved syntax'</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">':'</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">DecodeError</span><span class="p">(</span><span class="s1">'Unexpected key/value separator between items'</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'#'</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="p">()</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nextchar</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="s1">' </span><span class="se">\t</span><span class="s1">'</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">unshift_annotation</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">comment_line</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="s1">'</span><span class="se">\n\r</span><span class="s1">'</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">unshift_annotation</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'f'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">require_delimiter</span><span class="p">(</span><span class="s1">'#f'</span><span class="p">);</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'t'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">require_delimiter</span><span class="p">(</span><span class="s1">'#t'</span><span class="p">);</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'{'</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_set</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'"'</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_literal_binary</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'x'</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nextchar</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'"'</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_hex_binary</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'d'</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_hex_float</span><span class="p">())</span>
|
|
<span class="k">raise</span> <span class="n">DecodeError</span><span class="p">(</span><span class="s1">'Invalid #x syntax'</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'['</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_base64_binary</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'!'</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parse_embedded</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">DecodeError</span><span class="p">(</span><span class="s1">'No parse_embedded function supplied'</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="n">Embedded</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parse_embedded</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">())))</span>
|
|
<span class="k">raise</span> <span class="n">DecodeError</span><span class="p">(</span><span class="s1">'Invalid # syntax'</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'<'</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="p">()</span>
|
|
<span class="n">vs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">upto</span><span class="p">(</span><span class="s1">'>'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">vs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">DecodeError</span><span class="p">(</span><span class="s1">'Missing record label'</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="n">Record</span><span class="p">(</span><span class="n">vs</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">vs</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'['</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">upto</span><span class="p">(</span><span class="s1">']'</span><span class="p">,</span> <span class="kc">True</span><span class="p">))</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">'{'</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_dictionary</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="s1">'>]},'</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">DecodeError</span><span class="p">(</span><span class="s1">'Unexpected '</span> <span class="o">+</span> <span class="n">c</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">read_raw_symbol_or_number</span><span class="p">([</span><span class="n">c</span><span class="p">]))</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h3 id="preserves.text.Parser.try_next" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">try_next</span><span class="p">()</span></code>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Like <a class="autorefs autorefs-internal" href="#preserves.text.Parser.next">next</a>, but returns <code>None</code> instead of raising
|
|
<a class="autorefs autorefs-internal" href="../error/#preserves.error.ShortPacket">ShortPacket</a>.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">381</span>
|
|
<span class="normal">382</span>
|
|
<span class="normal">383</span>
|
|
<span class="normal">384</span>
|
|
<span class="normal">385</span>
|
|
<span class="normal">386</span>
|
|
<span class="normal">387</span>
|
|
<span class="normal">388</span>
|
|
<span class="normal">389</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">try_next</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Like [next][preserves.text.Parser.next], but returns `None` instead of raising</span>
|
|
<span class="sd"> [ShortPacket][preserves.error.ShortPacket]."""</span>
|
|
<span class="n">start</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">ShortPacket</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="n">start</span>
|
|
<span class="k">return</span> <span class="kc">None</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h2 id="preserves.text.parse" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">parse</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
|
|
|
|
</h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Yields the first complete encoded value from <code>text</code>, passing <code>kwargs</code> through to the
|
|
<a class="autorefs autorefs-internal" href="#preserves.text.Parser">Parser</a> constructor. Raises exceptions as per
|
|
<a class="autorefs autorefs-internal" href="#preserves.text.Parser.next">next</a>.</p>
|
|
|
|
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>text</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>encoded data to decode</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">400</span>
|
|
<span class="normal">401</span>
|
|
<span class="normal">402</span>
|
|
<span class="normal">403</span>
|
|
<span class="normal">404</span>
|
|
<span class="normal">405</span>
|
|
<span class="normal">406</span>
|
|
<span class="normal">407</span>
|
|
<span class="normal">408</span>
|
|
<span class="normal">409</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Yields the first complete encoded value from `text`, passing `kwargs` through to the</span>
|
|
<span class="sd"> [Parser][preserves.text.Parser] constructor. Raises exceptions as per</span>
|
|
<span class="sd"> [next][preserves.text.Parser.next].</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> text (str): encoded data to decode</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="n">Parser</span><span class="p">(</span><span class="n">input_buffer</span><span class="o">=</span><span class="n">text</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h2 id="preserves.text.parse_with_annotations" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">parse_with_annotations</span><span class="p">(</span><span class="n">bs</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
|
|
|
|
</h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Like <a class="autorefs autorefs-internal" href="#preserves.text.parse">parse</a>, but supplying <code>include_annotations=True</code> to the
|
|
<a class="autorefs autorefs-internal" href="#preserves.text.Parser">Parser</a> constructor.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">411</span>
|
|
<span class="normal">412</span>
|
|
<span class="normal">413</span>
|
|
<span class="normal">414</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">parse_with_annotations</span><span class="p">(</span><span class="n">bs</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Like [parse][preserves.text.parse], but supplying `include_annotations=True` to the</span>
|
|
<span class="sd"> [Parser][preserves.text.Parser] constructor."""</span>
|
|
<span class="k">return</span> <span class="n">Parser</span><span class="p">(</span><span class="n">input_buffer</span><span class="o">=</span><span class="n">bs</span><span class="p">,</span> <span class="n">include_annotations</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h2 id="preserves.text.stringify" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">stringify</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
|
|
|
|
</h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Convert a single <code>Value</code> <code>v</code> to a string. Any supplied <code>kwargs</code> are passed on to the
|
|
underlying <a class="autorefs autorefs-internal" href="#preserves.text.Formatter">Formatter</a> constructor.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>preserves/text.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">598</span>
|
|
<span class="normal">599</span>
|
|
<span class="normal">600</span>
|
|
<span class="normal">601</span>
|
|
<span class="normal">602</span>
|
|
<span class="normal">603</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">stringify</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Convert a single `Value` `v` to a string. Any supplied `kwargs` are passed on to the</span>
|
|
<span class="sd"> underlying [Formatter][preserves.text.Formatter] constructor."""</span>
|
|
<span class="n">e</span> <span class="o">=</span> <span class="n">Formatter</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<span class="n">e</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">e</span><span class="o">.</span><span class="n">contents</span><span class="p">()</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<hr>
|
|
<div class="md-source-file">
|
|
<small>
|
|
|
|
Last update:
|
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 16, 2023</span>
|
|
|
|
<br>
|
|
Created:
|
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 16, 2023</span>
|
|
|
|
|
|
</small>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
|
|
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
|
|
|
|
|
|
<script src="../assets/javascripts/bundle.81fa17fe.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |