{{ project }}
+{% endif %} + +{% if theme_description %} +{{ theme_description }}
+{% endif %} + +{% if theme_github_user and theme_github_repo %} +{% if theme_github_button|lower == 'true' %} ++ +
+{% endif %} +{% endif %} + +{% if theme_travis_button|lower != 'false' %} +{% if theme_travis_button|lower == 'true' %} + {% set path = theme_github_user + '/' + theme_github_repo %} +{% else %} + {% set path = theme_travis_button %} +{% endif %} +
+
+ 
+
+
+
+ 
+
+
Donate/support
+{% endif %} + +{% if theme_donate_url %} +
+
+
+
+
+
+ 
+
+
+Professionally-supported {{ project }} is available with the +Tidelift Subscription. +
+{% endif %} diff --git a/docs/.venv/lib/python3.9/site-packages/alabaster/layout.html b/docs/.venv/lib/python3.9/site-packages/alabaster/layout.html new file mode 100644 index 0000000..a7ca710 --- /dev/null +++ b/docs/.venv/lib/python3.9/site-packages/alabaster/layout.html @@ -0,0 +1,126 @@ +{%- extends "basic/layout.html" %} + +{%- block extrahead %} + {{ super() }} + + {% if theme_touch_icon %} + + {% endif %} + + {# Deprecated in favor of html_baseurl (pageurl). This is already set in the basic theme #} + {% if theme_canonical_url and not pageurl %} + + {% endif %} +{% endblock %} + +{# top+bottom related navs; we also have our own in sidebar #} +{%- macro rellink_markup() %} + +{%- endmacro %} + +{%- set theme_show_relbar_top = theme_show_relbar_top or theme_show_relbars %} +{%- set theme_show_relbar_bottom = theme_show_relbar_bottom or theme_show_relbars %} + +{# removed existing top+bottom related nav, and embed in main content #} +{%- block relbar1 %}{% endblock %} +{%- block relbar2 %}{% endblock %} + +{# Nav should appear before content, not after #} +{%- block content %} +{%- if theme_fixed_sidebar|lower == 'true' %} +
+ {{ sidebar() }}
+ {%- block document %}
+
+{%- else %}
+{{ super() }}
+{%- endif %}
+{%- endblock %}
+
+{%- block footer %}
+
+
+ {% if theme_github_banner|lower != 'false' %}
+
+
+ {%- if render_sidebar %}
+
+ {%- endblock %}
+
+
+ {%- endif %}
+
+ {%- block relbar_top %}
+ {%- if theme_show_relbar_top|tobool %}
+
+ {%- endif %}
+ {% endblock %}
+
+
+ {%- endif %}
+
+ {% block body %} {% endblock %}
+
+
+ {%- block relbar_bottom %}
+ {%- if theme_show_relbar_bottom|tobool %}
+
+ {%- endif %}
+ {% endblock %}
+
+ {%- if render_sidebar %}
+  if theme_github_banner|lower != 'true' else 'https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png' }})
+
+ {% endif %}
+
+ {% if theme_analytics_id %}
+
+ {% endif %}
+{%- endblock %}
diff --git a/docs/.venv/lib/python3.9/site-packages/alabaster/navigation.html b/docs/.venv/lib/python3.9/site-packages/alabaster/navigation.html
new file mode 100644
index 0000000..760dcc9
--- /dev/null
+++ b/docs/.venv/lib/python3.9/site-packages/alabaster/navigation.html
@@ -0,0 +1,10 @@
+{{ _('Navigation') }}
+{{ toctree(includehidden=theme_sidebar_includehidden, collapse=theme_sidebar_collapse) }} +{% if theme_extra_nav_links %} ++
-
+ {% for text, uri in theme_extra_nav_links.items() %}
+
- {{ text }} + {% endfor %} +
+
diff --git a/docs/.venv/lib/python3.9/site-packages/alabaster/static/alabaster.css_t b/docs/.venv/lib/python3.9/site-packages/alabaster/static/alabaster.css_t
new file mode 100644
index 0000000..720b7af
--- /dev/null
+++ b/docs/.venv/lib/python3.9/site-packages/alabaster/static/alabaster.css_t
@@ -0,0 +1,776 @@
+{%- set theme_body_bg = theme_body_bg or theme_base_bg %}
+{%- set theme_code_highlight_bg = theme_code_highlight_bg or theme_body_bg %}
+{%- set theme_sidebar_header = theme_sidebar_header or theme_gray_1 %}
+{%- set theme_sidebar_link = theme_sidebar_link or theme_gray_1 %}
+{%- set theme_anchor_hover_fg = theme_anchor_hover_fg or theme_gray_1 %}
+
+{%- set theme_footnote_border = theme_footnote_border or theme_gray_2 %}
+{%- set theme_pre_bg = theme_pre_bg or theme_gray_2 %}
+
+{%- set theme_head_font_family = theme_head_font_family or theme_font_family %}
+
+{#- set up admonition styling #}
+{#- - basic level #}
+{%- set theme_admonition_xref_bg = theme_admonition_xref_bg or theme_xref_bg %}
+{%- set theme_admonition_bg = theme_admonition_bg or theme_gray_2 %}
+{%- set theme_note_bg = theme_note_bg or theme_gray_2 %}
+{%- set theme_seealso_bg = theme_seealso_bg or theme_gray_2 %}
+
+{#- - critical level #}
+{%- set theme_danger_bg = theme_danger_bg or theme_pink_1 %}
+{%- set theme_danger_border = theme_danger_border or theme_pink_2 %}
+{%- set theme_danger_shadow = theme_danger_shadow or theme_pink_3 %}
+
+{%- set theme_error_bg = theme_error_bg or theme_pink_1 %}
+{%- set theme_error_border = theme_error_border or theme_pink_2 %}
+{%- set theme_error_shadow = theme_error_shadow or theme_pink_3 %}
+
+{#- - warning level #}
+{%- set theme_caution_bg = theme_caution_bg or theme_pink_1 %}
+{%- set theme_caution_border = theme_caution_border or theme_pink_2 %}
+
+{%- set theme_attention_bg = theme_attention_bg or theme_pink_1 %}
+{%- set theme_attention_border = theme_attention_border or theme_pink_2 %}
+
+{%- set theme_warn_bg = theme_warn_bg or theme_pink_1 %}
+{%- set theme_warn_border = theme_warn_border or theme_pink_2 %}
+
+{#- - normal level #}
+{%- set theme_important_bg = theme_important_bg or theme_gray_2 %}
+{%- set theme_tip_bg = theme_tip_bg or theme_gray_2 %}
+{%- set theme_hint_bg = theme_hint_bg or theme_gray_2 %}
+
+{#- /set up admonition styling #}
+
+{%- set theme_shadow = theme_shadow or theme_gray_2 %}
+
+
+{%- set theme_topic_bg = theme_topic_bg or theme_gray_2 %}
+
+{%- set theme_narrow_sidebar_link = theme_narrow_sidebar_link or theme_gray_3 %}
+{%- set theme_sidebar_hr = theme_sidebar_hr or theme_gray_3 %}
+
+{%- set theme_relbar_border = theme_relbar_border or theme_gray_2 -%}
+
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: {{ theme_font_family }};
+ font-size: {{ theme_font_size }};
+ background-color: {{ theme_base_bg }};
+ color: {{ theme_base_text }};
+ margin: 0;
+ padding: 0;
+}
+
+
+div.document {
+ width: {{ theme_page_width }};
+ margin: 30px auto 0 auto;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 {{ theme_sidebar_width }};
+}
+
+div.sphinxsidebar {
+ width: {{ theme_sidebar_width }};
+ font-size: 14px;
+ line-height: 1.5;
+}
+
+hr {
+ border: 1px solid {{ theme_hr_border }};
+}
+
+div.body {
+ background-color: {{ theme_body_bg }};
+ color: {{ theme_body_text }};
+ padding: 0 30px 0 30px;
+}
+
+div.body > .section {
+ text-align: {{ theme_body_text_align }};
+}
+
+div.footer {
+ width: {{ theme_page_width }};
+ margin: 20px auto 30px auto;
+ font-size: 14px;
+ color: {{ theme_footer_text }};
+ text-align: right;
+}
+
+div.footer a {
+ color: {{ theme_footer_text }};
+}
+
+p.caption {
+ font-family: {{ theme_caption_font_family }};
+ font-size: {{ theme_caption_font_size }};
+}
+
+{% if theme_show_related|lower == 'false' %}
+div.relations {
+ display: none;
+}
+{% endif %}
+
+div.sphinxsidebar {
+ max-height: 100%;
+ overflow-y: auto;
+}
+
+div.sphinxsidebar a {
+ color: {{ theme_sidebar_link }};
+ text-decoration: none;
+ border-bottom: 1px dotted {{ theme_sidebar_link_underscore }};
+}
+
+div.sphinxsidebar a:hover {
+ border-bottom: 1px solid {{ theme_sidebar_link_underscore }};
+}
+
+div.sphinxsidebarwrapper {
+ padding: 18px 10px;
+}
+
+div.sphinxsidebarwrapper p.logo {
+ padding: 0;
+ margin: -10px 0 0 0px;
+ text-align: center;
+}
+
+div.sphinxsidebarwrapper h1.logo {
+ margin-top: -10px;
+ text-align: center;
+ margin-bottom: 5px;
+ text-align: {{ theme_logo_text_align }};
+}
+
+div.sphinxsidebarwrapper h1.logo-name {
+ margin-top: 0px;
+}
+
+div.sphinxsidebarwrapper p.blurb {
+ margin-top: 0;
+ font-style: {{ theme_description_font_style }};
+}
+
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+ font-family: {{ theme_head_font_family }};
+ color: {{ theme_sidebar_header }};
+ font-size: 24px;
+ font-weight: normal;
+ margin: 0 0 5px 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h4 {
+ font-size: 20px;
+}
+
+div.sphinxsidebar h3 a {
+ color: {{ theme_sidebar_link }};
+}
+
+div.sphinxsidebar p.logo a,
+div.sphinxsidebar h3 a,
+div.sphinxsidebar p.logo a:hover,
+div.sphinxsidebar h3 a:hover {
+ border: none;
+}
+
+div.sphinxsidebar p {
+ color: {{ theme_sidebar_text }};
+ margin: 10px 0;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px 0;
+ padding: 0;
+ color: {{ theme_sidebar_list }};
+}
+
+div.sphinxsidebar ul li.toctree-l1 > a {
+ font-size: 120%;
+}
+
+div.sphinxsidebar ul li.toctree-l2 > a {
+ font-size: 110%;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid {{ theme_sidebar_search_button }};
+ font-family: {{ theme_font_family }};
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ width: 160px;
+}
+
+div.sphinxsidebar .search > div {
+ display: table-cell;
+}
+
+div.sphinxsidebar hr {
+ border: none;
+ height: 1px;
+ color: {{ theme_sidebar_hr }};
+ background: {{ theme_sidebar_hr }};
+
+ text-align: left;
+ margin-left: 0;
+ width: 50%;
+}
+
+div.sphinxsidebar .badge {
+ border-bottom: none;
+}
+
+div.sphinxsidebar .badge:hover {
+ border-bottom: none;
+}
+
+/* To address an issue with donation coming after search */
+div.sphinxsidebar h3.donation {
+ margin-top: 10px;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: {{ theme_link }};
+ text-decoration: underline;
+}
+
+a:hover {
+ color: {{ theme_link_hover }};
+ text-decoration: underline;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: {{ theme_head_font_family }};
+ font-weight: normal;
+ margin: 30px 0px 10px 0px;
+ padding: 0;
+}
+
+div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: {{ theme_anchor }};
+ padding: 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ color: {{ theme_anchor_hover_fg }};
+ background: {{ theme_anchor_hover_bg }};
+}
+
+div.body p, div.body dd, div.body li {
+ line-height: 1.4em;
+}
+
+div.admonition {
+ margin: 20px 0px;
+ padding: 10px 30px;
+ background-color: {{ theme_admonition_bg }};
+ border: 1px solid {{ theme_admonition_border }};
+}
+
+div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+ background-color: {{ theme_admonition_xref_bg }};
+ border-bottom: 1px solid {{ theme_admonition_xref_border }};
+}
+
+div.admonition p.admonition-title {
+ font-family: {{ theme_head_font_family }};
+ font-weight: normal;
+ font-size: 24px;
+ margin: 0 0 10px 0;
+ padding: 0;
+ line-height: 1;
+}
+
+div.admonition p.last {
+ margin-bottom: 0;
+}
+
+div.highlight {
+ background-color: {{ theme_code_highlight_bg }};
+}
+
+dt:target, .highlight {
+ background: {{ theme_highlight_bg }};
+}
+
+div.warning {
+ background-color: {{ theme_warn_bg }};
+ border: 1px solid {{ theme_warn_border }};
+}
+
+div.danger {
+ background-color: {{ theme_danger_bg }};
+ border: 1px solid {{ theme_danger_border }};
+ -moz-box-shadow: 2px 2px 4px {{ theme_danger_shadow }};
+ -webkit-box-shadow: 2px 2px 4px {{ theme_danger_shadow }};
+ box-shadow: 2px 2px 4px {{ theme_danger_shadow }};
+}
+
+div.error {
+ background-color: {{ theme_error_bg }};
+ border: 1px solid {{ theme_error_border }};
+ -moz-box-shadow: 2px 2px 4px {{ theme_error_shadow }};
+ -webkit-box-shadow: 2px 2px 4px {{ theme_error_shadow }};
+ box-shadow: 2px 2px 4px {{ theme_error_shadow }};
+}
+
+div.caution {
+ background-color: {{ theme_caution_bg }};
+ border: 1px solid {{ theme_caution_border }};
+}
+
+div.attention {
+ background-color: {{ theme_attention_bg }};
+ border: 1px solid {{ theme_attention_border }};
+}
+
+div.important {
+ background-color: {{ theme_important_bg }};
+ border: 1px solid {{ theme_important_border }};
+}
+
+div.note {
+ background-color: {{ theme_note_bg }};
+ border: 1px solid {{ theme_note_border }};
+}
+
+div.tip {
+ background-color: {{ theme_tip_bg }};
+ border: 1px solid {{ theme_tip_border }};
+}
+
+div.hint {
+ background-color: {{ theme_hint_bg }};
+ border: 1px solid {{ theme_hint_border }};
+}
+
+div.seealso {
+ background-color: {{ theme_seealso_bg }};
+ border: 1px solid {{ theme_seealso_border }};
+}
+
+div.topic {
+ background-color: {{ theme_topic_bg }};
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre, tt, code {
+ font-family: {{theme_code_font_family}};
+ font-size: {{ theme_code_font_size }};
+}
+
+.hll {
+ background-color: {{theme_code_highlight}};
+ margin: 0 -12px;
+ padding: 0 12px;
+ display: block;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname, code.descname, code.descclassname {
+ font-size: 0.95em;
+}
+
+tt.descname, code.descname {
+ padding-right: 0.08em;
+}
+
+img.screenshot {
+ -moz-box-shadow: 2px 2px 4px {{ theme_shadow }};
+ -webkit-box-shadow: 2px 2px 4px {{ theme_shadow }};
+ box-shadow: 2px 2px 4px {{ theme_shadow }};
+}
+
+table.docutils {
+ border: 1px solid {{ theme_table_border }};
+ -moz-box-shadow: 2px 2px 4px {{ theme_shadow }};
+ -webkit-box-shadow: 2px 2px 4px {{ theme_shadow }};
+ box-shadow: 2px 2px 4px {{ theme_shadow }};
+}
+
+table.docutils td, table.docutils th {
+ border: 1px solid {{ theme_table_border }};
+ padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+ border: none;
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+table.footnote {
+ margin: 15px 0;
+ width: 100%;
+ border: 1px solid {{ theme_footnote_border }};
+ background: {{ theme_footnote_bg }};
+ font-size: 0.9em;
+}
+
+table.footnote + table.footnote {
+ margin-top: -15px;
+ border-top: none;
+}
+
+table.field-list th {
+ padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+ padding: 0;
+}
+
+table.field-list p {
+ margin-bottom: 0.8em;
+}
+
+/* Cloned from
+ * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
+ */
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+table.footnote td.label {
+ width: .1px;
+ padding: 0.3em 0 0.3em 0.5em;
+}
+
+table.footnote td {
+ padding: 0.3em 0.5em;
+}
+
+dl {
+ margin-left: 0;
+ margin-right: 0;
+ margin-top: 0;
+ padding: 0;
+}
+
+dl dd {
+ margin-left: 30px;
+}
+
+blockquote {
+ margin: 0 0 0 30px;
+ padding: 0;
+}
+
+ul, ol {
+ /* Matches the 30px from the narrow-screen "li > ul" selector below */
+ margin: 10px 0 10px 30px;
+ padding: 0;
+}
+
+pre {
+ background: {{ theme_pre_bg }};
+ padding: 7px 30px;
+ margin: 15px 0px;
+ line-height: 1.3em;
+}
+
+div.viewcode-block:target {
+ background: {{ theme_viewcode_target_bg }};
+}
+
+dl pre, blockquote pre, li pre {
+ margin-left: 0;
+ padding-left: 30px;
+}
+
+tt, code {
+ background-color: {{ theme_code_bg }};
+ color: {{ theme_code_text }};
+ /* padding: 1px 2px; */
+}
+
+tt.xref, code.xref, a tt {
+ background-color: {{ theme_xref_bg }};
+ border-bottom: 1px solid {{ theme_xref_border }};
+}
+
+a.reference {
+ text-decoration: none;
+ border-bottom: 1px dotted {{ theme_link }};
+}
+
+/* Don't put an underline on images */
+a.image-reference, a.image-reference:hover {
+ border-bottom: none;
+}
+
+a.reference:hover {
+ border-bottom: 1px solid {{ theme_link_hover }};
+}
+
+a.footnote-reference {
+ text-decoration: none;
+ font-size: 0.7em;
+ vertical-align: top;
+ border-bottom: 1px dotted {{ theme_link }};
+}
+
+a.footnote-reference:hover {
+ border-bottom: 1px solid {{ theme_link_hover }};
+}
+
+a:hover tt, a:hover code {
+ background: {{ theme_code_hover }};
+}
+
+
+@media screen and (max-width: 870px) {
+
+ div.sphinxsidebar {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+
+ }
+
+ div.documentwrapper {
+ margin-left: 0;
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ }
+
+ div.bodywrapper {
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ margin-left: 0;
+ }
+
+ ul {
+ margin-left: 0;
+ }
+
+ li > ul {
+ /* Matches the 30px from the "ul, ol" selector above */
+ margin-left: 30px;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .bodywrapper {
+ margin: 0;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+
+
+
+}
+
+
+
+@media screen and (max-width: 875px) {
+
+ body {
+ margin: 0;
+ padding: 20px 30px;
+ }
+
+ div.documentwrapper {
+ float: none;
+ background: {{ theme_base_bg }};
+ }
+
+ div.sphinxsidebar {
+ display: block;
+ float: none;
+ width: 102.5%;
+ {%- if theme_fixed_sidebar|lower == 'true' %}
+ margin: -20px -30px 20px -30px;
+ {%- else %}
+ margin: 50px -30px -20px -30px;
+ {%- endif %}
+ padding: 10px 20px;
+ background: {{ theme_narrow_sidebar_bg }};
+ color: {{ theme_narrow_sidebar_fg }};
+ }
+
+ div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
+ div.sphinxsidebar h3 a {
+ color: {{ theme_base_bg }};
+ }
+
+ div.sphinxsidebar a {
+ color: {{ theme_narrow_sidebar_link }};
+ }
+
+ div.sphinxsidebar p.logo {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+ margin: 0;
+ }
+
+ div.footer {
+ display: none;
+ }
+
+ div.bodywrapper {
+ margin: 0;
+ }
+
+ div.body {
+ min-height: 0;
+ padding: 0;
+ }
+
+ .rtd_doc_footer {
+ display: none;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+}
+
+{%- if theme_fixed_sidebar|lower == 'true' %}
+@media screen and (min-width: 876px) {
+ div.sphinxsidebar {
+ position: fixed;
+ margin-left: 0;
+ }
+}
+{%- endif %}
+
+
+/* misc. */
+
+.revsys-inline {
+ display: none!important;
+}
+
+/* Hide ugly table cell borders in ..bibliography:: directive output */
+table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
+ border: none;
+ /* Below needed in some edge cases; if not applied, bottom shadows appear */
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+
+/* relbar */
+
+.related {
+ line-height: 30px;
+ width: 100%;
+ font-size: 0.9rem;
+}
+
+.related.top {
+ border-bottom: 1px solid {{ theme_relbar_border }};
+ margin-bottom: 20px;
+}
+
+.related.bottom {
+ border-top: 1px solid {{ theme_relbar_border }};
+}
+
+.related ul {
+ padding: 0;
+ margin: 0;
+ list-style: none;
+}
+
+.related li {
+ display: inline;
+}
+
+nav#rellinks {
+ float: right;
+}
+
+nav#rellinks li+li:before {
+ content: "|";
+}
+
+nav#breadcrumbs li+li:before {
+ content: "\00BB";
+}
+
+/* Hide certain items when printing */
+@media print {
+ div.related {
+ display: none;
+ }
+}
diff --git a/docs/.venv/lib/python3.9/site-packages/alabaster/static/custom.css b/docs/.venv/lib/python3.9/site-packages/alabaster/static/custom.css
new file mode 100644
index 0000000..2a924f1
--- /dev/null
+++ b/docs/.venv/lib/python3.9/site-packages/alabaster/static/custom.css
@@ -0,0 +1 @@
+/* This file intentionally left blank. */
diff --git a/docs/.venv/lib/python3.9/site-packages/alabaster/support.py b/docs/.venv/lib/python3.9/site-packages/alabaster/support.py
new file mode 100644
index 0000000..3b2ce04
--- /dev/null
+++ b/docs/.venv/lib/python3.9/site-packages/alabaster/support.py
@@ -0,0 +1,89 @@
+from pygments.style import Style
+from pygments.token import (
+ Comment,
+ Error,
+ Generic,
+ Keyword,
+ Literal,
+ Name,
+ Number,
+ Operator,
+ Other,
+ Punctuation,
+ String,
+ Whitespace,
+)
+
+
+# Originally based on FlaskyStyle which was based on 'tango'.
+class Alabaster(Style):
+ background_color = "#f8f8f8" # doesn't seem to override CSS 'pre' styling?
+ default_style = ""
+
+ styles = {
+ # No corresponding class for the following:
+ # Text: "", # class: ''
+ Whitespace: "#f8f8f8", # class: 'w'
+ Error: "#a40000 border:#ef2929", # class: 'err'
+ Other: "#000000", # class 'x'
+ Comment: "italic #8f5902", # class: 'c'
+ Comment.Preproc: "noitalic", # class: 'cp'
+ Keyword: "bold #004461", # class: 'k'
+ Keyword.Constant: "bold #004461", # class: 'kc'
+ Keyword.Declaration: "bold #004461", # class: 'kd'
+ Keyword.Namespace: "bold #004461", # class: 'kn'
+ Keyword.Pseudo: "bold #004461", # class: 'kp'
+ Keyword.Reserved: "bold #004461", # class: 'kr'
+ Keyword.Type: "bold #004461", # class: 'kt'
+ Operator: "#582800", # class: 'o'
+ Operator.Word: "bold #004461", # class: 'ow' - like keywords
+ Punctuation: "bold #000000", # class: 'p'
+ # because special names such as Name.Class, Name.Function, etc.
+ # are not recognized as such later in the parsing, we choose them
+ # to look the same as ordinary variables.
+ Name: "#000000", # class: 'n'
+ Name.Attribute: "#c4a000", # class: 'na' - to be revised
+ Name.Builtin: "#004461", # class: 'nb'
+ Name.Builtin.Pseudo: "#3465a4", # class: 'bp'
+ Name.Class: "#000000", # class: 'nc' - to be revised
+ Name.Constant: "#000000", # class: 'no' - to be revised
+ Name.Decorator: "#888", # class: 'nd' - to be revised
+ Name.Entity: "#ce5c00", # class: 'ni'
+ Name.Exception: "bold #cc0000", # class: 'ne'
+ Name.Function: "#000000", # class: 'nf'
+ Name.Property: "#000000", # class: 'py'
+ Name.Label: "#f57900", # class: 'nl'
+ Name.Namespace: "#000000", # class: 'nn' - to be revised
+ Name.Other: "#000000", # class: 'nx'
+ Name.Tag: "bold #004461", # class: 'nt' - like a keyword
+ Name.Variable: "#000000", # class: 'nv' - to be revised
+ Name.Variable.Class: "#000000", # class: 'vc' - to be revised
+ Name.Variable.Global: "#000000", # class: 'vg' - to be revised
+ Name.Variable.Instance: "#000000", # class: 'vi' - to be revised
+ Number: "#990000", # class: 'm'
+ Literal: "#000000", # class: 'l'
+ Literal.Date: "#000000", # class: 'ld'
+ String: "#4e9a06", # class: 's'
+ String.Backtick: "#4e9a06", # class: 'sb'
+ String.Char: "#4e9a06", # class: 'sc'
+ String.Doc: "italic #8f5902", # class: 'sd' - like a comment
+ String.Double: "#4e9a06", # class: 's2'
+ String.Escape: "#4e9a06", # class: 'se'
+ String.Heredoc: "#4e9a06", # class: 'sh'
+ String.Interpol: "#4e9a06", # class: 'si'
+ String.Other: "#4e9a06", # class: 'sx'
+ String.Regex: "#4e9a06", # class: 'sr'
+ String.Single: "#4e9a06", # class: 's1'
+ String.Symbol: "#4e9a06", # class: 'ss'
+ Generic: "#000000", # class: 'g'
+ Generic.Deleted: "#a40000", # class: 'gd'
+ Generic.Emph: "italic #000000", # class: 'ge'
+ Generic.Error: "#ef2929", # class: 'gr'
+ Generic.Heading: "bold #000080", # class: 'gh'
+ Generic.Inserted: "#00A000", # class: 'gi'
+ Generic.Output: "#888", # class: 'go'
+ Generic.Prompt: "#745334", # class: 'gp'
+ Generic.Strong: "bold #000000", # class: 'gs'
+ Generic.Subheading: "bold #800080", # class: 'gu'
+ Generic.Traceback: "bold #a40000", # class: 'gt'
+ }
diff --git a/docs/.venv/lib/python3.9/site-packages/alabaster/theme.conf b/docs/.venv/lib/python3.9/site-packages/alabaster/theme.conf
new file mode 100644
index 0000000..e85049e
--- /dev/null
+++ b/docs/.venv/lib/python3.9/site-packages/alabaster/theme.conf
@@ -0,0 +1,132 @@
+[theme]
+inherit = basic
+stylesheet = alabaster.css
+sidebars = about.html, navigation.html, relations.html, searchbox.html, donate.html
+pygments_style = alabaster.support.Alabaster
+
+[options]
+body_min_width = inherit
+analytics_id =
+badge_branch = master
+canonical_url =
+codecov_button = false
+description =
+description_font_style = normal
+donate_url =
+extra_nav_links =
+fixed_sidebar = false
+github_banner = false
+github_button = true
+github_count = true
+github_repo =
+github_type = watch
+github_user =
+gittip_user =
+gratipay_user =
+logo =
+logo_name = false
+logo_text_align = left
+opencollective =
+opencollective_button_color = white
+page_width = 940px
+relbar_border =
+show_powered_by = true
+show_related = false
+show_relbar_bottom =
+show_relbar_top =
+show_relbars = false
+sidebar_collapse = true
+sidebar_includehidden = true
+sidebar_width = 220px
+tidelift_url =
+touch_icon =
+travis_button = false
+
+gray_1 = #444
+gray_2 = #EEE
+gray_3 = #AAA
+
+pink_1 = #FCC
+pink_2 = #FAA
+pink_3 = #D52C2C
+
+base_bg = #fff
+base_text = #000
+hr_border = #B1B4B6
+body_bg =
+body_text = #3E4349
+body_text_align = left
+footer_text = #888
+link = #004B6B
+link_hover = #6D4100
+sidebar_header =
+sidebar_text = #555
+sidebar_link =
+sidebar_link_underscore = #999
+sidebar_search_button = #CCC
+sidebar_list = #000
+sidebar_hr =
+anchor = #DDD
+anchor_hover_fg =
+anchor_hover_bg = #EAEAEA
+table_border = #888
+shadow =
+
+# Admonition options
+## basic level
+admonition_bg =
+admonition_border = #CCC
+note_bg =
+note_border = #CCC
+seealso_bg =
+seealso_border = #CCC
+
+## critical level
+danger_bg =
+danger_border =
+danger_shadow =
+error_bg =
+error_border =
+error_shadow =
+
+## normal level
+tip_bg =
+tip_border = #CCC
+hint_bg =
+hint_border = #CCC
+important_bg =
+important_border = #CCC
+
+## warning level
+caution_bg =
+caution_border =
+attention_bg =
+attention_border =
+warn_bg =
+warn_border =
+
+topic_bg =
+code_highlight_bg =
+highlight_bg = #FAF3E8
+xref_border = #fff
+xref_bg = #FBFBFB
+admonition_xref_border = #fafafa
+admonition_xref_bg =
+footnote_bg = #FDFDFD
+footnote_border =
+pre_bg =
+narrow_sidebar_bg = #333
+narrow_sidebar_fg = #FFF
+narrow_sidebar_link =
+font_size = 17px
+caption_font_size = inherit
+viewcode_target_bg = #ffd
+code_bg = #ecf0f3
+code_text = #222
+code_hover = #EEE
+code_font_size = 0.9em
+code_font_family = 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace
+font_family = Georgia, serif
+head_font_family =
+caption_font_family = inherit
+code_highlight = #FFC
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__init__.py b/docs/.venv/lib/python3.9/site-packages/babel/__init__.py
new file mode 100644
index 0000000..6a9789c
--- /dev/null
+++ b/docs/.venv/lib/python3.9/site-packages/babel/__init__.py
@@ -0,0 +1,37 @@
+"""
+ babel
+ ~~~~~
+
+ Integrated collection of utilities that assist in internationalizing and
+ localizing applications.
+
+ This package is basically composed of two major parts:
+
+ * tools to build and work with ``gettext`` message catalogs
+ * a Python interface to the CLDR (Common Locale Data Repository), providing
+ access to various locale display names, localized number and date
+ formatting, etc.
+
+ :copyright: (c) 2013-2024 by the Babel Team.
+ :license: BSD, see LICENSE for more details.
+"""
+
+from babel.core import (
+ Locale,
+ UnknownLocaleError,
+ default_locale,
+ get_locale_identifier,
+ negotiate_locale,
+ parse_locale,
+)
+
+__version__ = '2.15.0'
+
+__all__ = [
+ 'Locale',
+ 'UnknownLocaleError',
+ 'default_locale',
+ 'get_locale_identifier',
+ 'negotiate_locale',
+ 'parse_locale',
+]
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/__init__.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/__init__.cpython-39.pyc
new file mode 100644
index 0000000..2935ce8
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/__init__.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/core.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/core.cpython-39.pyc
new file mode 100644
index 0000000..42b3304
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/core.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/dates.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/dates.cpython-39.pyc
new file mode 100644
index 0000000..6b077e2
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/dates.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/languages.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/languages.cpython-39.pyc
new file mode 100644
index 0000000..15500a5
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/languages.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/lists.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/lists.cpython-39.pyc
new file mode 100644
index 0000000..93cf7c5
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/lists.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/localedata.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/localedata.cpython-39.pyc
new file mode 100644
index 0000000..35864f9
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/localedata.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/numbers.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/numbers.cpython-39.pyc
new file mode 100644
index 0000000..fa06bd7
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/numbers.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/plural.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/plural.cpython-39.pyc
new file mode 100644
index 0000000..5a80f98
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/plural.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/support.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/support.cpython-39.pyc
new file mode 100644
index 0000000..8704ccb
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/support.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/units.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/units.cpython-39.pyc
new file mode 100644
index 0000000..d0fa6f0
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/units.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/util.cpython-39.pyc b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/util.cpython-39.pyc
new file mode 100644
index 0000000..331df39
Binary files /dev/null and b/docs/.venv/lib/python3.9/site-packages/babel/__pycache__/util.cpython-39.pyc differ
diff --git a/docs/.venv/lib/python3.9/site-packages/babel/core.py b/docs/.venv/lib/python3.9/site-packages/babel/core.py
new file mode 100644
index 0000000..56a4ee5
--- /dev/null
+++ b/docs/.venv/lib/python3.9/site-packages/babel/core.py
@@ -0,0 +1,1296 @@
+"""
+ babel.core
+ ~~~~~~~~~~
+
+ Core locale representation and locale data access.
+
+ :copyright: (c) 2013-2024 by the Babel Team.
+ :license: BSD, see LICENSE for more details.
+"""
+
+from __future__ import annotations
+
+import os
+import pickle
+from collections.abc import Iterable, Mapping
+from typing import TYPE_CHECKING, Any
+
+from babel import localedata
+from babel.plural import PluralRule
+
+__all__ = ['UnknownLocaleError', 'Locale', 'default_locale', 'negotiate_locale',
+ 'parse_locale']
+
+if TYPE_CHECKING:
+ from typing_extensions import Literal, TypeAlias
+
+ _GLOBAL_KEY: TypeAlias = Literal[
+ "all_currencies",
+ "currency_fractions",
+ "language_aliases",
+ "likely_subtags",
+ "meta_zones",
+ "parent_exceptions",
+ "script_aliases",
+ "territory_aliases",
+ "territory_currencies",
+ "territory_languages",
+ "territory_zones",
+ "variant_aliases",
+ "windows_zone_mapping",
+ "zone_aliases",
+ "zone_territories",
+ ]
+
+ _global_data: Mapping[_GLOBAL_KEY, Mapping[str, Any]] | None
+
+_global_data = None
+_default_plural_rule = PluralRule({})
+
+
+def _raise_no_data_error():
+ raise RuntimeError('The babel data files are not available. '
+ 'This usually happens because you are using '
+ 'a source checkout from Babel and you did '
+ 'not build the data files. Just make sure '
+ 'to run "python setup.py import_cldr" before '
+ 'installing the library.')
+
+
+def get_global(key: _GLOBAL_KEY) -> Mapping[str, Any]:
+ """Return the dictionary for the given key in the global data.
+
+ The global data is stored in the ``babel/global.dat`` file and contains
+ information independent of individual locales.
+
+ >>> get_global('zone_aliases')['UTC']
+ u'Etc/UTC'
+ >>> get_global('zone_territories')['Europe/Berlin']
+ u'DE'
+
+ The keys available are:
+
+ - ``all_currencies``
+ - ``currency_fractions``
+ - ``language_aliases``
+ - ``likely_subtags``
+ - ``parent_exceptions``
+ - ``script_aliases``
+ - ``territory_aliases``
+ - ``territory_currencies``
+ - ``territory_languages``
+ - ``territory_zones``
+ - ``variant_aliases``
+ - ``windows_zone_mapping``
+ - ``zone_aliases``
+ - ``zone_territories``
+
+ .. note:: The internal structure of the data may change between versions.
+
+ .. versionadded:: 0.9
+
+ :param key: the data key
+ """
+ global _global_data
+ if _global_data is None:
+ dirname = os.path.join(os.path.dirname(__file__))
+ filename = os.path.join(dirname, 'global.dat')
+ if not os.path.isfile(filename):
+ _raise_no_data_error()
+ with open(filename, 'rb') as fileobj:
+ _global_data = pickle.load(fileobj)
+ assert _global_data is not None
+ return _global_data.get(key, {})
+
+
+LOCALE_ALIASES = {
+ 'ar': 'ar_SY', 'bg': 'bg_BG', 'bs': 'bs_BA', 'ca': 'ca_ES', 'cs': 'cs_CZ',
+ 'da': 'da_DK', 'de': 'de_DE', 'el': 'el_GR', 'en': 'en_US', 'es': 'es_ES',
+ 'et': 'et_EE', 'fa': 'fa_IR', 'fi': 'fi_FI', 'fr': 'fr_FR', 'gl': 'gl_ES',
+ 'he': 'he_IL', 'hu': 'hu_HU', 'id': 'id_ID', 'is': 'is_IS', 'it': 'it_IT',
+ 'ja': 'ja_JP', 'km': 'km_KH', 'ko': 'ko_KR', 'lt': 'lt_LT', 'lv': 'lv_LV',
+ 'mk': 'mk_MK', 'nl': 'nl_NL', 'nn': 'nn_NO', 'no': 'nb_NO', 'pl': 'pl_PL',
+ 'pt': 'pt_PT', 'ro': 'ro_RO', 'ru': 'ru_RU', 'sk': 'sk_SK', 'sl': 'sl_SI',
+ 'sv': 'sv_SE', 'th': 'th_TH', 'tr': 'tr_TR', 'uk': 'uk_UA',
+}
+
+
+class UnknownLocaleError(Exception):
+ """Exception thrown when a locale is requested for which no locale data
+ is available.
+ """
+
+ def __init__(self, identifier: str) -> None:
+ """Create the exception.
+
+ :param identifier: the identifier string of the unsupported locale
+ """
+ Exception.__init__(self, f"unknown locale {identifier!r}")
+
+ #: The identifier of the locale that could not be found.
+ self.identifier = identifier
+
+
+class Locale:
+ """Representation of a specific locale.
+
+ >>> locale = Locale('en', 'US')
+ >>> repr(locale)
+ "Locale('en', territory='US')"
+ >>> locale.display_name
+ u'English (United States)'
+
+ A `Locale` object can also be instantiated from a raw locale string:
+
+ >>> locale = Locale.parse('en-US', sep='-')
+ >>> repr(locale)
+ "Locale('en', territory='US')"
+
+ `Locale` objects provide access to a collection of locale data, such as
+ territory and language names, number and date format patterns, and more:
+
+ >>> locale.number_symbols['latn']['decimal']
+ u'.'
+
+ If a locale is requested for which no locale data is available, an
+ `UnknownLocaleError` is raised:
+
+ >>> Locale.parse('en_XX')
+ Traceback (most recent call last):
+ ...
+ UnknownLocaleError: unknown locale 'en_XX'
+
+ For more information see :rfc:`3066`.
+ """
+
+ def __init__(
+ self,
+ language: str,
+ territory: str | None = None,
+ script: str | None = None,
+ variant: str | None = None,
+ modifier: str | None = None,
+ ) -> None:
+ """Initialize the locale object from the given identifier components.
+
+ >>> locale = Locale('en', 'US')
+ >>> locale.language
+ 'en'
+ >>> locale.territory
+ 'US'
+
+ :param language: the language code
+ :param territory: the territory (country or region) code
+ :param script: the script code
+ :param variant: the variant code
+ :param modifier: a modifier (following the '@' symbol, sometimes called '@variant')
+ :raise `UnknownLocaleError`: if no locale data is available for the
+ requested locale
+ """
+ #: the language code
+ self.language = language
+ #: the territory (country or region) code
+ self.territory = territory
+ #: the script code
+ self.script = script
+ #: the variant code
+ self.variant = variant
+ #: the modifier
+ self.modifier = modifier
+ self.__data: localedata.LocaleDataDict | None = None
+
+ identifier = str(self)
+ identifier_without_modifier = identifier.partition('@')[0]
+ if not localedata.exists(identifier_without_modifier):
+ raise UnknownLocaleError(identifier)
+
+ @classmethod
+ def default(cls, category: str | None = None, aliases: Mapping[str, str] = LOCALE_ALIASES) -> Locale:
+ """Return the system default locale for the specified category.
+
+ >>> for name in ['LANGUAGE', 'LC_ALL', 'LC_CTYPE', 'LC_MESSAGES']:
+ ... os.environ[name] = ''
+ >>> os.environ['LANG'] = 'fr_FR.UTF-8'
+ >>> Locale.default('LC_MESSAGES')
+ Locale('fr', territory='FR')
+
+ The following fallbacks to the variable are always considered:
+
+ - ``LANGUAGE``
+ - ``LC_ALL``
+ - ``LC_CTYPE``
+ - ``LANG``
+
+ :param category: one of the ``LC_XXX`` environment variable names
+ :param aliases: a dictionary of aliases for locale identifiers
+ """
+ # XXX: use likely subtag expansion here instead of the
+ # aliases dictionary.
+ locale_string = default_locale(category, aliases=aliases)
+ return cls.parse(locale_string)
+
+ @classmethod
+ def negotiate(
+ cls,
+ preferred: Iterable[str],
+ available: Iterable[str],
+ sep: str = '_',
+ aliases: Mapping[str, str] = LOCALE_ALIASES,
+ ) -> Locale | None:
+ """Find the best match between available and requested locale strings.
+
+ >>> Locale.negotiate(['de_DE', 'en_US'], ['de_DE', 'de_AT'])
+ Locale('de', territory='DE')
+ >>> Locale.negotiate(['de_DE', 'en_US'], ['en', 'de'])
+ Locale('de')
+ >>> Locale.negotiate(['de_DE', 'de'], ['en_US'])
+
+ You can specify the character used in the locale identifiers to separate
+ the different components. This separator is applied to both lists. Also,
+ case is ignored in the comparison:
+
+ >>> Locale.negotiate(['de-DE', 'de'], ['en-us', 'de-de'], sep='-')
+ Locale('de', territory='DE')
+
+ :param preferred: the list of locale identifiers preferred by the user
+ :param available: the list of locale identifiers available
+ :param aliases: a dictionary of aliases for locale identifiers
+ """
+ identifier = negotiate_locale(preferred, available, sep=sep,
+ aliases=aliases)
+ if identifier:
+ return Locale.parse(identifier, sep=sep)
+ return None
+
+ @classmethod
+ def parse(
+ cls,
+ identifier: str | Locale | None,
+ sep: str = '_',
+ resolve_likely_subtags: bool = True,
+ ) -> Locale:
+ """Create a `Locale` instance for the given locale identifier.
+
+ >>> l = Locale.parse('de-DE', sep='-')
+ >>> l.display_name
+ u'Deutsch (Deutschland)'
+
+ If the `identifier` parameter is not a string, but actually a `Locale`
+ object, that object is returned:
+
+ >>> Locale.parse(l)
+ Locale('de', territory='DE')
+
+ If the `identifier` parameter is neither of these, such as `None`
+ e.g. because a default locale identifier could not be determined,
+ a `TypeError` is raised:
+
+ >>> Locale.parse(None)
+ Traceback (most recent call last):
+ ...
+ TypeError: ...
+
+ This also can perform resolving of likely subtags which it does
+ by default. This is for instance useful to figure out the most
+ likely locale for a territory you can use ``'und'`` as the
+ language tag:
+
+ >>> Locale.parse('und_AT')
+ Locale('de', territory='AT')
+
+ Modifiers are optional, and always at the end, separated by "@":
+
+ >>> Locale.parse('de_AT@euro')
+ Locale('de', territory='AT', modifier='euro')
+
+ :param identifier: the locale identifier string
+ :param sep: optional component separator
+ :param resolve_likely_subtags: if this is specified then a locale will
+ have its likely subtag resolved if the
+ locale otherwise does not exist. For
+ instance ``zh_TW`` by itself is not a
+ locale that exists but Babel can
+ automatically expand it to the full
+ form of ``zh_hant_TW``. Note that this
+ expansion is only taking place if no
+ locale exists otherwise. For instance
+ there is a locale ``en`` that can exist
+ by itself.
+ :raise `ValueError`: if the string does not appear to be a valid locale
+ identifier
+ :raise `UnknownLocaleError`: if no locale data is available for the
+ requested locale
+ :raise `TypeError`: if the identifier is not a string or a `Locale`
+ """
+ if isinstance(identifier, Locale):
+ return identifier
+ elif not isinstance(identifier, str):
+ raise TypeError(f"Unexpected value for identifier: {identifier!r}")
+
+ parts = parse_locale(identifier, sep=sep)
+ input_id = get_locale_identifier(parts)
+
+ def _try_load(parts):
+ try:
+ return cls(*parts)
+ except UnknownLocaleError:
+ return None
+
+ def _try_load_reducing(parts):
+ # Success on first hit, return it.
+ locale = _try_load(parts)
+ if locale is not None:
+ return locale
+
+ # Now try without script and variant
+ locale = _try_load(parts[:2])
+ if locale is not None:
+ return locale
+
+ locale = _try_load(parts)
+ if locale is not None:
+ return locale
+ if not resolve_likely_subtags:
+ raise UnknownLocaleError(input_id)
+
+ # From here onwards is some very bad likely subtag resolving. This
+ # whole logic is not entirely correct but good enough (tm) for the
+ # time being. This has been added so that zh_TW does not cause
+ # errors for people when they upgrade. Later we should properly
+ # implement ICU like fuzzy locale objects and provide a way to
+ # maximize and minimize locale tags.
+
+ if len(parts) == 5:
+ language, territory, script, variant, modifier = parts
+ else:
+ language, territory, script, variant = parts
+ modifier = None
+ language = get_global('language_aliases').get(language, language)
+ territory = get_global('territory_aliases').get(territory or '', (territory,))[0]
+ script = get_global('script_aliases').get(script or '', script)
+ variant = get_global('variant_aliases').get(variant or '', variant)
+
+ if territory == 'ZZ':
+ territory = None
+ if script == 'Zzzz':
+ script = None
+
+ parts = language, territory, script, variant, modifier
+
+ # First match: try the whole identifier
+ new_id = get_locale_identifier(parts)
+ likely_subtag = get_global('likely_subtags').get(new_id)
+ if likely_subtag is not None:
+ locale = _try_load_reducing(parse_locale(likely_subtag))
+ if locale is not None:
+ return locale
+
+ # If we did not find anything so far, try again with a
+ # simplified identifier that is just the language
+ likely_subtag = get_global('likely_subtags').get(language)
+ if likely_subtag is not None:
+ parts2 = parse_locale(likely_subtag)
+ if len(parts2) == 5:
+ language2, _, script2, variant2, modifier2 = parts2
+ else:
+ language2, _, script2, variant2 = parts2
+ modifier2 = None
+ locale = _try_load_reducing((language2, territory, script2, variant2, modifier2))
+ if locale is not None:
+ return locale
+
+ raise UnknownLocaleError(input_id)
+
+ def __eq__(self, other: object) -> bool:
+ for key in ('language', 'territory', 'script', 'variant', 'modifier'):
+ if not hasattr(other, key):
+ return False
+ return (
+ self.language == getattr(other, 'language') and # noqa: B009
+ self.territory == getattr(other, 'territory') and # noqa: B009
+ self.script == getattr(other, 'script') and # noqa: B009
+ self.variant == getattr(other, 'variant') and # noqa: B009
+ self.modifier == getattr(other, 'modifier') # noqa: B009
+ )
+
+ def __ne__(self, other: object) -> bool:
+ return not self.__eq__(other)
+
+ def __hash__(self) -> int:
+ return hash((self.language, self.territory, self.script,
+ self.variant, self.modifier))
+
+ def __repr__(self) -> str:
+ parameters = ['']
+ for key in ('territory', 'script', 'variant', 'modifier'):
+ value = getattr(self, key)
+ if value is not None:
+ parameters.append(f"{key}={value!r}")
+ return f"Locale({self.language!r}{', '.join(parameters)})"
+
+ def __str__(self) -> str:
+ return get_locale_identifier((self.language, self.territory,
+ self.script, self.variant,
+ self.modifier))
+
+ @property
+ def _data(self) -> localedata.LocaleDataDict:
+ if self.__data is None:
+ self.__data = localedata.LocaleDataDict(localedata.load(str(self)))
+ return self.__data
+
+ def get_display_name(self, locale: Locale | str | None = None) -> str | None:
+ """Return the display name of the locale using the given locale.
+
+ The display name will include the language, territory, script, and
+ variant, if those are specified.
+
+ >>> Locale('zh', 'CN', script='Hans').get_display_name('en')
+ u'Chinese (Simplified, China)'
+
+ Modifiers are currently passed through verbatim:
+
+ >>> Locale('it', 'IT', modifier='euro').get_display_name('en')
+ u'Italian (Italy, euro)'
+
+ :param locale: the locale to use
+ """
+ if locale is None:
+ locale = self
+ locale = Locale.parse(locale)
+ retval = locale.languages.get(self.language)
+ if retval and (self.territory or self.script or self.variant):
+ details = []
+ if self.script:
+ details.append(locale.scripts.get(self.script))
+ if self.territory:
+ details.append(locale.territories.get(self.territory))
+ if self.variant:
+ details.append(locale.variants.get(self.variant))
+ if self.modifier:
+ details.append(self.modifier)
+ detail_string = ', '.join(atom for atom in details if atom)
+ if detail_string:
+ retval += f" ({detail_string})"
+ return retval
+
+ display_name = property(get_display_name, doc="""\
+ The localized display name of the locale.
+
+ >>> Locale('en').display_name
+ u'English'
+ >>> Locale('en', 'US').display_name
+ u'English (United States)'
+ >>> Locale('sv').display_name
+ u'svenska'
+
+ :type: `unicode`
+ """)
+
+ def get_language_name(self, locale: Locale | str | None = None) -> str | None:
+ """Return the language of this locale in the given locale.
+
+ >>> Locale('zh', 'CN', script='Hans').get_language_name('de')
+ u'Chinesisch'
+
+ .. versionadded:: 1.0
+
+ :param locale: the locale to use
+ """
+ if locale is None:
+ locale = self
+ locale = Locale.parse(locale)
+ return locale.languages.get(self.language)
+
+ language_name = property(get_language_name, doc="""\
+ The localized language name of the locale.
+
+ >>> Locale('en', 'US').language_name
+ u'English'
+ """)
+
+ def get_territory_name(self, locale: Locale | str | None = None) -> str | None:
+ """Return the territory name in the given locale."""
+ if locale is None:
+ locale = self
+ locale = Locale.parse(locale)
+ return locale.territories.get(self.territory or '')
+
+ territory_name = property(get_territory_name, doc="""\
+ The localized territory name of the locale if available.
+
+ >>> Locale('de', 'DE').territory_name
+ u'Deutschland'
+ """)
+
+ def get_script_name(self, locale: Locale | str | None = None) -> str | None:
+ """Return the script name in the given locale."""
+ if locale is None:
+ locale = self
+ locale = Locale.parse(locale)
+ return locale.scripts.get(self.script or '')
+
+ script_name = property(get_script_name, doc="""\
+ The localized script name of the locale if available.
+
+ >>> Locale('sr', 'ME', script='Latn').script_name
+ u'latinica'
+ """)
+
+ @property
+ def english_name(self) -> str | None:
+ """The english display name of the locale.
+
+ >>> Locale('de').english_name
+ u'German'
+ >>> Locale('de', 'DE').english_name
+ u'German (Germany)'
+
+ :type: `unicode`"""
+ return self.get_display_name(Locale('en'))
+
+ # { General Locale Display Names
+
+ @property
+ def languages(self) -> localedata.LocaleDataDict:
+ """Mapping of language codes to translated language names.
+
+ >>> Locale('de', 'DE').languages['ja']
+ u'Japanisch'
+
+ See `ISO 639 Related Topics
+-
+
- Documentation overview
-
+ {%- for parent in parents %}
+
- {{ parent.title }}
-
+ {%- endfor %}
+ {%- if prev %}
+
- Previous: {{ prev.title }} + {%- endif %} + {%- if next %} +
- Next: {{ next.title }} + {%- endif %} + {%- for parent in parents %} +
+ {%- endfor %}
+
+ - {{ parent.title }}