1021 lines
37 KiB
HTML
1021 lines
37 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
|
|
|
|
<head>
|
|
|
|
<title>bootstraparse.modules.context_mngr.HeaderContainer</title>
|
|
<meta name="generator" content="pydoctor 22.5.1">
|
|
|
|
</meta>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
|
|
<link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
|
|
<link rel="stylesheet" type="text/css" href="apidocs.css" />
|
|
<link rel="stylesheet" type="text/css" href="extra.css" />
|
|
</head>
|
|
|
|
<body>
|
|
|
|
|
|
|
|
<nav class="navbar navbar-default mainnavbar">
|
|
|
|
|
|
<div class="container-fluid">
|
|
|
|
|
|
<div class="navbar-header">
|
|
|
|
<div class="navlinks">
|
|
<span class="navbar-brand">
|
|
bootstraparse <a href="index.html">API Documentation</a>
|
|
</span>
|
|
|
|
<a href="moduleIndex.html">
|
|
Modules
|
|
</a>
|
|
|
|
<a href="classIndex.html">
|
|
Classes
|
|
</a>
|
|
|
|
<a href="nameIndex.html">
|
|
Names
|
|
</a>
|
|
|
|
<div id="search-box-container">
|
|
<div class="input-group">
|
|
<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />
|
|
|
|
<span class="input-group-btn">
|
|
<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
|
|
<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="search-results-container" style="display: none;">
|
|
|
|
<div id="search-buttons">
|
|
<span class="label label-default" id="search-docstrings-button">
|
|
<label class="checkbox-inline">
|
|
<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
|
|
search in docstrings
|
|
</input>
|
|
</label>
|
|
</span>
|
|
|
|
</div>
|
|
|
|
<noscript>
|
|
<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
|
|
</noscript>
|
|
|
|
<div class="hint" id="search-help-box">
|
|
<p class="rst-last">
|
|
|
|
Search bar offers the following options:
|
|
<ul>
|
|
<li>
|
|
<strong>Term presence.</strong> The below example searches for documents that
|
|
must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Search in specific fields.</strong> The following search matches all objects
|
|
in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>
|
|
|
|
<p>
|
|
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
|
|
Last two fields are only applicable if "search in docstrings" is enabled.
|
|
</p>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Fuzzy matches.</strong> The following search matches all documents
|
|
that have a word within 1 edit distance of “foo”: <code>foo~1</code>
|
|
</li>
|
|
</ul>
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div id="search-status"> </div>
|
|
|
|
<div class="warning" id="search-warn-box" style="display: none;">
|
|
<p class="rst-last"><span id="search-warn"></span></p>
|
|
</div>
|
|
|
|
<table id="search-results">
|
|
<!-- Filled dynamically by JS -->
|
|
</table>
|
|
|
|
<div style="margin-top: 8px;">
|
|
<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="container-fluid">
|
|
|
|
<!-- Side navigation -->
|
|
<div class="sidebarcontainer" style="display: none;">
|
|
|
|
<div class="sidebar"><nav class="sidebar">
|
|
|
|
|
|
<div>
|
|
|
|
<div class="thingTitle">
|
|
<span>Class</span>
|
|
<code class="thisobject"><a href="bootstraparse.modules.context_mngr.HeaderContainer.html" class="internal-link" title="This class"><wbr></wbr>Header<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
<div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="childrenKindTitle">Methods</div>
|
|
<ul>
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#export" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.export">export</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#get_content" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.get_content">get<wbr></wbr>_content</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<div class="childrenKindTitle">Inherited Methods</div>
|
|
<ul>
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__eq__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__eq__">__eq__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__getitem__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__getitem__">__getitem__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__getslice__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__getslice__">__getslice__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__init__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__init__">__init__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__invert__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__invert__">__invert__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__iter__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__iter__">__iter__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__len__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__len__">__len__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__repr__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__repr__">__repr__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__rshift__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__rshift__">__rshift__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__setitem__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__setitem__">__setitem__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__str__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__str__">__str__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#add" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.add">add</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#class_name" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.class_name">class<wbr></wbr>_name</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#debug_map" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.debug_map">debug<wbr></wbr>_map</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#get_optionals" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.get_optionals">get<wbr></wbr>_optionals</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#get_others" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.get_others">get<wbr></wbr>_others</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#print_all" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.print_all">print<wbr></wbr>_all</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#to_container" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.to_container">to<wbr></wbr>_container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#validate" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.validate">validate</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<div class="childrenKindTitle">Attributes</div>
|
|
<ul>
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#subtype" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.subtype">subtype</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#type" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.type">type</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#others" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.others">others</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<div class="childrenKindTitle">Inherited Attributes</div>
|
|
<ul>
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#content" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.content">content</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#indentation_level" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.indentation_level">indentation<wbr></wbr>_level</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#map" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.map">map</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#optionals" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.optionals">optionals</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><div>
|
|
|
|
<div class="thingTitle">
|
|
<span>Module</span>
|
|
<code><a href="bootstraparse.modules.context_mngr.html" class="internal-link" title="The parent of this class">context<wbr></wbr>_mngr</a></code>
|
|
</div>
|
|
|
|
<div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="childrenKindTitle">Classes</div>
|
|
<ul>
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer"><wbr></wbr>Base<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.ContextManager.html" class="internal-link" title="bootstraparse.modules.context_mngr.ContextManager"><wbr></wbr>Context<wbr></wbr>Manager</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.DisplayContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.DisplayContainer"><wbr></wbr>Display<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.EtCustomSpanContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.EtCustomSpanContainer"><wbr></wbr>Et<wbr></wbr>Custom<wbr></wbr>Span<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.EtEmContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.EtEmContainer"><wbr></wbr>Et<wbr></wbr>Em<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.EtOlistContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.EtOlistContainer"><wbr></wbr>Et<wbr></wbr>Olist<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.EtStrikethroughContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.EtStrikethroughContainer"><wbr></wbr>Et<wbr></wbr>Strikethrough<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.EtStrongContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.EtStrongContainer"><wbr></wbr>Et<wbr></wbr>Strong<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.EtUlistContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.EtUlistContainer"><wbr></wbr>Et<wbr></wbr>Ulist<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.EtUnderlineContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.EtUnderlineContainer"><wbr></wbr>Et<wbr></wbr>Underline<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class=" thisobject">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.HeaderContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer"><wbr></wbr>Header<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.HyperLinkContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.HyperLinkContainer"><wbr></wbr>Hyper<wbr></wbr>Link<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.LinebreakContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.LinebreakContainer"><wbr></wbr>Linebreak<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.ReContextContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.ReContextContainer"><wbr></wbr>Re<wbr></wbr>Context<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.SeContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.SeContainer"><wbr></wbr>Se<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.TableCellContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.TableCellContainer"><wbr></wbr>Table<wbr></wbr>Cell<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.TableRowContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.TableRowContainer"><wbr></wbr>Table<wbr></wbr>Row<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.TableSeparatorContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.TableSeparatorContainer"><wbr></wbr>Table<wbr></wbr>Separator<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.TextContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.TextContainer"><wbr></wbr>Text<wbr></wbr>Container</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="childrenKindTitle">Variables</div>
|
|
<ul>
|
|
|
|
<li class="private">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="bootstraparse.modules.context_mngr.html#_to_container" class="internal-link" title="bootstraparse.modules.context_mngr._to_container">_to<wbr></wbr>_container</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</nav>
|
|
</div>
|
|
<div id="collapseSideBar">
|
|
<a class="btn btn-link" onclick="toggleSideBarCollapse()" title="Toggle Sidebar Collapse">
|
|
</a>
|
|
</div>
|
|
<script src="sidebartoggle.js" type="text/javascript"></script>
|
|
|
|
</div>
|
|
|
|
<div id="main" class="">
|
|
|
|
|
|
|
|
|
|
<div class="page-header">
|
|
<h1 class="class"><code><code><a href="index.html" class="internal-link">bootstraparse</a></code><wbr></wbr>.<code><a href="bootstraparse.modules.html" class="internal-link" title="bootstraparse.modules">modules</a></code><wbr></wbr>.<code><a href="bootstraparse.modules.context_mngr.html" class="internal-link" title="bootstraparse.modules.context_mngr">context_mngr</a></code><wbr></wbr>.<code><a href="bootstraparse.modules.context_mngr.HeaderContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer">HeaderContainer</a></code></code></h1>
|
|
<div id="showPrivate">
|
|
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="categoryHeader">
|
|
class documentation
|
|
</div>
|
|
|
|
<div class="extrasDocstring">
|
|
<p><code><span class="py-keyword">class</span> <span class="py-defname">HeaderContainer</span>(<a href="bootstraparse.modules.context_mngr.BaseContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer">BaseContainer</a>):</code></p>
|
|
<p><a href="classIndex.html#bootstraparse.modules.context_mngr.HeaderContainer">View In Hierarchy</a></p>
|
|
</div>
|
|
|
|
<div class="moduleDocstring">
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
|
|
<div id="splitTables">
|
|
<table class="children sortable" id="id32">
|
|
|
|
|
|
<tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#export" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.export">export</a></code></td>
|
|
<td>Export the container to a string. :type exm: export.ExportManager :rtype : str</td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#get_content" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.get_content">get<wbr></wbr>_content</a></code></td>
|
|
<td>Get the content of any BaseContainer object (default self.content). :param exm: ExportManager to use for exporting :param arbitrary_list: List to get the content from :type exm: export.ExportManager :type arbitrary_list: list[BaseContainer] :rtype : str...</td>
|
|
</tr><tr class="classvariable">
|
|
|
|
<td>Class Variable</td>
|
|
<td><code><a href="#subtype" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.subtype">subtype</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="classvariable">
|
|
|
|
<td>Class Variable</td>
|
|
<td><code><a href="#type" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.type">type</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="instancevariable">
|
|
|
|
<td>Instance Variable</td>
|
|
<td><code><a href="#others" class="internal-link" title="bootstraparse.modules.context_mngr.HeaderContainer.others">others</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p class="inheritedFrom">
|
|
Inherited from <code><a href="bootstraparse.modules.context_mngr.BaseContainer.html" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer">BaseContainer</a></code>:
|
|
</p>
|
|
<table class="children sortable" id="id33">
|
|
|
|
|
|
<tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__eq__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__eq__">__eq__</a></code></td>
|
|
<td>:param other: The other object to compare to :type other: BaseContainer | list[(syntax.SemanticType | BaseContainer)] | syntax.SemanticType :rtype : bool</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__getitem__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__getitem__">__getitem__</a></code></td>
|
|
<td>:param item: Index of the element to get :type item: int :rtype : (syntax.SemanticType | BaseContainer)</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__getslice__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__getslice__">__getslice__</a></code></td>
|
|
<td>:param start: Start index of the slice :param end: End index of the slice :type start: int :type end: int :rtype : list[(syntax.SemanticType | BaseContainer)]</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__init__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__init__">__init__</a></code></td>
|
|
<td>:param content: List of tokens to be added to the container :param optionals: List of optional tokens to be added to the container (from the parser) :param others: List of values to add to the .format() method :type content: (list[(syntax...</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__invert__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__invert__">__invert__</a></code></td>
|
|
<td>Returns the inverted optionals of the container. :rtype : BaseContainer</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__iter__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__iter__">__iter__</a></code></td>
|
|
<td>:ytype : iter[syntax.SemanticType]</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__len__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__len__">__len__</a></code></td>
|
|
<td>:rtype : int</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__repr__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__repr__">__repr__</a></code></td>
|
|
<td>:rtype : str</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__rshift__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__rshift__">__rshift__</a></code></td>
|
|
<td>:param other: The name of the map element to get :type other: str :rtype : (syntax.SemanticType | BaseContainer)</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__setitem__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__setitem__">__setitem__</a></code></td>
|
|
<td>:param key: Index of the element to set :param value: Value to set :type key: int :type value: (syntax.SemanticType | BaseContainer)</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#__str__" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.__str__">__str__</a></code></td>
|
|
<td>:rtype : str</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#add" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.add">add</a></code></td>
|
|
<td>Adds a list of elements to the container. :param other: List of elements to add :type other: syntax.SemanticType :return: None</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#class_name" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.class_name">class<wbr></wbr>_name</a></code></td>
|
|
<td>A string representation of the class name. :rtype : str</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#debug_map" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.debug_map">debug<wbr></wbr>_map</a></code></td>
|
|
<td>Prints the map of the container. :return: None</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#get_optionals" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.get_optionals">get<wbr></wbr>_optionals</a></code></td>
|
|
<td>Get the optionals of the container. :rtype : (syntax.SemanticType | BaseContainer) :return: The optionals of the container</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#get_others" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.get_others">get<wbr></wbr>_others</a></code></td>
|
|
<td>Get the other values of the container. :rtype : dict[str, str] :return: The other values of the container</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#print_all" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.print_all">print<wbr></wbr>_all</a></code></td>
|
|
<td>Prints the container and all its content.</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#to_container" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.to_container">to<wbr></wbr>_container</a></code></td>
|
|
<td>Returns a container with the same content as the current container. Used for compatibility with the syntax for encapsulation.</td>
|
|
</tr><tr class="basemethod">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#validate" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.validate">validate</a></code></td>
|
|
<td>Takes a list as input and checks if every element is in map. :param other: List of elements to check :type other: list[(syntax.SemanticType | BaseContainer)] :return: True if every element is in map, False otherwise...</td>
|
|
</tr><tr class="baseinstancevariable">
|
|
|
|
<td>Instance Variable</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#content" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.content">content</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="baseinstancevariable">
|
|
|
|
<td>Instance Variable</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#indentation_level" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.indentation_level">indentation<wbr></wbr>_level</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="baseinstancevariable">
|
|
|
|
<td>Instance Variable</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#map" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.map">map</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="baseinstancevariable">
|
|
|
|
<td>Instance Variable</td>
|
|
<td><code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#optionals" class="internal-link" title="bootstraparse.modules.context_mngr.BaseContainer.optionals">optionals</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="childList">
|
|
<div class="basemethod">
|
|
|
|
|
|
<a name="bootstraparse.modules.context_mngr.HeaderContainer.export">
|
|
|
|
</a>
|
|
<a name="export">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">export</span>(self, exm):
|
|
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
<div class="interfaceinfo">overrides <code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#export" class="internal-link">bootstraparse.modules.context_mngr.BaseContainer.export</a></code></div>
|
|
|
|
<div><p>Export the container to a string. :type exm: export.ExportManager :rtype : str</p>
|
|
</div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="bootstraparse.modules.context_mngr.HeaderContainer.get_content">
|
|
|
|
</a>
|
|
<a name="get_content">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">get_content</span>(self, exm, arbitrary_list=None):
|
|
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
<div class="interfaceinfo">overrides <code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#get_content" class="internal-link">bootstraparse.modules.context_mngr.BaseContainer.get_content</a></code></div>
|
|
|
|
<div><p>Get the content of any BaseContainer object (default self.content). :param exm: ExportManager to use for exporting :param arbitrary_list: List to get the content from :type exm: export.ExportManager :type arbitrary_list: list[BaseContainer] :rtype : str</p>
|
|
</div>
|
|
</div>
|
|
</div><div class="baseclassvariable">
|
|
|
|
|
|
<a name="bootstraparse.modules.context_mngr.HeaderContainer.subtype">
|
|
|
|
</a>
|
|
<a name="subtype">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">subtype</span>: <code>str</code> =
|
|
|
|
</div>
|
|
<div class="functionBody">
|
|
<div class="interfaceinfo">overrides <code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#subtype" class="internal-link">bootstraparse.modules.context_mngr.BaseContainer.subtype</a></code></div>
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
|
|
</div>
|
|
</div><div class="baseclassvariable">
|
|
|
|
|
|
<a name="bootstraparse.modules.context_mngr.HeaderContainer.type">
|
|
|
|
</a>
|
|
<a name="type">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">type</span>: <code>str</code> =
|
|
|
|
</div>
|
|
<div class="functionBody">
|
|
<div class="interfaceinfo">overrides <code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#type" class="internal-link">bootstraparse.modules.context_mngr.BaseContainer.type</a></code></div>
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
|
|
</div>
|
|
</div><div class="baseinstancevariable">
|
|
|
|
|
|
<a name="bootstraparse.modules.context_mngr.HeaderContainer.others">
|
|
|
|
</a>
|
|
<a name="others">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">others</span>: <code>dict</code> =
|
|
|
|
</div>
|
|
<div class="functionBody">
|
|
<div class="interfaceinfo">overrides <code><a href="bootstraparse.modules.context_mngr.BaseContainer.html#others" class="internal-link">bootstraparse.modules.context_mngr.BaseContainer.others</a></code></div>
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="navbar navbar-default">
|
|
|
|
|
|
<div class="container">
|
|
<a href="index.html">API Documentation</a> for bootstraparse,
|
|
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
|
22.5.1 at 2022-06-15 19:40:50.
|
|
</div>
|
|
|
|
<!-- Search related scripts needs to be loaded at the end of HTML
|
|
parsing not to introduce overhead and display HTML data asap -->
|
|
<script src="ajax.js" type="text/javascript"></script>
|
|
<script src="searchlib.js" type="text/javascript"></script>
|
|
<script src="search.js" type="text/javascript"></script>
|
|
|
|
</footer>
|
|
|
|
<script src="pydoctor.js" type="text/javascript"></script>
|
|
|
|
</body>
|
|
</html> |